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>.
27 use base qw(Koha::Objects);
29 use Koha::SearchEngine::Indexer;
33 Koha::Items - Koha Item object set class
41 =head3 filter_by_for_hold
43 my $filtered_items = $items->filter_by_for_hold;
45 Return the items of the set that are holdable
49 sub filter_by_for_hold {
51 return $self->search( { notforloan => { '<=' => 0 } } ); # items with negative or zero notforloan value are holdable
54 =head3 filter_by_visible_in_opac
56 my $filered_items = $items->filter_by_visible_in_opac(
62 Returns a new resultset, containing those items that are not expected to be hidden in OPAC
63 for the passed I<Koha::Patron> object that is passed.
65 The I<OpacHiddenItems>, I<hidelostitems> and I<OpacHiddenItemsExceptions> system preferences
70 sub filter_by_visible_in_opac {
71 my ($self, $params) = @_;
73 my $patron = $params->{patron};
77 # Filter out OpacHiddenItems unless disabled by OpacHiddenItemsExceptions
78 unless ( $patron and $patron->category->override_hidden_items ) {
79 my $rules = C4::Context->yaml_preference('OpacHiddenItems') // {};
82 foreach my $field ( keys %$rules ) {
83 $rules_params->{$field} =
84 [ { '-not_in' => $rules->{$field} }, undef ];
87 $result = $result->search( $rules_params );
90 if (C4::Context->preference('hidelostitems')) {
91 $result = $result->filter_out_lost;
97 =head3 filter_out_lost
99 my $filered_items = $items->filter_out_lost;
101 Returns a new resultset, containing those items that are not marked as lost.
105 sub filter_out_lost {
108 my $params = { itemlost => 0 };
110 return $self->search( $params );
113 =head3 move_to_biblio
115 $items->move_to_biblio($to_biblio);
117 Move items to a given biblio.
122 my ( $self, $to_biblio ) = @_;
124 my $biblionumbers = { $to_biblio->biblionumber => 1 };
125 while ( my $item = $self->next() ) {
126 $biblionumbers->{ $item->biblionumber } = 1;
127 $item->move_to_biblio( $to_biblio, { skip_record_index => 1 } );
129 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
130 for my $biblionumber ( keys %{$biblionumbers} ) {
131 $indexer->index_records( $biblionumber, "specialUpdate", "biblioserver" );
136 =head2 Internal methods
156 Kyle M Hall <kyle@bywatersolutions.com>
157 Tomas Cohen Arazi <tomascohen@theke.io>
158 Martin Renvoize <martin.renvoize@ptfs-europe.com>