Koha/Template/Plugin/Borrowers.pm

   1 package Koha::Template::Plugin::Borrowers;
   2
   3 # Copyright ByWater Solutions 2013
   4 # Copyright Equinox Software, Inc. 2014
   5
   6 # This file is part of Koha.
   7 #
   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
  11 # version.
  12 #
  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.
  16 #
  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.
  20
  21 use Modern::Perl;
  22
  23 use base qw( Template::Plugin );
  24
  25 use Koha::Patron::Debarments qw();
  26 use Koha::Patrons;
  27
  28 =pod
  29
  30 This plugin is a home for various patron related Template Toolkit functions
  31 to help streamline Koha and to move logic from the Perl code into the
  32 Templates when it makes sense to do so.
  33
  34 To use, first, include the line '[% USE Borrowers %]' at the top
  35 of the template to enable the plugin.
  36
  37 For example: [% IF Borrowers.IsDebarred( borrower ) %]
  38 removes the necessity of setting a template variable in Perl code to
  39 find out if a patron is restricted even if that variable is not evaluated
  40 in any way in the script.
  41
  42 =cut
  43
  44 sub IsDebarred {
  45     my ( $self, $borrower ) = @_;
  46
  47     return unless $borrower;
  48
  49     return Koha::Patrons->find( $borrower->{borrowernumber} )->is_debarred;
  50 }
  51
  52 sub HasOverdues {
  53     my ( $self, $borrowernumber ) = @_;
  54
  55     return unless $borrowernumber;
  56
  57     return Koha::Patrons->find( $borrowernumber )->has_overdues;
  58 }
  59
  60 1;