Koha/Patron/HouseboundProfile.pm

   1 package Koha::Patron::HouseboundProfile;
   2
   3 # This file is part of Koha.
   4 #
   5 # Koha is free software; you can redistribute it and/or modify it under the
   6 # terms of the GNU General Public License as published by the Free Software
   7 # Foundation; either version 3 of the License, or (at your option) any later
   8 # version.
   9 #
  10 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  11 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  12 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License along
  15 # with Koha; if not, write to the Free Software Foundation, Inc.,
  16 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17
  18 use Modern::Perl;
  19
  20 use Koha::Database;
  21 use Koha::Patron::HouseboundVisits;
  22
  23 use base qw(Koha::Object);
  24
  25 =head1 NAME
  26
  27 Koha::Patron::HouseboundProfile - Koha Patron HouseboundProfile Object class
  28
  29 =head1 SYNOPSIS
  30
  31 HouseboundProfile class used primarily by members/housebound.pl.
  32
  33 =head1 DESCRIPTION
  34
  35 Standard Koha::Objects definitions, and additional methods.
  36
  37 =head1 API
  38
  39 =head2 Class Methods
  40
  41 =cut
  42
  43 =head3 housebound_visits
  44
  45   my $visits = Koha::Patron::HouseboundProfile->housebound_visits;
  46
  47 Returns an arrayref of all visits associated this houseboundProfile.
  48
  49 =cut
  50
  51 sub housebound_visits {
  52     my ( $self ) = @_;
  53     my @visits = Koha::Patron::HouseboundVisits
  54         ->special_search({ borrowernumber => $self->borrowernumber });
  55     return \@visits;
  56 }
  57
  58 =head3 _type
  59
  60 =cut
  61
  62 sub _type {
  63     return 'HouseboundProfile';
  64 }
  65
  66 1;
  67
  68 =head1 AUTHOR
  69
  70 Alex Sassmannshausen <alex.sassmannshausen@ptfs-europe.com>
  71
  72 =cut