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 $items->filter_by_not_for_loan;
  43
  44 Return the items of the set that are not for loan
  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> and I<hidelostitems> system preferences are honoured.
  65
  66 =cut
  67
  68 sub filter_by_visible_in_opac {
  69     my ($self, $params) = @_;
  70
  71     my $patron = $params->{patron};
  72
  73     my $result = $self;
  74
  75     unless ( $patron and $patron->category->override_hidden_items ) {
  76         $result = $result->filter_out_opachiddenitems;
  77     }
  78
  79     if (C4::Context->preference('hidelostitems')) {
  80         $result = $result->filter_out_lost;
  81     }
  82
  83     return $result;
  84 }
  85
  86 =head3 filter_out_opachiddenitems
  87
  88     my $filered_items = $items->filter_out_opachiddenitems;
  89
  90 Returns a new resultset, containing those items that are not expected to be hidden in OPAC.
  91 The I<OpacHiddenItems> system preference is honoured.
  92
  93 =cut
  94
  95 sub filter_out_opachiddenitems {
  96     my ($self) = @_;
  97
  98     my $rules = C4::Context->yaml_preference('OpacHiddenItems') // {};
  99
 100     my $rules_params;
 101     foreach my $field (keys %$rules){
 102         $rules_params->{$field}->{'-not_in'} = $rules->{$field};
 103     }
 104
 105     return $self->search( $rules_params );
 106 }
 107
 108 =head3 filter_out_lost
 109
 110     my $filered_items = $items->filter_out_lost;
 111
 112 Returns a new resultset, containing those items that are not marked as lost.
 113
 114 =cut
 115
 116 sub filter_out_lost {
 117     my ($self) = @_;
 118
 119     my $params = { itemlost => 0 };
 120
 121     return $self->search( $params );
 122 }
 123
 124 =head2 Internal methods
 125
 126 =head3 _type
 127
 128 =cut
 129
 130 sub _type {
 131     return 'Item';
 132 }
 133
 134 =head3 object_class
 135
 136 =cut
 137
 138 sub object_class {
 139     return 'Koha::Item';
 140 }
 141
 142 =head1 AUTHOR
 143
 144 Kyle M Hall <kyle@bywatersolutions.com>
 145
 146 =cut
 147
 148 1;