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/>.
  16
  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  */
  24
  25 defined('MOODLE_INTERNAL') || die();
  26
  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 {
  33
  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;
  47
  48         if ($firstinitial !== 'all') {
  49             set_user_preference('ifirst', $firstinitial);
  50         }
  51         if ($lastinitial !== 'all') {
  52             set_user_preference('ilast', $lastinitial);
  53         }
  54
  55         if (!isset($heading)) {
  56             $heading = get_string('allparticipants');
  57         }
  58
  59         $content = html_writer::start_tag('form', array('action' => new moodle_url($url)));
  60         $content .= html_writer::start_tag('div');
  61
  62         // Search utility heading.
  63         $content .= $OUTPUT->heading($heading.get_string('labelsep', 'langconfig').$usercount.'/'.$totalcount, 3);
  64
  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);
  70
  71         $content .= html_writer::end_tag('div');
  72         $content .= html_writer::tag('div', '&nbsp;');
  73         $content .= html_writer::end_tag('form');
  74
  75         return $content;
  76     }
  77
  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         }
  97
  98         $items = $tagfeed->export_for_template($this->output);
  99
 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         }
 108
 109         return $this->output->render_from_template('core_tag/tagfeed', $items);
 110     }
 111
 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      * @param string|moodle_url $baseurl The url with params needed to call up this page.
 119      * @return bool|string
 120      */
 121     public function unified_filter($course, $context, $filtersapplied, $baseurl = null) {
 122         global $CFG, $DB, $USER;
 123
 124         require_once($CFG->dirroot . '/enrol/locallib.php');
 125         require_once($CFG->dirroot . '/lib/grouplib.php');
 126         $manager = new course_enrolment_manager($this->page, $course);
 127
 128         $filteroptions = [];
 129
 130         // Filter options for role.
 131         $roles = role_fix_names(get_profile_roles($context), $context, ROLENAME_ALIAS, true);
 132         $criteria = get_string('role');
 133         $roleoptions = [];
 134         foreach ($roles as $id => $role) {
 135             $roleoptions += $this->format_filter_option(USER_FILTER_ROLE, $criteria, $id, $role);
 136         }
 137         $filteroptions += $roleoptions;
 138
 139         // Filter options for groups, if available.
 140         if (has_capability('moodle/site:accessallgroups', $context) || $course->groupmode != SEPARATEGROUPS) {
 141             // List all groups if the user can access all groups, or we are in visible group mode or no groups mode.
 142             $groups = $manager->get_all_groups();
 143         } else {
 144             // Otherwise, just list the groups the user belongs to.
 145             $groups = groups_get_all_groups($course->id, $USER->id);
 146         }
 147         $criteria = get_string('group');
 148         $groupoptions = [];
 149         foreach ($groups as $id => $group) {
 150             $groupoptions += $this->format_filter_option(USER_FILTER_GROUP, $criteria, $id, $group->name);
 151         }
 152         $filteroptions += $groupoptions;
 153
 154         $canreviewenrol = has_capability('moodle/course:enrolreview', $context);
 155
 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         }
 164
 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         }
 174
 175         $isfrontpage = ($course->id == SITEID);
 176
 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');
 201
 202             // Days.
 203             for ($i = 1; $i < 7; $i++) {
 204                 $timestamp = strtotime('-' . $i . ' days', $now);
 205                 if ($timestamp < $minlastaccess) {
 206                     break;
 207                 }
 208                 $value = get_string('numdays', 'moodle', $i);
 209                 $timeoptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $value);
 210             }
 211             // Weeks.
 212             for ($i = 1; $i < 10; $i++) {
 213                 $timestamp = strtotime('-'.$i.' weeks', $now);
 214                 if ($timestamp < $minlastaccess) {
 215                     break;
 216                 }
 217                 $value = get_string('numweeks', 'moodle', $i);
 218                 $timeoptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $value);
 219             }
 220             // Months.
 221             for ($i = 2; $i < 12; $i++) {
 222                 $timestamp = strtotime('-'.$i.' months', $now);
 223                 if ($timestamp < $minlastaccess) {
 224                     break;
 225                 }
 226                 $value = get_string('nummonths', 'moodle', $i);
 227                 $timeoptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $value);
 228             }
 229             // Try a year.
 230             $timestamp = strtotime('-1 year', $now);
 231             if ($timestamp >= $minlastaccess) {
 232                 $value = get_string('numyear', 'moodle', 1);
 233                 $timeoptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $value);
 234             }
 235             if (!empty($lastaccess0exists)) {
 236                 $value = get_string('never', 'moodle');
 237                 $timeoptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $value);
 238             }
 239             if (count($timeoptions) > 1) {
 240                 $filteroptions += $timeoptions;
 241             }
 242         }
 243
 244         // Add missing applied filters to the filter options.
 245         $filteroptions = $this->handle_missing_applied_filters($filtersapplied, $filteroptions);
 246
 247         $indexpage = new \core_user\output\unified_filter($filteroptions, $filtersapplied, $baseurl);
 248         $context = $indexpage->export_for_template($this->output);
 249
 250         return $this->output->render_from_template('core_user/unified_filter', $context);
 251     }
 252
 253     /**
 254      * Returns a formatted filter option.
 255      *
 256      * @param int $filtertype The filter type (e.g. status, role, group, enrolment, last access).
 257      * @param string $criteria The string label of the filter type.
 258      * @param int $value The value for the filter option.
 259      * @param string $label The string representation of the filter option's value.
 260      * @return array The formatted option with the ['filtertype:value' => 'criteria: label'] format.
 261      */
 262     protected function format_filter_option($filtertype, $criteria, $value, $label) {
 263         $optionlabel = get_string('filteroption', 'moodle', (object)['criteria' => $criteria, 'value' => $label]);
 264         $optionvalue = "$filtertype:$value";
 265         return [$optionvalue => $optionlabel];
 266     }
 267
 268     /**
 269      * Handles cases when after reloading the applied filters are missing in the filter options.
 270      *
 271      * @param array $filtersapplied The applied filters.
 272      * @param array $filteroptions The filter options.
 273      * @return array The formatted options with the ['filtertype:value' => 'criteria: label'] format.
 274      */
 275     private function handle_missing_applied_filters($filtersapplied, $filteroptions) {
 276         global $DB;
 277
 278         foreach ($filtersapplied as $filter) {
 279             if (!array_key_exists($filter, $filteroptions)) {
 280                 $filtervalue = explode(':', $filter);
 281                 if (count($filtervalue) !== 2) {
 282                     continue;
 283                 }
 284                 $key = $filtervalue[0];
 285                 $value = $filtervalue[1];
 286
 287                 switch($key) {
 288                     case USER_FILTER_LAST_ACCESS:
 289                         $now = usergetmidnight(time());
 290                         $criteria = get_string('usersnoaccesssince');
 291                         // Days.
 292                         for ($i = 1; $i < 7; $i++) {
 293                             $timestamp = strtotime('-' . $i . ' days', $now);
 294                             if ($timestamp < $value) {
 295                                 break;
 296                             }
 297                             $val = get_string('numdays', 'moodle', $i);
 298                             $filteroptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $val);
 299                         }
 300                         // Weeks.
 301                         for ($i = 1; $i < 10; $i++) {
 302                             $timestamp = strtotime('-'.$i.' weeks', $now);
 303                             if ($timestamp < $value) {
 304                                 break;
 305                             }
 306                             $val = get_string('numweeks', 'moodle', $i);
 307                             $filteroptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $val);
 308                         }
 309                         // Months.
 310                         for ($i = 2; $i < 12; $i++) {
 311                             $timestamp = strtotime('-'.$i.' months', $now);
 312                             if ($timestamp < $value) {
 313                                 break;
 314                             }
 315                             $val = get_string('nummonths', 'moodle', $i);
 316                             $filteroptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $val);
 317                         }
 318                         // Try a year.
 319                         $timestamp = strtotime('-1 year', $now);
 320                         if ($timestamp >= $value) {
 321                             $val = get_string('numyear', 'moodle', 1);
 322                             $filteroptions += $this->format_filter_option(USER_FILTER_LAST_ACCESS, $criteria, $timestamp, $val);
 323                         }
 324                         break;
 325                     case USER_FILTER_ROLE:
 326                         $criteria = get_string('role');
 327                         if ($role = $DB->get_record('role', array('id' => $value))) {
 328                             $role = role_get_name($role);
 329                             $filteroptions += $this->format_filter_option(USER_FILTER_ROLE, $criteria, $value, $role);
 330                         }
 331                         break;
 332                 }
 333             }
 334         }
 335         return $filteroptions;
 336     }
 337 }