Bug 16933 - Update documentation/help file.
[koha.git] / Koha / Patron / Modification.pm
blobd1e033b3b6c718bd534eda353177e56ad03e0cc7
1 package Koha::Patron::Modification;
3 # Copyright ByWater Solutions 2014
5 # This file is part of Koha.
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.
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.
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.
20 use Modern::Perl;
22 use Carp;
24 use Koha::Database;
26 use Koha::Patron::Modifications;
27 use Koha::Exceptions::Patron::Modification;
29 use base qw(Koha::Object);
31 =head1 NAME
33 Koha::Patron::Modification - Class represents a request to modify or create a patron
35 =head2 Class Methods
37 =cut
39 =head2 store
41 =cut
43 sub store {
44 my ($self) = @_;
46 if ( $self->verification_token ) {
47 if ( Koha::Patron::Modifications->search( { verification_token => $self->verification_token } )->count() ) {
48 Koha::Exceptions::Patron::Modification::DuplicateVerificationToken->throw(
49 "Duplicate verification token " . $self->verification_token
54 return $self->SUPER::store();
57 =head2 approve
59 $m->approve();
61 Commits the pending modifications to the borrower record and removes
62 them from the modifications table.
64 =cut
66 sub approve {
67 my ($self) = @_;
69 my $data = $self->unblessed();
71 delete $data->{timestamp};
72 delete $data->{verification_token};
74 foreach my $key ( keys %$data ) {
75 delete $data->{$key} unless ( defined( $data->{$key} ) );
78 my $patron = Koha::Patrons->find( $self->borrowernumber );
80 return unless $patron;
82 $patron->set($data);
84 if ( $patron->store() ) {
85 return $self->delete();
89 =head3 type
91 =cut
93 sub _type {
94 return 'BorrowerModification';
97 =head1 AUTHOR
99 Kyle M Hall <kyle@bywatersolutions.com>
101 =cut