search/amd/src/form-search-user-selector.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/>.
  16. /**
  17.  * Search user selector module.
  18.  *
  19.  * @module core_search/form-search-user-selector
  20.  * @copyright 2017 The Open University
  21.  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  22.  */
  24. define(['jquery', 'core/ajax', 'core/templates'], function($, Ajax, Templates) {
  26.     return /** @alias module:core_search/form-search-user-selector */ {
  28.         processResults: function(selector, results) {
  29.             var users = [];
  30.             $.each(results, function(index, user) {
  31.                 users.push({
  32.                     value: user.id,
  33.                     label: user._label
  34.                 });
  35.             });
  36.             return users;
  37.         },
  39.         transport: function(selector, query, success, failure) {
  40.             var promise;
  42.             // Search within specific course if known and if the 'search within' dropdown is set
  43.             // to search within course or activity.
  44.             var args = {query: query};
  45.             var courseid = $(selector).attr('withincourseid');
  46.             if (typeof courseid !== "undefined" && $('#id_searchwithin').val() !== '') {
  47.                 args.courseid = courseid;
  48.             } else {
  49.                 args.courseid = 0;
  50.             }
  52.             // Call AJAX request.
  53.             promise = Ajax.call([{methodname: 'core_search_get_relevant_users', args: args}]);
  55.             // When AJAX request returns, handle the results.
  56.             promise[0].then(function(results) {
  57.                 var promises = [];
  59.                 // Render label with user name and picture.
  60.                 $.each(results, function(index, user) {
  61.                     promises.push(Templates.render('core_search/form-user-selector-suggestion', user));
  62.                 });
  64.                 // Apply the label to the results.
  65.                 return $.when.apply($.when, promises).then(function() {
  66.                     var args = arguments;
  67.                     var i = 0;
  68.                     $.each(results, function(index, user) {
  69.                         user._label = args[i++];
  70.                     });
  71.                     success(results);
  72.                     return;
  73.                 });
  75.             }).fail(failure);
  76.         }
  78.     };
  80. });