From b106ff504c936670cc2ac355b5e95f41d9383a1c Mon Sep 17 00:00:00 2001 From: Martin Renvoize Date: Wed, 14 Oct 2020 13:01:38 +0100 Subject: [PATCH] Bug 24786: (QA follow-up) POD Fixes Signed-off-by: Katrin Fischer --- Koha/Template/Plugin/Registers.pm | 32 +++++++++++++++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) diff --git a/Koha/Template/Plugin/Registers.pm b/Koha/Template/Plugin/Registers.pm index d68c834e0a..313a2b11eb 100644 --- a/Koha/Template/Plugin/Registers.pm +++ b/Koha/Template/Plugin/Registers.pm @@ -17,6 +17,22 @@ package Koha::Template::Plugin::Registers; # You should have received a copy of the GNU General Public License # along with Koha; if not, see . +=head1 NAME + +Koha::Template::Plugin::Registers + +=head1 DESCRIPTION + +The Registers plugin is a helper that returns register related session information for templates + +=head1 SYNOPSIS + + [% USE Registers %] + [% SET registers = Registers.all() %] + [% SET registers = Registers.all( { filters => { current_branch => 1 } } ); + +=cut + use Modern::Perl; use Template::Plugin; @@ -26,6 +42,14 @@ use C4::Koha; use C4::Context; use Koha::Cash::Registers; +=head1 FUNCTIONS + +=head2 session_register_id + +Return the register_id for the register attached to the current session. + +=cut + sub session_register_id { my ($self) = @_; @@ -34,6 +58,12 @@ sub session_register_id { ''; } +=head2 session_register_name + +Return the register_name for the register attached to the current session. + +=cut + sub session_register_name { my ($self) = @_; @@ -42,7 +72,7 @@ sub session_register_name { : ''; } -=head2 +=head2 all [% SET registers = Registers.all() %] [% SET registers = Registers.all( { filters => { current_branch => 1 } } ); -- 2.11.0