You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
348 lines
16 KiB
348 lines
16 KiB
2 years ago
|
<?php
|
||
|
|
// 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/>.
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Provides user rendering functionality such as printing private files tree and displaying a search utility
|
||
|
|
*
|
||
|
|
* @package core_user
|
||
|
|
* @copyright 2010 Dongsheng Cai <dongsheng@moodle.com>
|
||
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||
|
|
*/
|
||
|
|
|
||
|
|
defined('MOODLE_INTERNAL') || die();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Provides user rendering functionality such as printing private files tree and displaying a search utility
|
||
|
|
* @copyright 2010 Dongsheng Cai <dongsheng@moodle.com>
|
||
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||
|
|
*/
|
||
|
|
class core_user_renderer extends plugin_renderer_base {
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Prints user search utility that can search user by first initial of firstname and/or first initial of lastname
|
||
|
|
* Prints a header with a title and the number of users found within that subset
|
||
|
|
* @param string $url the url to return to, complete with any parameters needed for the return
|
||
|
|
* @param string $firstinitial the first initial of the firstname
|
||
|
|
* @param string $lastinitial the first initial of the lastname
|
||
|
|
* @param int $usercount the amount of users meeting the search criteria
|
||
|
|
* @param int $totalcount the amount of users of the set/subset being searched
|
||
|
|
* @param string $heading heading of the subset being searched, default is All Participants
|
||
|
|
* @return string html output
|
||
|
|
*/
|
||
|
|
public function user_search($url, $firstinitial, $lastinitial, $usercount, $totalcount, $heading = null) {
|
||
|
|
global $OUTPUT;
|
||
|
|
|
||
|
|
if ($firstinitial !== 'all') {
|
||
|
|
set_user_preference('ifirst', $firstinitial);
|
||
|
|
}
|
||
|
|
if ($lastinitial !== 'all') {
|
||
|
|
set_user_preference('ilast', $lastinitial);
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!isset($heading)) {
|
||
|
|
$heading = get_string('allparticipants');
|
||
|
|
}
|
||
|
|
|
||
|
|
$content = html_writer::start_tag('form', array('action' => new moodle_url($url)));
|
||
|
|
$content .= html_writer::start_tag('div');
|
||
|
|
|
||
|
|
// Search utility heading.
|
||
|
|
$content .= $OUTPUT->heading($heading.get_string('labelsep', 'langconfig').$usercount.'/'.$totalcount, 3);
|
||
|
|
|
||
|
|
// Initials bar.
|
||
|
|
$prefixfirst = 'sifirst';
|
||
|
|
$prefixlast = 'silast';
|
||
|
|
$content .= $OUTPUT->initials_bar($firstinitial, 'firstinitial', get_string('firstname'), $prefixfirst, $url);
|
||
|
|
$content .= $OUTPUT->initials_bar($lastinitial, 'lastinitial', get_string('lastname'), $prefixlast, $url);
|
||
|
|
|
||
|
|
$content .= html_writer::end_tag('div');
|
||
|
|
$content .= html_writer::tag('div', ' ');
|
||
|
|
$content .= html_writer::end_tag('form');
|
||
|
|
|
||
|
|
return $content;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Displays the list of tagged users
|
||
|
|
*
|
||
|
|
* @param array $userlist
|
||
|
|
* @param bool $exclusivemode if set to true it means that no other entities tagged with this tag
|
||
|
|
* are displayed on the page and the per-page limit may be bigger
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function user_list($userlist, $exclusivemode) {
|
||
|
|
$tagfeed = new core_tag\output\tagfeed();
|
||
|
|
foreach ($userlist as $user) {
|
||
|
|
$userpicture = $this->output->user_picture($user, array('size' => $exclusivemode ? 100 : 35));
|
||
|
|
$fullname = fullname($user);
|
||
|
|
if (user_can_view_profile($user)) {
|
||
|
|
$profilelink = new moodle_url('/user/view.php', array('id' => $user->id));
|
||
|
|
$fullname = html_writer::link($profilelink, $fullname);
|
||
|
|
}
|
||
|
|
$tagfeed->add($userpicture, $fullname);
|
||
|
|
}
|
||
|
|
|
||
|
|
$items = $tagfeed->export_for_template($this->output);
|
||
|
|
|
||
|
|
if ($exclusivemode) {
|
||
|
|
$output = '<div><ul class="inline-list">';
|
||
|
|
foreach ($items['items'] as $item) {
|
||
|
|
$output .= '<li><div class="user-box">'. $item['img'] . $item['heading'] ."</div></li>\n";
|
||
|
|
}
|
||
|
|
$output .= "</ul></div>\n";
|
||
|
|
return $output;
|
||
|
|
}
|
||
|
|
|
||
|
|
return $this->output->render_from_template('core_tag/tagfeed', $items);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Renders the unified filter element for the course participants page.
|
||
|
|
*
|
||
|
|
* @param stdClass $course The course object.
|
||
|
|
* @param context $context The context object.
|
||
|
|
* @param array $filtersapplied Array of currently applied filters.
|
||
|
|
* @param string|moodle_url $baseurl The url with params needed to call up this page.
|
||
|
|
* @return bool|string
|
||
|
|
*/
|
||
|
|
public function unified_filter($course, $context, $filtersapplied, $baseurl = null) {
|
||
|
|
global $CFG, $DB, $USER;
|
||
|
|
|
||
|
|
require_once($CFG->dirroot . '/enrol/locallib.php');
|
||
|
|
require_once($CFG->dirroot . '/lib/grouplib.php');
|
||
|
|
$manager = new course_enrolment_manager($this->page, $course);
|
||
|
|
|
||
|
|
$filteroptions = [];
|
||
|
|
|
||
|
|
// Filter options for role.
|
||
|
|
$roleseditable = has_capability('moodle/role:assign', $context);
|
||
|
|
$roles = get_viewable_roles($context);
|
||
|
|
if ($roleseditable) {
|
||
|
|
$roles += get_assignable_roles($context, ROLENAME_ALIAS);
|
||
|
|
}
|
||
|
|
|
||
|
|
$criteria = get_string('role');
|
||
|
|
$roleoptions = [];
|
||
|
|
foreach ($roles as $id => $role) {
|
||
|
|
$roleoptions += $this->format_filter_option(USER_FILTER_ROLE, $criteria, $id, $role);
|
||
|
|
}
|
||
|
|
$filteroptions += $roleoptions;
|
||
|
|
|
||
|
|
// Filter options for groups, if available.
|
||
|
|
if (has_capability('moodle/site:accessallgroups', $context) || $course->groupmode != SEPARATEGROUPS) {
|
||
|
|
// List all groups if the user can access all groups, or we are in visible group mode or no groups mode.
|
||
|
|
$groups = $manager->get_all_groups();
|
||
|
|
if (!empty($groups)) {
|
||
|
|
// Add 'No group' option, to enable filtering users without any group.
|
||
|
|
$nogroup[USERSWITHOUTGROUP] = (object)['name' => get_string('nogroup', 'group')];
|
||
|
|
$groups = $nogroup + $groups;
|
||
|
|
}
|
||
|
|
} else {
|
||
|
|
// Otherwise, just list the groups the user belongs to.
|
||
|
|
$groups = groups_get_all_groups($course->id, $USER->id);
|
||
|
|
}
|
||
|
|
$criteria = get_string('group');
|
||
|
|
$groupoptions = [];
|
||
|
|
foreach ($groups as $id => $group) {
|
||
|
|
$groupoptions += $this->format_filter_option(USER_FILTER_GROUP, $criteria, $id, $group->name);
|
||
|
|
}
|
||
|
|
$filteroptions += $groupoptions;
|
||
|
|
|
||
|
|
$canreviewenrol = has_capability('moodle/course:enrolreview', $context);
|
||
|
|
|
||
|
|
// Filter options for status.
|
||
|
|
if ($canreviewenrol) {
|
||
|
|
$criteria = get_string('status');
|
||
|
|
// Add statuses.
|
||
|
|
$filteroptions += $this->format_filter_option(USER_FILTER_STATUS, $criteria, ENROL_USER_ACTIVE, get_string('active'));
|
||
|
|
$filteroptions += $this->format_filter_option(USER_FILTER_STATUS, $criteria, ENROL_USER_SUSPENDED,
|
||
|
|
get_string('inactive'));
|
||
|
|
}
|
||
|
|
|
||
|
|
// Filter options for enrolment methods.
|
||
|
|
if ($canreviewenrol && $enrolmentmethods = $manager->get_enrolment_instance_names(true)) {
|
||
|
|
$criteria = get_string('enrolmentinstances', 'enrol');
|
||
|
|
$enroloptions = [];
|
||
|
|
foreach ($enrolmentmethods as $id => $enrolname) {
|
||
|
|
$enroloptions += $this->format_filter_option(USER_FILTER_ENROLMENT, $criteria, $id, $enrolname);
|
||
|
|
}
|
||
|
|
$filteroptions += $enroloptions;
|
||
|
|
}
|
||
|
|
|
||
|
|
$isfrontpage = ($course->id == SITEID);
|
||
|
|
|
||
|
|
// Get the list of fields we have to hide.
|
||
|
|
$hiddenfields = array();
|
||
|
|
if (!has_capability('moodle/course:viewhiddenuserfields', $context)) {
|
||
|
|
$hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields));
|
||
|
|
}
|
||
|
|
$haslastaccess = !isset($hiddenfields['lastaccess']);
|
||
|
|
// Filter options for last access.
|
||
|
|
if ($haslastaccess) {
|
||
|
|
// Get minimum lastaccess for this course and display a dropbox to filter by lastaccess going back this far.
|
||
|
|
// We need to make it diferently for normal courses and site course.
|
||
|
|
if (!$isfrontpage) {
|
||
|
|
$params = ['courseid' => $course->id, 'timeaccess' => 0];
|
||
|
|
$select = 'courseid = :courseid AND timeaccess != :timeaccess';
|
||
|
|
$minlastaccess = $DB->get_field_select('user_lastaccess', 'MIN(timeaccess)', $select, $params);
|
||
|
|
$lastaccess0exists = $DB->record_exists('user_lastaccess', $params);
|
||
|
|
} else {
|
||
|
|
$params = ['lastaccess' => 0];
|
||
|
|
$select = 'lastaccess != :lastaccess';
|
||
|
|
$minlastaccess = $DB->get_field_select('user', 'MIN(lastaccess)', $select, $params);
|
||
|
|
$lastaccess0exists = $DB->record_exists('user', $params);
|
||
|
|
}
|
||
|
|
$now = usergetmidnight(time());
|
||
|
|
$timeoptions = [];
|
||
|
|
$criteria = get_string('usersnoaccesssince');
|
||
|
|
|
||
|
|
// Days.
|
||
|
|
for ($i = 1; $i < 7; $i++) {
|
||
|
|
$timestamp = strtotime('-' . $i . ' days', $now);
|
||
|
|
if ($timestamp < $minlastaccess) {
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
$value = get_string('numdays', 'moodle', $i);
|
||
|
|
$timeoptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $value);
|
||
|
|
}
|
||
|
|
// Weeks.
|
||
|
|
for ($i = 1; $i < 10; $i++) {
|
||
|
|
$timestamp = strtotime('-'.$i.' weeks', $now);
|
||
|
|
if ($timestamp < $minlastaccess) {
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
$value = get_string('numweeks', 'moodle', $i);
|
||
|
|
$timeoptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $value);
|
||
|
|
}
|
||
|
|
// Months.
|
||
|
|
for ($i = 2; $i < 12; $i++) {
|
||
|
|
$timestamp = strtotime('-'.$i.' months', $now);
|
||
|
|
if ($timestamp < $minlastaccess) {
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
$value = get_string('nummonths', 'moodle', $i);
|
||
|
|
$timeoptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $value);
|
||
|
|
}
|
||
|
|
// Try a year.
|
||
|
|
$timestamp = strtotime('-1 year', $now);
|
||
|
|
if ($timestamp >= $minlastaccess) {
|
||
|
|
$value = get_string('numyear', 'moodle', 1);
|
||
|
|
$timeoptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $value);
|
||
|
|
}
|
||
|
|
if (!empty($lastaccess0exists)) {
|
||
|
|
$value = get_string('never', 'moodle');
|
||
|
|
$timeoptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $value);
|
||
|
|
}
|
||
|
|
if (count($timeoptions) > 1) {
|
||
|
|
$filteroptions += $timeoptions;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
// Add missing applied filters to the filter options.
|
||
|
|
$filteroptions = $this->handle_missing_applied_filters($filtersapplied, $filteroptions);
|
||
|
|
|
||
|
|
$indexpage = new \core_user\output\unified_filter($filteroptions, $filtersapplied, $baseurl);
|
||
|
|
$context = $indexpage->export_for_template($this->output);
|
||
|
|
|
||
|
|
return $this->output->render_from_template('core_user/unified_filter', $context);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns a formatted filter option.
|
||
|
|
*
|
||
|
|
* @param int $filtertype The filter type (e.g. status, role, group, enrolment, last access).
|
||
|
|
* @param string $criteria The string label of the filter type.
|
||
|
|
* @param int $value The value for the filter option.
|
||
|
|
* @param string $label The string representation of the filter option's value.
|
||
|
|
* @return array The formatted option with the ['filtertype:value' => 'criteria: label'] format.
|
||
|
|
*/
|
||
|
|
protected function format_filter_option($filtertype, $criteria, $value, $label) {
|
||
|
|
$optionlabel = get_string('filteroption', 'moodle', (object)['criteria' => $criteria, 'value' => $label]);
|
||
|
|
$optionvalue = "$filtertype:$value";
|
||
|
|
return [$optionvalue => $optionlabel];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Handles cases when after reloading the applied filters are missing in the filter options.
|
||
|
|
*
|
||
|
|
* @param array $filtersapplied The applied filters.
|
||
|
|
* @param array $filteroptions The filter options.
|
||
|
|
* @return array The formatted options with the ['filtertype:value' => 'criteria: label'] format.
|
||
|
|
*/
|
||
|
|
private function handle_missing_applied_filters($filtersapplied, $filteroptions) {
|
||
|
|
global $DB;
|
||
|
|
|
||
|
|
foreach ($filtersapplied as $filter) {
|
||
|
|
if (!array_key_exists($filter, $filteroptions)) {
|
||
|
|
$filtervalue = explode(':', $filter);
|
||
|
|
if (count($filtervalue) !== 2) {
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
$key = $filtervalue[0];
|
||
|
|
$value = $filtervalue[1];
|
||
|
|
|
||
|
|
switch($key) {
|
||
|
|
case USER_FILTER_LAST_ACCESS:
|
||
|
|
$now = usergetmidnight(time());
|
||
|
|
$criteria = get_string('usersnoaccesssince');
|
||
|
|
// Days.
|
||
|
|
for ($i = 1; $i < 7; $i++) {
|
||
|
|
$timestamp = strtotime('-' . $i . ' days', $now);
|
||
|
|
if ($timestamp < $value) {
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
$val = get_string('numdays', 'moodle', $i);
|
||
|
|
$filteroptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $val);
|
||
|
|
}
|
||
|
|
// Weeks.
|
||
|
|
for ($i = 1; $i < 10; $i++) {
|
||
|
|
$timestamp = strtotime('-'.$i.' weeks', $now);
|
||
|
|
if ($timestamp < $value) {
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
$val = get_string('numweeks', 'moodle', $i);
|
||
|
|
$filteroptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $val);
|
||
|
|
}
|
||
|
|
// Months.
|
||
|
|
for ($i = 2; $i < 12; $i++) {
|
||
|
|
$timestamp = strtotime('-'.$i.' months', $now);
|
||
|
|
if ($timestamp < $value) {
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
$val = get_string('nummonths', 'moodle', $i);
|
||
|
|
$filteroptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $val);
|
||
|
|
}
|
||
|
|
// Try a year.
|
||
|
|
$timestamp = strtotime('-1 year', $now);
|
||
|
|
if ($timestamp >= $value) {
|
||
|
|
$val = get_string('numyear', 'moodle', 1);
|
||
|
|
$filteroptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $val);
|
||
|
|
}
|
||
|
|
break;
|
||
|
|
case USER_FILTER_ROLE:
|
||
|
|
$criteria = get_string('role');
|
||
|
|
if ($role = $DB->get_record('role', array('id' => $value))) {
|
||
|
|
$role = role_get_name($role);
|
||
|
|
$filteroptions += $this->format_filter_option(USER_FILTER_ROLE, $criteria, $value, $role);
|
||
|
|
}
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
return $filteroptions;
|
||
|
|
}
|
||
|
|
}
|