Bug 4173: Followup: Document KohaAuthorisedValues plugin
[koha.git] / Koha / Template / Plugin / KohaAuthorisedValues.pm
1 package Koha::Template::Plugin::KohaAuthorisedValues;
2
3 # Copyright ByWater Solutions 2012
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 Template::Plugin;
23 use base qw( Template::Plugin );
24
25 use C4::Koha;
26
27 =pod
28
29 This plugin allows one to get the description for an authorised value
30 from within a template.
31
32 First, include the line '[% USE KohaAuthorisedValues %]' at the top
33 of the template to enable the plugin.
34
35 To use, call KohaAuthorisedValues.GetByCode with the category
36 of the authorised value, the code to look up, and optionally,
37 the OPAC flag ( if set, it will return the OPAC description rather
38 than the Intranet description ).
39
40 For example: [% KohaAuthorisedValues.GetByCode( 'LOST', item.itemlost, 1 ) %]
41 will print the OPAC description for the LOST value stored in item.itemlost.
42
43 =cut
44
45 sub GetByCode {
46     my ( $self, $category, $code, $opac ) = @_;
47     return GetAuthorisedValueByCode( $category, $code, $opac );
48 }
49
50 1;