admin/tool/templatelibrary/amd/src/search.js

   1 // This file is part of Moodle - http://moodle.org/
   2 //
   3 // Moodle is free software: you can redistribute it and/or modify
   4 // it under the terms of the GNU General Public License as published by
   5 // the Free Software Foundation, either version 3 of the License, or
   6 // (at your option) any later version.
   7 //
   8 // Moodle is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 // GNU General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU General Public License
  14 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  15
  16 /**
  17  * This module adds ajax search functions to the template library page.
  18  *
  19  * @module     tool_templatelibrary/search
  20  * @package    tool_templatelibrary
  21  * @copyright  2015 Damyon Wiese <damyon@moodle.com>
  22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  */
  24 define(['jquery', 'core/ajax', 'core/log', 'core/notification', 'core/templates', 'core/config'],
  25        function($, ajax, log, notification, templates, config) {
  26
  27     /**
  28      * The ajax call has returned with a new list of templates.
  29      *
  30      * @method reloadListTemplate
  31      * @param {String[]} templateList List of template ids.
  32      */
  33     var reloadListTemplate = function(templateList) {
  34         templates.render('tool_templatelibrary/search_results', {templates: templateList})
  35             .done(function(result, js) {
  36                 templates.replaceNode($('[data-region="searchresults"]'), result, js);
  37             }).fail(notification.exception);
  38     };
  39
  40     /**
  41      * Get the current values for the form inputs and refresh the list of matching templates.
  42      *
  43      * @method refreshSearch
  44      * @param {String} themename The naeme of the theme.
  45      */
  46     var refreshSearch = function(themename) {
  47         var componentStr = $('[data-field="component"]').val();
  48         var searchStr = $('[data-field="search"]').val();
  49
  50         // Trigger the search.
  51         document.location.hash = searchStr;
  52
  53         ajax.call([
  54             {methodname: 'tool_templatelibrary_list_templates',
  55               args: {component: componentStr, search: searchStr, themename: themename},
  56               done: reloadListTemplate,
  57               fail: notification.exception}
  58         ], true, false);
  59     };
  60
  61     var throttle = null;
  62
  63     /**
  64      * Call the specified function after a delay. If this function is called again before the function is executed,
  65      * the function will only be executed once.
  66      *
  67      * @method queueRefresh
  68      * @param {function} callback
  69      * @param {Number} delay The time in milliseconds to delay.
  70      */
  71     var queueRefresh = function(callback, delay) {
  72         if (throttle !== null) {
  73             window.clearTimeout(throttle);
  74         }
  75
  76         throttle = window.setTimeout(function() {
  77             callback();
  78             throttle = null;
  79         }, delay);
  80     };
  81
  82     var changeHandler = function() {
  83         queueRefresh(refreshSearch.bind(this, config.theme), 400);
  84     };
  85     // Add change handlers to refresh the list.
  86     $('[data-region="list-templates"]').on('change', '[data-field="component"]', changeHandler);
  87     $('[data-region="list-templates"]').on('input', '[data-field="search"]', changeHandler);
  88
  89     $('[data-field="search"]').val(document.location.hash.replace('#', ''));
  90     refreshSearch(config.theme);
  91     return {};
  92 });