3 # Copyright 2014 ByWater Solutions
4 # Copyright 2016 Koha Development Team
6 # This file is part of Koha.
8 # Koha is free software; you can redistribute it and/or modify it under the
9 # terms of the GNU General Public License as published by the Free Software
10 # Foundation; either version 3 of the License, or (at your option) any later
13 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
14 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
15 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License along
18 # with Koha; if not, write to the Free Software Foundation, Inc.,
19 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
28 use Koha::ArticleRequests;
29 use Koha::ArticleRequest::Status;
32 use base qw(Koha::Objects);
36 Koha::Patron - Koha Patron Object class
44 =head3 search_housebound_choosers
46 Returns all Patrons which are Housebound choosers.
50 sub search_housebound_choosers {
52 my $cho = $self->_resultset
53 ->search_related('housebound_role', {
54 housebound_chooser => 1,
55 })->search_related('borrowernumber');
56 return Koha::Patrons->_new_from_dbic($cho);
59 =head3 search_housebound_deliverers
61 Returns all Patrons which are Housebound deliverers.
65 sub search_housebound_deliverers {
67 my $del = $self->_resultset
68 ->search_related('housebound_role', {
69 housebound_deliverer => 1,
70 })->search_related('borrowernumber');
71 return Koha::Patrons->_new_from_dbic($del);
76 my $patrons = Koha::Patrons->search_upcoming_membership_expires();
78 The 'before' and 'after' represent the number of days before/after the date
79 that is set by the preference MembershipExpiryDaysNotice.
80 If the pref is 14, before 2 and after 3 then you will get all expires
85 sub search_upcoming_membership_expires {
86 my ( $self, $params ) = @_;
87 my $before = $params->{before} || 0;
88 my $after = $params->{after} || 0;
89 delete $params->{before};
90 delete $params->{after};
92 my $days = C4::Context->preference("MembershipExpiryDaysNotice") || 0;
93 my $date_before = dt_from_string->add( days => $days - $before );
94 my $date_after = dt_from_string->add( days => $days + $after );
95 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
97 $params->{dateexpiry} = {
98 ">=" => $dtf->format_date( $date_before ),
99 "<=" => $dtf->format_date( $date_after ),
101 return $self->SUPER::search(
102 $params, { join => ['branchcode', 'categorycode'] }
108 Returns a Koha::Patron object for this borrower's guarantor
115 return Koha::Patrons->find( $self->guarantorid() );
118 =head3 article_requests
120 my @requests = $borrower->article_requests();
121 my $requests = $borrower->article_requests();
123 Returns either a list of ArticleRequests objects,
124 or an ArtitleRequests object, depending on the
129 sub article_requests {
132 $self->{_article_requests} ||= Koha::ArticleRequests->search({ borrowernumber => $self->borrowernumber() });
134 return $self->{_article_requests};
137 =head3 article_requests_current
139 my @requests = $patron->article_requests_current
141 Returns the article requests associated with this patron that are incomplete
145 sub article_requests_current {
148 $self->{_article_requests_current} ||= Koha::ArticleRequests->search(
150 borrowernumber => $self->id(),
152 { status => Koha::ArticleRequest::Status::Pending },
153 { status => Koha::ArticleRequest::Status::Processing }
158 return $self->{_article_requests_current};
161 =head3 article_requests_finished
163 my @requests = $biblio->article_requests_finished
165 Returns the article requests associated with this patron that are completed
169 sub article_requests_finished {
170 my ( $self, $borrower ) = @_;
172 $self->{_article_requests_finished} ||= Koha::ArticleRequests->search(
174 borrowernumber => $self->id(),
176 { status => Koha::ArticleRequest::Status::Completed },
177 { status => Koha::ArticleRequest::Status::Canceled }
182 return $self->{_article_requests_finished};
185 =head3 search_patrons_to_anonymise
187 my $patrons = Koha::Patrons->search_patrons_to_anonymise( $date );
189 This method returns all patrons who has an issue history older than a given date.
193 sub search_patrons_to_anonymise {
194 my ( $class, $older_than_date, $library ) = @_;
195 $older_than_date = $older_than_date ? dt_from_string($older_than_date) : dt_from_string;
197 ( C4::Context->preference('IndependentBranches') && C4::Context->userenv && !C4::Context->IsSuperLibrarian() && C4::Context->userenv->{branch} )
198 ? C4::Context->userenv->{branch}
201 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
202 my $rs = $class->_resultset->search(
203 { returndate => { '<' => $dtf->format_datetime($older_than_date), },
204 'old_issues.borrowernumber' => { 'not' => undef },
205 privacy => { '<>' => 0 }, # Keep forever
206 ( $library ? ( 'old_issues.branchcode' => $library ) : () ),
208 { join => ["old_issues"],
209 group_by => 'borrowernumber'
212 return Koha::Patrons->_new_from_dbic($rs);
215 =head3 anonymise_issue_history
217 Koha::Patrons->search->anonymise_issue_history( $older_than_date );
219 Anonymise issue history (old_issues) for all patrons older than the given date.
220 To make sure all the conditions are met, the caller has the responsability to
221 call search_patrons_to_anonymise to filter the Koha::Patrons set
225 sub anonymise_issue_history {
226 my ( $self, $older_than_date ) = @_;
228 return unless $older_than_date;
229 $older_than_date = dt_from_string $older_than_date;
231 # The default of 0 does not work due to foreign key constraints
232 # The anonymisation should not fail quietly if AnonymousPatron is not a valid entry
233 # Set it to undef (NULL)
234 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
235 my $old_issues_to_anonymise = $self->search_related( 'old_issues', { returndate => { '<' => $dtf->format_datetime($older_than_date) } } );
236 my $anonymous_patron = C4::Context->preference('AnonymousPatron') || undef;
237 $old_issues_to_anonymise->update( { 'old_issues.borrowernumber' => $anonymous_patron } );
249 return 'Koha::Patron';
254 Kyle M Hall <kyle@bywatersolutions.com>