Koha/admin/columns_settings.pl
Jonathan Druart ebf4e33cbf Bug 10212: Columns configuration for tables
This development introduces ColVis into Koha and provides a configuration
page for columns visibility.

ColVis is a plugin for DataTables. It allows to change the visibility of
the columns in the table.

* This development adds:
  - the js and css file for ColVis
  - a new DB table 'columns_settings'
  - a new template plugin 'ColumnsSettings'
  - a new package C4::Utils::DataTables::ColumnsSettings
  - a new admin page admin/columns_settings.pl

* How it works:
A yaml file is created (admin/columns_settings.yml) in order to take an
inventory of all tables where ColVis is implemented. This file is read
to create the list of modules, pages and tables in the configuration
page.
There are 3 possible keys in the yml:
 - is_hidden: default is 0
The column will be hidden.
 - cannot_be_toggled: default is 0.
ColVis will allow to hide/show the column.
 - cannot_be_modified: default is 0
Default values (in the yml) won't be modifiable.

When a user changes (or saves) the configuration for one module, all
columns are added to the DB table. The values in the DB get the upper hand
on the yaml values.

* Humm, strange?
It seems weird to have 2 storages for the same values. But I
think it will be easy to add an entry and maintain the yaml rather than
adding a new row (and new entry in updatedatabase script) in the DB.

* To go further: We can imagine that the configuration is saved for each
user (and not globally like it is made with this patch).

This patch cannot be tested as it, you need to apply the "POC" patch.

Signed-off-by: Owen Leonard <oleonard@myacpl.org>
Signed-off-by: Katrin Fischer <Katrin.Fischer.83@web.de>
Passes all tests and QA script, more comments on last patch.

Signed-off-by: Tomas Cohen Arazi <tomascohen@gmail.com>
2014-08-26 09:28:03 -03:00

62 lines
1.7 KiB
Perl
Executable file

#!/usr/bin/perl
use Modern::Perl;
use CGI;
use YAML qw( LoadFile );
use C4::Auth;
use C4::Context;
use C4::Output;
use C4::Utils::DataTables::ColumnsSettings qw( get_modules );
my $input = new CGI;
my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
{
template_name => "admin/columns_settings.tt",
query => $input,
type => "intranet",
authnotrequired => 0,
flagsrequired => { parameters => 'parameters_remaining_permissions' },
debug => 1,
}
);
my $action = $input->param('action') // 'list';
if ( $action eq 'save' ) {
my $module = $input->param('module');
my @columnids = $input->param("columnid");
my @columns;
for my $columnid (@columnids) {
next unless $columnid =~ m|^([^_]*)_([^_]*)_(.*)$|;
my $is_hidden = $input->param( $columnid . '_hidden' ) // 0;
my $cannot_be_toggled =
$input->param( $columnid . '_cannot_be_toggled' ) // 0;
push @columns,
{
module => $module,
page => $1,
tablename => $2,
columnname => $3,
is_hidden => $is_hidden,
cannot_be_toggled => $cannot_be_toggled,
};
}
C4::Utils::DataTables::ColumnsSettings::update_columns(
{
columns => \@columns,
}
);
$action = 'list';
}
if ( $action eq 'list' ) {
my $modules = C4::Utils::DataTables::ColumnsSettings::get_modules;
$template->param(
panel => ( $input->param('panel') || 0 ),
modules => $modules,
);
}
output_html_with_http_headers $input, $cookie, $template->output;