Bug 5670: Housebound Readers Module
[koha-ffzg.git] / Koha / Patron / HouseboundVisit.pm
1 package Koha::Patron::HouseboundVisit;
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
22 use base qw(Koha::Object);
23
24 =head1 NAME
25
26 Koha::Patron::HouseboundVisit - Koha Patron HouseboundVisit Object class
27
28 =head1 SYNOPSIS
29
30 HouseboundVisit class used primarily by members/housebound.pl.
31
32 =head1 DESCRIPTION
33
34 Standard Koha::Objects definitions, and additional methods.
35
36 =head1 API
37
38 =head2 Class Methods
39
40 =cut
41
42 =head3 chooser
43
44   my $chooser = Koha::Patron::HouseboundVisit->chooser;
45
46 Returns the prefetched chooser for this visit.
47
48 =cut
49
50 sub chooser {
51     my ( $self ) = @_;
52     return $self->_result->chooser_brwnumber;
53 }
54
55 =head3 deliverer
56
57   my $deliverer = Koha::Patron::HouseboundVisit->deliverer;
58
59 Returns the prefetched deliverer for this visit.
60
61 =cut
62
63 sub deliverer {
64     my ( $self ) = @_;
65     return $self->_result->deliverer_brwnumber;
66
67 }
68
69 =head3 _type
70
71 =cut
72
73 sub _type {
74     return 'HouseboundVisit';
75 }
76
77 1;
78
79 =head1 AUTHOR
80
81 Alex Sassmannshausen <alex.sassmannshausen@ptfs-europe.com>
82
83 =cut