Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
- Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
- PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
/lib/ -> myprofilelib.php (source)
Differences Between: [Versions 310 and 400] [Versions 311 and 400] [Versions 39 and 400] [Versions 400 and 401] [Versions 400 and 402] [Versions 400 and 403]
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 * Defines core nodes for my profile navigation tree. 19 * 20 * @package core 21 * @copyright 2015 onwards Ankit Agarwal 22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 23 */ 24 25 defined('MOODLE_INTERNAL') || die(); 26 27 /** 28 * Defines core nodes for my profile navigation tree. 29 * 30 * @param \core_user\output\myprofile\tree $tree Tree object 31 * @param stdClass $user user object 32 * @param bool $iscurrentuser is the user viewing profile, current user ? 33 * @param stdClass $course course object 34 * 35 * @return bool 36 */ 37 function core_myprofile_navigation(core_user\output\myprofile\tree $tree, $user, $iscurrentuser, $course) { 38 global $CFG, $USER, $DB, $PAGE, $OUTPUT; 39 40 $usercontext = context_user::instance($user->id, MUST_EXIST); 41 $systemcontext = context_system::instance(); 42 $courseorusercontext = !empty($course) ? context_course::instance($course->id) : $usercontext; 43 $courseorsystemcontext = !empty($course) ? context_course::instance($course->id) : $systemcontext; 44 $courseid = !empty($course) ? $course->id : SITEID; 45 46 $contactcategory = new core_user\output\myprofile\category('contact', get_string('userdetails')); 47 // No after property specified intentionally. It is a hack to make administration block appear towards the end. Refer MDL-49928. 48 $coursedetailscategory = new core_user\output\myprofile\category('coursedetails', get_string('coursedetails')); 49 $miscategory = new core_user\output\myprofile\category('miscellaneous', get_string('miscellaneous'), 'coursedetails'); 50 $reportcategory = new core_user\output\myprofile\category('reports', get_string('reports'), 'miscellaneous'); 51 $admincategory = new core_user\output\myprofile\category('administration', get_string('administration'), 'reports'); 52 $loginactivitycategory = new core_user\output\myprofile\category('loginactivity', get_string('loginactivity'), 'administration'); 53 54 // Add categories. 55 $tree->add_category($contactcategory); 56 $tree->add_category($coursedetailscategory); 57 $tree->add_category($miscategory); 58 $tree->add_category($reportcategory); 59 $tree->add_category($admincategory); 60 $tree->add_category($loginactivitycategory); 61 62 // Add core nodes. 63 // Full profile node. 64 if (!empty($course)) { 65 if (user_can_view_profile($user, null, $usercontext)) { 66 $url = new moodle_url('/user/profile.php', array('id' => $user->id)); 67 $node = new core_user\output\myprofile\node('miscellaneous', 'fullprofile', get_string('fullprofile'), null, $url); 68 $tree->add_node($node); 69 } 70 } 71 72 // Edit profile. 73 if (isloggedin() && !isguestuser($user) && !is_mnet_remote_user($user)) { 74 if (($iscurrentuser || is_siteadmin($USER) || !is_siteadmin($user)) && has_capability('moodle/user:update', 75 $systemcontext)) { 76 $url = new moodle_url('/user/editadvanced.php', array('id' => $user->id, 'course' => $courseid, 77 'returnto' => 'profile')); 78 $node = new core_user\output\myprofile\node('contact', 'editprofile', get_string('editmyprofile'), null, $url, 79 null, null, 'editprofile'); 80 $tree->add_node($node); 81 } else if ((has_capability('moodle/user:editprofile', $usercontext) && !is_siteadmin($user)) 82 || ($iscurrentuser && has_capability('moodle/user:editownprofile', $systemcontext))) { 83 $userauthplugin = false; 84 if (!empty($user->auth)) { 85 $userauthplugin = get_auth_plugin($user->auth); 86 } 87 if ($userauthplugin && $userauthplugin->can_edit_profile()) { 88 $url = $userauthplugin->edit_profile_url(); 89 if (empty($url)) { 90 if (empty($course)) { 91 $url = new moodle_url('/user/edit.php', array('id' => $user->id, 'returnto' => 'profile')); 92 } else { 93 $url = new moodle_url('/user/edit.php', array('id' => $user->id, 'course' => $course->id, 94 'returnto' => 'profile')); 95 } 96 } 97 $node = new core_user\output\myprofile\node('contact', 'editprofile', 98 get_string('editmyprofile'), null, $url, null, null, 'editprofile'); 99 $tree->add_node($node); 100 } 101 } 102 } 103 104 // Preference page. 105 if (!$iscurrentuser && $PAGE->settingsnav->can_view_user_preferences($user->id)) { 106 $url = new moodle_url('/user/preferences.php', array('userid' => $user->id)); 107 $title = get_string('preferences', 'moodle'); 108 $node = new core_user\output\myprofile\node('administration', 'preferences', $title, null, $url); 109 $tree->add_node($node); 110 } 111 112 // Login as ... 113 if (!$user->deleted && !$iscurrentuser && 114 !\core\session\manager::is_loggedinas() && has_capability('moodle/user:loginas', 115 $courseorsystemcontext) && !is_siteadmin($user->id)) { 116 $url = new moodle_url('/course/loginas.php', 117 array('id' => $courseid, 'user' => $user->id, 'sesskey' => sesskey())); 118 $node = new core_user\output\myprofile\node('administration', 'loginas', get_string('loginas'), null, $url); 119 $tree->add_node($node); 120 } 121 122 // Contact details. 123 if (has_capability('moodle/user:viewhiddendetails', $courseorusercontext)) { 124 $hiddenfields = array(); 125 } else { 126 $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields)); 127 } 128 // TODO Does not support custom user profile fields (MDL-70456). 129 $identityfields = array_flip(\core_user\fields::get_identity_fields($courseorusercontext, false)); 130 131 if (is_mnet_remote_user($user)) { 132 $sql = "SELECT h.id, h.name, h.wwwroot, 133 a.name as application, a.display_name 134 FROM {mnet_host} h, {mnet_application} a 135 WHERE h.id = ? AND h.applicationid = a.id"; 136 137 $remotehost = $DB->get_record_sql($sql, array($user->mnethostid)); 138 $remoteuser = new stdclass(); 139 $remoteuser->remotetype = $remotehost->display_name; 140 $hostinfo = new stdclass(); 141 $hostinfo->remotename = $remotehost->name; 142 $hostinfo->remoteurl = $remotehost->wwwroot; 143 144 $node = new core_user\output\myprofile\node('contact', 'mnet', get_string('remoteuser', 'mnet', $remoteuser), null, null, 145 get_string('remoteuserinfo', 'mnet', $hostinfo), null, 'remoteuserinfo'); 146 $tree->add_node($node); 147 } 148 149 if ($iscurrentuser 150 or (!isset($hiddenfields['email']) and ( 151 $user->maildisplay == core_user::MAILDISPLAY_EVERYONE 152 or ($user->maildisplay == core_user::MAILDISPLAY_COURSE_MEMBERS_ONLY and enrol_sharing_course($user, $USER)) 153 or has_capability('moodle/course:useremail', $courseorusercontext) // TODO: Deprecate/remove for MDL-37479. 154 )) 155 or (isset($identityfields['email'])) 156 ) { 157 $maildisplay = obfuscate_mailto($user->email, ''); 158 if ($iscurrentuser) { 159 if ($user->maildisplay == core_user::MAILDISPLAY_EVERYONE) { 160 $maildisplay .= ' ' . get_string('emaildisplayeveryone'); 161 } else if ($user->maildisplay == core_user::MAILDISPLAY_COURSE_MEMBERS_ONLY) { 162 $maildisplay .= ' ' . get_string('emaildisplaycoursemembersonly'); 163 } else { 164 $maildisplay .= ' ' . get_string('emaildisplayhide'); 165 } 166 } 167 $node = new core_user\output\myprofile\node('contact', 'email', get_string('email'), 168 null, null, $maildisplay); 169 $tree->add_node($node); 170 } 171 172 if (!isset($hiddenfields['moodlenetprofile']) && $user->moodlenetprofile) { 173 $node = new core_user\output\myprofile\node('contact', 'moodlenetprofile', get_string('moodlenetprofile', 'user'), null, 174 null, $user->moodlenetprofile); 175 $tree->add_node($node); 176 } 177 178 if (!isset($hiddenfields['country']) && $user->country) { 179 $node = new core_user\output\myprofile\node('contact', 'country', get_string('country'), null, null, 180 get_string($user->country, 'countries')); 181 $tree->add_node($node); 182 } 183 184 if (!isset($hiddenfields['city']) && $user->city) { 185 $node = new core_user\output\myprofile\node('contact', 'city', get_string('city'), null, null, $user->city); 186 $tree->add_node($node); 187 } 188 189 if (isset($identityfields['address']) && $user->address) { 190 $node = new core_user\output\myprofile\node('contact', 'address', get_string('address'), null, null, $user->address); 191 $tree->add_node($node); 192 } 193 194 if (isset($identityfields['phone1']) && $user->phone1) { 195 $node = new core_user\output\myprofile\node('contact', 'phone1', get_string('phone1'), null, null, $user->phone1); 196 $tree->add_node($node); 197 } 198 199 if (isset($identityfields['phone2']) && $user->phone2) { 200 $node = new core_user\output\myprofile\node('contact', 'phone2', get_string('phone2'), null, null, $user->phone2); 201 $tree->add_node($node); 202 } 203 204 if (isset($identityfields['institution']) && $user->institution) { 205 $node = new core_user\output\myprofile\node('contact', 'institution', get_string('institution'), null, null, 206 $user->institution); 207 $tree->add_node($node); 208 } 209 210 if (isset($identityfields['department']) && $user->department) { 211 $node = new core_user\output\myprofile\node('contact', 'department', get_string('department'), null, null, 212 $user->department); 213 $tree->add_node($node); 214 } 215 216 if (isset($identityfields['idnumber']) && $user->idnumber) { 217 $node = new core_user\output\myprofile\node('contact', 'idnumber', get_string('idnumber'), null, null, 218 s($user->idnumber)); 219 $tree->add_node($node); 220 } 221 222 // Printing tagged interests. We want this only for full profile. 223 if (empty($course) && ($interests = core_tag_tag::get_item_tags('core', 'user', $user->id))) { 224 $node = new core_user\output\myprofile\node('contact', 'interests', get_string('interests'), null, null, 225 $OUTPUT->tag_list($interests, '')); 226 $tree->add_node($node); 227 } 228 229 if ($iscurrentuser || !isset($hiddenfields['mycourses'])) { 230 $showallcourses = optional_param('showallcourses', 0, PARAM_INT); 231 if ($mycourses = enrol_get_all_users_courses($user->id, true, null)) { 232 $shown = 0; 233 $courselisting = html_writer::start_tag('ul'); 234 foreach ($mycourses as $mycourse) { 235 if ($mycourse->category) { 236 context_helper::preload_from_record($mycourse); 237 $ccontext = context_course::instance($mycourse->id); 238 if (!isset($course) || $mycourse->id != $course->id) { 239 $linkattributes = null; 240 if ($mycourse->visible == 0) { 241 if (!has_capability('moodle/course:viewhiddencourses', $ccontext)) { 242 continue; 243 } 244 $linkattributes['class'] = 'dimmed'; 245 } 246 $params = array('id' => $user->id, 'course' => $mycourse->id); 247 if ($showallcourses) { 248 $params['showallcourses'] = 1; 249 } 250 $url = new moodle_url('/user/view.php', $params); 251 $courselisting .= html_writer::tag('li', html_writer::link($url, $ccontext->get_context_name(false), 252 $linkattributes)); 253 } else { 254 $courselisting .= html_writer::tag('li', $ccontext->get_context_name(false)); 255 } 256 } 257 $shown++; 258 if (!$showallcourses && $shown == $CFG->navcourselimit) { 259 $url = null; 260 if (isset($course)) { 261 $url = new moodle_url('/user/view.php', 262 array('id' => $user->id, 'course' => $course->id, 'showallcourses' => 1)); 263 } else { 264 $url = new moodle_url('/user/profile.php', array('id' => $user->id, 'showallcourses' => 1)); 265 } 266 $courselisting .= html_writer::tag('li', html_writer::link($url, get_string('viewmore'), 267 array('title' => get_string('viewmore'))), array('class' => 'viewmore')); 268 break; 269 } 270 } 271 $courselisting .= html_writer::end_tag('ul'); 272 if (!empty($mycourses)) { 273 // Add this node only if there are courses to display. 274 $node = new core_user\output\myprofile\node('coursedetails', 'courseprofiles', 275 get_string('courseprofiles'), null, null, rtrim($courselisting, ', ')); 276 $tree->add_node($node); 277 } 278 } 279 } 280 281 if (!empty($course)) { 282 283 // Show roles in this course. 284 if ($rolestring = get_user_roles_in_course($user->id, $course->id)) { 285 $node = new core_user\output\myprofile\node('coursedetails', 'roles', get_string('roles'), null, null, $rolestring); 286 $tree->add_node($node); 287 } 288 289 // Show groups this user is in. 290 if (!isset($hiddenfields['groups']) && !empty($course)) { 291 $accessallgroups = has_capability('moodle/site:accessallgroups', $courseorsystemcontext); 292 if ($usergroups = groups_get_all_groups($course->id, $user->id)) { 293 $groupstr = ''; 294 foreach ($usergroups as $group) { 295 if ($course->groupmode == SEPARATEGROUPS and !$accessallgroups and $user->id != $USER->id) { 296 // In separate groups mode, I only have to see the groups shared between both users. 297 if (!groups_is_member($group->id, $USER->id)) { 298 continue; 299 } 300 } 301 302 if ($course->groupmode != NOGROUPS) { 303 $groupstr .= ' <a href="'.$CFG->wwwroot.'/user/index.php?id='.$course->id.'&group='.$group->id.'">' 304 .format_string($group->name).'</a>,'; 305 } else { 306 // The user/index.php shows groups only when course in group mode. 307 $groupstr .= ' '.format_string($group->name); 308 } 309 } 310 if ($groupstr !== '') { 311 $node = new core_user\output\myprofile\node('coursedetails', 'groups', 312 get_string('group'), null, null, rtrim($groupstr, ', ')); 313 $tree->add_node($node); 314 } 315 } 316 } 317 318 if (!isset($hiddenfields['suspended'])) { 319 if ($user->suspended) { 320 $node = new core_user\output\myprofile\node('coursedetails', 'suspended', 321 null, null, null, get_string('suspended', 'auth')); 322 $tree->add_node($node); 323 } 324 } 325 } 326 327 $categories = profile_get_user_fields_with_data_by_category($user->id); 328 foreach ($categories as $categoryid => $fields) { 329 foreach ($fields as $formfield) { 330 if ($formfield->is_visible() and !$formfield->is_empty()) { 331 $node = new core_user\output\myprofile\node('contact', 'custom_field_' . $formfield->field->shortname, 332 format_string($formfield->field->name), null, null, $formfield->display_data()); 333 $tree->add_node($node); 334 } 335 } 336 } 337 338 // First access. (Why only for sites ?) 339 if (!isset($hiddenfields['firstaccess']) && empty($course)) { 340 if ($user->firstaccess) { 341 $datestring = userdate($user->firstaccess)." (".format_time(time() - $user->firstaccess).")"; 342 } else { 343 $datestring = get_string("never"); 344 } 345 $node = new core_user\output\myprofile\node('loginactivity', 'firstaccess', get_string('firstsiteaccess'), null, null, 346 $datestring); 347 $tree->add_node($node); 348 } 349 350 // Last access. 351 if (!isset($hiddenfields['lastaccess'])) { 352 if (empty($course)) { 353 $string = get_string('lastsiteaccess'); 354 if ($user->lastaccess) { 355 $datestring = userdate($user->lastaccess) . " (" . format_time(time() - $user->lastaccess) . ")"; 356 } else { 357 $datestring = get_string("never"); 358 } 359 } else { 360 $string = get_string('lastcourseaccess'); 361 if ($lastaccess = $DB->get_record('user_lastaccess', array('userid' => $user->id, 'courseid' => $course->id))) { 362 $datestring = userdate($lastaccess->timeaccess)." (".format_time(time() - $lastaccess->timeaccess).")"; 363 } else { 364 $datestring = get_string("never"); 365 } 366 } 367 368 $node = new core_user\output\myprofile\node('loginactivity', 'lastaccess', $string, null, null, 369 $datestring); 370 $tree->add_node($node); 371 } 372 373 // Last ip. 374 if (has_capability('moodle/user:viewlastip', $usercontext) && !isset($hiddenfields['lastip'])) { 375 if ($user->lastip) { 376 $iplookupurl = new moodle_url('/iplookup/index.php', array('ip' => $user->lastip, 'user' => $user->id)); 377 $ipstring = html_writer::link($iplookupurl, $user->lastip); 378 } else { 379 $ipstring = get_string("none"); 380 } 381 $node = new core_user\output\myprofile\node('loginactivity', 'lastip', get_string('lastip'), null, null, 382 $ipstring); 383 $tree->add_node($node); 384 } 385 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
