Koha/Template/Plugin/Koha.pm

   1 package Koha::Template::Plugin::Koha;
   2
   3 # Copyright ByWater Solutions 2013
   4
   5 # This file is part of Koha.
   6 #
   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 2 of the License, or (at your option) any later
  10 # version.
  11 #
  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.
  15 #
  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.
  19
  20 use Modern::Perl;
  21
  22 use base qw( Template::Plugin );
  23
  24 use C4::Context;
  25
  26 =pod
  27
  28 This plugin contains various Koha replated Template Toolkit functions
  29 to help streamline Koha and to move logic from the Perl code into the
  30 Templates when it makes sense to do so.
  31
  32 To use, first, include the line '[% USE Koha %]' at the top
  33 of the template to enable the plugin.
  34
  35 For example: [% IF Koha.Preference( 'MyPreference ) == 'SettingA' %]
  36 removes the necessity of setting a template variable in Perl code for
  37 each and every system preference, even if no evaluation of the setting
  38 is necessary.
  39
  40 =cut
  41
  42 sub Preference {
  43     my ( $self, $pref ) = @_;
  44     return C4::Context->preference( $pref );
  45 }
  46
  47 1;