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
  52     return $self->search(
  53         {
  54             itemlost   => 0,
  55             withdrawn  => 0,
  56             notforloan => { '<=' => 0 }
  57             ,    # items with negative or zero notforloan value are holdable
  58         }
  59     );
  60 }
  61
  62 =head3 filter_by_visible_in_opac
  63
  64     my $filered_items = $items->filter_by_visible_in_opac(
  65         {
  66             [ patron => $patron ]
  67         }
  68     );
  69
  70 Returns a new resultset, containing those items that are not expected to be hidden in OPAC
  71 for the passed I<Koha::Patron> object that is passed.
  72
  73 The I<OpacHiddenItems>, I<hidelostitems> and I<OpacHiddenItemsExceptions> system preferences
  74 are honoured.
  75
  76 =cut
  77
  78 sub filter_by_visible_in_opac {
  79     my ($self, $params) = @_;
  80
  81     my $patron = $params->{patron};
  82
  83     my $result = $self;
  84
  85     # Filter out OpacHiddenItems unless disabled by OpacHiddenItemsExceptions
  86     unless ( $patron and $patron->category->override_hidden_items ) {
  87         my $rules = C4::Context->yaml_preference('OpacHiddenItems') // {};
  88
  89         my $rules_params;
  90         foreach my $field ( keys %$rules ) {
  91             $rules_params->{$field} =
  92               [ { '-not_in' => $rules->{$field} }, undef ];
  93         }
  94
  95         $result = $result->search( $rules_params );
  96     }
  97
  98     if (C4::Context->preference('hidelostitems')) {
  99         $result = $result->filter_out_lost;
 100     }
 101
 102     return $result;
 103 }
 104
 105 =head3 filter_out_lost
 106
 107     my $filered_items = $items->filter_out_lost;
 108
 109 Returns a new resultset, containing those items that are not marked as lost.
 110
 111 =cut
 112
 113 sub filter_out_lost {
 114     my ($self) = @_;
 115
 116     my $params = { itemlost => 0 };
 117
 118     return $self->search( $params );
 119 }
 120
 121 =head3 move_to_biblio
 122
 123  $items->move_to_biblio($to_biblio);
 124
 125 Move items to a given biblio.
 126
 127 =cut
 128
 129 sub move_to_biblio {
 130     my ( $self, $to_biblio ) = @_;
 131
 132     my $biblionumbers = { $to_biblio->biblionumber => 1 };
 133     while ( my $item = $self->next() ) {
 134         $biblionumbers->{ $item->biblionumber } = 1;
 135         $item->move_to_biblio( $to_biblio, { skip_record_index => 1 } );
 136     }
 137     my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
 138     for my $biblionumber ( keys %{$biblionumbers} ) {
 139         $indexer->index_records( $biblionumber, "specialUpdate", "biblioserver" );
 140     }
 141 }
 142
 143
 144 =head2 Internal methods
 145
 146 =head3 _type
 147
 148 =cut
 149
 150 sub _type {
 151     return 'Item';
 152 }
 153
 154 =head3 object_class
 155
 156 =cut
 157
 158 sub object_class {
 159     return 'Koha::Item';
 160 }
 161
 162 =head1 AUTHOR
 163
 164 Kyle M Hall <kyle@bywatersolutions.com>
 165 Tomas Cohen Arazi <tomascohen@theke.io>
 166 Martin Renvoize <martin.renvoize@ptfs-europe.com>
 167
 168 =cut
 169
 170 1;