MDL-60733 oauth: Remove outdated comment
[moodle.git] / user / renderer.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
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.
8 //
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.
13 //
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/>.
17 /**
18  * Provides user rendering functionality such as printing private files tree and displaying a search utility
19  *
20  * @package    core_user
21  * @copyright  2010 Dongsheng Cai <dongsheng@moodle.com>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
27 /**
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
31  */
32 class core_user_renderer extends plugin_renderer_base {
34     /**
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
44      */
45     public function user_search($url, $firstinitial, $lastinitial, $usercount, $totalcount, $heading = null) {
46         global $OUTPUT;
48         if ($firstinitial !== 'all') {
49             set_user_preference('ifirst', $firstinitial);
50         }
51         if ($lastinitial !== 'all') {
52             set_user_preference('ilast', $lastinitial);
53         }
55         if (!isset($heading)) {
56             $heading = get_string('allparticipants');
57         }
59         $content = html_writer::start_tag('form', array('action' => new moodle_url($url)));
60         $content .= html_writer::start_tag('div');
62         // Search utility heading.
63         $content .= $OUTPUT->heading($heading.get_string('labelsep', 'langconfig').$usercount.'/'.$totalcount, 3);
65         // Initials bar.
66         $prefixfirst = 'sifirst';
67         $prefixlast = 'silast';
68         $content .= $OUTPUT->initials_bar($firstinitial, 'firstinitial', get_string('firstname'), $prefixfirst, $url);
69         $content .= $OUTPUT->initials_bar($lastinitial, 'lastinitial', get_string('lastname'), $prefixlast, $url);
71         $content .= html_writer::end_tag('div');
72         $content .= html_writer::tag('div', '&nbsp;');
73         $content .= html_writer::end_tag('form');
75         return $content;
76     }
78     /**
79      * Displays the list of tagged users
80      *
81      * @param array $userlist
82      * @param bool $exclusivemode if set to true it means that no other entities tagged with this tag
83      *             are displayed on the page and the per-page limit may be bigger
84      * @return string
85      */
86     public function user_list($userlist, $exclusivemode) {
87         $tagfeed = new core_tag\output\tagfeed();
88         foreach ($userlist as $user) {
89             $userpicture = $this->output->user_picture($user, array('size' => $exclusivemode ? 100 : 35));
90             $fullname = fullname($user);
91             if (user_can_view_profile($user)) {
92                 $profilelink = new moodle_url('/user/view.php', array('id' => $user->id));
93                 $fullname = html_writer::link($profilelink, $fullname);
94             }
95             $tagfeed->add($userpicture, $fullname);
96         }
98         $items = $tagfeed->export_for_template($this->output);
100         if ($exclusivemode) {
101             $output = '<div><ul class="inline-list">';
102             foreach ($items['items'] as $item) {
103                 $output .= '<li><div class="user-box">'. $item['img'] . $item['heading'] ."</div></li>\n";
104             }
105             $output .= "</ul></div>\n";
106             return $output;
107         }
109         return $this->output->render_from_template('core_tag/tagfeed', $items);
110     }
112     /**
113      * Renders the unified filter element for the course participants page.
114      *
115      * @param stdClass $course The course object.
116      * @param context $context The context object.
117      * @param array $filtersapplied Array of currently applied filters.
118      * @return bool|string
119      */
120     public function unified_filter($course, $context, $filtersapplied) {
121         global $CFG, $DB, $USER;
123         require_once($CFG->dirroot . '/enrol/locallib.php');
124         $manager = new course_enrolment_manager($this->page, $course);
126         $filteroptions = [];
128         // Filter options for role.
129         $roles = role_fix_names(get_profile_roles($context), $context, ROLENAME_ALIAS, true);
130         $criteria = get_string('role');
131         $roleoptions = [];
132         foreach ($roles as $id => $role) {
133             $roleoptions += $this->format_filter_option(USER_FILTER_ROLE, $criteria, $id, $role);
134         }
135         $filteroptions += $roleoptions;
137         // Filter options for groups, if available.
138         if ($course->groupmode != NOGROUPS) {
139             if (has_capability('moodle/site:accessallgroups', $context) || $course->groupmode == VISIBLEGROUPS) {
140                 // List all groups if the user can access all groups, or we are in visible group mode.
141                 $groups = $manager->get_all_groups();
142             } else {
143                 // Otherwise, just list the groups the user belongs to.
144                 $groups = groups_get_all_groups($course->id, $USER->id);
145             }
146             $criteria = get_string('group');
147             $groupoptions = [];
148             foreach ($groups as $id => $group) {
149                 $groupoptions += $this->format_filter_option(USER_FILTER_GROUP, $criteria, $id, $group->name);
150             }
151             $filteroptions += $groupoptions;
152         }
154         $canreviewenrol = has_capability('moodle/course:enrolreview', $context);
156         // Filter options for status.
157         if ($canreviewenrol) {
158             $criteria = get_string('status');
159             // Add statuses.
160             $filteroptions += $this->format_filter_option(USER_FILTER_STATUS, $criteria, ENROL_USER_ACTIVE, get_string('active'));
161             $filteroptions += $this->format_filter_option(USER_FILTER_STATUS, $criteria, ENROL_USER_SUSPENDED,
162                 get_string('inactive'));
163         }
165         // Filter options for enrolment methods.
166         if ($canreviewenrol && $enrolmentmethods = $manager->get_enrolment_instance_names(true)) {
167             $criteria = get_string('enrolmentinstances', 'enrol');
168             $enroloptions = [];
169             foreach ($enrolmentmethods as $id => $enrolname) {
170                 $enroloptions += $this->format_filter_option(USER_FILTER_ENROLMENT, $criteria, $id, $enrolname);
171             }
172             $filteroptions += $enroloptions;
173         }
175         $isfrontpage = ($course->id == SITEID);
177         // Get the list of fields we have to hide.
178         $hiddenfields = array();
179         if (!has_capability('moodle/course:viewhiddenuserfields', $context)) {
180             $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields));
181         }
182         $haslastaccess = !isset($hiddenfields['lastaccess']);
183         // Filter options for last access.
184         if ($haslastaccess) {
185             // Get minimum lastaccess for this course and display a dropbox to filter by lastaccess going back this far.
186             // We need to make it diferently for normal courses and site course.
187             if (!$isfrontpage) {
188                 $params = ['courseid' => $course->id, 'timeaccess' => 0];
189                 $select = 'courseid = :courseid AND timeaccess != :timeaccess';
190                 $minlastaccess = $DB->get_field_select('user_lastaccess', 'MIN(timeaccess)', $select, $params);
191                 $lastaccess0exists = $DB->record_exists('user_lastaccess', $params);
192             } else {
193                 $params = ['lastaccess' => 0];
194                 $select = 'lastaccess != :lastaccess';
195                 $minlastaccess = $DB->get_field_select('user', 'MIN(lastaccess)', $select, $params);
196                 $lastaccess0exists = $DB->record_exists('user', $params);
197             }
198             $now = usergetmidnight(time());
199             $timeoptions = [];
200             $criteria = get_string('usersnoaccesssince');
202             // Days.
203             for ($i = 1; $i < 7; $i++) {
204                 $timestamp = strtotime('-' . $i . ' days', $now);
205                 if ($timestamp >= $minlastaccess) {
206                     $value = get_string('numdays', 'moodle', $i);
207                     $timeoptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $value);
208                 }
209             }
210             // Weeks.
211             for ($i = 1; $i < 10; $i++) {
212                 $timestamp = strtotime('-'.$i.' weeks', $now);
213                 if ($timestamp >= $minlastaccess) {
214                     $value = get_string('numweeks', 'moodle', $i);
215                     $timeoptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $value);
216                 }
217             }
218             // Months.
219             for ($i = 2; $i < 12; $i++) {
220                 $timestamp = strtotime('-'.$i.' months', $now);
221                 if ($timestamp >= $minlastaccess) {
222                     $value = get_string('nummonths', 'moodle', $i);
223                     $timeoptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $value);
224                 }
225             }
226             // Try a year.
227             $timestamp = strtotime('-'.$i.' year', $now);
228             if ($timestamp >= $minlastaccess) {
229                 $value = get_string('lastyear', 'moodle');
230                 $timeoptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $value);
231             }
232             if (!empty($lastaccess0exists)) {
233                 $value = get_string('never', 'moodle');
234                 $timeoptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $value);
235             }
236             if (count($timeoptions) > 1) {
237                 $filteroptions += $timeoptions;
238             }
239         }
242         $indexpage = new \core_user\output\unified_filter($filteroptions, $filtersapplied);
243         $context = $indexpage->export_for_template($this->output);
245         return $this->output->render_from_template('core_user/unified_filter', $context);
246     }
248     /**
249      * Returns a formatted filter option.
250      *
251      * @param int $filtertype The filter type (e.g. status, role, group, enrolment, last access).
252      * @param string $criteria The string label of the filter type.
253      * @param int $value The value for the filter option.
254      * @param string $label The string representation of the filter option's value.
255      * @return array The formatted option with the ['filtertype:value' => 'criteria: label'] format.
256      */
257     protected function format_filter_option($filtertype, $criteria, $value, $label) {
258         $optionlabel = get_string('filteroption', 'moodle', (object)['criteria' => $criteria, 'value' => $label]);
259         $optionvalue = "$filtertype:$value";
260         return [$optionvalue => $optionlabel];
261     }