Koha/Patron.pm

   1 package Koha::Patron;
   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 use Koha::Patrons;
  26 use Koha::Patron::Images;
  27
  28 use base qw(Koha::Object);
  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 guarantor
  41
  42 Returns a Koha::Patron object for this patron's guarantor
  43
  44 =cut
  45
  46 sub guarantor {
  47     my ( $self ) = @_;
  48
  49     return unless $self->guarantorid();
  50
  51     return Koha::Patrons->find( $self->guarantorid() );
  52 }
  53
  54 sub image {
  55     my ( $self ) = @_;
  56
  57     return Koha::Patron::Images->find( $self->borrowernumber )
  58 }
  59
  60 =head3 guarantees
  61
  62 Returns the guarantees (list of Koha::Patron) of this patron
  63
  64 =cut
  65
  66 sub guarantees {
  67     my ( $self ) = @_;
  68
  69     return Koha::Patrons->search( { guarantorid => $self->borrowernumber } );
  70 }
  71
  72 =head3 siblings
  73
  74 Returns the siblings of this patron.
  75
  76 =cut
  77
  78 sub siblings {
  79     my ( $self ) = @_;
  80
  81     my $guarantor = $self->guarantor;
  82
  83     return unless $guarantor;
  84
  85     return Koha::Patrons->search(
  86         {
  87             guarantorid => {
  88                 '!=' => undef,
  89                 '=' => $guarantor->id,
  90             },
  91             borrowernumber => {
  92                 '!=' => $self->borrowernumber,
  93             }
  94         }
  95     );
  96 }
  97
  98 =head3 type
  99
 100 =cut
 101
 102 sub _type {
 103     return 'Borrower';
 104 }
 105
 106 =head1 AUTHOR
 107
 108 Kyle M Hall <kyle@bywatersolutions.com>
 109
 110 =cut
 111
 112 1;