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 use Carp;
  23
  24 use Koha::Database;
  25
  26 use Koha::Item;
  27
  28 use base qw(Koha::Objects);
  29
  30 =head1 NAME
  31
  32 Koha::Items - Koha Item object set class
  33
  34 =head1 API
  35
  36 =head2 Class methods
  37
  38 =cut
  39
  40 =head3 filter_by_for_loan
  41
  42     my $filtered_items = $items->filter_by_for_loan;
  43
  44 Return the items of the set that are loanable
  45
  46 =cut
  47
  48 sub filter_by_for_loan {
  49     my ($self) = @_;
  50     return $self->search( { notforloan => [ 0, undef ] } );
  51 }
  52
  53 =head3 filter_by_visible_in_opac
  54
  55     my $filered_items = $items->filter_by_visible_in_opac(
  56         {
  57             [ patron => $patron ]
  58         }
  59     );
  60
  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.
  63
  64 The I<OpacHiddenItems>, I<hidelostitems> and I<OpacHiddenItemsExceptions> system preferences
  65 are honoured.
  66
  67 =cut
  68
  69 sub filter_by_visible_in_opac {
  70     my ($self, $params) = @_;
  71
  72     my $patron = $params->{patron};
  73
  74     my $result = $self;
  75
  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') // {};
  79
  80         my $rules_params;
  81         foreach my $field (keys %$rules){
  82             $rules_params->{$field}->{'-not_in'} = $rules->{$field};
  83         }
  84
  85         $result = $result->search( $rules_params );
  86     }
  87
  88     if (C4::Context->preference('hidelostitems')) {
  89         $result = $result->filter_out_lost;
  90     }
  91
  92     return $result;
  93 }
  94
  95 =head3 filter_out_lost
  96
  97     my $filered_items = $items->filter_out_lost;
  98
  99 Returns a new resultset, containing those items that are not marked as lost.
 100
 101 =cut
 102
 103 sub filter_out_lost {
 104     my ($self) = @_;
 105
 106     my $params = { itemlost => 0 };
 107
 108     return $self->search( $params );
 109 }
 110
 111 =head2 Internal methods
 112
 113 =head3 _type
 114
 115 =cut
 116
 117 sub _type {
 118     return 'Item';
 119 }
 120
 121 =head3 object_class
 122
 123 =cut
 124
 125 sub object_class {
 126     return 'Koha::Item';
 127 }
 128
 129 =head1 AUTHOR
 130
 131 Kyle M Hall <kyle@bywatersolutions.com>
 132 Tomas Cohen Arazi <tomascohen@theke.io>
 133 Martin Renvoize <martin.renvoize@ptfs-europe.com>
 134
 135 =cut
 136
 137 1;