2 // This file is part of Moodle - http://moodle.org/
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 // GNU General Public License for more details.
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
18 * Provides user rendering functionality such as printing private files tree and displaying a search utility
21 * @copyright 2010 Dongsheng Cai <dongsheng@moodle.com>
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25 defined('MOODLE_INTERNAL') ||
die();
28 * Provides user rendering functionality such as printing private files tree and displaying a search utility
29 * @copyright 2010 Dongsheng Cai <dongsheng@moodle.com>
30 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
32 class core_user_renderer
extends plugin_renderer_base
{
35 * Prints user search utility that can search user by first initial of firstname and/or first initial of lastname
36 * Prints a header with a title and the number of users found within that subset
37 * @param string $url the url to return to, complete with any parameters needed for the return
38 * @param string $firstinitial the first initial of the firstname
39 * @param string $lastinitial the first initial of the lastname
40 * @param int $usercount the amount of users meeting the search criteria
41 * @param int $totalcount the amount of users of the set/subset being searched
42 * @param string $heading heading of the subset being searched, default is All Participants
43 * @return string html output
45 public function user_search($url, $firstinitial, $lastinitial, $usercount, $totalcount, $heading = null) {
47 if ($firstinitial !== 'all') {
48 set_user_preference('ifirst', $firstinitial);
50 if ($lastinitial !== 'all') {
51 set_user_preference('ilast', $lastinitial);
54 if (!isset($heading)) {
55 $heading = get_string('allparticipants');
58 $content = html_writer
::start_tag('form', array('action' => new moodle_url($url)));
59 $content .= html_writer
::start_tag('div');
61 // Search utility heading.
62 $content .= $this->output
->heading($heading.get_string('labelsep', 'langconfig').$usercount.'/'.$totalcount, 3);
65 $prefixfirst = 'sifirst';
66 $prefixlast = 'silast';
67 $content .= $this->output
->initials_bar($firstinitial, 'firstinitial', get_string('firstname'), $prefixfirst, $url);
68 $content .= $this->output
->initials_bar($lastinitial, 'lastinitial', get_string('lastname'), $prefixlast, $url);
70 $content .= html_writer
::end_tag('div');
71 $content .= html_writer
::tag('div', ' ');
72 $content .= html_writer
::end_tag('form');
78 * Displays the list of tagged users
80 * @param array $userlist
81 * @param bool $exclusivemode if set to true it means that no other entities tagged with this tag
82 * are displayed on the page and the per-page limit may be bigger
85 public function user_list($userlist, $exclusivemode) {
86 $tagfeed = new core_tag\output\tagfeed
();
87 foreach ($userlist as $user) {
88 $userpicture = $this->output
->user_picture($user, array('size' => $exclusivemode ?
100 : 35));
89 $fullname = fullname($user);
90 if (user_can_view_profile($user)) {
91 $profilelink = new moodle_url('/user/view.php', array('id' => $user->id
));
92 $fullname = html_writer
::link($profilelink, $fullname);
94 $tagfeed->add($userpicture, $fullname);
97 $items = $tagfeed->export_for_template($this->output
);
100 $output = '<div><ul class="inline-list">';
101 foreach ($items['items'] as $item) {
102 $output .= '<li><div class="user-box">'. $item['img'] . $item['heading'] ."</div></li>\n";
104 $output .= "</ul></div>\n";
108 return $this->output
->render_from_template('core_tag/tagfeed', $items);
112 * Renders the unified filter element for the course participants page.
114 * @param stdClass $course The course object.
115 * @param context $context The context object.
116 * @param array $filtersapplied Array of currently applied filters.
117 * @param string|moodle_url $baseurl The url with params needed to call up this page.
118 * @return bool|string
120 public function unified_filter($course, $context, $filtersapplied, $baseurl = null) {
121 global $CFG, $DB, $USER;
123 require_once($CFG->dirroot
. '/enrol/locallib.php');
124 require_once($CFG->dirroot
. '/lib/grouplib.php');
125 $manager = new course_enrolment_manager($this->page
, $course);
129 // Filter options for role.
130 $roleseditable = has_capability('moodle/role:assign', $context);
131 $roles = get_viewable_roles($context);
132 if ($roleseditable) {
133 $roles +
= get_assignable_roles($context, ROLENAME_ALIAS
);
136 $criteria = get_string('role');
137 $roleoptions = $this->format_filter_option(USER_FILTER_ROLE
, $criteria, -1, get_string('noroles', 'role'));
138 foreach ($roles as $id => $role) {
139 $roleoptions +
= $this->format_filter_option(USER_FILTER_ROLE
, $criteria, $id, $role);
141 $filteroptions +
= $roleoptions;
143 // Filter options for groups, if available.
144 if (has_capability('moodle/site:accessallgroups', $context) ||
$course->groupmode
!= SEPARATEGROUPS
) {
145 // List all groups if the user can access all groups, or we are in visible group mode or no groups mode.
146 $groups = $manager->get_all_groups();
147 if (!empty($groups)) {
148 // Add 'No group' option, to enable filtering users without any group.
149 $nogroup[USERSWITHOUTGROUP
] = (object)['name' => get_string('nogroup', 'group')];
150 $groups = $nogroup +
$groups;
153 // Otherwise, just list the groups the user belongs to.
154 $groups = groups_get_all_groups($course->id
, $USER->id
);
156 $criteria = get_string('group');
158 foreach ($groups as $id => $group) {
159 $groupoptions +
= $this->format_filter_option(USER_FILTER_GROUP
, $criteria, $id, $group->name
);
161 $filteroptions +
= $groupoptions;
163 $canreviewenrol = has_capability('moodle/course:enrolreview', $context);
165 // Filter options for status.
166 if ($canreviewenrol) {
167 $criteria = get_string('status');
169 $filteroptions +
= $this->format_filter_option(USER_FILTER_STATUS
, $criteria, ENROL_USER_ACTIVE
, get_string('active'));
170 $filteroptions +
= $this->format_filter_option(USER_FILTER_STATUS
, $criteria, ENROL_USER_SUSPENDED
,
171 get_string('inactive'));
174 // Filter options for enrolment methods.
175 if ($canreviewenrol && $enrolmentmethods = $manager->get_enrolment_instance_names(true)) {
176 $criteria = get_string('enrolmentinstances', 'enrol');
178 foreach ($enrolmentmethods as $id => $enrolname) {
179 $enroloptions +
= $this->format_filter_option(USER_FILTER_ENROLMENT
, $criteria, $id, $enrolname);
181 $filteroptions +
= $enroloptions;
184 $isfrontpage = ($course->id
== SITEID
);
186 // Get the list of fields we have to hide.
187 $hiddenfields = array();
188 if (!has_capability('moodle/course:viewhiddenuserfields', $context)) {
189 $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields
));
191 $haslastaccess = !isset($hiddenfields['lastaccess']);
192 // Filter options for last access.
193 if ($haslastaccess) {
194 // Get minimum lastaccess for this course and display a dropbox to filter by lastaccess going back this far.
195 // We need to make it diferently for normal courses and site course.
197 $params = ['courseid' => $course->id
, 'timeaccess' => 0];
198 $select = 'courseid = :courseid AND timeaccess != :timeaccess';
199 $minlastaccess = $DB->get_field_select('user_lastaccess', 'MIN(timeaccess)', $select, $params);
200 $lastaccess0exists = $DB->record_exists('user_lastaccess', $params);
202 $params = ['lastaccess' => 0];
203 $select = 'lastaccess != :lastaccess';
204 $minlastaccess = $DB->get_field_select('user', 'MIN(lastaccess)', $select, $params);
205 $lastaccess0exists = $DB->record_exists('user', $params);
207 $now = usergetmidnight(time());
209 $criteria = get_string('usersnoaccesssince');
212 for ($i = 1; $i < 7; $i++
) {
213 $timestamp = strtotime('-' . $i . ' days', $now);
214 if ($timestamp < $minlastaccess) {
217 $value = get_string('numdays', 'moodle', $i);
218 $timeoptions +
= $this->format_filter_option(USER_FILTER_LAST_ACCESS
, $criteria, $timestamp, $value);
221 for ($i = 1; $i < 10; $i++
) {
222 $timestamp = strtotime('-'.$i.' weeks', $now);
223 if ($timestamp < $minlastaccess) {
226 $value = get_string('numweeks', 'moodle', $i);
227 $timeoptions +
= $this->format_filter_option(USER_FILTER_LAST_ACCESS
, $criteria, $timestamp, $value);
230 for ($i = 2; $i < 12; $i++
) {
231 $timestamp = strtotime('-'.$i.' months', $now);
232 if ($timestamp < $minlastaccess) {
235 $value = get_string('nummonths', 'moodle', $i);
236 $timeoptions +
= $this->format_filter_option(USER_FILTER_LAST_ACCESS
, $criteria, $timestamp, $value);
239 $timestamp = strtotime('-1 year', $now);
240 if ($timestamp >= $minlastaccess) {
241 $value = get_string('numyear', 'moodle', 1);
242 $timeoptions +
= $this->format_filter_option(USER_FILTER_LAST_ACCESS
, $criteria, $timestamp, $value);
244 if (!empty($lastaccess0exists)) {
245 $value = get_string('never', 'moodle');
246 $timeoptions +
= $this->format_filter_option(USER_FILTER_LAST_ACCESS
, $criteria, $timestamp, $value);
248 if (count($timeoptions) > 1) {
249 $filteroptions +
= $timeoptions;
253 // Add missing applied filters to the filter options.
254 $filteroptions = $this->handle_missing_applied_filters($filtersapplied, $filteroptions);
256 $indexpage = new \core_user\output\
unified_filter($filteroptions, $filtersapplied, $baseurl);
257 $context = $indexpage->export_for_template($this->output
);
259 return $this->output
->render_from_template('core_user/unified_filter', $context);
263 * Returns a formatted filter option.
265 * @param int $filtertype The filter type (e.g. status, role, group, enrolment, last access).
266 * @param string $criteria The string label of the filter type.
267 * @param int $value The value for the filter option.
268 * @param string $label The string representation of the filter option's value.
269 * @return array The formatted option with the ['filtertype:value' => 'criteria: label'] format.
271 protected function format_filter_option($filtertype, $criteria, $value, $label) {
272 $optionlabel = get_string('filteroption', 'moodle', (object)['criteria' => $criteria, 'value' => $label]);
273 $optionvalue = "$filtertype:$value";
274 return [$optionvalue => $optionlabel];
278 * Handles cases when after reloading the applied filters are missing in the filter options.
280 * @param array $filtersapplied The applied filters.
281 * @param array $filteroptions The filter options.
282 * @return array The formatted options with the ['filtertype:value' => 'criteria: label'] format.
284 private function handle_missing_applied_filters($filtersapplied, $filteroptions) {
287 foreach ($filtersapplied as $filter) {
288 if (!array_key_exists($filter, $filteroptions)) {
289 $filtervalue = explode(':', $filter);
290 if (count($filtervalue) !== 2) {
293 $key = $filtervalue[0];
294 $value = $filtervalue[1];
297 case USER_FILTER_LAST_ACCESS
:
298 $now = usergetmidnight(time());
299 $criteria = get_string('usersnoaccesssince');
301 for ($i = 1; $i < 7; $i++
) {
302 $timestamp = strtotime('-' . $i . ' days', $now);
303 if ($timestamp < $value) {
306 $val = get_string('numdays', 'moodle', $i);
307 $filteroptions +
= $this->format_filter_option(USER_FILTER_LAST_ACCESS
, $criteria, $timestamp, $val);
310 for ($i = 1; $i < 10; $i++
) {
311 $timestamp = strtotime('-'.$i.' weeks', $now);
312 if ($timestamp < $value) {
315 $val = get_string('numweeks', 'moodle', $i);
316 $filteroptions +
= $this->format_filter_option(USER_FILTER_LAST_ACCESS
, $criteria, $timestamp, $val);
319 for ($i = 2; $i < 12; $i++
) {
320 $timestamp = strtotime('-'.$i.' months', $now);
321 if ($timestamp < $value) {
324 $val = get_string('nummonths', 'moodle', $i);
325 $filteroptions +
= $this->format_filter_option(USER_FILTER_LAST_ACCESS
, $criteria, $timestamp, $val);
328 $timestamp = strtotime('-1 year', $now);
329 if ($timestamp >= $value) {
330 $val = get_string('numyear', 'moodle', 1);
331 $filteroptions +
= $this->format_filter_option(USER_FILTER_LAST_ACCESS
, $criteria, $timestamp, $val);
334 case USER_FILTER_ROLE
:
335 $criteria = get_string('role');
336 if ($role = $DB->get_record('role', array('id' => $value))) {
337 $role = role_get_name($role);
338 $filteroptions +
= $this->format_filter_option(USER_FILTER_ROLE
, $criteria, $value, $role);
344 return $filteroptions;