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
   6 # under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 3 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # Koha is distributed in the hope that it will be useful, but
  11 # WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  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 a I<Koha::Patron::HouseboundVisits> iterator for all the visits
  48 associated this houseboundProfile.
  49
  50 =cut
  51
  52 sub housebound_visits {
  53     my ( $self ) = @_;
  54     return Koha::Patron::HouseboundVisits
  55         ->special_search({ borrowernumber => $self->borrowernumber });
  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