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 Returns a new resultset, containing those items that are not expected to be hidden in OPAC.
  58 The I<OpacHiddenItems> and I<hidelostitems> system preferences are honoured.
  59
  60 =cut
  61
  62 sub filter_by_visible_in_opac {
  63     my ($self, $params) = @_;
  64
  65     my $rules = C4::Context->yaml_preference('OpacHiddenItems') // {};
  66
  67     my $rules_params;
  68     foreach my $field (keys %$rules){
  69         $rules_params->{$field}->{'-not_in'} = $rules->{$field};
  70     }
  71
  72     my $itemlost_params;
  73     $itemlost_params = { itemlost => 0 }
  74         if C4::Context->preference('hidelostitems');
  75
  76     my $search_params;
  77     if ( $rules_params and $itemlost_params ) {
  78         $search_params = {
  79             '-and' => [ $rules_params, $itemlost_params ]
  80         };
  81     }
  82     else {
  83         $search_params = $rules_params // $itemlost_params;
  84     }
  85
  86     return $self->search( $search_params );
  87 }
  88
  89 =head2 Internal methods
  90
  91 =head3 _type
  92
  93 =cut
  94
  95 sub _type {
  96     return 'Item';
  97 }
  98
  99 =head3 object_class
 100
 101 =cut
 102
 103 sub object_class {
 104     return 'Koha::Item';
 105 }
 106
 107 =head1 AUTHOR
 108
 109 Kyle M Hall <kyle@bywatersolutions.com>
 110
 111 =cut
 112
 113 1;