Koha/Patrons.pm

   1 package Koha::Patrons;
   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 under the
   8 # terms of the GNU General Public License as published by the Free Software
   9 # Foundation; either version 3 of the License, or (at your option) any later
  10 # version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  14 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License along
  17 # with Koha; if not, write to the Free Software Foundation, Inc.,
  18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19
  20 use Modern::Perl;
  21
  22 use Carp;
  23
  24 use Koha::Database;
  25
  26 use Koha::Patron;
  27
  28 use base qw(Koha::Objects);
  29
  30 =head1 NAME
  31
  32 Koha::Patron - Koha Patron Object class
  33
  34 =head1 API
  35
  36 =head2 Class Methods
  37
  38 =cut
  39
  40 =head3 housebound_choosers
  41
  42 Returns all Patrons which are Housebound choosers.
  43
  44 =cut
  45
  46 sub housebound_choosers {
  47     my ( $self ) = @_;
  48     my $cho = $self->_resultset->search
  49         ->search_related('borrower_attributes', {
  50             code => 'HSBND',
  51             attribute => 'CHO',
  52         })->search_related('borrowernumber');
  53     return Koha::Patrons->_new_from_dbic($cho);
  54 }
  55
  56 =head3 housebound_deliverers
  57
  58 Returns all Patrons which are Housebound deliverers.
  59
  60 =cut
  61
  62 sub housebound_deliverers {
  63     my ( $self ) = @_;
  64     my $del = $self->_resultset->search
  65         ->search_related('borrower_attributes', {
  66             code => 'HSBND',
  67             attribute => 'DEL',
  68         })->search_related('borrowernumber');
  69     return Koha::Patrons->_new_from_dbic($del);
  70 }
  71
  72 =head3 type
  73
  74 =cut
  75
  76 sub _type {
  77     return 'Borrower';
  78 }
  79
  80 sub object_class {
  81     return 'Koha::Patron';
  82 }
  83
  84 =head1 AUTHOR
  85
  86 Kyle M Hall <kyle@bywatersolutions.com>
  87
  88 =cut
  89
  90 1;