Bug 24545: Fix license statements
[srvgit] / Koha / Old / Checkout.pm
1 package Koha::Old::Checkout;
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
22 use base qw(Koha::Object);
23
24 =head1 NAME
25
26 Koha::Old:Checkout - Koha checkout object for returned items
27
28 =head1 API
29
30 =head2 Class methods
31
32 =head3 item
33
34 my $item = $checkout->item;
35
36 Return the checked out item
37
38 =cut
39
40 sub item {
41     my ( $self ) = @_;
42     my $item_rs = $self->_result->item;
43     return Koha::Item->_new_from_dbic( $item_rs );
44 }
45
46 =head3 patron
47
48 my $patron = $checkout->patron
49
50 Return the patron for who the checkout has been done
51
52 =cut
53
54 sub patron {
55     my ( $self ) = @_;
56     my $patron_rs = $self->_result->borrower;
57     return unless $patron_rs;
58     return Koha::Patron->_new_from_dbic( $patron_rs );
59 }
60
61 =head3 to_api_mapping
62
63 This method returns the mapping for representing a Koha::Old::Checkout object
64 on the API.
65
66 =cut
67
68 sub to_api_mapping {
69     return {
70         issue_id        => 'checkout_id',
71         borrowernumber  => 'patron_id',
72         itemnumber      => 'item_id',
73         date_due        => 'due_date',
74         branchcode      => 'library_id',
75         returndate      => 'checkin_date',
76         lastreneweddate => 'last_renewed_date',
77         issuedate       => 'checkout_date',
78         notedate        => 'note_date',
79     };
80 }
81
82 =head2 Internal methods
83
84 =head3 _type
85
86 =cut
87
88 sub _type {
89     return 'OldIssue';
90 }
91
92 1;