Koha/Items.pm

   1 package Koha::Items;
   2
   3 # Copyright ByWater Solutions 2014
   4 #
   5 # This file is part of Koha.
   6 #
   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.
  11 #
  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.
  16 #
  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>.
  19
  20 use Modern::Perl;
  21
  22
  23 use Koha::Database;
  24
  25 use Koha::Item;
  26
  27 use base qw(Koha::Objects);
  28
  29 use Koha::SearchEngine::Indexer;
  30
  31 =head1 NAME
  32
  33 Koha::Items - Koha Item object set class
  34
  35 =head1 API
  36
  37 =head2 Class methods
  38
  39 =cut
  40
  41 =head3 filter_by_for_hold
  42
  43     my $filtered_items = $items->filter_by_for_hold;
  44
  45 Return the items of the set that are holdable
  46
  47 =cut
  48
  49 sub filter_by_for_hold {
  50     my ($self) = @_;
  51     return $self->search( { notforloan => { '<=' => 0 } } ); # items with negative or zero notforloan value are holdable
  52 }
  53
  54 =head3 filter_by_visible_in_opac
  55
  56     my $filered_items = $items->filter_by_visible_in_opac(
  57         {
  58             [ patron => $patron ]
  59         }
  60     );
  61
  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.
  64
  65 The I<OpacHiddenItems>, I<hidelostitems> and I<OpacHiddenItemsExceptions> system preferences
  66 are honoured.
  67
  68 =cut
  69
  70 sub filter_by_visible_in_opac {
  71     my ($self, $params) = @_;
  72
  73     my $patron = $params->{patron};
  74
  75     my $result = $self;
  76
  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') // {};
  80
  81         my $rules_params;
  82         foreach my $field ( keys %$rules ) {
  83             $rules_params->{$field} =
  84               [ { '-not_in' => $rules->{$field} }, undef ];
  85         }
  86
  87         $result = $result->search( $rules_params );
  88     }
  89
  90     if (C4::Context->preference('hidelostitems')) {
  91         $result = $result->filter_out_lost;
  92     }
  93
  94     return $result;
  95 }
  96
  97 =head3 filter_out_lost
  98
  99     my $filered_items = $items->filter_out_lost;
 100
 101 Returns a new resultset, containing those items that are not marked as lost.
 102
 103 =cut
 104
 105 sub filter_out_lost {
 106     my ($self) = @_;
 107
 108     my $params = { itemlost => 0 };
 109
 110     return $self->search( $params );
 111 }
 112
 113 =head3 move_to_biblio
 114
 115  $items->move_to_biblio($to_biblio);
 116
 117 Move items to a given biblio.
 118
 119 =cut
 120
 121 sub move_to_biblio {
 122     my ( $self, $to_biblio ) = @_;
 123
 124     while (my $item = $self->next()) {
 125         $item->move_to_biblio($to_biblio, { skip_record_index => 1 });
 126     }
 127     my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
 128     $indexer->index_records( $self->biblionumber, "specialUpdate", "biblioserver" );
 129     $indexer->index_records( $from_biblio->biblionumber, "specialUpdate", "biblioserver" );
 130 }
 131
 132
 133 =head2 Internal methods
 134
 135 =head3 _type
 136
 137 =cut
 138
 139 sub _type {
 140     return 'Item';
 141 }
 142
 143 =head3 object_class
 144
 145 =cut
 146
 147 sub object_class {
 148     return 'Koha::Item';
 149 }
 150
 151 =head1 AUTHOR
 152
 153 Kyle M Hall <kyle@bywatersolutions.com>
 154 Tomas Cohen Arazi <tomascohen@theke.io>
 155 Martin Renvoize <martin.renvoize@ptfs-europe.com>
 156
 157 =cut
 158
 159 1;