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 =head1 NAME
  21
  22 Koha::Template::Plugin::ColumnsSettings
  23
  24 =head2 SYNOPSYS
  25
  26     [% USE ColumnsSettings %]
  27
  28     . . .
  29
  30     [% UNLESS ColumnsSettings.is_hidden( 'module', 'page', 'table', 'column') %]
  31         <th id="column" data-colname="column">Column title</th>
  32     [% END %]
  33
  34     . . .
  35
  36     [% UNLESS ColumnsSettings.is_hidden( 'module', 'page', 'table', 'column') %]
  37         <td>[% row.column %]</td>
  38     [% END %]
  39
  40     . . .
  41
  42     <script>
  43         var columns_settings = [% ColumnsSettings.GetColumns( 'module', 'page', 'table', 'json' ) | $raw %];
  44         var table = KohaTable("id", { "bAutoWidth": false }, columns_settings );
  45     </script>
  46
  47 This plugin allows to get the column configuration for a table. It should be used both in table markup
  48 and as the input for datatables visibility settings to take full effect.
  49
  50 =cut
  51
  52 use Modern::Perl;
  53
  54 use Template::Plugin;
  55 use base qw( Template::Plugin );
  56
  57 use YAML qw( LoadFile );
  58 use JSON qw( to_json );
  59
  60 use C4::Context qw( config );
  61 use C4::Utils::DataTables::ColumnsSettings;
  62
  63 =head1 FUNCTIONS
  64
  65 =head2 GetColumns
  66
  67     <script>
  68         var columns_settings = [% ColumnsSettings.GetColumns( 'module', 'page', 'table', 'json' ) | $raw %];
  69         var table = KohaTable("id", { "bAutoWidth": false }, columns_settings );
  70     </script>
  71
  72 Used to get the full column settings configuration for datatables, usually requires a format of 'json' to pass into
  73 datatables instantiator.
  74
  75 =cut
  76
  77 sub GetColumns {
  78     my ( $self, $module, $page, $table, $format ) = @_;
  79     $format //= q{};
  80
  81     my $columns = C4::Utils::DataTables::ColumnsSettings::get_columns( $module, $page, $table );
  82
  83     return $format eq 'json'
  84         ? to_json( $columns )
  85         : $columns
  86 }
  87
  88 =head2 is_hidden
  89
  90     [% UNLESS ColumnsSettings.is_hidden( 'module', 'page', 'table', 'column') %]
  91         <th id="column" data-colname="column">Column title</th>
  92     [% END %]
  93
  94 Used to fetch an individual columns display status so we can fully hide a column in the markup for cases where
  95 it may contain confidential information and should be fully hidden rather than just hidden from display.
  96
  97 =cut
  98
  99 sub is_hidden {
 100     my ( $self, $module, $page, $table, $column_name ) = @_;
 101     my $columns = C4::Utils::DataTables::ColumnsSettings::get_columns( $module, $page, $table );
 102     foreach my $keys(@$columns){
 103         if($keys->{'columnname'} eq $column_name){
 104             return $keys->{'is_hidden'};
 105         }
 106     }
 107     return 0;
 108 }
 109
 110 1;