Bug 9916 - Use DataTables in the OPAC
[koha.git] / koha-tmpl / opac-tmpl / prog / en / js / datatables.js
index e0cc888..3c4ffdf 100644 (file)
@@ -23,362 +23,78 @@ var dataTablesDefaults = {
         "sSearch"           : window.MSG_DT_SEARCH || "Search:",
         "sZeroRecords"      : window.MSG_DT_ZERO_RECORDS || "No matching records found"
     },
-    "sDom": '<"top pager"ilpf>t<"bottom pager"ip>'
+    // "aaSorting": [$(" - select row position of th -")],
+    "sDom": 't',
+    "bPaginate": false,
+    // "fnHeaderCallback": function() {
+    //     return $('th.sorting.nosort,th.sorting_desc.nosort,th.sorting_asc.nosort').removeClass("sorting sorting_desc sorting_asc").unbind("click");
+    // }
 };
 
+/* Plugin to allow sorting on data stored in a span's title attribute
+ *
+ * Ex: <td><span title="[% ISO_date %]">[% formatted_date %]</span></td>
+ *
+ * In DataTables config:
+ *     "aoColumns": [
+ *        { "sType": "title-string" },
+ *      ]
+ * http://datatables.net/plug-ins/sorting#hidden_title_string
+ */
+jQuery.extend( jQuery.fn.dataTableExt.oSort, {
+    "title-string-pre": function ( a ) {
+        return a.match(/title="(.*?)"/)[1].toLowerCase();
+    },
 
-// Return an array of string containing the values of a particular column
-$.fn.dataTableExt.oApi.fnGetColumnData = function ( oSettings, iColumn, bUnique, bFiltered, bIgnoreEmpty ) {
-    // check that we have a column id
-    if ( typeof iColumn == "undefined" ) return new Array();
-    // by default we only wany unique data
-    if ( typeof bUnique == "undefined" ) bUnique = true;
-    // by default we do want to only look at filtered data
-    if ( typeof bFiltered == "undefined" ) bFiltered = true;
-    // by default we do not wany to include empty values
-    if ( typeof bIgnoreEmpty == "undefined" ) bIgnoreEmpty = true;
-    // list of rows which we're going to loop through
-    var aiRows;
-    // use only filtered rows
-    if (bFiltered == true) aiRows = oSettings.aiDisplay;
-    // use all rows
-    else aiRows = oSettings.aiDisplayMaster; // all row numbers
+    "title-string-asc": function ( a, b ) {
+        return ((a < b) ? -1 : ((a > b) ? 1 : 0));
+    },
 
-    // set up data array
-    var asResultData = new Array();
-    for (var i=0,c=aiRows.length; i<c; i++) {
-        iRow = aiRows[i];
-        var aData = this.fnGetData(iRow);
-        var sValue = aData[iColumn];
-        // ignore empty values?
-        if (bIgnoreEmpty == true && sValue.length == 0) continue;
-        // ignore unique values?
-        else if (bUnique == true && jQuery.inArray(sValue, asResultData) > -1) continue;
-        // else push the value onto the result data array
-        else asResultData.push(sValue);
+    "title-string-desc": function ( a, b ) {
+        return ((a < b) ? 1 : ((a > b) ? -1 : 0));
     }
-    return asResultData;
-}
-
-// List of unbind keys (Ctrl, Alt, Direction keys, etc.)
-// These keys must not launch filtering
-var blacklist_keys = new Array(0, 16, 17, 18, 37, 38, 39, 40);
-
-// Set a filtering delay for global search field
-jQuery.fn.dataTableExt.oApi.fnSetFilteringDelay = function ( oSettings, iDelay ) {
-    /*
-     * Inputs:      object:oSettings - dataTables settings object - automatically given
-     *              integer:iDelay - delay in milliseconds
-     * Usage:       $('#example').dataTable().fnSetFilteringDelay(250);
-     * Author:      Zygimantas Berziunas (www.zygimantas.com) and Allan Jardine
-     * License:     GPL v2 or BSD 3 point style
-     * Contact:     zygimantas.berziunas /AT\ hotmail.com
+} );
+
+(function() {
+
+    /* Plugin to allow text sorting to ignore articles
+     *
+     * In DataTables config:
+     *     "aoColumns": [
+     *        { "sType": "anti-the" },
+     *      ]
+     * Based on the plugin found here:
+     * http://datatables.net/plug-ins/sorting#anti_the
+     * Modified to exclude HTML tags from sorting
+     * Extended to accept a string of space-separated articles
+     * from a configuration file (in English, "a," "an," and "the")
      */
-    var
-        _that = this,
-        iDelay = (typeof iDelay == 'undefined') ? 250 : iDelay;
-
-    this.each( function ( i ) {
-        $.fn.dataTableExt.iApiIndex = i;
-        var
-            $this = this,
-            oTimerId = null,
-            sPreviousSearch = null,
-            anControl = $( 'input', _that.fnSettings().aanFeatures.f );
-
-        anControl.unbind( 'keyup.DT' ).bind( 'keyup.DT', function(event) {
-            var $$this = $this;
-            if (blacklist_keys.indexOf(event.keyCode) != -1) {
-                return this;
-            }else if ( event.keyCode == '13' ) {
-                $.fn.dataTableExt.iApiIndex = i;
-                _that.fnFilter( $(this).val() );
-            } else {
-                if (sPreviousSearch === null || sPreviousSearch != anControl.val()) {
-                    window.clearTimeout(oTimerId);
-                    sPreviousSearch = anControl.val();
-                    oTimerId = window.setTimeout(function() {
-                        $.fn.dataTableExt.iApiIndex = i;
-                        _that.fnFilter( anControl.val() );
-                    }, iDelay);
-                }
-            }
-        });
-
-        return this;
-    } );
-    return this;
-}
-
-// Add a filtering delay on general search and on all input (with a class 'filter')
-jQuery.fn.dataTableExt.oApi.fnAddFilters = function ( oSettings, sClass, iDelay ) {
-    var table = this;
-    this.fnSetFilteringDelay(iDelay);
-    var filterTimerId = null;
-    $("input."+sClass).keyup(function(event) {
-      if (blacklist_keys.indexOf(event.keyCode) != -1) {
-        return this;
-      }else if ( event.keyCode == '13' ) {
-        table.fnFilter( $(this).val(), $(this).attr('data-column_num') );
-      } else {
-        window.clearTimeout(filterTimerId);
-        var input = this;
-        filterTimerId = window.setTimeout(function() {
-          table.fnFilter($(input).val(), $(input).attr('data-column_num'));
-        }, iDelay);
-      }
-    });
-}
-
-// Useful if you want to filter on dates with 2 inputs (start date and end date)
-// You have to include calendar.inc to use it
-function dt_add_rangedate_filter(begindate_id, enddate_id, dateCol) {
-    $.fn.dataTableExt.afnFiltering.push(
-        function( oSettings, aData, iDataIndex ) {
-
-            var beginDate = Date_from_syspref($("#"+begindate_id).val()).getTime();
-            var endDate   = Date_from_syspref($("#"+enddate_id).val()).getTime();
-
-            var data = Date_from_syspref(aData[dateCol]).getTime();
 
-            if ( !parseInt(beginDate) && ! parseInt(endDate) ) {
-                return true;
-            }
-            else if ( beginDate <= data && !parseInt(endDate) ) {
-                return true;
-            }
-            else if ( data <= endDate && !parseInt(beginDate) ) {
-                return true;
-            }
-            else if ( beginDate <= data && data <= endDate) {
-                return true;
-            }
-            return false;
+    if(CONFIG_EXCLUDE_ARTICLES_FROM_SORT){
+        var articles = CONFIG_EXCLUDE_ARTICLES_FROM_SORT.split(" ");
+        var rpattern = "";
+        for(i=0;i<articles.length;i++){
+            rpattern += "^" + articles[i] + " ";
+            if(i < articles.length - 1){ rpattern += "|"; }
         }
-    );
-}
-
-//Sorting for dates (uk format)
-function dt_add_type_uk_date() {
-  jQuery.fn.dataTableExt.aTypes.unshift(
-    function ( sData )
-    {
-      if (sData.match(/(0[1-9]|[12][0-9]|3[01])\/(0[1-9]|1[012])\/(19|20|21)\d\d/))
-      {
-        return 'uk_date';
-      }
-      return null;
+        var re = new RegExp(rpattern, "i");
     }
-  );
-
-  jQuery.fn.dataTableExt.oSort['uk_date-asc']  = function(a,b) {
-    var re = /(\d{2}\/\d{2}\/\d{4})/;
-    a.match(re);
-    var ukDatea = RegExp.$1.split("/");
-    b.match(re);
-    var ukDateb = RegExp.$1.split("/");
-
-    var x = (ukDatea[2] + ukDatea[1] + ukDatea[0]) * 1;
-    var y = (ukDateb[2] + ukDateb[1] + ukDateb[0]) * 1;
-
-    return ((x < y) ? -1 : ((x > y) ?  1 : 0));
-  };
-
-  jQuery.fn.dataTableExt.oSort['uk_date-desc'] = function(a,b) {
-    var re = /(\d{2}\/\d{2}\/\d{4})/;
-    a.match(re);
-    var ukDatea = RegExp.$1.split("/");
-    b.match(re);
-    var ukDateb = RegExp.$1.split("/");
-
-    var x = (ukDatea[2] + ukDatea[1] + ukDatea[0]) * 1;
-    var y = (ukDateb[2] + ukDateb[1] + ukDateb[0]) * 1;
 
-    return ((x < y) ? 1 : ((x > y) ?  -1 : 0));
-  };
-}
-
-// Sorting on html contains
-// <a href="foo.pl">bar</a> sort on 'bar'
-function dt_overwrite_html_sorting_localeCompare() {
-    jQuery.fn.dataTableExt.oSort['html-asc']  = function(a,b) {
-        a = a.replace(/<.*?>/g, "").replace(/\s+/g, " ");
-        b = b.replace(/<.*?>/g, "").replace(/\s+/g, " ");
-        if (typeof(a.localeCompare == "function")) {
-           return a.localeCompare(b);
-        } else {
-           return (a > b) ? 1 : ((a < b) ? -1 : 0);
-        }
-    };
-
-    jQuery.fn.dataTableExt.oSort['html-desc'] = function(a,b) {
-        a = a.replace(/<.*?>/g, "").replace(/\s+/g, " ");
-        b = b.replace(/<.*?>/g, "").replace(/\s+/g, " ");
-        if(typeof(b.localeCompare == "function")) {
-            return b.localeCompare(a);
-        } else {
-            return (b > a) ? 1 : ((b < a) ? -1 : 0);
-        }
-    };
-}
-
-// Sorting on string without accentued characters
-function dt_overwrite_string_sorting_localeCompare() {
-    jQuery.fn.dataTableExt.oSort['string-asc']  = function(a,b) {
-        a = a.replace(/<.*?>/g, "").replace(/\s+/g, " ");
-        b = b.replace(/<.*?>/g, "").replace(/\s+/g, " ");
-        if (typeof(a.localeCompare == "function")) {
-           return a.localeCompare(b);
-        } else {
-           return (a > b) ? 1 : ((a < b) ? -1 : 0);
-        }
-    };
-
-    jQuery.fn.dataTableExt.oSort['string-desc'] = function(a,b) {
-        a = a.replace(/<.*?>/g, "").replace(/\s+/g, " ");
-        b = b.replace(/<.*?>/g, "").replace(/\s+/g, " ");
-        if(typeof(b.localeCompare == "function")) {
-            return b.localeCompare(a);
-        } else {
-            return (b > a) ? 1 : ((b < a) ? -1 : 0);
-        }
-    };
-}
-
-// Replace a node with a html and js contain.
-function replace_html( original_node, type ) {
-    switch ( $(original_node).attr('data-type') ) {
-        case "range_dates":
-            var id = $(original_node).attr("data-id");
-            var format = $(original_node).attr("data-format");
-            replace_html_date( original_node, id, format );
-            break;
-        default:
-            alert("_(This node can't be replaced)");
-    }
-}
-
-// Replace a node with a "From [date] To [date]" element
-// Used on tfoot > td
-function replace_html_date( original_node, id, format ) {
-    var node = $('<span style="white-space:nowrap">' + _("From") + '<input type="text" id="' + id + 'from" readonly="readonly" placeholder=\'' + _("Pick date") + '\' size="7" /><a title="Delete this filter" style="cursor:pointer" onclick=\'$("#' + id + 'from").val("").change();\' >&times;</a></span><br/><span style="white-space:nowrap">' + _("To") + '<input type="text" id="' + id + 'to" readonly="readonly" placeholder=\'' + _("Pick date") + '\' size="7" /><a title="Delete this filter" style="cursor:pointer" onclick=\'$("#' + id + 'to").val("").change();\' >&times;</a></span>');
-    $(original_node).replaceWith(node);
-    var script = document.createElement( 'script' );
-    script.type = 'text/javascript';
-    var script_content = "Calendar.setup({";
-    script_content += "    inputField: \"" + id + "from\",";
-    script_content += "    ifFormat: \"" + format + "\",";
-    script_content += "    button: \"" + id + "from\",";
-    script_content += "    onClose: function(){ $(\"#" + id + "from\").change(); this.hide();}";
-    script_content += "  });";
-    script_content += "  Calendar.setup({";
-    script_content += "    inputField: \"" + id + "to\",";
-    script_content += "    ifFormat: \"" + format + "\",";
-    script_content += "    button: \"" + id + "to\",";
-    script_content += "    onClose: function(){ $(\"#" + id + "to\").change(); this.hide();}";
-    script_content += "  });";
-    script.text = script_content;
-    $(original_node).append( script );
-}
-
-$.fn.dataTableExt.oPagination.four_button = {
-    /*
-     * Function: oPagination.four_button.fnInit
-     * Purpose:  Initalise dom elements required for pagination with a list of the pages
-     * Returns:  -
-     * Inputs:   object:oSettings - dataTables settings object
-     *           node:nPaging - the DIV which contains this pagination control
-     *           function:fnCallbackDraw - draw function which must be called on update
-     */
-    "fnInit": function ( oSettings, nPaging, fnCallbackDraw )
-    {
-        nFirst = document.createElement( 'span' );
-        nPrevious = document.createElement( 'span' );
-        nNext = document.createElement( 'span' );
-        nLast = document.createElement( 'span' );
-
-/*        nFirst.appendChild( document.createTextNode( oSettings.oLanguage.oPaginate.sFirst ) );
-        nPrevious.appendChild( document.createTextNode( oSettings.oLanguage.oPaginate.sPrevious ) );
-        nNext.appendChild( document.createTextNode( oSettings.oLanguage.oPaginate.sNext ) );
-        nLast.appendChild( document.createTextNode( oSettings.oLanguage.oPaginate.sLast ) );*/
-
-        nFirst.className = "paginate_button first";
-        nPrevious.className = "paginate_button previous";
-        nNext.className="paginate_button next";
-        nLast.className = "paginate_button last";
-
-        nPaging.appendChild( nFirst );
-        nPaging.appendChild( nPrevious );
-        nPaging.appendChild( nNext );
-        nPaging.appendChild( nLast );
-
-        $(nFirst).click( function () {
-            oSettings.oApi._fnPageChange( oSettings, "first" );
-            fnCallbackDraw( oSettings );
-        } );
-
-        $(nPrevious).click( function() {
-            oSettings.oApi._fnPageChange( oSettings, "previous" );
-            fnCallbackDraw( oSettings );
-        } );
-
-        $(nNext).click( function() {
-            oSettings.oApi._fnPageChange( oSettings, "next" );
-            fnCallbackDraw( oSettings );
-        } );
-
-        $(nLast).click( function() {
-            oSettings.oApi._fnPageChange( oSettings, "last" );
-            fnCallbackDraw( oSettings );
-        } );
+    jQuery.extend( jQuery.fn.dataTableExt.oSort, {
+        "anti-the-pre": function ( a ) {
+            var x = String(a).replace( /<[\s\S]*?>/g, "" );
+            var y = x.trim();
+            var z = y.replace(re, "").toLowerCase();
+            return z;
+        },
 
-        /* Disallow text selection */
-        $(nFirst).bind( 'selectstart', function () { return false; } );
-        $(nPrevious).bind( 'selectstart', function () { return false; } );
-        $(nNext).bind( 'selectstart', function () { return false; } );
-        $(nLast).bind( 'selectstart', function () { return false; } );
-    },
+        "anti-the-asc": function ( a, b ) {
+            return ((a < b) ? -1 : ((a > b) ? 1 : 0));
+        },
 
-    /*
-     * Function: oPagination.four_button.fnUpdate
-     * Purpose:  Update the list of page buttons shows
-     * Returns:  -
-     * Inputs:   object:oSettings - dataTables settings object
-     *           function:fnCallbackDraw - draw function which must be called on update
-     */
-    "fnUpdate": function ( oSettings, fnCallbackDraw )
-    {
-        if ( !oSettings.aanFeatures.p )
-        {
-            return;
+        "anti-the-desc": function ( a, b ) {
+            return ((a < b) ? 1 : ((a > b) ? -1 : 0));
         }
+    });
 
-        /* Loop over each instance of the pager */
-        var an = oSettings.aanFeatures.p;
-        for ( var i=0, iLen=an.length ; i<iLen ; i++ )
-        {
-            var buttons = an[i].getElementsByTagName('span');
-            if ( oSettings._iDisplayStart === 0 )
-            {
-                buttons[0].className = "paginate_disabled_first";
-                buttons[1].className = "paginate_disabled_previous";
-            }
-            else
-            {
-                buttons[0].className = "paginate_enabled_first";
-                buttons[1].className = "paginate_enabled_previous";
-            }
-
-            if ( oSettings.fnDisplayEnd() == oSettings.fnRecordsDisplay() )
-            {
-                buttons[2].className = "paginate_disabled_next";
-                buttons[3].className = "paginate_disabled_last";
-            }
-            else
-            {
-                buttons[2].className = "paginate_enabled_next";
-                buttons[3].className = "paginate_enabled_last";
-            }
-        }
-    }
-};
+}());
\ No newline at end of file