<<

NAME

Koha::Patron - Koha Patron Object class

API

Class Methods

delete

$patron->delete

Delete patron's holds, lists and finally the patron.

Lists owned by the borrower are deleted, but entries from the borrower to other lists are kept.

category

my $patron_category = $patron->category

Return the patron category for this patron

guarantor

Returns a Koha::Patron object for this patron's guarantor

guarantees

Returns the guarantees (list of Koha::Patron) of this patron

housebound_profile

Returns the HouseboundProfile associated with this patron.

housebound_role

Returns the HouseboundRole associated with this patron.

siblings

Returns the siblings of this patron.

wants_check_for_previous_checkout

    $wants_check = $patron->wants_check_for_previous_checkout;

Return 1 if Koha needs to perform PrevIssue checking, else 0.

do_check_for_previous_checkout

    $do_check = $patron->do_check_for_previous_checkout($item);

Return 1 if the bib associated with $ITEM has previously been checked out to $PATRON, 0 otherwise.

is_debarred

my $debarment_expiration = $patron->is_debarred;

Returns the date a patron debarment will expire, or undef if the patron is not debarred

is_expired

my $is_expired = $patron->is_expired;

Returns 1 if the patron is expired or 0;

is_going_to_expire

my $is_going_to_expire = $patron->is_going_to_expire;

Returns 1 if the patron is going to expired, depending on the NotifyBorrowerDeparture pref or 0

update_password

my $updated = $patron->update_password( $userid, $password );

Update the userid and the password of a patron. If the userid already exists, returns and let DBIx::Class warns This will add an entry to action_logs if BorrowersLog is set.

renew_account

my $new_expiry_date = $patron->renew_account

Extending the subscription to the expiry date.

has_overdues

my $has_overdues = $patron->has_overdues;

Returns the number of patron's overdues

track_login

    $patron->track_login;
    $patron->track_login({ force => 1 });

    Tracks a (successful) login attempt.
    The preference TrackLastPatronActivity must be enabled. Or you
    should pass the force parameter.

move_to_deleted

my $is_moved = $patron->move_to_deleted;

Move a patron to the deletedborrowers table. This can be done before deleting a patron, to make sure the data are not completely deleted.

article_requests

my @requests = $borrower->article_requests(); my $requests = $borrower->article_requests();

Returns either a list of ArticleRequests objects, or an ArtitleRequests object, depending on the calling context.

article_requests_current

my @requests = $patron->article_requests_current

Returns the article requests associated with this patron that are incomplete

article_requests_finished

my @requests = $biblio->article_requests_finished

Returns the article requests associated with this patron that are completed

add_enrolment_fee_if_needed

my $enrolment_fee = $patron->add_enrolment_fee_if_needed;

Add enrolment fee for a patron if needed.

checkouts

my $checkouts = $patron->checkouts

old_checkouts

my $old_checkouts = $patron->old_checkouts

get_overdues

my $overdue_items = $patron->get_overdues

Return the overdued items

get_age

my $age = $patron->get_age

Return the age of the patron

account

my $account = $patron->account

holds

my $holds = $patron->holds

Return all the holds placed by this patron

first_valid_email_address

get_club_enrollments

get_enrollable_clubs

account_locked

my $is_locked = $patron->account_locked

Return true if the patron has reach the maximum number of login attempts (see pref FailedLoginAttempts). Otherwise return false. If the pref is not set (empty string, null or 0), the feature is considered as disabled.

type

AUTHOR

Kyle M Hall <kyle@bywatersolutions.com> Alex Sassmannshausen <alex.sassmannshausen@ptfs-europe.com>

<<