Bug 24254: Compare itemlost with 0

[koha-ffzg.git] / Koha / Items.pm

diff --git a/Koha/Items.pm b/Koha/Items.pm
index 7b86c5a..f123a61 100644 (file)
--- a/Koha/Items.pm
+++ b/Koha/Items.pm
@@ -4,18 +4,18 @@ package Koha::Items;
 #
 # This file is part of Koha.
 #
-# Koha is free software; you can redistribute it and/or modify it under the
-# terms of the GNU General Public License as published by the Free Software
-# Foundation; either version 3 of the License, or (at your option) any later
-# version.
+# Koha is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
 #
-# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
-# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
-# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+# Koha is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
 #
-# You should have received a copy of the GNU General Public License along
-# with Koha; if not, write to the Free Software Foundation, Inc.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+# You should have received a copy of the GNU General Public License
+# along with Koha; if not, see <http://www.gnu.org/licenses>.
 
 use Modern::Perl;
 
@@ -33,11 +33,63 @@ Koha::Items - Koha Item object set class
 
 =head1 API
 
-=head2 Class Methods
+=head2 Class methods
 
 =cut
 
-=head3 type
+=head3 filter_by_for_loan
+
+$items->filter_by_not_for_loan;
+
+Return the items of the set that are not for loan
+
+=cut
+
+sub filter_by_for_loan {
+    my ($self) = @_;
+    return $self->search( { notforloan => [ 0, undef ] } );
+}
+
+=head3 filter_by_visible_in_opac
+
+    my $filered_items = $items->filter_by_visible_in_opac({ rules => $rules });
+
+Returns a new resultset, containing those items that are not expected to be hidden in OPAC.
+If no I<rules> are passed, it returns the whole resultset, with the only caveat that the
+I<hidelostitems> system preference is honoured.
+
+=cut
+
+sub filter_by_visible_in_opac {
+    my ($self, $params) = @_;
+
+    my $rules = $params->{rules} // {};
+
+    my $rules_params;
+    foreach my $field (keys %$rules){
+        $rules_params->{$field}->{'-not_in'} = $rules->{$field};
+    }
+
+    my $itemlost_params;
+    $itemlost_params = { itemlost => 0 }
+        if C4::Context->preference('hidelostitems');
+
+    my $search_params;
+    if ( $rules_params and $itemlost_params ) {
+        $search_params = {
+            '-and' => [ $rules_params, $itemlost_params ]
+        };
+    }
+    else {
+        $search_params = $rules_params // $itemlost_params;
+    }
+
+    return $self->search( $search_params );
+}
+
+=head2 Internal methods
+
+=head3 _type
 
 =cut