From 4b07b330c3633d197b69145a9f26357a36e52a64 Mon Sep 17 00:00:00 2001
From: Owen Leonard <oleonard@myacpl.org>
Date: Sun, 19 Aug 2018 15:19:49 -0400
Subject: [PATCH] Bug 21216: Add filter/search options to notices table

This patch adds a DataTables toolbar to the Notices & slips table,
including a filter field, column visibility, and data export options.

To test, apply the patch and clear your browser cache if necessary.

 - Go to Tools -> Notices & slips
 - Confirm that there is a table toolbar with a filter, a "Column
   visibility" button, and "Excel," "CSV," "Copy," and "Print" buttons.
 - Confirm that showing and hiding columns via the button is working
   correctly.
 - Confirm that only the first four columns are sortable.

Go to Administration -> Columns settings.

- Expand the "Tools" section.
- Find "id=lettert."
- Make some selections to configure default settings of the reports
  table.
- Return to reports and confirm that these defaults are applied.

Signed-off-by: Claire Gravely <claire.gravely@bsz-bw.de>
---
 admin/columns_settings.yml                            | 18 ++++++++++++++++++
 .../prog/en/modules/admin/columns_settings.tt         |  6 ++++++
 .../intranet-tmpl/prog/en/modules/tools/letter.tt     |  4 ++++
 koha-tmpl/intranet-tmpl/prog/js/letter.js             | 19 ++++++++++++-------
 4 files changed, 40 insertions(+), 7 deletions(-)

diff --git a/admin/columns_settings.yml b/admin/columns_settings.yml
index 3e2a672..3d44069 100644
--- a/admin/columns_settings.yml
+++ b/admin/columns_settings.yml
@@ -568,3 +568,21 @@ modules:
           columnname: serial_status
         -
           columnname: serial_notes
+
+  tools:
+    notices:
+      lettert:
+        -
+          columnname: library
+        -
+          columnname: module
+        -
+          columnname: code
+        -
+          columnname: name
+        -
+          columnname: copy_notice
+        -
+          columnname: actions
+          cannot_be_toggled: 1
+          cannot_be_modified: 1
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/columns_settings.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/columns_settings.tt
index b41b653..c6e4f9e 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/columns_settings.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/columns_settings.tt
@@ -146,6 +146,12 @@
             [% PROCESS pagelist module=modules.members modulename="members" %]
           </div>
 
+            <h3><a href="#tools">Tools</a></h3>
+            <div id="tools">
+                <h4>Tools tables</h4>
+                [% PROCESS pagelist module=modules.tools modulename="tools" %]
+            </div>
+
           <h3><a href="#opac">OPAC</a></h3>
           <div id="opac">
             <h4>OPAC tables</h4>
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/tools/letter.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/tools/letter.tt
index 36df8f6..56cca28 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/tools/letter.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/tools/letter.tt
@@ -2,6 +2,7 @@
 [% USE Asset %]
 [% USE Koha %]
 [% USE Branches %]
+[% USE ColumnsSettings %]
 [% SET footerjs = 1 %]
 [% INCLUDE 'doc-head-open.inc' %]
 <title>Koha &rsaquo; Tools &rsaquo; Notices[% IF ( add_form or copy_form ) %][% IF ( modify ) %] &rsaquo; Modify notice[% ELSE %] &rsaquo; Add notice[% END %][% END %][% IF ( add_validate or copy_validate) %] &rsaquo; Notice added[% END %][% IF ( delete_confirm ) %] &rsaquo; Confirm deletion[% END %]</title>
@@ -460,6 +461,7 @@
 [% MACRO jsinclude BLOCK %]
     [% Asset.js("js/tools-menu.js") | $raw %]
     [% INCLUDE 'datatables.inc' %]
+    [% INCLUDE 'columns_settings.inc' %]
     [% Asset.js("lib/jquery/plugins/jquery.fixFloat.js") | $raw %]
     [% Asset.js("lib/jquery/plugins/jquery.insertatcaret.js") | $raw %]
     <script>
@@ -476,6 +478,8 @@
         var MSG_EMPTY_TITLE_AND_CONTENT = _("Please specify title and content for %s");
         var MSG_EMPTY_TEMPLATES = _("Please fill at least one template.");
         var MSG_LOADING = _("Loading");
+        var MSG_NO_NOTICE_FOUND = _("No matching notices found");
+        var columns_settings = [% ColumnsSettings.GetColumns( 'tools', 'notices', 'lettert', 'json' ) | $raw %];
      </script>
     [% Asset.js("js/letter.js") | $raw %]
 [% END %]
diff --git a/koha-tmpl/intranet-tmpl/prog/js/letter.js b/koha-tmpl/intranet-tmpl/prog/js/letter.js
index 4415d19..953a35b 100644
--- a/koha-tmpl/intranet-tmpl/prog/js/letter.js
+++ b/koha-tmpl/intranet-tmpl/prog/js/letter.js
@@ -1,5 +1,5 @@
 /* Variables defined in letter.tt: */
-/* global _ module add_form copy_form dataTablesDefaults no_op_set MSG_EMPTY_TITLE_AND_CONTENT MSG_EMPTY_TEMPLATES code MSG_CODE_EXISTS MSG_CODE_EXISTS_FOR_LIBRARY MSG_DT_LOADING_RECORDS interface theme */
+/* global _ module add_form copy_form no_op_set MSG_EMPTY_TITLE_AND_CONTENT MSG_EMPTY_TEMPLATES code MSG_CODE_EXISTS MSG_CODE_EXISTS_FOR_LIBRARY MSG_DT_LOADING_RECORDS interface theme KohaTable columns_settings */
 
 var modal_loading = "<div id=\"loading\"><img src=\"" + interface + "/" + theme + "/img/spinner-small.gif\" alt=\"\" /> "+ MSG_DT_LOADING_RECORDS +"</div>";
 
@@ -35,13 +35,18 @@ $(document).ready(function() {
         $('#toolbar').fixFloat();
     }
 
-    $("#lettert:has(tbody tr)").dataTable($.extend(true, {}, dataTablesDefaults, {
-        "sDom": 't',
-        "aoColumnDefs": [
-            { "bSortable": false, "bSearchable": false, 'aTargets': [ 'nosort' ] }
+    var ntable = KohaTable("lettert", {
+        "autoWidth": false,
+        "paging": false,
+        "aaSorting": [[ 3, "asc" ]],
+        "columnDefs": [
+            { "bSortable": false, "aTargets": [ "nosort" ] },
+            { "sType": "title-string", "aTargets" : [ "title-string"] }
         ],
-        "bPaginate": false
-    }));
+        "oLanguage": {
+            "sZeroRecords": MSG_NO_NOTICE_FOUND
+        },
+    }, columns_settings);
 
     if( no_op_set ){
         $('#branch').change(function() {
-- 
2.1.4