Koha/Template/Plugin/ColumnsSettings.pm

   1 package Koha::Template::Plugin::ColumnsSettings;
   2
   3 # This file is part of Koha.
   4 #
   5 # Copyright BibLibre 2014
   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 YAML qw( LoadFile );
  26 use JSON qw( to_json );
  27
  28 use C4::Context qw( config );
  29 use C4::Utils::DataTables::ColumnsSettings;
  30
  31 =pod
  32
  33 This plugin allows to get the column configuration for a table.
  34
  35 First, include the line '[% USE Tables %]' at the top
  36 of the template to enable the plugin.
  37
  38 To use, call ColumnsSettings.GetColumns with the module, the page and the table where the template is called.
  39
  40 For example: [% ColumnsSettings.GetColumns( 'circ', 'circulation', 'holdst' ) %]
  41
  42 =cut
  43
  44 sub GetColumns {
  45     my ( $self, $module, $page, $table, $format ) = @_;
  46     $format //= q{};
  47
  48     my $columns = C4::Utils::DataTables::ColumnsSettings::get_columns( $module, $page, $table );
  49
  50     return $format eq 'json'
  51         ? to_json( $columns )
  52         : $columns
  53 }
  54
  55 1;