MDL-61028 core_search: Allow filtering search by user (front-end)

Creates a new 'Users' field in the search filters form. This field
requires new JavaScript and, to implement this, a new AJAX-callable
web service to search for users by name, with detailed restrictions
based on the current user's access to view profiles.
This commit is contained in:
sam marshall 2018-04-20 16:44:32 +01:00
parent 71d985ab7d
commit a6cacdd266
9 changed files with 417 additions and 1 deletions

View file

@ -0,0 +1 @@
define(["jquery","core/ajax","core/templates"],function(a,b,c){return{processResults:function(b,c){var d=[];return a.each(c,function(a,b){d.push({value:b.id,label:b._label})}),d},transport:function(d,e,f,g){var h,i={query:e},j=a(d).attr("withincourseid");"undefined"!=typeof j&&""!==a("#id_searchwithin").val()?i.courseid=j:i.courseid=0,h=b.call([{methodname:"core_search_get_relevant_users",args:i}]),h[0].then(function(b){var d=[];return a.each(b,function(a,b){d.push(c.render("core_search/form-user-selector-suggestion",b))}),a.when.apply(a.when,d).then(function(){var c=arguments,d=0;a.each(b,function(a,b){b._label=c[d++]}),f(b)})}).fail(g)}}});

View file

@ -0,0 +1,82 @@
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Search user selector module.
*
* @module core_search/form-search-user-selector
* @class form-search-user-selector
* @package core_search
* @copyright 2017 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
define(['jquery', 'core/ajax', 'core/templates'], function($, Ajax, Templates) {
return /** @alias module:core_search/form-search-user-selector */ {
processResults: function(selector, results) {
var users = [];
$.each(results, function(index, user) {
users.push({
value: user.id,
label: user._label
});
});
return users;
},
transport: function(selector, query, success, failure) {
var promise;
// Search within specific course if known and if the 'search within' dropdown is set
// to search within course or activity.
var args = {query: query};
var courseid = $(selector).attr('withincourseid');
if (typeof courseid !== "undefined" && $('#id_searchwithin').val() !== '') {
args.courseid = courseid;
} else {
args.courseid = 0;
}
// Call AJAX request.
promise = Ajax.call([{methodname: 'core_search_get_relevant_users', args: args}]);
// When AJAX request returns, handle the results.
promise[0].then(function(results) {
var promises = [];
// Render label with user name and picture.
$.each(results, function(index, user) {
promises.push(Templates.render('core_search/form-user-selector-suggestion', user));
});
// Apply the label to the results.
return $.when.apply($.when, promises).then(function() {
var args = arguments;
var i = 0;
$.each(results, function(index, user) {
user._label = args[i++];
});
success(results);
return;
});
}).fail(failure);
}
};
});