Koha/Template/Plugin/Categories.pm

   1 package Koha::Template::Plugin::Categories;
   2
   3 # Copyright 2013-2014 BibLibre
   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 Template::Plugin;
  21 use base qw( Template::Plugin );
  22
  23 use Koha::Patron::Categories;
  24
  25 sub all {
  26     return Koha::Patron::Categories->search_limited;
  27 }
  28
  29 1;
  30
  31 =head1 NAME
  32
  33 Koha::Template::Plugin::Categories - TT Plugin for categories
  34
  35 =head1 SYNOPSIS
  36
  37 [% USE Categories %]
  38
  39 [% Categories.all() %]
  40
  41 =head1 ROUTINES
  42
  43 =head2 all
  44
  45 In a template, you can get the all categories with
  46 the following TT code: [% Categories.all() %]
  47
  48 =head2 GetName
  49
  50 In a template, you can get the name of a patron category using
  51 [% Categories.GetName( categorycode ) %].
  52
  53 =head1 AUTHOR
  54
  55 Jonathan Druart <jonathan.druart@biblibre.com>
  56
  57 =cut