Koha/Template/Plugin/Desks.pm

   1 package Koha::Template::Plugin::Desks;
   2
   3 # Copyright (C) BULAC 2020
   4
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  19
  20 use Modern::Perl;
  21
  22 use Template::Plugin;
  23 use base qw( Template::Plugin );
  24
  25 use C4::Context;
  26 use Koha::Desks;
  27
  28 =head1 NAME
  29
  30 Koha::Template::Plugin::Desks - A module for dealing with desks in templates
  31
  32 =head1 DESCRIPTION
  33
  34 This plugin contains getters functions, to fetch all desks a library
  35 got or the current one.
  36
  37 =head2 Methods
  38
  39 =head3 GetLoggedInDeskId
  40
  41 [% Desks.GetLoggedInDeskId %]
  42
  43 return the desk name that is attached to the session or empty string
  44
  45 =cut
  46
  47 sub GetLoggedInDeskId {
  48     my ($self) = @_;
  49
  50     return C4::Context->userenv
  51       ? C4::Context->userenv->{'desk_id'}
  52       : '';
  53 }
  54
  55 =head3 GetLoggedInDeskName
  56
  57 [% Desks.GetLoggedInDeskName %]
  58
  59 Return the desk name that is attached to the session or empty string
  60
  61 =cut
  62
  63 sub GetLoggedInDeskName {
  64     my ($self) = @_;
  65
  66     return C4::Context->userenv
  67       ? C4::Context->userenv->{'desk_name'}
  68       : '';
  69 }
  70
  71 =head3 ListForLibrary
  72
  73 [% Desks.ListForLibrary %]
  74
  75 returns all desks existing at the current library
  76
  77 =cut
  78
  79 sub ListForLibrary {
  80     my ($self) = @_;
  81     my $branch_limit =
  82       C4::Context->userenv ? C4::Context->userenv->{"branch"} : "";
  83     return scalar Koha::Desks->search(
  84         { branchcode => $branch_limit },
  85         { order_by   => { '-asc' => 'desk_name' } }
  86     );
  87 }
  88
  89 =head3 all
  90
  91 [% Desks.all %]
  92
  93 returns all desks existing at all libraries
  94
  95 =cut
  96
  97
  98 sub all {
  99
 100     my ( $self ) = @_;
 101     return Koha::Desks->search();
 102 }
 103
 104 1;