3 # Copyright ByWater Solutions 2014
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
28 use base qw(Koha::Objects);
32 Koha::Items - Koha Item object set class
40 =head3 filter_by_for_hold
42 my $filtered_items = $items->filter_by_for_hold;
44 Return the items of the set that are holdable
48 sub filter_by_for_hold {
50 return $self->search( { notforloan => { '<=' => 0 } } ); # items with negative or zero notforloan value are holdable
53 =head3 filter_by_visible_in_opac
55 my $filered_items = $items->filter_by_visible_in_opac(
61 Returns a new resultset, containing those items that are not expected to be hidden in OPAC
62 for the passed I<Koha::Patron> object that is passed.
64 The I<OpacHiddenItems>, I<hidelostitems> and I<OpacHiddenItemsExceptions> system preferences
69 sub filter_by_visible_in_opac {
70 my ($self, $params) = @_;
72 my $patron = $params->{patron};
76 # Filter out OpacHiddenItems unless disabled by OpacHiddenItemsExceptions
77 unless ( $patron and $patron->category->override_hidden_items ) {
78 my $rules = C4::Context->yaml_preference('OpacHiddenItems') // {};
81 foreach my $field ( keys %$rules ) {
82 $rules_params->{$field} =
83 [ { '-not_in' => $rules->{$field} }, undef ];
86 $result = $result->search( $rules_params );
89 if (C4::Context->preference('hidelostitems')) {
90 $result = $result->filter_out_lost;
96 =head3 filter_out_lost
98 my $filered_items = $items->filter_out_lost;
100 Returns a new resultset, containing those items that are not marked as lost.
104 sub filter_out_lost {
107 my $params = { itemlost => 0 };
109 return $self->search( $params );
112 =head2 Internal methods
132 Kyle M Hall <kyle@bywatersolutions.com>
133 Tomas Cohen Arazi <tomascohen@theke.io>
134 Martin Renvoize <martin.renvoize@ptfs-europe.com>