From 8f1400c8cc04c709532a399d04e7f52187c15bd2 Mon Sep 17 00:00:00 2001 From: Kyle M Hall Date: Thu, 6 Sep 2012 09:23:08 -0400 Subject: [PATCH] Bug 4173: Followup: Document KohaAuthorisedValues plugin Signed-off-by: Paul Poulain --- Koha/Template/Plugin/KohaAuthorisedValues.pm | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/Koha/Template/Plugin/KohaAuthorisedValues.pm b/Koha/Template/Plugin/KohaAuthorisedValues.pm index 58297c09f7..68b13479db 100644 --- a/Koha/Template/Plugin/KohaAuthorisedValues.pm +++ b/Koha/Template/Plugin/KohaAuthorisedValues.pm @@ -24,6 +24,24 @@ use base qw( Template::Plugin ); use C4::Koha; +=pod + +This plugin allows one to get the description for an authorised value +from within a template. + +First, include the line '[% USE KohaAuthorisedValues %]' at the top +of the template to enable the plugin. + +To use, call KohaAuthorisedValues.GetByCode with the category +of the authorised value, the code to look up, and optionally, +the OPAC flag ( if set, it will return the OPAC description rather +than the Intranet description ). + +For example: [% KohaAuthorisedValues.GetByCode( 'LOST', item.itemlost, 1 ) %] +will print the OPAC description for the LOST value stored in item.itemlost. + +=cut + sub GetByCode { my ( $self, $category, $code, $opac ) = @_; return GetAuthorisedValueByCode( $category, $code, $opac ); -- 2.20.1