From 090926c281663f7ea7c641054ff2eedda1178268 Mon Sep 17 00:00:00 2001 From: Andrew Nicols Date: Wed, 30 Jul 2025 23:34:15 +0800 Subject: [PATCH] MDL-82159 core: Coding style fixes for navigation --- .../navigation/breadcrumb_navigation_node.php | 2 - .../classes/navigation/flat_navigation.php | 21 +- .../navigation/flat_navigation_node.php | 2 - .../classes/navigation/global_navigation.php | 645 +++++++----- .../navigation/global_navigation_for_ajax.php | 64 +- public/lib/classes/navigation/navbar.php | 110 ++- .../classes/navigation/navigation_cache.php | 13 +- .../classes/navigation/navigation_json.php | 31 +- .../classes/navigation/navigation_node.php | 234 ++--- .../navigation/navigation_node_collection.php | 74 +- .../navigation/settings_navigation.php | 915 ++++++++++++------ .../navigation/exposed_global_navigation.php | 10 +- .../exposed_settings_navigation.php | 10 +- .../navigation/navigation_testcase.php | 34 +- public/lib/tests/navigation/navbar_test.php | 12 +- .../navigation/navigation_cache_test.php | 1 - .../tests/navigation/navigation_node_test.php | 75 +- .../navigation/settings_navigation_test.php | 8 +- 18 files changed, 1392 insertions(+), 869 deletions(-) diff --git a/public/lib/classes/navigation/breadcrumb_navigation_node.php b/public/lib/classes/navigation/breadcrumb_navigation_node.php index 7a20eee304b..59e4c934cac 100644 --- a/public/lib/classes/navigation/breadcrumb_navigation_node.php +++ b/public/lib/classes/navigation/breadcrumb_navigation_node.php @@ -28,7 +28,6 @@ use core\exception\coding_exception; * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class breadcrumb_navigation_node extends navigation_node { - /** @var $last boolean A flag indicating this is the last item in the list of breadcrumbs. */ private $last = false; @@ -41,7 +40,6 @@ class breadcrumb_navigation_node extends navigation_node { if (is_array($navnode)) { parent::__construct($navnode); } else if ($navnode instanceof navigation_node) { - // Just clone everything. $objvalues = get_object_vars($navnode); foreach ($objvalues as $key => $value) { diff --git a/public/lib/classes/navigation/flat_navigation.php b/public/lib/classes/navigation/flat_navigation.php index c97fbb533de..8690dd008e9 100644 --- a/public/lib/classes/navigation/flat_navigation.php +++ b/public/lib/classes/navigation/flat_navigation.php @@ -30,6 +30,10 @@ use moodle_page; * @copyright 2016 Damyon Wiese * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ +#[\core\attribute\deprecated( + since: '4.0', + reason: 'Do not use this class any more. Leverage secondary/tertiary navigation concepts.' +)] class flat_navigation extends navigation_node_collection { /** @var moodle_page the moodle page that the navigation belongs to */ protected $page; @@ -66,7 +70,7 @@ class flat_navigation extends navigation_node_collection { // First walk the nav tree looking for "flat_navigation" nodes. if ($course->id > 1) { // It's a real course. - $url = new url('/course/view.php', array('id' => $course->id)); + $url = new url('/course/view.php', ['id' => $course->id]); $coursecontext = context_course::instance($course->id, MUST_EXIST); $displaycontext = context_helper::get_navigation_filter_context($coursecontext); @@ -123,9 +127,11 @@ class flat_navigation extends navigation_node_collection { } // Add-a-block in editing mode. - if (isset($this->page->theme->addblockposition) && + if ( + isset($this->page->theme->addblockposition) && $this->page->theme->addblockposition == BLOCK_ADDBLOCK_POSITION_FLATNAV && - $PAGE->user_is_editing() && $PAGE->user_can_edit_blocks()) { + $PAGE->user_is_editing() && $PAGE->user_can_edit_blocks() + ) { $url = new url($PAGE->url, ['bui_addblock' => '', 'sesskey' => sesskey()]); $addablock = navigation_node::create(get_string('addblock'), $url); $flat = new flat_navigation_node($addablock, 0); @@ -136,8 +142,11 @@ class flat_navigation extends navigation_node_collection { $addblockurl = "?{$url->get_query_string(false)}"; - $PAGE->requires->js_call_amd('core_block/add_modal', 'init', - [$addblockurl, $this->page->get_edited_page_hash()]); + $PAGE->requires->js_call_amd( + 'core_block/add_modal', + 'init', + [$addblockurl, $this->page->get_edited_page_hash()] + ); } } @@ -149,7 +158,7 @@ class flat_navigation extends navigation_node_collection { * otherwise adds at end * @return navigation_node Added node */ - public function add(navigation_node $node, $beforekey=null) { + public function add(navigation_node $node, $beforekey = null) { $result = parent::add($node, $beforekey); // Extend the parent to get a name for the collection of nodes if required. if (empty($this->collectionlabel)) { diff --git a/public/lib/classes/navigation/flat_navigation_node.php b/public/lib/classes/navigation/flat_navigation_node.php index 20f74daa52b..4ddb924e63e 100644 --- a/public/lib/classes/navigation/flat_navigation_node.php +++ b/public/lib/classes/navigation/flat_navigation_node.php @@ -29,7 +29,6 @@ use core\exception\coding_exception; * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class flat_navigation_node extends navigation_node { - /** @var $indent integer The indent level */ private $indent = 0; @@ -49,7 +48,6 @@ class flat_navigation_node extends navigation_node { if (is_array($navnode)) { parent::__construct($navnode); } else if ($navnode instanceof navigation_node) { - // Just clone everything. $objvalues = get_object_vars($navnode); foreach ($objvalues as $key => $value) { diff --git a/public/lib/classes/navigation/global_navigation.php b/public/lib/classes/navigation/global_navigation.php index 5804af2a79d..d111355b46d 100644 --- a/public/lib/classes/navigation/global_navigation.php +++ b/public/lib/classes/navigation/global_navigation.php @@ -58,25 +58,25 @@ class global_navigation extends navigation_node { /** @var bool switch to let us know if the navigation object is initialised*/ protected $initialised = false; /** @var array An array of course information */ - protected $mycourses = array(); + protected $mycourses = []; /** @var navigation_node[] An array for containing root navigation nodes */ - protected $rootnodes = array(); + protected $rootnodes = []; /** @var bool A switch for whether to show empty sections in the navigation */ protected $showemptysections = true; /** @var bool A switch for whether courses should be shown within categories on the navigation. */ protected $showcategories = null; - /** @var null@var bool A switch for whether or not to show categories in the my courses branch. */ + /** @var null|var bool A switch for whether or not to show categories in the my courses branch. */ protected $showmycategories = null; /** @var array An array of stdClasses for users that the navigation is extended for */ - protected $extendforuser = array(); + protected $extendforuser = []; /** @var navigation_cache */ protected $cache; /** @var array An array of course ids that are present in the navigation */ - protected $addedcourses = array(); + protected $addedcourses = []; /** @var bool */ protected $allcategoriesloaded = false; /** @var array An array of category ids that are included in the navigation */ - protected $addedcategories = array(); + protected $addedcategories = []; /** @var int expansion limit */ protected $expansionlimit = 0; /** @var int userid to allow parent to see child's profile page navigation */ @@ -85,9 +85,9 @@ class global_navigation extends navigation_node { protected $cacheexpandcourse = null; /** Used when loading categories to load all top level categories [parent = 0] **/ - const LOAD_ROOT_CATEGORIES = 0; + public const LOAD_ROOT_CATEGORIES = 0; /** Used when loading categories to load all categories **/ - const LOAD_ALL_CATEGORIES = -1; + public const LOAD_ALL_CATEGORIES = -1; /** * Constructs a new global navigation @@ -104,38 +104,38 @@ class global_navigation extends navigation_node { $homepage = get_home_page(); if ($homepage == HOMEPAGE_MY) { // We are using the users my moodle for the root element. - $properties = array( + $properties = [ 'key' => 'myhome', 'type' => navigation_node::TYPE_SYSTEM, 'text' => get_string('myhome'), 'action' => new url('/my/'), 'icon' => new pix_icon('i/dashboard', ''), - ); + ]; } else if ($homepage == HOMEPAGE_MYCOURSES) { // We are using the user's course summary page for the root element. - $properties = array( + $properties = [ 'key' => 'mycourses', 'type' => navigation_node::TYPE_SYSTEM, 'text' => get_string('mycourses'), 'action' => new url('/my/courses.php'), - 'icon' => new pix_icon('i/course', '') - ); + 'icon' => new pix_icon('i/course', ''), + ]; } else { // We are using the site home for the root element. - $properties = array( + $properties = [ 'key' => 'home', 'type' => navigation_node::TYPE_SYSTEM, 'text' => get_string('home'), 'action' => new url('/'), 'icon' => new pix_icon('i/home', ''), - ); + ]; } - // Use the parents constructor.... good good reuse + // Use the parents constructor.... good good reuse. parent::__construct($properties); $this->showinflatnavigation = true; - // Initalise and set defaults + // Initalise and set defaults. $this->page = $page; $this->forceopen = true; $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME); @@ -168,53 +168,72 @@ class global_navigation extends navigation_node { */ public function initialise() { global $CFG, $SITE, $USER; - // Check if it has already been initialised + // Check if it has already been initialised. if ($this->initialised || during_initial_install()) { return true; } $this->initialised = true; - // Set up the five base root nodes. These are nodes where we will put our - // content and are as follows: - // site: Navigation for the front page. - // myprofile: User profile information goes here. - // currentcourse: The course being currently viewed. - // mycourses: The users courses get added here. - // courses: Additional courses are added here. - // users: Other users information loaded here. - $this->rootnodes = array(); + // Set up the five base root nodes. These are nodes where we will put our content and are as follows: + // - site: Navigation for the front page. + // - myprofile: User profile information goes here. + // - currentcourse: The course being currently viewed. + // - mycourses: The users courses get added here. + // - courses: Additional courses are added here. + // - users: Other users information loaded here. + $this->rootnodes = []; $defaulthomepage = get_home_page(); if ($defaulthomepage == HOMEPAGE_SITE) { - // The home element should be my moodle because the root element is the site - if (isloggedin() && !isguestuser()) { // Makes no sense if you aren't logged in + // The home element should be my moodle because the root element is the site. + if (isloggedin() && !isguestuser()) { // Makes no sense if you aren't logged in. if (!empty($CFG->enabledashboard)) { // Only add dashboard to home if it's enabled. - $this->rootnodes['home'] = $this->add(get_string('myhome'), new url('/my/'), - self::TYPE_SETTING, null, 'myhome', new pix_icon('i/dashboard', '')); + $this->rootnodes['home'] = $this->add( + get_string('myhome'), + new url('/my/'), + self::TYPE_SETTING, + null, + 'myhome', + new pix_icon('i/dashboard', '') + ); $this->rootnodes['home']->showinflatnavigation = true; } } } else { - // The home element should be the site because the root node is my moodle - $this->rootnodes['home'] = $this->add(get_string('sitehome'), new url('/'), - self::TYPE_SETTING, null, 'home', new pix_icon('i/home', '')); + // The home element should be the site because the root node is my moodle. + $this->rootnodes['home'] = $this->add( + get_string('sitehome'), + new url('/'), + self::TYPE_SETTING, + null, + 'home', + new pix_icon('i/home', '') + ); $this->rootnodes['home']->showinflatnavigation = true; - if (!empty($CFG->defaulthomepage) && - ($CFG->defaulthomepage == HOMEPAGE_MY || $CFG->defaulthomepage == HOMEPAGE_MYCOURSES)) { - // We need to stop automatic redirection + if ( + !empty($CFG->defaulthomepage) && + ($CFG->defaulthomepage == HOMEPAGE_MY || $CFG->defaulthomepage == HOMEPAGE_MYCOURSES) + ) { + // We need to stop automatic redirection. $this->rootnodes['home']->action->param('redirect', '0'); } } $this->rootnodes['site'] = $this->add_course($SITE); $this->rootnodes['myprofile'] = $this->add(get_string('profile'), null, self::TYPE_USER, null, 'myprofile'); - $this->rootnodes['currentcourse'] = $this->add(get_string('currentcourse'), null, self::TYPE_ROOTNODE, null, 'currentcourse'); + $this->rootnodes['currentcourse'] = $this->add( + get_string('currentcourse'), + null, + self::TYPE_ROOTNODE, + null, + 'currentcourse', + ); $this->rootnodes['mycourses'] = $this->add( get_string('mycourses'), new url('/my/courses.php'), self::TYPE_ROOTNODE, null, 'mycourses', - new pix_icon('i/course', '') + new pix_icon('i/course', ''), ); // We do not need to show this node in the breadcrumbs if the default homepage is mycourses. // It will be automatically handled by the breadcrumb generator. @@ -222,21 +241,26 @@ class global_navigation extends navigation_node { $this->rootnodes['mycourses']->mainnavonly = true; } - $this->rootnodes['courses'] = $this->add(get_string('courses'), new url('/course/index.php'), self::TYPE_ROOTNODE, null, 'courses'); + $this->rootnodes['courses'] = $this->add( + get_string('courses'), + new url('/course/index.php'), + self::TYPE_ROOTNODE, + null, + 'courses', + ); if (!core_course_category::user_top()) { $this->rootnodes['courses']->hide(); } $this->rootnodes['users'] = $this->add(get_string('users'), null, self::TYPE_ROOTNODE, null, 'users'); - // We always load the frontpage course to ensure it is available without - // JavaScript enabled. + // We always load the frontpage course to ensure it is available without JavaScript enabled. $this->add_front_page_course_essentials($this->rootnodes['site'], $SITE); $this->load_course_sections($SITE, $this->rootnodes['site']); $course = $this->page->course; $this->load_courses_enrolled(); - // $issite gets set to true if the current pages course is the sites frontpage course + // Note: $issite gets set to true if the current pages course is the sites frontpage course. $issite = ($this->page->course->id == $SITE->id); // Determine if the user is enrolled in any course. @@ -257,17 +281,17 @@ class global_navigation extends navigation_node { $canviewcourseprofile = true; - // Next load context specific content into the navigation + // Next load context specific content into the navigation. switch ($this->page->context->contextlevel) { - case CONTEXT_SYSTEM : + case CONTEXT_SYSTEM: // Nothing left to do here I feel. break; - case CONTEXT_COURSECAT : + case CONTEXT_COURSECAT: // This is essential, we must load categories. $this->load_all_categories($this->page->context->instanceid, true); break; - case CONTEXT_BLOCK : - case CONTEXT_COURSE : + case CONTEXT_BLOCK: + case CONTEXT_COURSE: if ($issite) { // Nothing left to do here. break; @@ -275,16 +299,16 @@ class global_navigation extends navigation_node { // Load the course associated with the current page into the navigation. $coursenode = $this->add_course($course, false, self::COURSE_CURRENT); + // If the course wasn't added then don't try going any further. if (!$coursenode) { $canviewcourseprofile = false; break; } - // If the user is not enrolled then we only want to show the - // course node and not populate it. + // If the user is not enrolled then we only want to show the course node and not populate it. - // Not enrolled, can't view, and hasn't switched roles + // Not enrolled, can't view, and hasn't switched roles. if (!can_access_course($course, null, '', true)) { if ($coursenode->isexpandable === true) { // Obviously the situation has changed, update the cache and adjust the node. @@ -294,8 +318,8 @@ class global_navigation extends navigation_node { $coursenode->isexpandable = true; $coursenode->nodetype = self::NODETYPE_BRANCH; } - // Very ugly hack - do not force "parents" to enrol into course their child is enrolled in, - // this hack has been propagated from user/view.php to display the navigation node. (MDL-25805) + // Very ugly hack - do not force "parents" to enrol into course their child is enrolled in. + // This hack has been propagated from user/view.php to display the navigation node. (MDL-25805). if (!$this->current_user_is_parent_role()) { $coursenode->make_active(); $canviewcourseprofile = false; @@ -312,19 +336,17 @@ class global_navigation extends navigation_node { // Add the essentials such as reports etc... $this->add_course_essentials($coursenode, $course); - // Extend course navigation with it's sections/activities + // Extend course navigation with it's sections/activities. $this->load_course_sections($course, $coursenode); if (!$coursenode->contains_active_node() && !$coursenode->search_for_active_node()) { $coursenode->make_active(); } break; - case CONTEXT_MODULE : + case CONTEXT_MODULE: if ($issite) { - // If this is the site course then most information will have - // already been loaded. - // However we need to check if there is more content that can - // yet be loaded for the specific module instance. + // If this is the site course then most information will have already been loaded. + // However we need to check if there is more content that can yet be loaded for the specific module instance. $activitynode = $this->rootnodes['site']->find($this->page->cm->id, navigation_node::TYPE_ACTIVITY); if ($activitynode) { $this->load_activity($this->page->cm, $this->page->course, $activitynode); @@ -335,7 +357,7 @@ class global_navigation extends navigation_node { $course = $this->page->course; $cm = $this->page->cm; - // Load the course associated with the page into the navigation + // Load the course associated with the page into the navigation. $coursenode = $this->add_course($course, false, self::COURSE_CURRENT); // If the course wasn't added then don't try going any further. @@ -344,8 +366,7 @@ class global_navigation extends navigation_node { break; } - // If the user is not enrolled then we only want to show the - // course node and not populate it. + // If the user is not enrolled then we only want to show the course node and not populate it. if (!can_access_course($course, null, '', true)) { $coursenode->make_active(); $canviewcourseprofile = false; @@ -354,27 +375,27 @@ class global_navigation extends navigation_node { $this->add_course_essentials($coursenode, $course); - // Load the course sections into the page + // Load the course sections into the page. $this->load_course_sections($course, $coursenode, null, $cm); $activity = $coursenode->find($cm->id, navigation_node::TYPE_ACTIVITY); if (!empty($activity)) { - // Finally load the cm specific navigaton information + // Finally load the cm specific navigaton information. $this->load_activity($cm, $course, $activity); - // Check if we have an active ndoe + + // Check if we have an active node. if (!$activity->contains_active_node() && !$activity->search_for_active_node()) { // And make the activity node active. $activity->make_active(); } } break; - case CONTEXT_USER : + case CONTEXT_USER: if ($issite) { - // The users profile information etc is already loaded - // for the front page. + // The users profile information etc is already loaded for the front page. break; } $course = $this->page->course; - // Load the course associated with the user into the navigation + // Load the course associated with the user into the navigation. $coursenode = $this->add_course($course, false, self::COURSE_CURRENT); // If the course wasn't added then don't try going any further. @@ -383,8 +404,7 @@ class global_navigation extends navigation_node { break; } - // If the user is not enrolled then we only want to show the - // course node and not populate it. + // If the user is not enrolled then we only want to show the course node and not populate it. if (!can_access_course($course, null, '', true)) { $coursenode->make_active(); $canviewcourseprofile = false; @@ -395,9 +415,13 @@ class global_navigation extends navigation_node { break; } - // Load for the current user + // Load for the current user. $this->load_for_user(); - if ($this->page->context->contextlevel >= CONTEXT_COURSE && $this->page->context->instanceid != $SITE->id && $canviewcourseprofile) { + if ( + $this->page->context->contextlevel >= CONTEXT_COURSE + && $this->page->context->instanceid != $SITE->id + && $canviewcourseprofile + ) { $this->load_for_user(null, true); } // Load each extending user into the navigation. @@ -410,10 +434,9 @@ class global_navigation extends navigation_node { // Give the local plugins a chance to include some navigation if they want. $this->load_local_plugin_navigation(); - // Remove any empty root nodes + // Remove any empty root nodes. foreach ($this->rootnodes as $node) { - // Dont remove the home node - /** @var navigation_node $node */ + // Dont remove the home node. if (!in_array($node->key, ['home', 'mycourses', 'myhome']) && !$node->has_children() && !$node->isactive) { $node->remove(); } @@ -465,7 +488,7 @@ class global_navigation extends navigation_node { if (!has_capability('moodle/user:viewdetails', $usercontext)) { return false; } - if ($DB->record_exists('role_assignments', array('userid' => $USER->id, 'contextid' => $usercontext->id))) { + if ($DB->record_exists('role_assignments', ['userid' => $USER->id, 'contextid' => $usercontext->id])) { return true; } } @@ -523,16 +546,16 @@ class global_navigation extends navigation_node { $limit = $CFG->navcourselimit; } - $toload = (empty($CFG->navshowallcourses))?self::LOAD_ROOT_CATEGORIES:self::LOAD_ALL_CATEGORIES; + $toload = (empty($CFG->navshowallcourses)) ? self::LOAD_ROOT_CATEGORIES : self::LOAD_ALL_CATEGORIES; // If we are going to show all courses AND we are showing categories then - // to save us repeated DB calls load all of the categories now + // to save us repeated DB calls load all of the categories now. if ($this->show_categories()) { $this->load_all_categories($toload); } - // Will be the return of our efforts - $coursenodes = array(); + // Will be the return of our efforts. + $coursenodes = []; // Check if we need to show categories. if ($this->show_categories()) { @@ -541,16 +564,16 @@ class global_navigation extends navigation_node { // be displayed. if ($categoryids !== null) { if (!is_array($categoryids)) { - $categoryids = array($categoryids); + $categoryids = [$categoryids]; } - list($categorywhere, $categoryparams) = $DB->get_in_or_equal($categoryids, SQL_PARAMS_NAMED, 'cc'); - $categorywhere = 'WHERE cc.id '.$categorywhere; + [$categorywhere, $categoryparams] = $DB->get_in_or_equal($categoryids, SQL_PARAMS_NAMED, 'cc'); + $categorywhere = 'WHERE cc.id ' . $categorywhere; } else if ($toload == self::LOAD_ROOT_CATEGORIES) { $categorywhere = 'WHERE cc.depth = 1 OR cc.depth = 2'; - $categoryparams = array(); + $categoryparams = []; } else { $categorywhere = ''; - $categoryparams = array(); + $categoryparams = []; } // First up we are going to get the categories that we are going to @@ -561,8 +584,8 @@ class global_navigation extends navigation_node { {$categorywhere} GROUP BY cc.id"; $categories = $DB->get_recordset_sql($sql, $categoryparams); - $fullfetch = array(); - $partfetch = array(); + $fullfetch = []; + $partfetch = []; foreach ($categories as $category) { if (!$this->can_add_more_courses_to_category($category->id)) { continue; @@ -578,7 +601,7 @@ class global_navigation extends navigation_node { if (count($fullfetch)) { // First up fetch all of the courses in categories where we know that we are going to // need the majority of courses. - list($categoryids, $categoryparams) = $DB->get_in_or_equal($fullfetch, SQL_PARAMS_NAMED, 'lcategory'); + [$categoryids, $categoryparams] = $DB->get_in_or_equal($fullfetch, SQL_PARAMS_NAMED, 'lcategory'); $ccselect = ', ' . context_helper::get_preload_record_columns_sql('ctx'); $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)"; $categoryparams['contextlevel'] = CONTEXT_COURSE; @@ -603,7 +626,11 @@ class global_navigation extends navigation_node { continue; } context_helper::preload_from_record($course); - if (!$course->visible && !is_role_switched($course->id) && !has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) { + if ( + !$course->visible + && !is_role_switched($course->id) + && !has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id)) + ) { continue; } $coursenodes[$course->id] = $this->add_course($course); @@ -622,7 +649,7 @@ class global_navigation extends navigation_node { $ccjoin WHERE c.category = :categoryid ORDER BY c.sortorder ASC"; - $courseparams = array('categoryid' => $categoryid, 'contextlevel' => CONTEXT_COURSE); + $courseparams = ['categoryid' => $categoryid, 'contextlevel' => CONTEXT_COURSE]; $coursesrs = $DB->get_recordset_sql($sql, $courseparams, 0, $limit * 5); foreach ($coursesrs as $course) { if ($course->id == $SITE->id) { @@ -640,7 +667,11 @@ class global_navigation extends navigation_node { break; } context_helper::preload_from_record($course); - if (!$course->visible && !is_role_switched($course->id) && !has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) { + if ( + !$course->visible + && !is_role_switched($course->id) + && !has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id)) + ) { continue; } $coursenodes[$course->id] = $this->add_course($course); @@ -649,8 +680,11 @@ class global_navigation extends navigation_node { } } } else { - // Prepare the SQL to load the courses and their contexts - list($courseids, $courseparams) = $DB->get_in_or_equal(array_keys($this->addedcourses), SQL_PARAMS_NAMED, 'lc', false); + // Prepare the SQL to load the courses and their contexts. + [ + $courseids, + $courseparams, + ] = $DB->get_in_or_equal(array_keys($this->addedcourses), SQL_PARAMS_NAMED, 'lc', false); $ccselect = ', ' . context_helper::get_preload_record_columns_sql('ctx'); $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)"; $courseparams['contextlevel'] = CONTEXT_COURSE; @@ -662,15 +696,19 @@ class global_navigation extends navigation_node { $coursesrs = $DB->get_recordset_sql($sql, $courseparams); foreach ($coursesrs as $course) { if ($course->id == $SITE->id) { - // frotpage is not wanted here + // Frontpage is not wanted here. continue; } if ($this->page->course && ($this->page->course->id == $course->id)) { - // Don't include the currentcourse in this nodelist - it's displayed in the Current course node + // Don't include the currentcourse in this nodelist - it's displayed in the Current course node. continue; } context_helper::preload_from_record($course); - if (!$course->visible && !is_role_switched($course->id) && !has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) { + if ( + !$course->visible + && !is_role_switched($course->id) + && !has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id)) + ) { continue; } $coursenodes[$course->id] = $this->add_course($course); @@ -706,7 +744,7 @@ class global_navigation extends navigation_node { return false; } $coursecount = count($category->children->type(self::TYPE_COURSE)); - } else if (is_object($category) && property_exists($category,'id')) { + } else if (is_object($category) && property_exists($category, 'id')) { $coursecount = count($this->addedcategories[$category->id]->children->type(self::TYPE_COURSE)); } return ($coursecount <= $limit); @@ -723,7 +761,7 @@ class global_navigation extends navigation_node { protected function load_all_categories($categoryid = self::LOAD_ROOT_CATEGORIES, $showbasecategories = false) { global $CFG, $DB; - // Check if this category has already been loaded + // Check if this category has already been loaded. if ($this->allcategoriesloaded || ($categoryid < 1 && $this->is_category_fully_loaded($categoryid))) { return true; } @@ -732,58 +770,58 @@ class global_navigation extends navigation_node { $sqlselect = "SELECT cc.*, $catcontextsql FROM {course_categories} cc JOIN {context} ctx ON cc.id = ctx.instanceid"; - $sqlwhere = "WHERE ctx.contextlevel = ".CONTEXT_COURSECAT; + $sqlwhere = "WHERE ctx.contextlevel = " . CONTEXT_COURSECAT; $sqlorder = "ORDER BY cc.depth ASC, cc.sortorder ASC, cc.id ASC"; - $params = array(); + $params = []; - $categoriestoload = array(); + $categoriestoload = []; + // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedIf if ($categoryid == self::LOAD_ALL_CATEGORIES) { - // We are going to load all categories regardless... prepare to fire - // on the database server! - } else if ($categoryid == self::LOAD_ROOT_CATEGORIES) { // can be 0 - // We are going to load all of the first level categories (categories without parents) + // We are going to load all categories regardless. + } else if ($categoryid == self::LOAD_ROOT_CATEGORIES) { // Note: can be 0. + // We are going to load all of the first level categories (categories without parents). $sqlwhere .= " AND cc.parent = 0"; } else if (array_key_exists($categoryid, $this->addedcategories)) { - // The category itself has been loaded already so we just need to ensure its subcategories - // have been loaded + // The category itself has been loaded already so we just need to ensure its subcategories have been loaded. $addedcategories = $this->addedcategories; unset($addedcategories[$categoryid]); if (count($addedcategories) > 0) { - list($sql, $params) = $DB->get_in_or_equal(array_keys($addedcategories), SQL_PARAMS_NAMED, 'parent', false); + [$sql, $params] = $DB->get_in_or_equal(array_keys($addedcategories), SQL_PARAMS_NAMED, 'parent', false); if ($showbasecategories) { - // We need to include categories with parent = 0 as well + // We need to include categories with parent = 0 as well. $sqlwhere .= " AND (cc.parent = :categoryid OR cc.parent = 0) AND cc.parent {$sql}"; } else { - // All we need is categories that match the parent + // All we need is categories that match the parent. $sqlwhere .= " AND cc.parent = :categoryid AND cc.parent {$sql}"; } } $params['categoryid'] = $categoryid; } else { // This category hasn't been loaded yet so we need to fetch it, work out its category path - // and load this category plus all its parents and subcategories - $category = $DB->get_record('course_categories', array('id' => $categoryid), 'path', MUST_EXIST); + // and load this category plus all its parents and subcategories. + $category = $DB->get_record('course_categories', ['id' => $categoryid], 'path', MUST_EXIST); $categoriestoload = explode('/', trim($category->path, '/')); - list($select, $params) = $DB->get_in_or_equal($categoriestoload); - // We are going to use select twice so double the params + [$select, $params] = $DB->get_in_or_equal($categoriestoload); + // We are going to use select twice so double the param. $params = array_merge($params, $params); - $basecategorysql = ($showbasecategories)?' OR cc.depth = 1':''; + $basecategorysql = ($showbasecategories) ? ' OR cc.depth = 1' : ''; $sqlwhere .= " AND (cc.id {$select} OR cc.parent {$select}{$basecategorysql})"; } $categoriesrs = $DB->get_recordset_sql("$sqlselect $sqlwhere $sqlorder", $params); - $categories = array(); + $categories = []; foreach ($categoriesrs as $category) { - // Preload the context.. we'll need it when adding the category in order - // to format the category name. + // Preload the context.. we'll need it when adding the category in order to format the category name. context_helper::preload_from_record($category); + + // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedIf if (array_key_exists($category->id, $this->addedcategories)) { // Do nothing, its already been added. } else if ($category->parent == '0') { - // This is a root category lets add it immediately + // This is a root category lets add it immediately. $this->add_category($category, $this->rootnodes['courses']); } else if (array_key_exists($category->parent, $this->addedcategories)) { - // This categories parent has already been added we can add this immediately + // This categories parent has already been added we can add this immediately. $this->add_category($category, $this->addedcategories[$category->parent]); } else { $categories[] = $category; @@ -794,8 +832,9 @@ class global_navigation extends navigation_node { // Now we have an array of categories we need to add them to the navigation. while (!empty($categories)) { $category = reset($categories); + // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedIf if (array_key_exists($category->id, $this->addedcategories)) { - // Do nothing + // Do nothing. } else if ($category->parent == '0') { $this->add_category($category, $this->rootnodes['courses']); } else if (array_key_exists($category->parent, $this->addedcategories)) { @@ -833,7 +872,7 @@ class global_navigation extends navigation_node { } // Check if there are any categories to load. if (count($categoriestoload) > 0) { - $readytoloadcourses = array(); + $readytoloadcourses = []; foreach ($categoriestoload as $category) { if ($this->can_add_more_courses_to_category($category)) { $readytoloadcourses[] = $category; @@ -844,17 +883,17 @@ class global_navigation extends navigation_node { } } - // Look for all categories which have been loaded + // Look for all categories which have been loaded. if (!empty($this->addedcategories)) { - $categoryids = array(); + $categoryids = []; foreach ($this->addedcategories as $category) { if ($this->can_add_more_courses_to_category($category)) { $categoryids[] = $category->key; } } if ($categoryids) { - list($categoriessql, $params) = $DB->get_in_or_equal($categoryids, SQL_PARAMS_NAMED); - $params['limit'] = (!empty($CFG->navcourselimit))?$CFG->navcourselimit:20; + [$categoriessql, $params] = $DB->get_in_or_equal($categoryids, SQL_PARAMS_NAMED); + $params['limit'] = (!empty($CFG->navcourselimit)) ? $CFG->navcourselimit : 20; $sql = "SELECT cc.id, COUNT(c.id) AS coursecount FROM {course_categories} cc JOIN {course} c ON c.category = cc.id @@ -863,8 +902,11 @@ class global_navigation extends navigation_node { HAVING COUNT(c.id) > :limit"; $excessivecategories = $DB->get_records_sql($sql, $params); foreach ($categories as &$category) { - if (array_key_exists($category->key, $excessivecategories) && !$this->can_add_more_courses_to_category($category)) { - $url = new url('/course/index.php', array('categoryid' => $category->key)); + if ( + array_key_exists($category->key, $excessivecategories) + && !$this->can_add_more_courses_to_category($category) + ) { + $url = new url('/course/index.php', ['categoryid' => $category->key]); $category->add(get_string('viewallcourses'), $url, self::TYPE_SETTING); } } @@ -886,7 +928,7 @@ class global_navigation extends navigation_node { return; } $canview = core_course_category::can_view_category($category); - $url = $canview ? new url('/course/index.php', array('categoryid' => $category->id)) : null; + $url = $canview ? new url('/course/index.php', ['categoryid' => $category->id]) : null; $context = context_helper::get_navigation_filter_context(context_coursecat::instance($category->id)); $categoryname = $canview ? format_string($category->name, true, ['context' => $context]) : get_string('categoryhidden'); @@ -910,13 +952,13 @@ class global_navigation extends navigation_node { protected function load_course(stdClass $course) { global $SITE; if ($course->id == $SITE->id) { - // This is always loaded during initialisation + // This is always loaded during initialisation. return $this->rootnodes['site']; } else if (array_key_exists($course->id, $this->addedcourses)) { - // The course has already been loaded so return a reference + // The course has already been loaded so return a reference. return $this->addedcourses[$course->id]; } else { - // Add the course + // Add the course. return $this->add_course($course); } } @@ -939,7 +981,7 @@ class global_navigation extends navigation_node { */ protected function load_course_sections(stdClass $course, navigation_node $coursenode, $sectionnum = null, $cm = null) { global $CFG, $SITE; - require_once($CFG->dirroot.'/course/lib.php'); + require_once($CFG->dirroot . '/course/lib.php'); if (isset($cm->sectionnum)) { $sectionnum = $cm->sectionnum; } @@ -965,16 +1007,16 @@ class global_navigation extends navigation_node { */ protected function generate_sections_and_activities(stdClass $course) { global $CFG; - require_once($CFG->dirroot.'/course/lib.php'); + require_once($CFG->dirroot . '/course/lib.php'); $modinfo = get_fast_modinfo($course); $sections = $modinfo->get_section_info_all(); $format = course_get_format($course); - // For course formats using 'numsections' trim the sections list + // For course formats using 'numsections' trim the sections list. $courseformatoptions = $format->get_format_options(); if (isset($courseformatoptions['numsections'])) { - $sections = array_slice($sections, 0, $courseformatoptions['numsections']+1, true); + $sections = array_slice($sections, 0, $courseformatoptions['numsections'] + 1, true); } $activities = []; @@ -988,7 +1030,7 @@ class global_navigation extends navigation_node { continue; } foreach ($section->get_sequence_cm_infos() as $cm) { - $activity = new stdClass; + $activity = new stdClass(); $activity->id = $cm->id; $activity->course = $course->id; $activity->section = $section->sectionnum; @@ -1039,9 +1081,9 @@ class global_navigation extends navigation_node { */ public function load_generic_course_sections(stdClass $course, navigation_node $coursenode) { global $CFG, $DB, $USER, $SITE; - require_once($CFG->dirroot.'/course/lib.php'); + require_once($CFG->dirroot . '/course/lib.php'); - list($sections, $activities) = $this->generate_sections_and_activities($course); + [$sections, $activities] = $this->generate_sections_and_activities($course); $navigationsections = []; foreach ($sections as $sectionid => $section) { @@ -1346,29 +1388,29 @@ class global_navigation extends navigation_node { protected function load_activity($cm, stdClass $course, navigation_node $activity) { global $CFG, $DB; - // make sure we have a $cm from get_fast_modinfo as this contains activity access details + // Make sure we have a $cm from get_fast_modinfo as this contains activity access details. if (!($cm instanceof cm_info)) { $modinfo = get_fast_modinfo($course); $cm = $modinfo->get_cm($cm->id); } $activity->nodetype = navigation_node::NODETYPE_LEAF; $activity->make_active(); - $file = $CFG->dirroot.'/mod/'.$cm->modname.'/lib.php'; - $function = $cm->modname.'_extend_navigation'; + $file = $CFG->dirroot . '/mod/' . $cm->modname . '/lib.php'; + $function = $cm->modname . '_extend_navigation'; if (file_exists($file)) { require_once($file); if (function_exists($function)) { - $activtyrecord = $DB->get_record($cm->modname, array('id' => $cm->instance), '*', MUST_EXIST); + $activtyrecord = $DB->get_record($cm->modname, ['id' => $cm->instance], '*', MUST_EXIST); $function($activity, $course, $activtyrecord, $cm); } } - // Allow the active advanced grading method plugin to append module navigation - $featuresfunc = $cm->modname.'_supports'; + // Allow the active advanced grading method plugin to append module navigation. + $featuresfunc = $cm->modname . '_supports'; if (function_exists($featuresfunc) && $featuresfunc(FEATURE_ADVANCED_GRADING)) { - require_once($CFG->dirroot.'/grade/grading/lib.php'); - $gradingman = get_grading_manager($cm->context, 'mod_'.$cm->modname); + require_once($CFG->dirroot . '/grade/grading/lib.php'); + $gradingman = get_grading_manager($cm->context, 'mod_' . $cm->modname); $gradingman->extend_navigation($this, $activity); } @@ -1383,27 +1425,26 @@ class global_navigation extends navigation_node { * @param bool $forceforcontext probably force something to be loaded somewhere (ask SamH if not sure what this means) * @return bool */ - protected function load_for_user($user=null, $forceforcontext=false) { + protected function load_for_user($user = null, $forceforcontext = false) { global $DB, $CFG, $USER, $SITE; require_once($CFG->dirroot . '/course/lib.php'); if ($user === null) { - // We can't require login here but if the user isn't logged in we don't - // want to show anything + // We can't require login here but if the user isn't logged in we don't want to show anything. if (!isloggedin() || isguestuser()) { return false; } $user = $USER; } else if (!is_object($user)) { - // If the user is not an object then get them from the database + // If the user is not an object then get them from the database. $select = context_helper::get_preload_record_columns_sql('ctx'); $sql = "SELECT u.*, $select FROM {user} u JOIN {context} ctx ON u.id = ctx.instanceid WHERE u.id = :userid AND ctx.contextlevel = :contextlevel"; - $user = $DB->get_record_sql($sql, array('userid' => (int)$user, 'contextlevel' => CONTEXT_USER), MUST_EXIST); + $user = $DB->get_record_sql($sql, ['userid' => (int)$user, 'contextlevel' => CONTEXT_USER], MUST_EXIST); context_helper::preload_from_record($user); } @@ -1411,16 +1452,16 @@ class global_navigation extends navigation_node { $usercontext = context_user::instance($user->id); - // Get the course set against the page, by default this will be the site + // Get the course set against the page, by default this will be the site. $course = $this->page->course; - $baseargs = array('id'=>$user->id); + $baseargs = ['id' => $user->id]; if ($course->id != $SITE->id && (!$iscurrentuser || $forceforcontext)) { $coursenode = $this->add_course($course, false, self::COURSE_CURRENT); $baseargs['course'] = $course->id; $coursecontext = context_course::instance($course->id); $issitecourse = false; } else { - // Load all categories and get the context for the system + // Load all categories and get the context for the system. $coursecontext = context_system::instance(); $issitecourse = true; } @@ -1435,7 +1476,7 @@ class global_navigation extends navigation_node { // This is the site so add a users node to the root branch. $usersnode = $this->rootnodes['users']; if (course_can_view_participants($coursecontext)) { - $usersnode->action = new url('/user/index.php', array('id' => $course->id)); + $usersnode->action = new url('/user/index.php', ['id' => $course->id]); } $userviewurl = new url('/user/profile.php', $baseargs); } @@ -1452,7 +1493,7 @@ class global_navigation extends navigation_node { $viewprofile = true; if (!$iscurrentuser) { require_once($CFG->dirroot . '/user/lib.php'); - if ($this->page->context->contextlevel == CONTEXT_USER && !has_capability('moodle/user:viewdetails', $usercontext) ) { + if ($this->page->context->contextlevel == CONTEXT_USER && !has_capability('moodle/user:viewdetails', $usercontext)) { $viewprofile = false; } else if ($this->page->context->contextlevel != CONTEXT_USER && !user_can_view_profile($user, $course, $usercontext)) { $viewprofile = false; @@ -1476,11 +1517,12 @@ class global_navigation extends navigation_node { // Add user information to the participants or user node. if ($issitecourse) { - // If the user is the current user or has permission to view the details of the requested // user than add a view profile link. - if ($iscurrentuser || has_capability('moodle/user:viewdetails', $coursecontext) || - has_capability('moodle/user:viewdetails', $usercontext)) { + if ( + $iscurrentuser || has_capability('moodle/user:viewdetails', $coursecontext) || + has_capability('moodle/user:viewdetails', $usercontext) + ) { if ($issitecourse || ($iscurrentuser && !$forceforcontext)) { $usernode->add(get_string('viewprofile'), new url('/user/profile.php', $baseargs)); } else { @@ -1490,21 +1532,27 @@ class global_navigation extends navigation_node { // Add blog nodes. if (!empty($CFG->enableblogs)) { - if (!$this->cache->cached('userblogoptions'.$user->id)) { - require_once($CFG->dirroot.'/blog/lib.php'); + if (!$this->cache->cached('userblogoptions' . $user->id)) { + require_once($CFG->dirroot . '/blog/lib.php'); // Get all options for the user. $options = blog_get_options_for_user($user); - $this->cache->set('userblogoptions'.$user->id, $options); + $this->cache->set('userblogoptions' . $user->id, $options); } else { - $options = $this->cache->{'userblogoptions'.$user->id}; + $options = $this->cache->{'userblogoptions' . $user->id}; } if (count($options) > 0) { $blogs = $usernode->add(get_string('blogs', 'blog'), null, navigation_node::TYPE_CONTAINER); foreach ($options as $type => $option) { if ($type == "rss") { - $blogs->add($option['string'], $option['link'], settings_navigation::TYPE_SETTING, null, null, - new pix_icon('i/rss', '')); + $blogs->add( + $option['string'], + $option['link'], + settings_navigation::TYPE_SETTING, + null, + null, + new pix_icon('i/rss', '') + ); } else { $blogs->add($option['string'], $option['link']); } @@ -1515,7 +1563,7 @@ class global_navigation extends navigation_node { // Add the messages link. // It is context based so can appear in the user's profile and in course participants information. if (!empty($CFG->messaging)) { - $messageargs = array('user1' => $USER->id); + $messageargs = ['user1' => $USER->id]; if ($USER->id != $user->id) { $messageargs['user2'] = $user->id; } @@ -1531,9 +1579,11 @@ class global_navigation extends navigation_node { } // Add a node to view the users notes if permitted. - if (!empty($CFG->enablenotes) && - has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $coursecontext)) { - $url = new url('/notes/index.php', array('user' => $user->id)); + if ( + !empty($CFG->enablenotes) && + has_any_capability(['moodle/notes:manage', 'moodle/notes:view'], $coursecontext) + ) { + $url = new url('/notes/index.php', ['user' => $user->id]); if ($coursecontext->instanceid != SITEID) { $url->param('course', $coursecontext->instanceid); } @@ -1547,7 +1597,7 @@ class global_navigation extends navigation_node { if ($course->id == SITEID) { $url = user_mygrades_url($user->id, $course->id); } else { // Otherwise we are in a course and should redirect to the user grade report (Activity report version). - $url = new url('/course/user.php', array('mode' => 'grade', 'id' => $course->id, 'user' => $user->id)); + $url = new url('/course/user.php', ['mode' => 'grade', 'id' => $course->id, 'user' => $user->id]); } if ($USER->id != $user->id) { $usernode->add(get_string('grades', 'grades'), $url, self::TYPE_SETTING, null, 'usergrades'); @@ -1558,11 +1608,12 @@ class global_navigation extends navigation_node { // If the user is the current user add the repositories for the current user. $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields)); - if (!$iscurrentuser && + if ( + !$iscurrentuser && $course->id == $SITE->id && has_capability('moodle/user:viewdetails', $usercontext) && - (!in_array('mycourses', $hiddenfields) || has_capability('moodle/user:viewhiddendetails', $coursecontext))) { - + (!in_array('mycourses', $hiddenfields) || has_capability('moodle/user:viewhiddendetails', $coursecontext)) + ) { // Add view grade report is permitted. $reports = component::get_plugin_list('gradereport'); arsort($reports); // User is last, we want to test it first. @@ -1573,20 +1624,22 @@ class global_navigation extends navigation_node { $count = 0; foreach ($userscourses as $usercourse) { if ($count === (int)$CFG->navcourselimit) { - $url = new url('/user/profile.php', array('id' => $user->id, 'showallcourses' => 1)); + $url = new url('/user/profile.php', ['id' => $user->id, 'showallcourses' => 1]); $userscoursesnode->add(get_string('showallcourses'), $url); break; } $count++; $usercoursecontext = context_course::instance($usercourse->id); - $usercourseshortname = format_string($usercourse->shortname, true, array('context' => $usercoursecontext)); - $usercoursenode = $userscoursesnode->add($usercourseshortname, new url('/user/view.php', - array('id' => $user->id, 'course' => $usercourse->id)), self::TYPE_CONTAINER); + $usercourseshortname = format_string($usercourse->shortname, true, ['context' => $usercoursecontext]); + $usercoursenode = $userscoursesnode->add($usercourseshortname, new url( + '/user/view.php', + ['id' => $user->id, 'course' => $usercourse->id] + ), self::TYPE_CONTAINER); $gradeavailable = has_capability('moodle/grade:view', $usercoursecontext); if (!$gradeavailable && !empty($usercourse->showgrades) && is_array($reports) && !empty($reports)) { foreach ($reports as $plugin => $plugindir) { - if (has_capability('gradereport/'.$plugin.':view', $usercoursecontext)) { + if (has_capability('gradereport/' . $plugin . ':view', $usercoursecontext)) { // Stop when the first visible plugin is found. $gradeavailable = true; break; @@ -1595,21 +1648,31 @@ class global_navigation extends navigation_node { } if ($gradeavailable) { - $url = new url('/grade/report/index.php', array('id' => $usercourse->id)); - $usercoursenode->add(get_string('grades'), $url, self::TYPE_SETTING, null, null, - new pix_icon('i/grades', '')); + $url = new url('/grade/report/index.php', ['id' => $usercourse->id]); + $usercoursenode->add( + get_string('grades'), + $url, + self::TYPE_SETTING, + null, + null, + new pix_icon('i/grades', '') + ); } // Add a node to view the users notes if permitted. - if (!empty($CFG->enablenotes) && - has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $usercoursecontext)) { - $url = new url('/notes/index.php', array('user' => $user->id, 'course' => $usercourse->id)); + if ( + !empty($CFG->enablenotes) && + has_any_capability(['moodle/notes:manage', 'moodle/notes:view'], $usercoursecontext) + ) { + $url = new url('/notes/index.php', ['user' => $user->id, 'course' => $usercourse->id]); $usercoursenode->add(get_string('notes', 'notes'), $url, self::TYPE_SETTING); } if (can_access_course($usercourse, $user->id, '', true)) { - $usercoursenode->add(get_string('entercourse'), new url('/course/view.php', - array('id' => $usercourse->id)), self::TYPE_SETTING, null, null, new pix_icon('i/course', '')); + $usercoursenode->add(get_string('entercourse'), new url( + '/course/view.php', + ['id' => $usercourse->id] + ), self::TYPE_SETTING, null, null, new pix_icon('i/course', '')); } $reporttab = $usercoursenode->add(get_string('activityreports')); @@ -1646,12 +1709,12 @@ class global_navigation extends navigation_node { */ public static function module_extends_navigation($modname) { global $CFG; - static $extendingmodules = array(); + static $extendingmodules = []; if (!array_key_exists($modname, $extendingmodules)) { $extendingmodules[$modname] = false; - $file = $CFG->dirroot.'/mod/'.$modname.'/lib.php'; + $file = $CFG->dirroot . '/mod/' . $modname . '/lib.php'; if (file_exists($file)) { - $function = $modname.'_extend_navigation'; + $function = $modname . '_extend_navigation'; require_once($file); $extendingmodules[$modname] = (function_exists($function)); } @@ -1686,7 +1749,7 @@ class global_navigation extends navigation_node { public function add_course(stdClass $course, $forcegeneric = false, $coursetype = self::COURSE_OTHER) { global $CFG, $SITE; - // We found the course... we can return it now :) + // We found the course... we can return it now. if (!$forcegeneric && array_key_exists($course->id, $this->addedcourses)) { return $this->addedcourses[$course->id]; } @@ -1694,8 +1757,9 @@ class global_navigation extends navigation_node { $coursecontext = context_course::instance($course->id); if ($coursetype != self::COURSE_MY && $coursetype != self::COURSE_CURRENT && $course->id != $SITE->id) { + // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedIf if (is_role_switched($course->id)) { - // user has to be able to access course in order to switch, let's skip the visibility test here + // User has to be able to access course in order to switch, let's skip the visibility test here. } else if (!core_course_category::can_view_course_info($course)) { return false; } @@ -1726,28 +1790,32 @@ class global_navigation extends navigation_node { } } else if ($coursetype == self::COURSE_CURRENT) { $parent = $this->rootnodes['currentcourse']; - $url = new url('/course/view.php', array('id'=>$course->id)); + $url = new url('/course/view.php', ['id' => $course->id]); $canexpandcourse = $this->can_expand_course($course); } else if ($coursetype == self::COURSE_MY && !$forcegeneric) { - if (!empty($CFG->navshowmycoursecategories) && ($parent = $this->rootnodes['mycourses']->find($course->category, self::TYPE_MY_CATEGORY))) { + // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedIf + if ( + !empty($CFG->navshowmycoursecategories) + && ($parent = $this->rootnodes['mycourses']->find($course->category, self::TYPE_MY_CATEGORY)) + ) { // Nothing to do here the above statement set $parent to the category within mycourses. } else { $parent = $this->rootnodes['mycourses']; } - $url = new url('/course/view.php', array('id'=>$course->id)); + $url = new url('/course/view.php', ['id' => $course->id]); } else { $parent = $this->rootnodes['courses']; - $url = new url('/course/view.php', array('id'=>$course->id)); + $url = new url('/course/view.php', ['id' => $course->id]); // They can only expand the course if they can access it. $canexpandcourse = $this->can_expand_course($course); if (!empty($course->category) && $this->show_categories($coursetype == self::COURSE_MY)) { if (!$this->is_category_fully_loaded($course->category)) { - // We need to load the category structure for this course + // We need to load the category structure for this course. $this->load_all_categories($course->category, false); } if (array_key_exists($course->category, $this->addedcategories)) { $parent = $this->addedcategories[$course->category]; - // This could lead to the course being created so we should check whether it is the case again + // This could lead to the course being created so we should check whether it is the case again. if (!$forcegeneric && array_key_exists($course->id, $this->addedcourses)) { return $this->addedcourses[$course->id]; } @@ -1821,7 +1889,13 @@ class global_navigation extends navigation_node { * @return bool */ protected function is_category_fully_loaded($categoryid) { - return (array_key_exists($categoryid, $this->addedcategories) && ($this->allcategoriesloaded || $this->addedcategories[$categoryid]->children->count() > 0)); + return ( + array_key_exists($categoryid, $this->addedcategories) + && ( + $this->allcategoriesloaded + || $this->addedcategories[$categoryid]->children->count() > 0 + ) + ); } /** @@ -1841,16 +1915,26 @@ class global_navigation extends navigation_node { return $this->add_front_page_course_essentials($coursenode, $course); } - if ($coursenode == false || !($coursenode instanceof navigation_node) || $coursenode->get('participants', navigation_node::TYPE_CONTAINER)) { + if ( + $coursenode == false + || !($coursenode instanceof navigation_node) + || $coursenode->get('participants', navigation_node::TYPE_CONTAINER) + ) { return true; } $navoptions = course_get_user_navigation_options($this->page->context, $course); - //Participants + // Participants. if ($navoptions->participants) { - $participants = $coursenode->add(get_string('participants'), new url('/user/index.php?id='.$course->id), - self::TYPE_CONTAINER, get_string('participants'), 'participants', new pix_icon('i/users', '')); + $participants = $coursenode->add( + get_string('participants'), + new url('/user/index.php?id=' . $course->id), + self::TYPE_CONTAINER, + get_string('participants'), + 'participants', + new pix_icon('i/users', '') + ); if ($navoptions->blogs) { $blogsurls = new url('/blog/index.php'); @@ -1863,7 +1947,13 @@ class global_navigation extends navigation_node { } if ($navoptions->notes) { - $participants->add(get_string('notes', 'notes'), new url('/notes/index.php', array('filtertype' => 'course', 'filterselect' => $course->id)), self::TYPE_SETTING, null, 'currentcoursenotes'); + $participants->add( + get_string('notes', 'notes'), + new url('/notes/index.php', ['filtertype' => 'course', 'filterselect' => $course->id]), + self::TYPE_SETTING, + null, + 'currentcoursenotes', + ); } } else if (count($this->extendforuser) > 0) { $coursenode->add(get_string('participants'), null, self::TYPE_CONTAINER, get_string('participants'), 'participants'); @@ -1876,23 +1966,40 @@ class global_navigation extends navigation_node { if ($navoptions->badges) { $url = new url('/badges/index.php', ['type' => 2, 'id' => $course->id]); - $coursenode->add(get_string('coursebadges', 'badges'), $url, - navigation_node::TYPE_SETTING, null, 'badgesview', - new pix_icon('i/badge', get_string('coursebadges', 'badges'))); + $coursenode->add( + get_string('coursebadges', 'badges'), + $url, + navigation_node::TYPE_SETTING, + null, + 'badgesview', + new pix_icon('i/badge', get_string('coursebadges', 'badges')) + ); } // Check access to the course and competencies page. if ($navoptions->competencies) { // Just a link to course competency. $title = get_string('competencies', 'core_competency'); - $path = new url("/admin/tool/lp/coursecompetencies.php", array('courseid' => $course->id)); - $coursenode->add($title, $path, navigation_node::TYPE_SETTING, null, 'competencies', - new pix_icon('i/competencies', '')); + $path = new url("/admin/tool/lp/coursecompetencies.php", ['courseid' => $course->id]); + $coursenode->add( + $title, + $path, + navigation_node::TYPE_SETTING, + null, + 'competencies', + new pix_icon('i/competencies', '') + ); } if ($navoptions->grades) { - $url = new url('/grade/report/index.php', array('id'=>$course->id)); - $gradenode = $coursenode->add(get_string('grades'), $url, self::TYPE_SETTING, null, - 'grades', new pix_icon('i/grades', '')); + $url = new url('/grade/report/index.php', ['id' => $course->id]); + $gradenode = $coursenode->add( + get_string('grades'), + $url, + self::TYPE_SETTING, + null, + 'grades', + new pix_icon('i/grades', '') + ); // If the page type matches the grade part, then make the nav drawer grade node (incl. all sub pages) active. if ($this->page->context->contextlevel < CONTEXT_MODULE && strpos($this->page->pagetype, 'grade-') === 0) { $gradenode->make_active(); @@ -1907,8 +2014,13 @@ class global_navigation extends navigation_node { 'instancetype' => 'coursecommunication', 'component' => 'core_course', ]); - $coursenode->add(get_string('communication', 'communication'), $url, - navigation_node::TYPE_SETTING, null, 'communication'); + $coursenode->add( + get_string('communication', 'communication'), + $url, + navigation_node::TYPE_SETTING, + null, + 'communication' + ); } if ($navoptions->overview) { @@ -1954,8 +2066,13 @@ class global_navigation extends navigation_node { // Participants. if ($navoptions->participants) { - $coursenode->add(get_string('participants'), new url('/user/index.php?id='.$course->id), - self::TYPE_CUSTOM, get_string('participants'), 'participants'); + $coursenode->add( + get_string('participants'), + new url('/user/index.php?id=' . $course->id), + self::TYPE_CUSTOM, + get_string('participants'), + 'participants' + ); } // Blogs. @@ -1974,28 +2091,46 @@ class global_navigation extends navigation_node { // Notes. if ($navoptions->notes) { - $coursenode->add(get_string('notes', 'notes'), new url('/notes/index.php', - array('filtertype' => 'course', 'filterselect' => $filterselect)), self::TYPE_SETTING, null, 'notes'); + $coursenode->add(get_string('notes', 'notes'), new url( + '/notes/index.php', + ['filtertype' => 'course', 'filterselect' => $filterselect] + ), self::TYPE_SETTING, null, 'notes'); } - // Tags + // Tags. if ($navoptions->tags) { - $node = $coursenode->add(get_string('tags', 'tag'), new url('/tag/search.php'), - self::TYPE_SETTING, null, 'tags'); + $node = $coursenode->add( + get_string('tags', 'tag'), + new url('/tag/search.php'), + self::TYPE_SETTING, + null, + 'tags' + ); } // Search. if ($navoptions->search) { - $node = $coursenode->add(get_string('search', 'search'), new url('/search/index.php'), - self::TYPE_SETTING, null, 'search'); + $node = $coursenode->add( + get_string('search', 'search'), + new url('/search/index.php'), + self::TYPE_SETTING, + null, + 'search' + ); } if (isloggedin()) { $usercontext = context_user::instance($USER->id); if (has_capability('moodle/user:manageownfiles', $usercontext)) { $url = new url('/user/files.php'); - $node = $coursenode->add(get_string('privatefiles'), $url, - self::TYPE_SETTING, null, 'privatefiles', new pix_icon('i/privatefiles', '')); + $node = $coursenode->add( + get_string('privatefiles'), + $url, + self::TYPE_SETTING, + null, + 'privatefiles', + new pix_icon('i/privatefiles', '') + ); $node->display = false; $node->showinflatnavigation = true; $node->mainnavonly = true; @@ -2013,6 +2148,7 @@ class global_navigation extends navigation_node { if ($COURSE->id != $SITE->id) { break; } + // Not the site. Fall through to default. default: // If this context is part of a course (excluding frontpage), use the course context. // Otherwise, use the system context. @@ -2027,8 +2163,14 @@ class global_navigation extends navigation_node { $params = ['contextid' => $context->id]; if (has_capability('moodle/contentbank:access', $context)) { $url = new url('/contentbank/index.php', $params); - $node = $coursenode->add(get_string('contentbank'), $url, - self::TYPE_CUSTOM, null, 'contentbank', new pix_icon('i/contentbank', '')); + $node = $coursenode->add( + get_string('contentbank'), + $url, + self::TYPE_CUSTOM, + null, + 'contentbank', + new pix_icon('i/contentbank', '') + ); $node->showinflatnavigation = true; } } @@ -2063,15 +2205,15 @@ class global_navigation extends navigation_node { // We only want to hide specific types of nodes. // Only nodes that represent "structure" in the navigation tree should be hidden. // If we hide all nodes then we risk hiding vital information. - $typestohide = array( + $typestohide = [ self::TYPE_CATEGORY, self::TYPE_COURSE, self::TYPE_SECTION, - self::TYPE_ACTIVITY - ); + self::TYPE_ACTIVITY, + ]; foreach ($nodes as $node) { - // We need to generate the full site node + // We need to generate the full site node. if ($type == self::TYPE_COURSE && $node->key == $SITE->id) { continue; } @@ -2081,21 +2223,8 @@ class global_navigation extends navigation_node { } return true; } - /** - * Attempts to get the navigation with the given key from this nodes children. - * - * This function only looks at this nodes children, it does NOT look recursivily. - * If the node can't be found then false is returned. - * - * If you need to search recursivily then use the {@link global_navigation::find()} method. - * - * Note: If you are trying to set the active node {@link navigation_node::override_active_url()} - * may be of more use to you. - * - * @param string|int $key The key of the node you wish to receive. - * @param int $type One of navigation_node::TYPE_* - * @return navigation_node|false - */ + + #[\Override] public function get($key, $type = null) { if (!$this->initialised) { $this->initialise(); @@ -2103,23 +2232,7 @@ class global_navigation extends navigation_node { return parent::get($key, $type); } - /** - * Searches this nodes children and their children to find a navigation node - * with the matching key and type. - * - * This method is recursive and searches children so until either a node is - * found or there are no more nodes to search. - * - * If you know that the node being searched for is a child of this node - * then use the {@link global_navigation::get()} method instead. - * - * Note: If you are trying to set the active node {@link navigation_node::override_active_url()} - * may be of more use to you. - * - * @param string|int $key The key of the node you wish to receive. - * @param ?int $type One of navigation_node::TYPE_* - * @return navigation_node|false - */ + #[\Override] public function find($key, $type) { if (!$this->initialised) { $this->initialise(); @@ -2163,7 +2276,7 @@ class global_navigation extends navigation_node { $numshownflatnavcourses = count($flatnavcourses); if ($numshowncourses && $this->show_my_categories()) { // Generate an array containing unique values of all the courses' categories. - $categoryids = array(); + $categoryids = []; foreach ($courses as $course) { if (in_array($course->category, $categoryids)) { continue; diff --git a/public/lib/classes/navigation/global_navigation_for_ajax.php b/public/lib/classes/navigation/global_navigation_for_ajax.php index 181762cf9af..2e4b9430eae 100644 --- a/public/lib/classes/navigation/global_navigation_for_ajax.php +++ b/public/lib/classes/navigation/global_navigation_for_ajax.php @@ -38,7 +38,6 @@ use moodle_page; * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class global_navigation_for_ajax extends global_navigation { - /** @var int used for determining what type of navigation_node::TYPE_* is being used */ protected $branchtype; @@ -46,7 +45,7 @@ class global_navigation_for_ajax extends global_navigation { protected $instanceid; /** @var array Holds an array of expandable nodes */ - protected $expandable = array(); + protected $expandable = []; /** * Constructs the navigation for use in an AJAX request @@ -63,11 +62,8 @@ class global_navigation_for_ajax extends global_navigation { $this->instanceid = $id; $this->initialise(); } - /** - * Initialise the navigation given the type and id for the branch to expand. - * - * @return array An array of the expandable nodes - */ + + #[\Override] public function initialise() { global $DB, $SITE; @@ -76,7 +72,7 @@ class global_navigation_for_ajax extends global_navigation { } $this->initialised = true; - $this->rootnodes = array(); + $this->rootnodes = []; $this->rootnodes['site'] = $this->add_course($SITE); $this->rootnodes['mycourses'] = $this->add( get_string('mycourses'), @@ -90,7 +86,7 @@ class global_navigation_for_ajax extends global_navigation { // This mimicks what is done during {@link global_navigation::initialise()}. $this->rootnodes['courses']->isexpandable = true; - // Branchtype will be one of navigation_node::TYPE_* + // Branchtype will be one of navigation_node::TYPE_*. switch ($this->branchtype) { case 0: if ($this->instanceid === 'mycourses') { @@ -99,14 +95,14 @@ class global_navigation_for_ajax extends global_navigation { $this->load_courses_other(); } break; - case self::TYPE_CATEGORY : + case self::TYPE_CATEGORY: $this->load_category($this->instanceid); break; - case self::TYPE_MY_CATEGORY : + case self::TYPE_MY_CATEGORY: $this->load_category($this->instanceid, self::TYPE_MY_CATEGORY); break; - case self::TYPE_COURSE : - $course = $DB->get_record('course', array('id' => $this->instanceid), '*', MUST_EXIST); + case self::TYPE_COURSE: + $course = $DB->get_record('course', ['id' => $this->instanceid], '*', MUST_EXIST); if (!can_access_course($course, null, '', true)) { // Thats OK all courses are expandable by default. We don't need to actually expand it we can just // add the course node and break. This leads to an empty node. @@ -119,24 +115,24 @@ class global_navigation_for_ajax extends global_navigation { $this->add_course_essentials($coursenode, $course); $this->load_course_sections($course, $coursenode); break; - case self::TYPE_SECTION : + case self::TYPE_SECTION: $sql = 'SELECT c.*, cs.section AS sectionnumber FROM {course} c LEFT JOIN {course_sections} cs ON cs.course = c.id WHERE cs.id = ?'; - $course = $DB->get_record_sql($sql, array($this->instanceid), MUST_EXIST); + $course = $DB->get_record_sql($sql, [$this->instanceid], MUST_EXIST); require_course_login($course, true, null, false, true); $this->page->set_context(context_course::instance($course->id)); $coursenode = $this->add_course($course, false, self::COURSE_CURRENT); $this->add_course_essentials($coursenode, $course); $this->load_course_sections($course, $coursenode, $course->sectionnumber); break; - case self::TYPE_ACTIVITY : + case self::TYPE_ACTIVITY: $sql = "SELECT c.* FROM {course} c JOIN {course_modules} cm ON cm.course = c.id WHERE cm.id = :cmid"; - $params = array('cmid' => $this->instanceid); + $params = ['cmid' => $this->instanceid]; $course = $DB->get_record_sql($sql, $params, MUST_EXIST); $modinfo = get_fast_modinfo($course); $cm = $modinfo->get_cm($this->instanceid); @@ -195,13 +191,13 @@ class global_navigation_for_ajax extends global_navigation { $sql = "SELECT cc.*, $catcontextsql FROM {course_categories} cc JOIN {context} ctx ON cc.id = ctx.instanceid - WHERE ctx.contextlevel = ".CONTEXT_COURSECAT." AND + WHERE ctx.contextlevel = " . CONTEXT_COURSECAT . " AND (cc.id = :categoryid1 OR cc.parent = :categoryid2) ORDER BY cc.depth ASC, cc.sortorder ASC, cc.id ASC"; - $params = array('categoryid1' => $categoryid, 'categoryid2' => $categoryid); + $params = ['categoryid1' => $categoryid, 'categoryid2' => $categoryid]; $categories = $DB->get_recordset_sql($sql, $params, 0, $limit); - $categorylist = array(); - $subcategories = array(); + $categorylist = []; + $subcategories = []; $basecategory = null; foreach ($categories as $category) { $categorylist[] = $category->id; @@ -215,12 +211,11 @@ class global_navigation_for_ajax extends global_navigation { } $categories->close(); - // If category is shown in MyHome then only show enrolled courses and hide empty subcategories, // else show all courses. if ($nodetype === self::TYPE_MY_CATEGORY) { $courses = enrol_get_my_courses('*'); - $categoryids = array(); + $categoryids = []; // Only search for categories if basecategory was found. if (!is_null($basecategory)) { @@ -231,13 +226,13 @@ class global_navigation_for_ajax extends global_navigation { // Get a unique list of category ids which a part of the path // to user's courses. - $coursesubcategories = array(); - $addedsubcategories = array(); + $coursesubcategories = []; + $addedsubcategories = []; - list($sql, $params) = $DB->get_in_or_equal($categoryids); - $categories = $DB->get_recordset_select('course_categories', 'id '.$sql, $params, 'sortorder, id', 'id, path'); + [$sql, $params] = $DB->get_in_or_equal($categoryids); + $categories = $DB->get_recordset_select('course_categories', 'id ' . $sql, $params, 'sortorder, id', 'id, path'); - foreach ($categories as $category){ + foreach ($categories as $category) { $coursesubcategories = array_merge($coursesubcategories, explode('/', trim($category->path, "/"))); } $categories->close(); @@ -246,8 +241,10 @@ class global_navigation_for_ajax extends global_navigation { // Only add a subcategory if it is part of the path to user's course and // wasn't already added. foreach ($subcategories as $subid => $subcategory) { - if (in_array($subid, $coursesubcategories) && - !in_array($subid, $addedsubcategories)) { + if ( + in_array($subid, $coursesubcategories) && + !in_array($subid, $addedsubcategories) + ) { $this->add_category($subcategory, $basecategory, $nodetype); $addedsubcategories[] = $subid; } @@ -262,11 +259,11 @@ class global_navigation_for_ajax extends global_navigation { } } else { if (!is_null($basecategory)) { - foreach ($subcategories as $key=>$category) { + foreach ($subcategories as $key => $category) { $this->add_category($category, $basecategory, $nodetype); } } - $courses = $DB->get_recordset('course', array('category' => $categoryid), 'sortorder', '*' , 0, $limit); + $courses = $DB->get_recordset('course', ['category' => $categoryid], 'sortorder', '*', 0, $limit); foreach ($courses as $course) { $this->add_course($course); } @@ -275,7 +272,8 @@ class global_navigation_for_ajax extends global_navigation { } /** - * Returns an array of expandable nodes + * Returns an array of expandable nodes. + * * @return array */ public function get_expandable() { diff --git a/public/lib/classes/navigation/navbar.php b/public/lib/classes/navigation/navbar.php index d747ae80ca3..a7fe67179d7 100644 --- a/public/lib/classes/navigation/navbar.php +++ b/public/lib/classes/navigation/navbar.php @@ -40,7 +40,7 @@ class navbar extends navigation_node { /** @var bool A switch for whether the navbar is initialised or not */ protected $initialised = false; /** @var mixed keys used to reference the nodes on the navbar */ - protected $keys = array(); + protected $keys = []; /** @var null|string content of the navbar */ protected $content = null; /** @var moodle_page object the moodle page that this navbar belongs to */ @@ -54,11 +54,11 @@ class navbar extends navigation_node { /** @var array An array of navigation nodes for the navbar */ protected $items; /** @var array An array of child node objects */ - public $children = array(); + public $children = []; /** @var bool A switch for whether we want to include the root node in the navbar */ public $includesettingsbase = false; /** @var breadcrumb_navigation_node[] $prependchildren */ - protected $prependchildren = array(); + protected $prependchildren = []; /** * The almighty constructor @@ -71,10 +71,11 @@ class navbar extends navigation_node { $this->duringinstall = true; return; } + $this->page = $page; $this->text = get_string('home'); $this->shorttext = get_string('home'); - $this->action = new moodle_url($CFG->wwwroot); + $this->action = new url($CFG->wwwroot); $this->nodetype = self::NODETYPE_BRANCH; $this->type = self::TYPE_SYSTEM; } @@ -108,7 +109,7 @@ class navbar extends navigation_node { * * @param bool $setting */ - public function ignore_active($setting=true) { + public function ignore_active($setting = true) { $this->ignoreactive = ($setting); } @@ -139,8 +140,8 @@ class navbar extends navigation_node { */ public function get_items() { global $CFG; - $items = array(); - // Make sure that navigation is initialised + $items = []; + // Make sure that navigation is initialised. if (!$this->has_items()) { return $items; } @@ -153,7 +154,7 @@ class navbar extends navigation_node { $items = array_reverse($this->children); } - // Check if navigation contains the active node + // Check if navigation contains the active node. if (!$this->ignoreactive) { // We will need to ensure the navigation has been initialised. $this->page->navigation->initialise($this->page); @@ -162,7 +163,7 @@ class navbar extends navigation_node { $settingsactivenode = $this->page->settingsnav->find_active_node(); if ($navigationactivenode && $settingsactivenode) { - // Parse a combined navigation tree + // Parse a combined navigation tree. while ($settingsactivenode && $settingsactivenode->parent !== null) { if (!$settingsactivenode->mainnavonly) { $items[] = new breadcrumb_navigation_node($settingsactivenode); @@ -170,16 +171,18 @@ class navbar extends navigation_node { $settingsactivenode = $settingsactivenode->parent; } if (!$this->includesettingsbase) { - // Removes the first node from the settings (root node) from the list + // Removes the first node from the settings (root node) from the list. array_pop($items); } while ($navigationactivenode && $navigationactivenode->parent !== null) { if (!$navigationactivenode->mainnavonly) { $items[] = new breadcrumb_navigation_node($navigationactivenode); } - if (!empty($CFG->navshowcategories) && + if ( + !empty($CFG->navshowcategories) && $navigationactivenode->type === self::TYPE_COURSE && - $navigationactivenode->parent->key === 'currentcourse') { + $navigationactivenode->parent->key === 'currentcourse' + ) { foreach ($this->get_course_categories() as $item) { $items[] = new breadcrumb_navigation_node($item); } @@ -187,14 +190,16 @@ class navbar extends navigation_node { $navigationactivenode = $navigationactivenode->parent; } } else if ($navigationactivenode) { - // Parse the navigation tree to get the active node + // Parse the navigation tree to get the active node. while ($navigationactivenode && $navigationactivenode->parent !== null) { if (!$navigationactivenode->mainnavonly) { $items[] = new breadcrumb_navigation_node($navigationactivenode); } - if (!empty($CFG->navshowcategories) && + if ( + !empty($CFG->navshowcategories) && $navigationactivenode->type === self::TYPE_COURSE && - $navigationactivenode->parent->key === 'currentcourse') { + $navigationactivenode->parent->key === 'currentcourse' + ) { foreach ($this->get_course_categories() as $item) { $items[] = new breadcrumb_navigation_node($item); } @@ -202,7 +207,7 @@ class navbar extends navigation_node { $navigationactivenode = $navigationactivenode->parent; } } else if ($settingsactivenode) { - // Parse the settings navigation to get the active node + // Parse the settings navigation to get the active node. while ($settingsactivenode && $settingsactivenode->parent !== null) { if (!$settingsactivenode->mainnavonly) { $items[] = new breadcrumb_navigation_node($settingsactivenode); @@ -212,15 +217,15 @@ class navbar extends navigation_node { } } - $items[] = new breadcrumb_navigation_node(array( + $items[] = new breadcrumb_navigation_node([ 'text' => $this->page->navigation->text, 'shorttext' => $this->page->navigation->shorttext, 'key' => $this->page->navigation->key, - 'action' => $this->page->navigation->action - )); + 'action' => $this->page->navigation->action, + ]); if (count($this->prependchildren) > 0) { - // Add the custom children + // Add the custom children. $items = array_merge($items, array_reverse($this->prependchildren)); } @@ -243,9 +248,9 @@ class navbar extends navigation_node { */ private function get_course_categories() { global $CFG; - require_once($CFG->dirroot.'/course/lib.php'); + require_once($CFG->dirroot . '/course/lib.php'); - $categories = array(); + $categories = []; $cap = 'moodle/category:viewhiddencategories'; $showcategories = !core_course_category::is_simple_site(); @@ -256,8 +261,8 @@ class navbar extends navigation_node { continue; } - $displaycontext = \context_helper::get_navigation_filter_context($context); - $url = new moodle_url('/course/index.php', ['categoryid' => $category->id]); + $displaycontext = context_helper::get_navigation_filter_context($context); + $url = new url('/course/index.php', ['categoryid' => $category->id]); $name = format_string($category->name, true, ['context' => $displaycontext]); $categorynode = breadcrumb_navigation_node::create($name, $url, self::TYPE_CATEGORY, null, $category->id); if (!$category->visible) { @@ -275,7 +280,7 @@ class navbar extends navigation_node { // Courses node may not be present. $courses = breadcrumb_navigation_node::create( get_string('courses'), - new moodle_url('/course/index.php'), + new url('/course/index.php'), self::TYPE_CONTAINER ); } @@ -293,44 +298,44 @@ class navbar extends navigation_node { * end of the navbar * * @param string $text - * @param string|moodle_url|action_link $action An action to associate with this node. + * @param string|url|action_link $action An action to associate with this node. * @param int $type One of navigation_node::TYPE_* * @param string $shorttext * @param string|int $key A key to identify this node with. Key + type is unique to a parent. * @param pix_icon $icon An optional icon to use for this node. * @return navigation_node */ - public function add($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, ?pix_icon $icon=null) { + public function add($text, $action = null, $type = self::TYPE_CUSTOM, $shorttext = null, $key = null, ?pix_icon $icon = null) { if ($this->content !== null) { debugging('Nav bar items must be printed before $OUTPUT->header() has been called', DEBUG_DEVELOPER); } - // Properties array used when creating the new navigation node - $itemarray = array( + // Properties array used when creating the new navigation node. + $itemarray = [ 'text' => $text, - 'type' => $type - ); - // Set the action if one was provided - if ($action!==null) { + 'type' => $type, + ]; + // Set the action if one was provided. + if ($action !== null) { $itemarray['action'] = $action; } - // Set the shorttext if one was provided - if ($shorttext!==null) { + // Set the shorttext if one was provided. + if ($shorttext !== null) { $itemarray['shorttext'] = $shorttext; } - // Set the icon if one was provided - if ($icon!==null) { + // Set the icon if one was provided. + if ($icon !== null) { $itemarray['icon'] = $icon; } - // Default the key to the number of children if not provided + // Default the key to the number of children if not provided. if ($key === null) { $key = count($this->children); } - // Set the key + // Set the key. $itemarray['key'] = $key; - // Set the parent to this node + // Set the parent to this node. $itemarray['parent'] = $this; - // Add the child using the navigation_node_collections add method + // Add the child using the navigation_node_collections add method. $this->children[] = new breadcrumb_navigation_node($itemarray); return $this; } @@ -339,32 +344,39 @@ class navbar extends navigation_node { * Prepends a new navigation_node to the start of the navbar * * @param string $text - * @param string|moodle_url|action_link $action An action to associate with this node. + * @param string|url|action_link $action An action to associate with this node. * @param int $type One of navigation_node::TYPE_* * @param string $shorttext * @param string|int $key A key to identify this node with. Key + type is unique to a parent. * @param pix_icon $icon An optional icon to use for this node. * @return navigation_node */ - public function prepend($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, ?pix_icon $icon=null) { + public function prepend( + $text, + $action = null, + $type = self::TYPE_CUSTOM, + $shorttext = null, + $key = null, + ?pix_icon $icon = null, + ) { if ($this->content !== null) { debugging('Nav bar items must be printed before $OUTPUT->header() has been called', DEBUG_DEVELOPER); } // Properties array used when creating the new navigation node. - $itemarray = array( + $itemarray = [ 'text' => $text, - 'type' => $type - ); + 'type' => $type, + ]; // Set the action if one was provided. - if ($action!==null) { + if ($action !== null) { $itemarray['action'] = $action; } // Set the shorttext if one was provided. - if ($shorttext!==null) { + if ($shorttext !== null) { $itemarray['shorttext'] = $shorttext; } // Set the icon if one was provided. - if ($icon!==null) { + if ($icon !== null) { $itemarray['icon'] = $icon; } // Default the key to the number of children if not provided. diff --git a/public/lib/classes/navigation/navigation_cache.php b/public/lib/classes/navigation/navigation_cache.php index dc9cec5244f..db69ecbda12 100644 --- a/public/lib/classes/navigation/navigation_cache.php +++ b/public/lib/classes/navigation/navigation_cache.php @@ -20,13 +20,6 @@ use core_cache\cache; use core_cache\session_cache; use core_shutdown_manager; -/** - * Class navigation_cache - * - * @package core - * @copyright 2025 Andrew Lyons - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later - */ /** * The navigation_cache class is used for global and settings navigation data. * @@ -59,12 +52,12 @@ class navigation_cache { protected $area; /** @var int cache time information */ #[\core\attribute\deprecated(null, since: '4.5', reason: 'This constant is no longer needed.', mdl: 'MDL-79628')] - const CACHETIME = 0; + public const CACHETIME = 0; /** @var int cache user id */ #[\core\attribute\deprecated(null, since: '4.5', reason: 'This constant is no longer needed.', mdl: 'MDL-79628')] - const CACHEUSERID = 1; + public const CACHEUSERID = 1; /** @var int cache value */ - const CACHEVALUE = 2; + public const CACHEVALUE = 2; /** @var null|array An array of cache areas to expire on shutdown */ public static $volatilecaches = null; diff --git a/public/lib/classes/navigation/navigation_json.php b/public/lib/classes/navigation/navigation_json.php index cd5b91000fa..74bbcfffac1 100644 --- a/public/lib/classes/navigation/navigation_json.php +++ b/public/lib/classes/navigation/navigation_json.php @@ -30,9 +30,9 @@ use core\url; */ class navigation_json { /** @var array An array of different node types */ - protected $nodetype = array('node','branch'); + protected $nodetype = ['node', 'branch']; /** @var array An array of node keys and types */ - protected $expandable = array(); + protected $expandable = []; /** * Turns a branch and all of its children into XML * @@ -50,7 +50,7 @@ class navigation_json { */ public function set_expandable($expandable) { foreach ($expandable as $node) { - $this->expandable[$node['key'].':'.$node['type']] = $node; + $this->expandable[$node['key'] . ':' . $node['type']] = $node; } } /** @@ -60,11 +60,11 @@ class navigation_json { * @param int $depth Pointlessly used to track the depth of the XML structure * @return string JSON */ - protected function convert_child($child, $depth=1) { + protected function convert_child($child, $depth = 1) { if (!$child->display) { return ''; } - $attributes = array(); + $attributes = []; $attributes['id'] = $child->id; $attributes['name'] = (string)$child->text; // This can be lang_string object so typecast it. $attributes['type'] = $child->type; @@ -73,17 +73,16 @@ class navigation_json { $attributes['requiresajaxloading'] = $child->requiresajaxloading; if ($child->icon instanceof pix_icon) { - $attributes['icon'] = array( + $attributes['icon'] = [ 'component' => $child->icon->component, 'pix' => $child->icon->pix, - ); - foreach ($child->icon->attributes as $key=>$value) { + ]; + foreach ($child->icon->attributes as $key => $value) { if ($key == 'class') { $attributes['icon']['classes'] = explode(' ', $value); } else if (!array_key_exists($key, $attributes['icon'])) { $attributes['icon'][$key] = $value; } - } } else if (!empty($child->icon)) { $attributes['icon'] = (string)$child->icon; @@ -92,13 +91,13 @@ class navigation_json { if ($child->forcetitle || $child->title !== $child->text) { $attributes['title'] = htmlentities($child->title ?? '', ENT_QUOTES, 'UTF-8'); } - if (array_key_exists($child->key.':'.$child->type, $this->expandable)) { + if (array_key_exists($child->key . ':' . $child->type, $this->expandable)) { $attributes['expandable'] = $child->key; - $child->add_class($this->expandable[$child->key.':'.$child->type]['id']); + $child->add_class($this->expandable[$child->key . ':' . $child->type]['id']); } - if (count($child->classes)>0) { - $attributes['class'] .= ' '.join(' ',$child->classes); + if (count($child->classes) > 0) { + $attributes['class'] .= ' ' . join(' ', $child->classes); } if (is_string($child->action)) { $attributes['link'] = $child->action; @@ -108,13 +107,13 @@ class navigation_json { $attributes['link'] = $child->action->url->out(); } $attributes['hidden'] = ($child->hidden); - $attributes['haschildren'] = ($child->children->count()>0 || $child->type == navigation_node::TYPE_CATEGORY); + $attributes['haschildren'] = ($child->children->count() > 0 || $child->type == navigation_node::TYPE_CATEGORY); $attributes['haschildren'] = $attributes['haschildren'] || $child->type == navigation_node::TYPE_MY_CATEGORY; if ($child->children->count() > 0) { - $attributes['children'] = array(); + $attributes['children'] = []; foreach ($child->children as $subchild) { - $attributes['children'][] = $this->convert_child($subchild, $depth+1); + $attributes['children'][] = $this->convert_child($subchild, $depth + 1); } } diff --git a/public/lib/classes/navigation/navigation_node.php b/public/lib/classes/navigation/navigation_node.php index 63d949387e6..f72b3319c86 100644 --- a/public/lib/classes/navigation/navigation_node.php +++ b/public/lib/classes/navigation/navigation_node.php @@ -40,45 +40,45 @@ use core\url; */ class navigation_node implements renderable { /** @var int Used to identify this node a leaf (default) 0 */ - const NODETYPE_LEAF = 0; + public const NODETYPE_LEAF = 0; /** @var int Used to identify this node a branch, happens with children 1 */ - const NODETYPE_BRANCH = 1; + public const NODETYPE_BRANCH = 1; /** @var null Unknown node type null */ - const TYPE_UNKNOWN = null; + public const TYPE_UNKNOWN = null; /** @var int System node type 0 */ - const TYPE_ROOTNODE = 0; + public const TYPE_ROOTNODE = 0; /** @var int System node type 1 */ - const TYPE_SYSTEM = 1; + public const TYPE_SYSTEM = 1; /** @var int Category node type 10 */ - const TYPE_CATEGORY = 10; + public const TYPE_CATEGORY = 10; /** var int Category displayed in MyHome navigation node */ - const TYPE_MY_CATEGORY = 11; + public const TYPE_MY_CATEGORY = 11; /** @var int Course node type 20 */ - const TYPE_COURSE = 20; + public const TYPE_COURSE = 20; /** @var int Course Structure node type 30 */ - const TYPE_SECTION = 30; + public const TYPE_SECTION = 30; /** @var int Activity node type, e.g. Forum, Quiz 40 */ - const TYPE_ACTIVITY = 40; + public const TYPE_ACTIVITY = 40; /** @var int Resource node type, e.g. Link to a file, or label 50 */ - const TYPE_RESOURCE = 50; + public const TYPE_RESOURCE = 50; /** @var int A custom node type, default when adding without specifing type 60 */ - const TYPE_CUSTOM = 60; + public const TYPE_CUSTOM = 60; /** @var int Setting node type, used only within settings nav 70 */ - const TYPE_SETTING = 70; + public const TYPE_SETTING = 70; /** @var int site admin branch node type, used only within settings nav 71 */ - const TYPE_SITE_ADMIN = 71; + public const TYPE_SITE_ADMIN = 71; /** @var int Setting node type, used only within settings nav 80 */ - const TYPE_USER = 80; + public const TYPE_USER = 80; /** @var int Setting node type, used for containers of no importance 90 */ - const TYPE_CONTAINER = 90; + public const TYPE_CONTAINER = 90; /** var int Course the current user is not enrolled in */ - const COURSE_OTHER = 0; + public const COURSE_OTHER = 0; /** var int Course the current user is enrolled in but not viewing */ - const COURSE_MY = 1; + public const COURSE_MY = 1; /** var int Course the current user is currently viewing */ - const COURSE_CURRENT = 2; + public const COURSE_CURRENT = 2; /** var string The course index page navigation node */ - const COURSE_INDEX_PAGE = 'courseindexpage'; + public const COURSE_INDEX_PAGE = 'courseindexpage'; /** @var int Parameter to aid the coder in tracking [optional] */ public $id = null; @@ -92,7 +92,7 @@ class navigation_node implements renderable { public $title = null; /** @var string A string that can be used to build a help button */ public $helpbutton = null; - /** @var moodle_url|action_link|null An action for the node (link) */ + /** @var url|action_link|null An action for the node (link) */ public $action = null; /** @var pix_icon The path to an icon to use for this node */ public $icon = null; @@ -105,11 +105,11 @@ class navigation_node implements renderable { /** @var bool If set to true the node will be expanded by default */ public $forceopen = false; /** @var array An array of CSS classes for the node */ - public $classes = array(); + public $classes = []; /** @var array An array of HTML attributes for the node */ public $attributes = []; /** @var navigation_node_collection An array of child nodes */ - public $children = array(); + public $children = []; /** @var bool If set to true the node will be recognised as active */ public $isactive = false; /** @var bool If set to true the node will be dimmed */ @@ -129,10 +129,10 @@ class navigation_node implements renderable { /** @var bool Set to true if we KNOW that this node can be expanded. */ public $isexpandable = false; /** @var array */ - protected $namedtypes = array(0 => 'system', 10 => 'category', 20 => 'course', 30 => 'structure', 40 => 'activity', + protected $namedtypes = [0 => 'system', 10 => 'category', 20 => 'course', 30 => 'structure', 40 => 'activity', 50 => 'resource', 60 => 'custom', 70 => 'setting', 71 => 'siteadmin', 80 => 'user', - 90 => 'container'); - /** @var moodle_url */ + 90 => 'container']; + /** @var url */ protected static $fullmeurl = null; /** @var bool toogles auto matching of active node */ public static $autofindactive = true; @@ -166,13 +166,13 @@ class navigation_node implements renderable { public function __construct($properties) { if (is_array($properties)) { // Check the array for each property that we allow to set at construction. - // text - The main content for the node - // shorttext - A short text if required for the node - // icon - The icon to display for the node - // type - The type of the node - // key - The key to use to identify the node - // parent - A reference to the nodes parent - // action - The action to attribute to this node, usually a URL to link to + // text - The main content for the node. + // shorttext - A short text if required for the node. + // icon - The icon to display for the node. + // type - The type of the node. + // key - The key to use to identify the node. + // parent - A reference to the nodes parent. + // action - The action to attribute to this node, usually a URL to link to. if (array_key_exists('text', $properties)) { $this->text = $properties['text']; } @@ -198,11 +198,12 @@ class navigation_node implements renderable { if (array_key_exists('key', $properties)) { $this->key = $properties['key']; } - // This needs to happen last because of the check_if_active call that occurs + + // This needs to happen last because of the check_if_active call that occurs. if (array_key_exists('action', $properties)) { $this->action = $properties['action']; if (is_string($this->action)) { - $this->action = new moodle_url($this->action); + $this->action = new url($this->action); } if (self::$autofindactive) { $this->check_if_active(); @@ -217,7 +218,7 @@ class navigation_node implements renderable { if ($this->text === null) { throw new coding_exception('You must set the text for the node when you create it.'); } - // Instantiate a new navigation node collection for this nodes children + // Instantiate a new navigation node collection for this nodes children. $this->children = new navigation_node_collection(); } @@ -230,19 +231,20 @@ class navigation_node implements renderable { * @param int $strength One of URL_MATCH_EXACT, URL_MATCH_PARAMS, or URL_MATCH_BASE * @return bool */ - public function check_if_active($strength=URL_MATCH_EXACT) { + public function check_if_active($strength = URL_MATCH_EXACT) { global $FULLME, $PAGE; - // Set fullmeurl if it hasn't already been set + + // Set fullmeurl if it hasn't already been set. if (self::$fullmeurl == null) { if ($PAGE->has_set_url()) { - self::override_active_url(new moodle_url($PAGE->url)); + self::override_active_url(new url($PAGE->url)); } else { - self::override_active_url(new moodle_url($FULLME)); + self::override_active_url(new url($FULLME)); } } - // Compare the action of this node against the fullmeurl - if ($this->action instanceof moodle_url && $this->action->compare(self::$fullmeurl, $strength)) { + // Compare the action of this node against the fullmeurl. + if ($this->action instanceof url && $this->action->compare(self::$fullmeurl, $strength)) { $this->make_active(); return true; } @@ -288,18 +290,17 @@ class navigation_node implements renderable { } /** - * This sets the URL that the URL of new nodes get compared to when locating - * the active node. + * This sets the URL that the URL of new nodes get compared to when locating the active node. * * The active node is the node that matches the URL set here. By default this * is either $PAGE->url or if that hasn't been set $FULLME. * - * @param moodle_url $url The url to use for the fullmeurl. + * @param url $url The url to use for the fullmeurl. * @param bool $loadadmintree use true if the URL point to administration tree */ - public static function override_active_url(moodle_url $url, $loadadmintree = false) { + public static function override_active_url(url $url, $loadadmintree = false) { // Clone the URL, in case the calling script changes their URL later. - self::$fullmeurl = new moodle_url($url); + self::$fullmeurl = new url($url); // True means we do not want AJAX loaded admin tree, required for all admin pages. if ($loadadmintree) { // Do not change back to false if already set. @@ -308,6 +309,8 @@ class navigation_node implements renderable { } /** + * Require the admin tree. + * * Use when page is linked from the admin tree, * if not used navigation could not find the page using current URL * because the tree is not fully loaded. @@ -317,43 +320,53 @@ class navigation_node implements renderable { } /** - * Creates a navigation node, ready to add it as a child using add_node - * function. (The created node needs to be added before you can use it.) + * Creates a navigation node, ready to add it as a child using add_node function. + * + * The created node needs to be added before you can use it. + * * @param string $text - * @param moodle_url|action_link $action + * @param url|action_link $action * @param int $type * @param string $shorttext * @param string|int $key * @param pix_icon $icon * @return navigation_node */ - public static function create($text, $action=null, $type=self::TYPE_CUSTOM, - $shorttext=null, $key=null, ?pix_icon $icon=null) { - if ($action && !($action instanceof moodle_url || $action instanceof action_link)) { + public static function create( + $text, + $action = null, + $type = self::TYPE_CUSTOM, + $shorttext = null, + $key = null, + ?pix_icon $icon = null + ) { + if ($action && !($action instanceof url || $action instanceof action_link)) { debugging( - "It is required that the action provided be either an action_url|moodle_url." . - " Please update your definition.", E_NOTICE); + "It is required that the action provided be either an action_url|url." . + " Please update your definition.", + E_NOTICE + ); } - // Properties array used when creating the new navigation node - $itemarray = array( + // Properties array used when creating the new navigation node. + $itemarray = [ 'text' => $text, - 'type' => $type - ); - // Set the action if one was provided - if ($action!==null) { + 'type' => $type, + ]; + // Set the action if one was provided. + if ($action !== null) { $itemarray['action'] = $action; } - // Set the shorttext if one was provided - if ($shorttext!==null) { + // Set the shorttext if one was provided. + if ($shorttext !== null) { $itemarray['shorttext'] = $shorttext; } - // Set the icon if one was provided - if ($icon!==null) { + // Set the icon if one was provided. + if ($icon !== null) { $itemarray['icon'] = $icon; } - // Set the key + // Set the key. $itemarray['key'] = $key; - // Construct and return + // Construct and return. return new navigation_node($itemarray); } @@ -361,21 +374,21 @@ class navigation_node implements renderable { * Adds a navigation node as a child of this node. * * @param string $text - * @param moodle_url|action_link|string $action + * @param url|action_link|string $action * @param ?int $type * @param string $shorttext * @param string|int $key * @param pix_icon $icon * @return navigation_node */ - public function add($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, ?pix_icon $icon=null) { + public function add($text, $action = null, $type = self::TYPE_CUSTOM, $shorttext = null, $key = null, ?pix_icon $icon = null) { if ($action && is_string($action)) { - $action = new moodle_url($action); + $action = new url($action); } - // Create child node + // Create child node. $childnode = self::create($text, $action, $type, $shorttext, $key, $icon); - // Add the child to end and return + // Add the child to end and return. return $this->add_node($childnode); } @@ -386,34 +399,36 @@ class navigation_node implements renderable { * @param string $beforekey * @return navigation_node The added node */ - public function add_node(navigation_node $childnode, $beforekey=null) { - // First convert the nodetype for this node to a branch as it will now have children + public function add_node(navigation_node $childnode, $beforekey = null) { + // First convert the nodetype for this node to a branch as it will now have children. if ($this->nodetype !== self::NODETYPE_BRANCH) { $this->nodetype = self::NODETYPE_BRANCH; } - // Set the parent to this node + // Set the parent to this node. $childnode->set_parent($this); - // Default the key to the number of children if not provided + // Default the key to the number of children if not provided. if ($childnode->key === null) { $childnode->key = $this->children->count(); } - // Add the child using the navigation_node_collections add method + // Add the child using the navigation_node_collections add method. $node = $this->children->add($childnode, $beforekey); // If added node is a category node or the user is logged in and it's a course - // then mark added node as a branch (makes it expandable by AJAX) + // then mark added node as a branch (makes it expandable by AJAX). $type = $childnode->type; - if (($type == self::TYPE_CATEGORY) || (isloggedin() && ($type == self::TYPE_COURSE)) || ($type == self::TYPE_MY_CATEGORY) || - ($type === self::TYPE_SITE_ADMIN)) { + if ( + ($type == self::TYPE_CATEGORY) || (isloggedin() && ($type == self::TYPE_COURSE)) || ($type == self::TYPE_MY_CATEGORY) || + ($type === self::TYPE_SITE_ADMIN) + ) { $node->nodetype = self::NODETYPE_BRANCH; } - // If this node is hidden mark it's children as hidden also + // If this node is hidden mark it's children as hidden also. if ($this->hidden) { $node->hidden = true; } - // Return added node (reference returned by $this->children->add() + // Return added node (reference returned by $this->children->add(). return $node; } @@ -474,7 +489,7 @@ class navigation_node implements renderable { * @param int $type One of navigation_node::TYPE_* * @return navigation_node|false */ - public function get($key, $type=null) { + public function get($key, $type = null) { return $this->children->get($key, $type); } @@ -493,7 +508,7 @@ class navigation_node implements renderable { * @return bool Returns true if it has children or could have (by AJAX expansion) */ public function has_children() { - return ($this->nodetype === navigation_node::NODETYPE_BRANCH || $this->children->count()>0 || $this->isexpandable); + return ($this->nodetype === self::NODETYPE_BRANCH || $this->children->count() > 0 || $this->isexpandable); } /** @@ -569,8 +584,8 @@ class navigation_node implements renderable { */ public function remove_class($class) { if (in_array($class, $this->classes)) { - $key = array_search($class,$this->classes); - if ($key!==false) { + $key = array_search($class, $this->classes); + if ($key !== false) { // Remove the class' array element. unset($this->classes[$key]); // Reindex the array to avoid failures when the classes array is iterated later in mustache templates. @@ -603,7 +618,7 @@ class navigation_node implements renderable { /** * Resets the page specific information on this node if it is being unserialised. */ - public function __wakeup(){ + public function __wakeup() { $this->forceopen = false; $this->isactive = false; $this->remove_class('active_tree_node'); @@ -698,11 +713,11 @@ class navigation_node implements renderable { * @param bool $shorttext If true shorttext is used rather than the normal text * @return string */ - public function get_content($shorttext=false) { - $navcontext = \context_helper::get_navigation_filter_context(null); + public function get_content($shorttext = false) { + $navcontext = context_helper::get_navigation_filter_context(null); $options = !empty($navcontext) ? ['context' => $navcontext] : null; - if ($shorttext && $this->shorttext!==null) { + if ($shorttext && $this->shorttext !== null) { return format_string($this->shorttext, null, $options); } else { return format_string($this->text, null, $options); @@ -715,7 +730,7 @@ class navigation_node implements renderable { * @return string */ public function get_title() { - if ($this->forcetitle || $this->action != null){ + if ($this->forcetitle || $this->action != null) { return $this->title; } else { return ''; @@ -744,7 +759,7 @@ class navigation_node implements renderable { $url = $this->action()->url; } - if (($url->out() === $CFG->wwwroot) || (strpos($url->out(), $CFG->wwwroot.'/') === 0)) { + if (($url->out() === $CFG->wwwroot) || (strpos($url->out(), $CFG->wwwroot . '/') === 0)) { return true; } } @@ -767,7 +782,7 @@ class navigation_node implements renderable { */ public function get_css_type() { if (array_key_exists($this->type, $this->namedtypes)) { - return 'type_'.$this->namedtypes[$this->type]; + return 'type_' . $this->namedtypes[$this->type]; } return 'type_unknown'; } @@ -780,10 +795,10 @@ class navigation_node implements renderable { public function find_expandable(array &$expandable) { foreach ($this->children as &$child) { if ($child->display && $child->has_children() && $child->children->count() == 0) { - $child->id = 'expandable_branch_'.$child->type.'_'.clean_param($child->key, PARAM_ALPHANUMEXT); + $child->id = 'expandable_branch_' . $child->type . '_' . clean_param($child->key, PARAM_ALPHANUMEXT); $this->add_class('canexpand'); $child->requiresajaxloading = true; - $expandable[] = array('id' => $child->id, 'key' => $child->key, 'type' => $child->type); + $expandable[] = ['id' => $child->id, 'key' => $child->key, 'type' => $child->type]; } $child->find_expandable($expandable); } @@ -823,11 +838,11 @@ class navigation_node implements renderable { * @param bool $return * @return array Array (tabs, selected, inactive, activated, return) */ - public function get_tabs_array(array $inactive=array(), $return=false) { - $tabs = array(); - $rows = array(); + public function get_tabs_array(array $inactive = [], $return = false) { + $tabs = []; + $rows = []; $selected = null; - $activated = array(); + $activated = []; foreach ($this->children as $node) { $tabs[] = new tabobject($node->key, $node->action, $node->get_content(), $node->get_title()); if ($node->contains_active_node()) { @@ -844,7 +859,7 @@ class navigation_node implements renderable { } } } - return array(array($tabs, $rows), $selected, $inactive, $activated, $return); + return [[$tabs, $rows], $selected, $inactive, $activated, $return]; } /** @@ -854,11 +869,11 @@ class navigation_node implements renderable { * @param navigation_node $parent */ public function set_parent(navigation_node $parent) { - // Set the parent (thats the easy part) + // Set the parent (thats the easy part). $this->parent = $parent; - // Check if this node is active (this is checked during construction) + // Check if this node is active (this is checked during construction). if ($this->isactive) { - // Force all of the parent nodes open so you can see this node + // Force all of the parent nodes open so you can see this node. $this->parent->force_open(); // Make all parents inactive so that its clear where we are. $this->parent->make_inactive(); @@ -892,7 +907,7 @@ class navigation_node implements renderable { * @since Moodle 3.2 */ public function action() { - if ($this->action instanceof moodle_url) { + if ($this->action instanceof url) { return $this->action; } else if ($this->action instanceof action_link) { return $this->action->url; @@ -907,10 +922,10 @@ class navigation_node implements renderable { */ public function actionattributes() { if ($this->action instanceof action_link) { - return array_map(function($key, $value) { + return array_map(function ($key, $value) { return [ 'name' => $key, - 'value' => $value + 'value' => $value, ]; }, array_keys($this->action->attributes), $this->action->attributes); } @@ -940,7 +955,7 @@ class navigation_node implements renderable { } $actionid = $this->action->attributes['id']; - $actionsdata = array_map(function($action) use ($PAGE, $actionid) { + $actionsdata = array_map(function ($action) use ($PAGE, $actionid) { $data = $action->export_for_template($PAGE->get_renderer('core')); $data->id = $actionid; return $data; @@ -994,7 +1009,7 @@ class navigation_node implements renderable { } $node->add( $lockstring, - new moodle_url( + new url( '/admin/lock.php', [ 'id' => $context->id, @@ -1003,11 +1018,10 @@ class navigation_node implements renderable { self::TYPE_SETTING, null, 'contextlocking', - new pix_icon($lockicon, '') + new pix_icon($lockicon, '') ); } } - } /** diff --git a/public/lib/classes/navigation/navigation_node_collection.php b/public/lib/classes/navigation/navigation_node_collection.php index dda0f843ec4..27d80a22480 100644 --- a/public/lib/classes/navigation/navigation_node_collection.php +++ b/public/lib/classes/navigation/navigation_node_collection.php @@ -37,19 +37,19 @@ use Traversable; * @copyright 2010 Sam Hemelryk * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ -class navigation_node_collection implements IteratorAggregate, Countable { +class navigation_node_collection implements Countable, IteratorAggregate { /** * A multidimensional array to where the first key is the type and the second * key is the nodes key. * @var array */ - protected $collection = array(); + protected $collection = []; /** * An array that contains references to nodes in the same order they were added. * This is maintained as a progressive array. * @var array */ - protected $orderedcollection = array(); + protected $orderedcollection = []; /** * A reference to the last node that was added to the collection * @var navigation_node @@ -68,28 +68,28 @@ class navigation_node_collection implements IteratorAggregate, Countable { protected $collectionlabel = ''; /** - * Adds a navigation node to the collection + * Adds a navigation node to the collection. * * @param navigation_node $node Node to add * @param string $beforekey If specified, adds before a node with this key, * otherwise adds at end * @return navigation_node Added node */ - public function add(navigation_node $node, $beforekey=null) { + public function add(navigation_node $node, $beforekey = null) { global $CFG; $key = $node->key; $type = $node->type; - // First check we have a 2nd dimension for this type + // First check we have a 2nd dimension for this type. if (!array_key_exists($type, $this->orderedcollection)) { - $this->orderedcollection[$type] = array(); + $this->orderedcollection[$type] = []; } - // Check for a collision and report if debugging is turned on + // Check for a collision and report if debugging is turned on. if ($CFG->debug && array_key_exists($key, $this->orderedcollection[$type])) { - debugging('Navigation node intersect: Adding a node that already exists '.$key, DEBUG_DEVELOPER); + debugging('Navigation node intersect: Adding a node that already exists ' . $key, DEBUG_DEVELOPER); } - // Find the key to add before + // Find the key to add before. $newindex = $this->count; $last = true; if ($beforekey !== null) { @@ -107,11 +107,11 @@ class navigation_node_collection implements IteratorAggregate, Countable { } // Add the node to the appropriate place in the by-type structure (which - // is not ordered, despite the variable name) + // is not ordered, despite the variable name). $this->orderedcollection[$type][$key] = $node; if (!$last) { // Update existing references in the ordered collection (which is the - // one that isn't called 'ordered') to shuffle them along if required + // one that isn't called 'ordered') to shuffle them along if required. for ($oldindex = $this->count; $oldindex > $newindex; $oldindex--) { $this->collection[$oldindex] = $this->collection[$oldindex - 1]; } @@ -121,21 +121,22 @@ class navigation_node_collection implements IteratorAggregate, Countable { // Update the last property to a reference to this new node. $this->last = $this->orderedcollection[$type][$key]; - // Reorder the array by index if needed + // Reorder the array by index if needed. if (!$last) { ksort($this->collection); } $this->count++; - // Return the reference to the now added node + // Return the reference to the now added node. return $node; } /** * Return a list of all the keys of all the nodes. + * * @return array the keys. */ public function get_key_list() { - $keys = array(); + $keys = []; foreach ($this->collection as $node) { $keys[] = $node->key; } @@ -167,14 +168,14 @@ class navigation_node_collection implements IteratorAggregate, Countable { * @param int $type One of navigation_node::TYPE_*. * @return navigation_node|null|false */ - public function get($key, $type=null) { + public function get($key, $type = null) { if ($type !== null) { - // If the type is known then we can simply check and fetch + // If the type is known then we can simply check and fetch. if (!empty($this->orderedcollection[$type][$key])) { return $this->orderedcollection[$type][$key]; } } else { - // Because we don't know the type we look in the progressive array + // Because we don't know the type we look in the progressive array. foreach ($this->collection as $node) { if ($node->key === $key) { return $node; @@ -196,18 +197,24 @@ class navigation_node_collection implements IteratorAggregate, Countable { * @param int $type One of navigation_node::TYPE_*. * @return navigation_node|false */ - public function find($key, $type=null) { - if ($type !== null && array_key_exists($type, $this->orderedcollection) && array_key_exists($key, $this->orderedcollection[$type])) { + public function find($key, $type = null) { + if ( + $type !== null + && array_key_exists($type, $this->orderedcollection) + && array_key_exists($key, $this->orderedcollection[$type]) + ) { return $this->orderedcollection[$type][$key]; } else { $nodes = $this->getIterator(); - // Search immediate children first + + // Search immediate children first. foreach ($nodes as &$node) { if ($node->key === $key && ($type === null || $type === $node->type)) { return $node; } } - // Now search each childs children + + // Now search each childs children. foreach ($nodes as &$node) { $result = $node->children->find($key, $type); if ($result !== false) { @@ -235,7 +242,7 @@ class navigation_node_collection implements IteratorAggregate, Countable { */ public function type($type) { if (!array_key_exists($type, $this->orderedcollection)) { - $this->orderedcollection[$type] = array(); + $this->orderedcollection[$type] = []; } return $this->orderedcollection[$type]; } @@ -246,7 +253,7 @@ class navigation_node_collection implements IteratorAggregate, Countable { * @param int $type * @return bool */ - public function remove($key, $type=null) { + public function remove($key, $type = null) { $child = $this->get($key, $type); if ($child !== false) { foreach ($this->collection as $colkey => $node) { @@ -263,25 +270,12 @@ class navigation_node_collection implements IteratorAggregate, Countable { return false; } - /** - * Gets the number of nodes in this collection - * - * This option uses an internal count rather than counting the actual options to avoid - * a performance hit through the count function. - * - * @return int - */ + #[\Override] public function count(): int { return $this->count; } - /** - * Gets an array iterator for the collection. - * - * This is required by the IteratorAggregator interface and is used by routines - * such as the foreach loop. - * - * @return ArrayIterator - */ + + #[\Override] public function getIterator(): Traversable { return new ArrayIterator($this->collection); } diff --git a/public/lib/classes/navigation/settings_navigation.php b/public/lib/classes/navigation/settings_navigation.php index 97ff006076f..45b9df4b2b3 100644 --- a/public/lib/classes/navigation/settings_navigation.php +++ b/public/lib/classes/navigation/settings_navigation.php @@ -58,7 +58,7 @@ class settings_navigation extends navigation_node { /** @var bool A switch to see if the navigation node is initialised */ protected $initialised = false; /** @var array An array of users that the nodes can extend for. */ - protected $userstoextendfor = array(); + protected $userstoextendfor = []; /** @var navigation_cache **/ protected $cache; @@ -72,10 +72,10 @@ class settings_navigation extends navigation_node { return; } $this->page = $page; - // Initialise the main navigation. It is most important that this is done - // before we try anything + // Initialise the main navigation. It is most important that this is done before we try anything. $this->page->navigation->initialise(); - // Initialise the navigation cache + + // Initialise the navigation cache. $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME); $this->children = new navigation_node_collection(); } @@ -106,7 +106,7 @@ class settings_navigation extends navigation_node { } switch ($context->contextlevel) { case CONTEXT_SYSTEM: - if ($this->page->url->compare(new url('/admin/settings.php', array('section'=>'frontpagesettings')))) { + if ($this->page->url->compare(new url('/admin/settings.php', ['section' => 'frontpagesettings']))) { $this->load_front_page_settings(($context->id == $this->context->id)); } break; @@ -145,11 +145,9 @@ class settings_navigation extends navigation_node { if ($isadminpage) { $adminsettings = $this->load_administration_settings(); } - } else if (!isset($SESSION->load_navigation_admin)) { $adminsettings = $this->load_administration_settings(); $SESSION->load_navigation_admin = (int)($adminsettings->children->count() > 0); - } else if ($SESSION->load_navigation_admin) { if ($isadminpage) { $adminsettings = $this->load_administration_settings(); @@ -163,8 +161,13 @@ class settings_navigation extends navigation_node { $adminsettings->remove(); $adminsettings = false; } - $siteadminnode = $this->add(get_string('administrationsite'), new url('/admin/search.php'), - self::TYPE_SITE_ADMIN, null, 'siteadministration'); + $siteadminnode = $this->add( + get_string('administrationsite'), + new url('/admin/search.php'), + self::TYPE_SITE_ADMIN, + null, + 'siteadministration' + ); $siteadminnode->id = 'expandable_branch_' . $siteadminnode->type . '_' . clean_param($siteadminnode->key, PARAM_ALPHANUMEXT); $siteadminnode->requiresajaxloading = 'true'; @@ -181,7 +184,7 @@ class settings_navigation extends navigation_node { // At this point we give any local plugins the ability to extend/tinker with the navigation settings. $this->load_local_plugin_settings(); - foreach ($this->children as $key=>$node) { + foreach ($this->children as $key => $node) { if ($node->nodetype == self::NODETYPE_BRANCH && $node->children->count() == 0) { // Site administration is shown as link. if (!empty($SESSION->load_navigation_admin) && ($node->type === self::TYPE_SITE_ADMIN)) { @@ -192,6 +195,7 @@ class settings_navigation extends navigation_node { } $this->initialised = true; } + /** * Override the parent function so that we can add preceeding hr's and set a * root node class against all first level element @@ -207,7 +211,8 @@ class settings_navigation extends navigation_node { * @param pix_icon $icon An icon that appears next to the node. * @return navigation_node with the new node added to it. */ - public function add($text, $url=null, $type=null, $shorttext=null, $key=null, ?pix_icon $icon=null) { + #[\Override] + public function add($text, $url = null, $type = null, $shorttext = null, $key = null, ?pix_icon $icon = null) { $node = parent::add($text, $url, $type, $shorttext, $key, $icon); $node->add_class('root_node'); return $node; @@ -225,10 +230,10 @@ class settings_navigation extends navigation_node { * @param pix_icon $icon An icon that appears next to the node. * @return navigation_node $node with the new node added to it. */ - public function prepend($text, $url=null, $type=null, $shorttext=null, $key=null, ?pix_icon $icon=null) { + public function prepend($text, $url = null, $type = null, $shorttext = null, $key = null, ?pix_icon $icon = null) { $children = $this->children; $childrenclass = get_class($children); - $this->children = new $childrenclass; + $this->children = new $childrenclass(); $node = $this->add($text, $url, $type, $shorttext, $key, $icon); foreach ($children as $child) { $this->children->add($child); @@ -248,7 +253,7 @@ class settings_navigation extends navigation_node { return true; } - if ($this->page->pagelayout === 'admin' or strpos($this->page->pagetype, 'admin-') === 0) { + if ($this->page->pagelayout === 'admin' || strpos($this->page->pagetype, 'admin-') === 0) { // Admin settings tree is intended for system level settings and management only, use navigation for the rest! if ($this->page->context->contextlevel != CONTEXT_SYSTEM) { return false; @@ -270,32 +275,40 @@ class settings_navigation extends navigation_node { * tree and start at the beginning * @return mixed A key to access the admin tree by */ - protected function load_administration_settings(?navigation_node $referencebranch=null, ?part_of_admin_tree $adminbranch=null) { + protected function load_administration_settings( + ?navigation_node $referencebranch = null, + ?part_of_admin_tree $adminbranch = null, + ) { global $CFG; // Check if we are just starting to generate this navigation. if ($referencebranch === null) { - - // Require the admin lib then get an admin structure + // Require the admin lib then get an admin structure. if (!function_exists('admin_get_root')) { - require_once($CFG->dirroot.'/lib/adminlib.php'); + require_once($CFG->dirroot . '/lib/adminlib.php'); } $adminroot = admin_get_root(false, false); - // This is the active section identifier + // This is the active section identifier. $this->adminsection = $this->page->url->param('section'); - // Disable the navigation from automatically finding the active node + // Disable the navigation from automatically finding the active node. navigation_node::$autofindactive = false; - $referencebranch = $this->add(get_string('administrationsite'), '/admin/search.php', self::TYPE_SITE_ADMIN, null, 'root'); + $referencebranch = $this->add( + get_string('administrationsite'), + '/admin/search.php', + self::TYPE_SITE_ADMIN, + null, + 'root', + ); foreach ($adminroot->children as $adminbranch) { $this->load_administration_settings($referencebranch, $adminbranch); } navigation_node::$autofindactive = true; - // Use the admin structure to locate the active page + // Use the admin structure to locate the active page. if (!$this->contains_active_node() && $current = $adminroot->locate($this->adminsection, true)) { $currentnode = $this; - while (($pathkey = array_pop($current->path))!==null && $currentnode) { + while (($pathkey = array_pop($current->path)) !== null && $currentnode) { $currentnode = $currentnode->get($pathkey); } if ($currentnode) { @@ -307,7 +320,7 @@ class settings_navigation extends navigation_node { return $referencebranch; } else if ($adminbranch->check_access()) { // We have a reference branch that we can access and is not hidden `hurrah` - // Now we need to display it and any children it may have + // Now we need to display it and any children it may have. $url = null; $icon = null; @@ -319,25 +332,43 @@ class settings_navigation extends navigation_node { } } - // Add the branch - $reference = $referencebranch->add($adminbranch->visiblename, $url, self::TYPE_SETTING, null, $adminbranch->name, $icon); + // Add the branch. + $reference = $referencebranch->add( + $adminbranch->visiblename, + $url, + self::TYPE_SETTING, + null, + $adminbranch->name, + $icon, + ); if ($adminbranch->is_hidden()) { - if (($adminbranch instanceof admin_externalpage || $adminbranch instanceof admin_settingpage) && $adminbranch->name == $this->adminsection) { + if ( + ( + $adminbranch instanceof admin_externalpage + || $adminbranch instanceof admin_settingpage + ) + && $adminbranch->name == $this->adminsection + ) { $reference->add_class('hidden'); } else { $reference->display = false; } } - // Check if we are generating the admin notifications and whether notificiations exist + // Check if we are generating the admin notifications and whether notificiations exist. if ($adminbranch->name === 'adminnotifications' && admin_critical_warnings_present()) { $reference->add_class('criticalnotification'); } - // Check if this branch has children - if ($reference && isset($adminbranch->children) && is_array($adminbranch->children) && count($adminbranch->children)>0) { + // Check if this branch has children. + if ( + $reference + && isset($adminbranch->children) + && is_array($adminbranch->children) + && count($adminbranch->children) > 0 + ) { foreach ($adminbranch->children as $branch) { - // Generate the child branches as well now using this branch as the reference + // Generate the child branches as well now using this branch as the reference. $this->load_administration_settings($reference, $branch); } } else { @@ -352,7 +383,7 @@ class settings_navigation extends navigation_node { * @param navigation_node $node */ protected function scan_for_active_node(navigation_node $node) { - if (!$node->check_if_active() && $node->children->count()>0) { + if (!$node->check_if_active() && $node->children->count() > 0) { foreach ($node->children as &$child) { $this->scan_for_active_node($child); } @@ -388,8 +419,7 @@ class settings_navigation extends navigation_node { $coursecontext = context_course::instance($course->id); $adminoptions = course_get_user_administration_options($course, $coursecontext); - // note: do not test if enrolled or viewing here because we need the enrol link in Course administration section - + // Note: Do not test if enrolled or viewing here because we need the enrol link in Course administration section. $coursenode = $this->add(get_string('courseadministration'), null, self::TYPE_COURSE, null, 'courseadmin'); if ($forceopen) { $coursenode->force_open(); @@ -411,30 +441,54 @@ class settings_navigation extends navigation_node { 'data-type' => 'course', ]); // Share course to MoodleNet link. - $coursenode->add(get_string('moodlenet:sharetomoodlenet', 'moodle'), - $action, self::TYPE_SETTING, null, 'exportcoursetomoodlenet')->set_force_into_more_menu(true); + $coursenode->add( + get_string('moodlenet:sharetomoodlenet', 'moodle'), + $action, + self::TYPE_SETTING, + null, + 'exportcoursetomoodlenet' + )->set_force_into_more_menu(true); // MoodleNet share progress link. $url = new url('/moodlenet/shareprogress.php'); - $coursenode->add(get_string('moodlenet:shareprogress'), - $url, self::TYPE_SETTING, null, 'moodlenetshareprogress')->set_force_into_more_menu(true); + $coursenode->add( + get_string('moodlenet:shareprogress'), + $url, + self::TYPE_SETTING, + null, + 'moodlenetshareprogress' + )->set_force_into_more_menu(true); } } catch (dml_missing_record_exception $e) { - debugging("Invalid MoodleNet OAuth 2 service set in site administration: 'moodlenet | oauthservice'. " . - "This must be a valid issuer."); + debugging( + "Invalid MoodleNet OAuth 2 service set in site administration: 'moodlenet | oauthservice'. " . + "This must be a valid issuer." + ); } if ($adminoptions->update) { - // Add the course settings link - $url = new url('/course/edit.php', array('id'=>$course->id)); - $coursenode->add(get_string('settings'), $url, self::TYPE_SETTING, null, - 'editsettings', new pix_icon('i/settings', '')); + // Add the course settings link. + $url = new url('/course/edit.php', ['id' => $course->id]); + $coursenode->add( + get_string('settings'), + $url, + self::TYPE_SETTING, + null, + 'editsettings', + new pix_icon('i/settings', '') + ); } if ($adminoptions->editcompletion) { - // Add the course completion settings link - $url = new url('/course/completion.php', array('id' => $course->id)); - $coursenode->add(get_string('coursecompletion', 'completion'), $url, self::TYPE_SETTING, null, 'coursecompletion', - new pix_icon('i/settings', '')); + // Add the course completion settings link. + $url = new url('/course/completion.php', ['id' => $course->id]); + $coursenode->add( + get_string('coursecompletion', 'completion'), + $url, + self::TYPE_SETTING, + null, + 'coursecompletion', + new pix_icon('i/settings', '') + ); } if (!$adminoptions->update && $adminoptions->tags) { @@ -442,32 +496,50 @@ class settings_navigation extends navigation_node { \core_course\route\controller\tags_controller::class, 'administer_tags', ], ['course' => $course->id]); - $coursenode->add(get_string('coursetags', 'tag'), $url, self::TYPE_SETTING, null, 'coursetags', new pix_icon('i/settings', '')); + $coursenode->add( + get_string('coursetags', 'tag'), + $url, + self::TYPE_SETTING, + null, + 'coursetags', + new pix_icon('i/settings', ''), + ); $coursenode->get('coursetags')->set_force_into_more_menu(); } - // add enrol nodes + // Add enrol nodes. enrol_add_course_navigation($coursenode, $course); - // Manage filters + // Manage filters. if ($adminoptions->filters) { - $url = new url('/filter/manage.php', array('contextid'=>$coursecontext->id)); - $coursenode->add(get_string('filters', 'admin'), $url, self::TYPE_SETTING, - null, 'filtermanagement', new pix_icon('i/filter', '')); + $url = new url('/filter/manage.php', ['contextid' => $coursecontext->id]); + $coursenode->add( + get_string('filters', 'admin'), + $url, + self::TYPE_SETTING, + null, + 'filtermanagement', + new pix_icon('i/filter', '') + ); } // View course reports. if ($adminoptions->reports) { - $reportnav = $coursenode->add(get_string('reports'), + $reportnav = $coursenode->add( + get_string('reports'), new url('/report/view.php', ['courseid' => $coursecontext->instanceid]), - self::TYPE_CONTAINER, null, 'coursereports', new pix_icon('i/stats', '')); + self::TYPE_CONTAINER, + null, + 'coursereports', + new pix_icon('i/stats', '') + ); $coursereports = component::get_plugin_list('coursereport'); foreach ($coursereports as $report => $dir) { - $libfile = $CFG->dirroot.'/course/report/'.$report.'/lib.php'; + $libfile = $CFG->dirroot . '/course/report/' . $report . '/lib.php'; if (file_exists($libfile)) { require_once($libfile); - $reportfunction = $report.'_report_extend_navigation'; - if (function_exists($report.'_report_extend_navigation')) { + $reportfunction = $report . '_report_extend_navigation'; + if (function_exists($report . '_report_extend_navigation')) { $reportfunction($reportnav, $course, $coursecontext); } } @@ -488,54 +560,80 @@ class settings_navigation extends navigation_node { // Check if we can view the gradebook's setup page. if ($adminoptions->gradebook) { - $url = new url('/grade/edit/tree/index.php', array('id' => $course->id)); - $coursenode->add(get_string('gradebooksetup', 'grades'), $url, self::TYPE_SETTING, - null, 'gradebooksetup', new pix_icon('i/settings', '')); + $url = new url('/grade/edit/tree/index.php', ['id' => $course->id]); + $coursenode->add( + get_string('gradebooksetup', 'grades'), + $url, + self::TYPE_SETTING, + null, + 'gradebooksetup', + new pix_icon('i/settings', '') + ); } // Add the context locking node. $this->add_context_locking_node($coursenode, $coursecontext); - // Add outcome if permitted + // Add outcome if permitted. if ($adminoptions->outcomes) { - $url = new url('/grade/edit/outcome/course.php', array('id'=>$course->id)); - $coursenode->add(get_string('outcomes', 'grades'), $url, self::TYPE_SETTING, null, 'outcomes', new pix_icon('i/outcomes', '')); + $url = new url('/grade/edit/outcome/course.php', ['id' => $course->id]); + $coursenode->add( + get_string('outcomes', 'grades'), + $url, + self::TYPE_SETTING, + null, + 'outcomes', + new pix_icon('i/outcomes', ''), + ); } - //Add badges navigation + // Add badges navigation. if ($adminoptions->badges) { - require_once($CFG->libdir .'/badgeslib.php'); + require_once($CFG->libdir . '/badgeslib.php'); badges_add_course_navigation($coursenode, $course); } - // Questions + // Questions. require_once($CFG->libdir . '/questionlib.php'); $baseurl = \core_question\local\bank\question_bank_helper::get_url_for_qbank_list($course->id); question_extend_settings_navigation($coursenode, $coursecontext, $baseurl)->trim_if_empty(); if ($adminoptions->update) { - // Repository Instances - if (!$this->cache->cached('contexthasrepos'.$coursecontext->id)) { + // Repository Instances. + if (!$this->cache->cached('contexthasrepos' . $coursecontext->id)) { require_once($CFG->dirroot . '/repository/lib.php'); $editabletypes = repository::get_editable_types($coursecontext); $haseditabletypes = !empty($editabletypes); unset($editabletypes); - $this->cache->set('contexthasrepos'.$coursecontext->id, $haseditabletypes); + $this->cache->set('contexthasrepos' . $coursecontext->id, $haseditabletypes); } else { - $haseditabletypes = $this->cache->{'contexthasrepos'.$coursecontext->id}; + $haseditabletypes = $this->cache->{'contexthasrepos' . $coursecontext->id}; } if ($haseditabletypes) { - $url = new url('/repository/manage_instances.php', array('contextid' => $coursecontext->id)); - $coursenode->add(get_string('repositories'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/repository', '')); + $url = new url('/repository/manage_instances.php', ['contextid' => $coursecontext->id]); + $coursenode->add( + get_string('repositories'), + $url, + self::TYPE_SETTING, + null, + null, + new pix_icon('i/repository', ''), + ); } } - // Manage files + // Manage files. if ($adminoptions->files) { - // hidden in new courses and courses where legacy files were turned off - $url = new url('/files/index.php', array('contextid'=>$coursecontext->id)); - $coursenode->add(get_string('courselegacyfiles'), $url, self::TYPE_SETTING, null, 'coursefiles', new pix_icon('i/folder', '')); - + // Hidden in new courses and courses where legacy files were turned off. + $url = new url('/files/index.php', ['contextid' => $coursecontext->id]); + $coursenode->add( + get_string('courselegacyfiles'), + $url, + self::TYPE_SETTING, + null, + 'coursefiles', + new pix_icon('i/folder', ''), + ); } // Let plugins hook into course navigation. @@ -555,21 +653,32 @@ class settings_navigation extends navigation_node { $linkattr = \core_course\output\content_export_link::get_attributes($coursecontext); $actionlink = new action_link($linkattr->url, $linkattr->displaystring, null, $linkattr->elementattributes); - $coursenode->add($linkattr->displaystring, $actionlink, self::TYPE_SETTING, null, 'download', - new pix_icon('t/download', '')); + $coursenode->add( + $linkattr->displaystring, + $actionlink, + self::TYPE_SETTING, + null, + 'download', + new pix_icon('t/download', '') + ); $coursenode->get('download')->set_force_into_more_menu(true); } // Course reuse options. - if ($adminoptions->import + if ( + $adminoptions->import || $adminoptions->backup || $adminoptions->restore || $adminoptions->copy - || $adminoptions->reset) { + || $adminoptions->reset + ) { $coursereusenav = $coursenode->add( get_string('coursereuse'), new url('/backup/view.php', ['id' => $course->id]), - self::TYPE_CONTAINER, null, 'coursereuse', new pix_icon('t/edit', ''), + self::TYPE_CONTAINER, + null, + 'coursereuse', + new pix_icon('t/edit', ''), ); // Import data from other courses. @@ -610,7 +719,7 @@ class settings_navigation extends navigation_node { } } - // Return we are done + // Return we are done. return $coursenode; } @@ -642,76 +751,129 @@ class settings_navigation extends navigation_node { $this->page->set_cm($cm, $this->page->course); } - $file = $CFG->dirroot.'/mod/'.$this->page->activityname.'/lib.php'; + $file = $CFG->dirroot . '/mod/' . $this->page->activityname . '/lib.php'; if (file_exists($file)) { require_once($file); } - $modulenode = $this->add(get_string('pluginadministration', $this->page->activityname), null, self::TYPE_SETTING, null, 'modulesettings'); + $modulenode = $this->add( + get_string('pluginadministration', $this->page->activityname), + null, + self::TYPE_SETTING, + null, + 'modulesettings', + ); $modulenode->nodetype = navigation_node::NODETYPE_BRANCH; $modulenode->force_open(); - // Settings for the module + // Settings for the module. if (has_capability('moodle/course:manageactivities', $this->page->cm->context)) { - $url = new url('/course/modedit.php', array('update' => $this->page->cm->id, 'return' => 1)); + $url = new url('/course/modedit.php', ['update' => $this->page->cm->id, 'return' => 1]); $modulenode->add(get_string('settings'), $url, self::TYPE_SETTING, null, 'modedit', new pix_icon('i/settings', '')); } - // Assign local roles - if (count(get_assignable_roles($this->page->cm->context))>0) { - $url = new url('/'.$CFG->admin.'/roles/assign.php', array('contextid'=>$this->page->cm->context->id)); - $modulenode->add(get_string('localroles', 'role'), $url, self::TYPE_SETTING, null, 'roleassign', - new pix_icon('i/role', '')); + // Assign local roles. + if (count(get_assignable_roles($this->page->cm->context)) > 0) { + $url = new url('/' . $CFG->admin . '/roles/assign.php', ['contextid' => $this->page->cm->context->id]); + $modulenode->add( + get_string('localroles', 'role'), + $url, + self::TYPE_SETTING, + null, + 'roleassign', + new pix_icon('i/role', '') + ); } - // Override roles - if (has_capability('moodle/role:review', $this->page->cm->context) or count(get_overridable_roles($this->page->cm->context))>0) { - $url = new url('/'.$CFG->admin.'/roles/permissions.php', array('contextid'=>$this->page->cm->context->id)); - $modulenode->add(get_string('permissions', 'role'), $url, self::TYPE_SETTING, null, 'roleoverride', - new pix_icon('i/permissions', '')); + // Override roles. + if ( + has_capability('moodle/role:review', $this->page->cm->context) + || count(get_overridable_roles($this->page->cm->context)) > 0 + ) { + $url = new url('/admin/roles/permissions.php', ['contextid' => $this->page->cm->context->id]); + $modulenode->add( + get_string('permissions', 'role'), + $url, + self::TYPE_SETTING, + null, + 'roleoverride', + new pix_icon('i/permissions', '') + ); } - // Check role permissions - if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:assign'), $this->page->cm->context)) { - $url = new url('/'.$CFG->admin.'/roles/check.php', array('contextid'=>$this->page->cm->context->id)); - $modulenode->add(get_string('checkpermissions', 'role'), $url, self::TYPE_SETTING, null, 'rolecheck', - new pix_icon('i/checkpermissions', '')); + // Check role permissions. + if ( + has_any_capability( + ['moodle/role:assign', 'moodle/role:safeoverride', 'moodle/role:override', 'moodle/role:assign'], + $this->page->cm->context, + ) + ) { + $url = new url('/' . $CFG->admin . '/roles/check.php', ['contextid' => $this->page->cm->context->id]); + $modulenode->add( + get_string('checkpermissions', 'role'), + $url, + self::TYPE_SETTING, + null, + 'rolecheck', + new pix_icon('i/checkpermissions', ''), + ); } // Add the context locking node. $this->add_context_locking_node($modulenode, $this->page->cm->context); - // Manage filters - if (has_capability('moodle/filter:manage', $this->page->cm->context) && count(filter_get_available_in_context($this->page->cm->context))>0) { - $url = new url('/filter/manage.php', array('contextid'=>$this->page->cm->context->id)); - $modulenode->add(get_string('filters', 'admin'), $url, self::TYPE_SETTING, null, 'filtermanage', - new pix_icon('i/filter', '')); + // Manage filters. + if ( + has_capability('moodle/filter:manage', $this->page->cm->context) && + count(filter_get_available_in_context($this->page->cm->context)) > 0 + ) { + $url = new url('/filter/manage.php', ['contextid' => $this->page->cm->context->id]); + $modulenode->add( + get_string('filters', 'admin'), + $url, + self::TYPE_SETTING, + null, + 'filtermanage', + new pix_icon('i/filter', '') + ); } - // Add reports + // Add reports. $reports = get_plugin_list_with_function('report', 'extend_navigation_module', 'lib.php'); foreach ($reports as $reportfunction) { $reportfunction($modulenode, $this->page->cm); } - // Add a backup link - $featuresfunc = $this->page->activityname.'_supports'; - if (function_exists($featuresfunc) && $featuresfunc(FEATURE_BACKUP_MOODLE2) && has_capability('moodle/backup:backupactivity', $this->page->cm->context)) { - $url = new url('/backup/backup.php', array('id'=>$this->page->cm->course, 'cm'=>$this->page->cm->id)); + // Add a backup link. + $featuresfunc = $this->page->activityname . '_supports'; + if ( + function_exists($featuresfunc) + && $featuresfunc(FEATURE_BACKUP_MOODLE2) + && has_capability('moodle/backup:backupactivity', $this->page->cm->context) + ) { + $url = new url('/backup/backup.php', ['id' => $this->page->cm->course, 'cm' => $this->page->cm->id]); $modulenode->add(get_string('backup'), $url, self::TYPE_SETTING, null, 'backup', new pix_icon('i/backup', '')); } - // Restore this activity - $featuresfunc = $this->page->activityname.'_supports'; - if (function_exists($featuresfunc) && $featuresfunc(FEATURE_BACKUP_MOODLE2) && has_capability('moodle/restore:restoreactivity', $this->page->cm->context)) { - $url = new url('/backup/restorefile.php', array('contextid'=>$this->page->cm->context->id)); + // Restore this activity. + $featuresfunc = $this->page->activityname . '_supports'; + if ( + function_exists($featuresfunc) && + $featuresfunc(FEATURE_BACKUP_MOODLE2) && + has_capability('moodle/restore:restoreactivity', $this->page->cm->context) + ) { + $url = new url('/backup/restorefile.php', ['contextid' => $this->page->cm->context->id]); $modulenode->add(get_string('restore'), $url, self::TYPE_SETTING, null, 'restore', new pix_icon('i/restore', '')); } - // Allow the active advanced grading method plugin to append its settings - $featuresfunc = $this->page->activityname.'_supports'; - if (function_exists($featuresfunc) && $featuresfunc(FEATURE_ADVANCED_GRADING) && has_capability('moodle/grade:managegradingforms', $this->page->cm->context)) { - require_once($CFG->dirroot.'/grade/grading/lib.php'); - $gradingman = get_grading_manager($this->page->cm->context, 'mod_'.$this->page->activityname); + // Allow the active advanced grading method plugin to append its settings. + $featuresfunc = $this->page->activityname . '_supports'; + if ( + function_exists($featuresfunc) + && $featuresfunc(FEATURE_ADVANCED_GRADING) + && has_capability('moodle/grade:managegradingforms', $this->page->cm->context) + ) { + require_once($CFG->dirroot . '/grade/grading/lib.php'); + $gradingman = get_grading_manager($this->page->cm->context, 'mod_' . $this->page->activityname); $gradingman->extend_settings_navigation($this, $modulenode); } - $function = $this->page->activityname.'_extend_settings_navigation'; + $function = $this->page->activityname . '_extend_settings_navigation'; if (function_exists($function)) { $function($this, $modulenode); } @@ -728,8 +890,13 @@ class settings_navigation extends navigation_node { 'data-action' => 'sendtomoodlenet', 'data-type' => 'activity', ]); - $modulenode->add(get_string('moodlenet:sharetomoodlenet', 'moodle'), - $action, self::TYPE_SETTING, null, 'exportmoodlenet')->set_force_into_more_menu(true); + $modulenode->add( + get_string('moodlenet:sharetomoodlenet', 'moodle'), + $action, + self::TYPE_SETTING, + null, + 'exportmoodlenet' + )->set_force_into_more_menu(true); } } catch (dml_missing_record_exception $e) { debugging("Invalid MoodleNet OAuth 2 service set in site administration: 'moodlenet | oauthservice'. " . @@ -808,7 +975,7 @@ class settings_navigation extends navigation_node { $this->userstoextendfor[] = $userid; if ($this->initialised) { $this->generate_user_settings($this->page->course->id, $userid, 'userviewingsettings'); - $children = array(); + $children = []; foreach ($this->children as $child) { $children[] = $child; } @@ -830,7 +997,7 @@ class settings_navigation extends navigation_node { * @param string $gstitle The string to pass to get_string for the branch title * @return navigation_node|false */ - protected function generate_user_settings($courseid, $userid, $gstitle='usercurrentsettings') { + protected function generate_user_settings($courseid, $userid, $gstitle = 'usercurrentsettings') { global $DB, $CFG, $USER, $SITE; if ($courseid != $SITE->id) { @@ -842,7 +1009,7 @@ class settings_navigation extends navigation_node { FROM {course} c JOIN {context} ctx ON c.id = ctx.instanceid WHERE c.id = :courseid AND ctx.contextlevel = :contextlevel"; - $params = array('courseid' => $courseid, 'contextlevel' => CONTEXT_COURSE); + $params = ['courseid' => $courseid, 'contextlevel' => CONTEXT_COURSE]; $course = $DB->get_record_sql($sql, $params, MUST_EXIST); context_helper::preload_from_record($course); } @@ -850,33 +1017,35 @@ class settings_navigation extends navigation_node { $course = $SITE; } - $coursecontext = context_course::instance($course->id); // Course context + $coursecontext = context_course::instance($course->id); $systemcontext = context_system::instance(); $currentuser = ($USER->id == $userid); if ($currentuser) { $user = $USER; - $usercontext = context_user::instance($user->id); // User context + $usercontext = context_user::instance($user->id); } else { $select = context_helper::get_preload_record_columns_sql('ctx'); $sql = "SELECT u.*, $select FROM {user} u JOIN {context} ctx ON u.id = ctx.instanceid WHERE u.id = :userid AND ctx.contextlevel = :contextlevel"; - $params = array('userid' => $userid, 'contextlevel' => CONTEXT_USER); + $params = ['userid' => $userid, 'contextlevel' => CONTEXT_USER]; $user = $DB->get_record_sql($sql, $params, IGNORE_MISSING); if (!$user) { return false; } context_helper::preload_from_record($user); - // Check that the user can view the profile - $usercontext = context_user::instance($user->id); // User context + // Check that the user can view the profile. + $usercontext = context_user::instance($user->id); // User context. $canviewuser = has_capability('moodle/user:viewdetails', $usercontext); if ($course->id == $SITE->id) { - if ($CFG->forceloginforprofiles && !has_coursecontact_role($user->id) && !$canviewuser) { // Reduce possibility of "browsing" userbase at site level - // Teachers can browse and be browsed at site level. If not forceloginforprofiles, allow access (bug #4366) + // Reduce possibility of "browsing" userbase at site level. + if ($CFG->forceloginforprofiles && !has_coursecontact_role($user->id) && !$canviewuser) { + // Teachers can browse and be browsed at site level. + // If not forceloginforprofiles, allow access (See MDL-4366). return false; } } else { @@ -924,7 +1093,7 @@ class settings_navigation extends navigation_node { $iscurrentuser = ($user->id == $USER->id); - $baseargs = array('id' => $user->id); + $baseargs = ['id' => $user->id]; if ($course->id != $SITE->id && !$iscurrentuser) { $baseargs['course'] = $course->id; $issitecourse = false; @@ -934,26 +1103,34 @@ class settings_navigation extends navigation_node { } // Add the user profile to the dashboard. - $profilenode = $mainpage->add(get_string('profile'), new url('/user/profile.php', - array('id' => $user->id)), self::TYPE_SETTING, null, 'myprofile'); + $profilenode = $mainpage->add(get_string('profile'), new url( + '/user/profile.php', + ['id' => $user->id] + ), self::TYPE_SETTING, null, 'myprofile'); // Add blog nodes. if (!empty($CFG->enableblogs)) { - if (!$this->cache->cached('userblogoptions'.$user->id)) { - require_once($CFG->dirroot.'/blog/lib.php'); + if (!$this->cache->cached('userblogoptions' . $user->id)) { + require_once($CFG->dirroot . '/blog/lib.php'); // Get all options for the user. $options = blog_get_options_for_user($user); - $this->cache->set('userblogoptions'.$user->id, $options); + $this->cache->set('userblogoptions' . $user->id, $options); } else { - $options = $this->cache->{'userblogoptions'.$user->id}; + $options = $this->cache->{'userblogoptions' . $user->id}; } if (count($options) > 0) { $blogs = $profilenode->add(get_string('blogs', 'blog'), null, navigation_node::TYPE_CONTAINER); foreach ($options as $type => $option) { if ($type == "rss") { - $blogs->add($option['string'], $option['link'], self::TYPE_SETTING, null, null, - new pix_icon('i/rss', '')); + $blogs->add( + $option['string'], + $option['link'], + self::TYPE_SETTING, + null, + null, + new pix_icon('i/rss', '') + ); } else { $blogs->add($option['string'], $option['link'], self::TYPE_SETTING, null, 'blog' . $type); } @@ -964,7 +1141,7 @@ class settings_navigation extends navigation_node { // Add the messages link. // It is context based so can appear in the user's profile and in course participants information. if (!empty($CFG->messaging)) { - $messageargs = array('user1' => $USER->id); + $messageargs = ['user1' => $USER->id]; if ($USER->id != $user->id) { $messageargs['user2'] = $user->id; } @@ -980,9 +1157,11 @@ class settings_navigation extends navigation_node { } // Add a node to view the users notes if permitted. - if (!empty($CFG->enablenotes) && - has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $coursecontext)) { - $url = new url('/notes/index.php', array('user' => $user->id)); + if ( + !empty($CFG->enablenotes) && + has_any_capability(['moodle/notes:manage', 'moodle/notes:view'], $coursecontext) + ) { + $url = new url('/notes/index.php', ['user' => $user->id]); if ($coursecontext->instanceid != SITEID) { $url->param('course', $coursecontext->instanceid); } @@ -996,7 +1175,7 @@ class settings_navigation extends navigation_node { if ($course->id == SITEID) { $url = user_mygrades_url($user->id, $course->id); } else { // Otherwise we are in a course and should redirect to the user grade report (Activity report version). - $url = new url('/course/user.php', array('mode' => 'grade', 'id' => $course->id, 'user' => $user->id)); + $url = new url('/course/user.php', ['mode' => 'grade', 'id' => $course->id, 'user' => $user->id]); } $mainpage->add(get_string('grades', 'grades'), $url, self::TYPE_SETTING, null, 'mygrades'); } @@ -1027,9 +1206,9 @@ class settings_navigation extends navigation_node { } else { // We can edit the user so show the user deleted message and link it to the profile. if ($course->id == $SITE->id) { - $profileurl = new url('/user/profile.php', array('id'=>$user->id)); + $profileurl = new url('/user/profile.php', ['id' => $user->id]); } else { - $profileurl = new url('/user/view.php', array('id'=>$user->id, 'course'=>$course->id)); + $profileurl = new url('/user/view.php', ['id' => $user->id, 'course' => $course->id]); } $usersetting->add(get_string('userdeleted'), $profileurl, self::TYPE_SETTING); } @@ -1045,16 +1224,20 @@ class settings_navigation extends navigation_node { // Add the profile edit link. if (isloggedin() && !isguestuser($user) && !is_mnet_remote_user($user)) { - if (($currentuser || is_siteadmin($USER) || !is_siteadmin($user)) && - has_capability('moodle/user:update', $systemcontext)) { - $url = new url('/user/editadvanced.php', array('id'=>$user->id, 'course'=>$course->id)); + if ( + ($currentuser || is_siteadmin($USER) || !is_siteadmin($user)) && + has_capability('moodle/user:update', $systemcontext) + ) { + $url = new url('/user/editadvanced.php', ['id' => $user->id, 'course' => $course->id]); $useraccount->add(get_string('editmyprofile'), $url, self::TYPE_SETTING, null, 'editprofile'); - } else if ((has_capability('moodle/user:editprofile', $usercontext) && !is_siteadmin($user)) || - ($currentuser && has_capability('moodle/user:editownprofile', $systemcontext))) { + } else if ( + (has_capability('moodle/user:editprofile', $usercontext) && !is_siteadmin($user)) || + ($currentuser && has_capability('moodle/user:editownprofile', $systemcontext)) + ) { if ($userauthplugin && $userauthplugin->can_edit_profile()) { $url = $userauthplugin->edit_profile_url(); if (empty($url)) { - $url = new url('/user/edit.php', array('id'=>$user->id, 'course'=>$course->id)); + $url = new url('/user/edit.php', ['id' => $user->id, 'course' => $course->id]); } $useraccount->add(get_string('editmyprofile'), $url, self::TYPE_SETTING, null, 'editprofile'); } @@ -1062,11 +1245,13 @@ class settings_navigation extends navigation_node { } // Change password link. - if ($userauthplugin && $currentuser && !\core\session\manager::is_loggedinas() && !isguestuser() && - has_capability('moodle/user:changeownpassword', $systemcontext) && $userauthplugin->can_change_password()) { + if ( + $userauthplugin && $currentuser && !\core\session\manager::is_loggedinas() && !isguestuser() && + has_capability('moodle/user:changeownpassword', $systemcontext) && $userauthplugin->can_change_password() + ) { $passwordchangeurl = $userauthplugin->change_password_url(); if (empty($passwordchangeurl)) { - $passwordchangeurl = new url('/login/change_password.php', array('id'=>$course->id)); + $passwordchangeurl = new url('/login/change_password.php', ['id' => $course->id]); } $useraccount->add(get_string("changepassword"), $passwordchangeurl, self::TYPE_SETTING, null, 'changepassword'); } @@ -1074,35 +1259,43 @@ class settings_navigation extends navigation_node { // Default homepage. $defaulthomepageuser = (!empty($CFG->defaulthomepage) && ($CFG->defaulthomepage == HOMEPAGE_USER)); if (isloggedin() && !isguestuser($user) && $defaulthomepageuser) { - if ($currentuser && has_capability('moodle/user:editownprofile', $systemcontext) || - has_capability('moodle/user:editprofile', $usercontext)) { + if ( + $currentuser && has_capability('moodle/user:editownprofile', $systemcontext) || + has_capability('moodle/user:editprofile', $usercontext) + ) { $url = new url('/user/defaulthomepage.php', ['id' => $user->id]); $useraccount->add(get_string('defaulthomepageuser'), $url, self::TYPE_SETTING, null, 'defaulthomepageuser'); } } if (isloggedin() && !isguestuser($user) && !is_mnet_remote_user($user)) { - if ($currentuser && has_capability('moodle/user:editownprofile', $systemcontext) || - has_capability('moodle/user:editprofile', $usercontext)) { - $url = new url('/user/language.php', array('id' => $user->id, 'course' => $course->id)); + if ( + $currentuser && has_capability('moodle/user:editownprofile', $systemcontext) || + has_capability('moodle/user:editprofile', $usercontext) + ) { + $url = new url('/user/language.php', ['id' => $user->id, 'course' => $course->id]); $useraccount->add(get_string('preferredlanguage'), $url, self::TYPE_SETTING, null, 'preferredlanguage'); } } $pluginmanager = core_plugin_manager::instance(); $enabled = $pluginmanager->get_enabled_plugins('mod'); if (isset($enabled['forum']) && isloggedin() && !isguestuser($user) && !is_mnet_remote_user($user)) { - if ($currentuser && has_capability('moodle/user:editownprofile', $systemcontext) || - has_capability('moodle/user:editprofile', $usercontext)) { - $url = new url('/user/forum.php', array('id' => $user->id, 'course' => $course->id)); + if ( + $currentuser && has_capability('moodle/user:editownprofile', $systemcontext) || + has_capability('moodle/user:editprofile', $usercontext) + ) { + $url = new url('/user/forum.php', ['id' => $user->id, 'course' => $course->id]); $useraccount->add(get_string('forumpreferences'), $url, self::TYPE_SETTING); } } $editors = editors_get_enabled(); if (count($editors) > 1) { if (isloggedin() && !isguestuser($user) && !is_mnet_remote_user($user)) { - if ($currentuser && has_capability('moodle/user:editownprofile', $systemcontext) || - has_capability('moodle/user:editprofile', $usercontext)) { - $url = new url('/user/editor.php', array('id' => $user->id, 'course' => $course->id)); + if ( + $currentuser && has_capability('moodle/user:editownprofile', $systemcontext) || + has_capability('moodle/user:editprofile', $usercontext) + ) { + $url = new url('/user/editor.php', ['id' => $user->id, 'course' => $course->id]); $useraccount->add(get_string('editorpreferences'), $url, self::TYPE_SETTING); } } @@ -1110,26 +1303,45 @@ class settings_navigation extends navigation_node { // Add "Calendar preferences" link. if (isloggedin() && !isguestuser($user)) { - if ($currentuser && has_capability('moodle/user:editownprofile', $systemcontext) || - has_capability('moodle/user:editprofile', $usercontext)) { - $url = new url('/user/calendar.php', array('id' => $user->id)); - $useraccount->add(get_string('calendarpreferences', 'calendar'), $url, self::TYPE_SETTING, null, 'preferredcalendar'); + if ( + $currentuser && has_capability('moodle/user:editownprofile', $systemcontext) || + has_capability('moodle/user:editprofile', $usercontext) + ) { + $url = new url('/user/calendar.php', ['id' => $user->id]); + $useraccount->add( + get_string('calendarpreferences', 'calendar'), + $url, + self::TYPE_SETTING, + null, + 'preferredcalendar', + ); } } // Add "Content bank preferences" link. if (isloggedin() && !isguestuser($user)) { - if ($currentuser && has_capability('moodle/user:editownprofile', $systemcontext) || - has_capability('moodle/user:editprofile', $usercontext)) { + if ( + $currentuser && has_capability('moodle/user:editownprofile', $systemcontext) || + has_capability('moodle/user:editprofile', $usercontext) + ) { $url = new url('/user/contentbank.php', ['id' => $user->id]); - $useraccount->add(get_string('contentbankpreferences', 'core_contentbank'), $url, self::TYPE_SETTING, - null, 'contentbankpreferences'); + $useraccount->add( + get_string('contentbankpreferences', 'core_contentbank'), + $url, + self::TYPE_SETTING, + null, + 'contentbankpreferences' + ); } } // View the roles settings. - if (has_any_capability(['moodle/role:assign', 'moodle/role:safeoverride', 'moodle/role:override', - 'moodle/role:manage'], $usercontext)) { + if ( + has_any_capability( + ['moodle/role:assign', 'moodle/role:safeoverride', 'moodle/role:override', 'moodle/role:manage'], + $usercontext, + ) + ) { $roles = $usersetting->add(get_string('roles'), null, self::TYPE_SETTING); $url = new url('/admin/roles/usersroles.php', ['userid' => $user->id, 'courseid' => $course->id]); @@ -1138,36 +1350,47 @@ class settings_navigation extends navigation_node { $assignableroles = get_assignable_roles($usercontext, ROLENAME_BOTH); if (!empty($assignableroles)) { - $url = new url('/admin/roles/assign.php', - array('contextid' => $usercontext->id, 'userid' => $user->id, 'courseid' => $course->id)); + $url = new url( + '/admin/roles/assign.php', + ['contextid' => $usercontext->id, 'userid' => $user->id, 'courseid' => $course->id] + ); $roles->add(get_string('assignrolesrelativetothisuser', 'role'), $url, self::TYPE_SETTING); } - if (has_capability('moodle/role:review', $usercontext) || count(get_overridable_roles($usercontext, ROLENAME_BOTH))>0) { - $url = new url('/admin/roles/permissions.php', - array('contextid' => $usercontext->id, 'userid' => $user->id, 'courseid' => $course->id)); + if ( + has_capability('moodle/role:review', $usercontext) + || count(get_overridable_roles($usercontext, ROLENAME_BOTH)) > 0 + ) { + $url = new url( + '/admin/roles/permissions.php', + ['contextid' => $usercontext->id, 'userid' => $user->id, 'courseid' => $course->id] + ); $roles->add(get_string('permissions', 'role'), $url, self::TYPE_SETTING); } - $url = new url('/admin/roles/check.php', - array('contextid' => $usercontext->id, 'userid' => $user->id, 'courseid' => $course->id)); + $url = new url( + '/admin/roles/check.php', + ['contextid' => $usercontext->id, 'userid' => $user->id, 'courseid' => $course->id] + ); $roles->add(get_string('checkpermissions', 'role'), $url, self::TYPE_SETTING); } // Repositories. - if (!$this->cache->cached('contexthasrepos'.$usercontext->id)) { + if (!$this->cache->cached('contexthasrepos' . $usercontext->id)) { require_once($CFG->dirroot . '/repository/lib.php'); $editabletypes = repository::get_editable_types($usercontext); $haseditabletypes = !empty($editabletypes); unset($editabletypes); - $this->cache->set('contexthasrepos'.$usercontext->id, $haseditabletypes); + $this->cache->set('contexthasrepos' . $usercontext->id, $haseditabletypes); } else { - $haseditabletypes = $this->cache->{'contexthasrepos'.$usercontext->id}; + $haseditabletypes = $this->cache->{'contexthasrepos' . $usercontext->id}; } if ($haseditabletypes) { $repositories = $usersetting->add(get_string('repositories', 'repository'), null, self::TYPE_SETTING); - $repositories->add(get_string('manageinstances', 'repository'), new url('/repository/manage_instances.php', - array('contextid' => $usercontext->id))); + $repositories->add(get_string('manageinstances', 'repository'), new url( + '/repository/manage_instances.php', + ['contextid' => $usercontext->id] + )); } // Portfolio. @@ -1176,10 +1399,10 @@ class settings_navigation extends navigation_node { if (portfolio_has_visible_instances()) { $portfolio = $usersetting->add(get_string('portfolios', 'portfolio'), null, self::TYPE_SETTING); - $url = new url('/user/portfolio.php', array('courseid'=>$course->id)); + $url = new url('/user/portfolio.php', ['courseid' => $course->id]); $portfolio->add(get_string('configure', 'portfolio'), $url, self::TYPE_SETTING); - $url = new url('/user/portfoliologs.php', array('courseid'=>$course->id)); + $url = new url('/user/portfoliologs.php', ['courseid' => $course->id]); $portfolio->add(get_string('logs', 'portfolio'), $url, self::TYPE_SETTING); } } @@ -1187,9 +1410,11 @@ class settings_navigation extends navigation_node { $enablemanagetokens = false; if (!empty($CFG->enablerssfeeds)) { $enablemanagetokens = true; - } else if (!is_siteadmin($USER->id) + } else if ( + !is_siteadmin($USER->id) && !empty($CFG->enablewebservices) - && has_capability('moodle/webservice:createtoken', context_system::instance()) ) { + && has_capability('moodle/webservice:createtoken', context_system::instance()) + ) { $enablemanagetokens = true; } // Security keys. @@ -1199,10 +1424,12 @@ class settings_navigation extends navigation_node { } // Messaging. - if (($currentuser && has_capability('moodle/user:editownmessageprofile', $systemcontext)) || (!isguestuser($user) && - has_capability('moodle/user:editmessageprofile', $usercontext) && !is_primary_admin($user->id))) { - $messagingurl = new url('/message/edit.php', array('id' => $user->id)); - $notificationsurl = new url('/message/notificationpreferences.php', array('userid' => $user->id)); + if ( + ($currentuser && has_capability('moodle/user:editownmessageprofile', $systemcontext)) || (!isguestuser($user) && + has_capability('moodle/user:editmessageprofile', $usercontext) && !is_primary_admin($user->id)) + ) { + $messagingurl = new url('/message/edit.php', ['id' => $user->id]); + $notificationsurl = new url('/message/notificationpreferences.php', ['userid' => $user->id]); $useraccount->add(get_string('messagepreferences', 'message'), $messagingurl, self::TYPE_SETTING); $useraccount->add(get_string('notificationpreferences', 'message'), $notificationsurl, self::TYPE_SETTING); } @@ -1211,15 +1438,26 @@ class settings_navigation extends navigation_node { if ($currentuser && !empty($CFG->enableblogs)) { $blog = $usersetting->add(get_string('blogs', 'blog'), null, navigation_node::TYPE_CONTAINER, null, 'blogs'); if (has_capability('moodle/blog:view', $systemcontext)) { - $blog->add(get_string('preferences', 'blog'), new url('/blog/preferences.php'), - navigation_node::TYPE_SETTING); + $blog->add( + get_string('preferences', 'blog'), + new url('/blog/preferences.php'), + navigation_node::TYPE_SETTING + ); } - if (!empty($CFG->useexternalblogs) && $CFG->maxexternalblogsperuser > 0 && - has_capability('moodle/blog:manageexternal', $systemcontext)) { - $blog->add(get_string('externalblogs', 'blog'), new url('/blog/external_blogs.php'), - navigation_node::TYPE_SETTING); - $blog->add(get_string('addnewexternalblog', 'blog'), new url('/blog/external_blog_edit.php'), - navigation_node::TYPE_SETTING); + if ( + !empty($CFG->useexternalblogs) && $CFG->maxexternalblogsperuser > 0 && + has_capability('moodle/blog:manageexternal', $systemcontext) + ) { + $blog->add( + get_string('externalblogs', 'blog'), + new url('/blog/external_blogs.php'), + navigation_node::TYPE_SETTING + ); + $blog->add( + get_string('addnewexternalblog', 'blog'), + new url('/blog/external_blog_edit.php'), + navigation_node::TYPE_SETTING + ); } // Remove the blog node if empty. $blog->trim_if_empty(); @@ -1232,11 +1470,17 @@ class settings_navigation extends navigation_node { $url = new url('/badges/mybadges.php'); $badges->add(get_string('managebadges', 'badges'), $url, self::TYPE_SETTING); } - $badges->add(get_string('preferences', 'badges'), new url('/badges/preferences.php'), - navigation_node::TYPE_SETTING); + $badges->add( + get_string('preferences', 'badges'), + new url('/badges/preferences.php'), + navigation_node::TYPE_SETTING + ); if (!empty($CFG->badges_allowexternalbackpack)) { - $badges->add(get_string('backpackdetails', 'badges'), new url('/badges/mybackpack.php'), - navigation_node::TYPE_SETTING); + $badges->add( + get_string('backpackdetails', 'badges'), + new url('/badges/mybackpack.php'), + navigation_node::TYPE_SETTING + ); } } @@ -1252,7 +1496,7 @@ class settings_navigation extends navigation_node { } /** - * Loads block specific settings in the navigation + * Loads block specific settings in the navigation. * * @return navigation_node */ @@ -1262,24 +1506,47 @@ class settings_navigation extends navigation_node { $blocknode = $this->add($this->context->get_context_name(), null, self::TYPE_SETTING, null, 'blocksettings'); $blocknode->force_open(); - // Assign local roles + // Assign local roles. if (get_assignable_roles($this->context, ROLENAME_ORIGINAL)) { - $assignurl = new url('/'.$CFG->admin.'/roles/assign.php', array('contextid' => $this->context->id)); - $blocknode->add(get_string('assignroles', 'role'), $assignurl, self::TYPE_SETTING, null, - 'roles', new pix_icon('i/assignroles', '')); + $assignurl = new url('/' . $CFG->admin . '/roles/assign.php', ['contextid' => $this->context->id]); + $blocknode->add( + get_string('assignroles', 'role'), + $assignurl, + self::TYPE_SETTING, + null, + 'roles', + new pix_icon('i/assignroles', '') + ); } - // Override roles - if (has_capability('moodle/role:review', $this->context) or count(get_overridable_roles($this->context))>0) { - $url = new url('/'.$CFG->admin.'/roles/permissions.php', array('contextid'=>$this->context->id)); - $blocknode->add(get_string('permissions', 'role'), $url, self::TYPE_SETTING, null, - 'permissions', new pix_icon('i/permissions', '')); + // Override roles. + if (has_capability('moodle/role:review', $this->context) || count(get_overridable_roles($this->context)) > 0) { + $url = new url('/admin/roles/permissions.php', ['contextid' => $this->context->id]); + $blocknode->add( + get_string('permissions', 'role'), + $url, + self::TYPE_SETTING, + null, + 'permissions', + new pix_icon('i/permissions', '') + ); } - // Check role permissions - if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:assign'), $this->context)) { - $url = new url('/'.$CFG->admin.'/roles/check.php', array('contextid'=>$this->context->id)); - $blocknode->add(get_string('checkpermissions', 'role'), $url, self::TYPE_SETTING, null, - 'checkpermissions', new pix_icon('i/checkpermissions', '')); + // Check role permissions. + if ( + has_any_capability( + ['moodle/role:assign', 'moodle/role:safeoverride', 'moodle/role:override', 'moodle/role:assign'], + $this->context, + ) + ) { + $url = new url('/' . $CFG->admin . '/roles/check.php', ['contextid' => $this->context->id]); + $blocknode->add( + get_string('checkpermissions', 'role'), + $url, + self::TYPE_SETTING, + null, + 'checkpermissions', + new pix_icon('i/checkpermissions', '') + ); } // Add the context locking node. @@ -1315,59 +1582,104 @@ class settings_navigation extends navigation_node { $categorynode->force_open(); if (can_edit_in_category($catcontext->instanceid)) { - $url = new url('/course/management.php', array('categoryid' => $catcontext->instanceid)); + $url = new url('/course/management.php', ['categoryid' => $catcontext->instanceid]); $editstring = get_string('managecategorythis'); $node = $categorynode->add($editstring, $url, self::TYPE_SETTING, null, 'managecategory', new pix_icon('i/edit', '')); $node->set_show_in_secondary_navigation(false); } if (has_capability('moodle/category:manage', $catcontext)) { - $editurl = new url('/course/editcategory.php', array('id' => $catcontext->instanceid)); + $editurl = new url('/course/editcategory.php', ['id' => $catcontext->instanceid]); $categorynode->add(get_string('settings'), $editurl, self::TYPE_SETTING, null, 'edit', new pix_icon('i/edit', '')); - $addsubcaturl = new url('/course/editcategory.php', array('parent' => $catcontext->instanceid)); - $categorynode->add(get_string('addsubcategory'), $addsubcaturl, self::TYPE_SETTING, null, - 'addsubcat', new pix_icon('i/withsubcat', ''))->set_show_in_secondary_navigation(false); + $addsubcaturl = new url('/course/editcategory.php', ['parent' => $catcontext->instanceid]); + $categorynode->add( + get_string('addsubcategory'), + $addsubcaturl, + self::TYPE_SETTING, + null, + 'addsubcat', + new pix_icon('i/withsubcat', '') + )->set_show_in_secondary_navigation(false); } - // Assign local roles + // Assign local roles. $assignableroles = get_assignable_roles($catcontext); if (!empty($assignableroles)) { - $assignurl = new url('/'.$CFG->admin.'/roles/assign.php', array('contextid' => $catcontext->id)); - $categorynode->add(get_string('assignroles', 'role'), $assignurl, self::TYPE_SETTING, null, 'roles', new pix_icon('i/assignroles', '')); + $assignurl = new url('/' . $CFG->admin . '/roles/assign.php', ['contextid' => $catcontext->id]); + $categorynode->add( + get_string('assignroles', 'role'), + $assignurl, + self::TYPE_SETTING, + null, + 'roles', + new pix_icon('i/assignroles', ''), + ); } - // Override roles - if (has_capability('moodle/role:review', $catcontext) or count(get_overridable_roles($catcontext)) > 0) { - $url = new url('/'.$CFG->admin.'/roles/permissions.php', array('contextid' => $catcontext->id)); - $categorynode->add(get_string('permissions', 'role'), $url, self::TYPE_SETTING, null, 'permissions', new pix_icon('i/permissions', '')); + // Override roles. + if (has_capability('moodle/role:review', $catcontext) || count(get_overridable_roles($catcontext)) > 0) { + $url = new url('/' . $CFG->admin . '/roles/permissions.php', ['contextid' => $catcontext->id]); + $categorynode->add( + get_string('permissions', 'role'), + $url, + self::TYPE_SETTING, + null, + 'permissions', + new pix_icon('i/permissions', ''), + ); } - // Check role permissions - if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride', - 'moodle/role:override', 'moodle/role:assign'), $catcontext)) { - $url = new url('/'.$CFG->admin.'/roles/check.php', array('contextid' => $catcontext->id)); - $categorynode->add(get_string('checkpermissions', 'role'), $url, self::TYPE_SETTING, null, 'rolecheck', new pix_icon('i/checkpermissions', '')); + // Check role permissions. + if ( + has_any_capability(['moodle/role:assign', 'moodle/role:safeoverride', + 'moodle/role:override', 'moodle/role:assign'], $catcontext) + ) { + $url = new url('/' . $CFG->admin . '/roles/check.php', ['contextid' => $catcontext->id]); + $categorynode->add( + get_string('checkpermissions', 'role'), + $url, + self::TYPE_SETTING, + null, + 'rolecheck', + new pix_icon('i/checkpermissions', ''), + ); } // Add the context locking node. $this->add_context_locking_node($categorynode, $catcontext); - // Cohorts - if (has_any_capability(array('moodle/cohort:view', 'moodle/cohort:manage'), $catcontext)) { - $categorynode->add(get_string('cohorts', 'cohort'), new url('/cohort/index.php', - array('contextid' => $catcontext->id)), self::TYPE_SETTING, null, 'cohort', new pix_icon('i/cohort', '')); + // Cohorts. + if (has_any_capability(['moodle/cohort:view', 'moodle/cohort:manage'], $catcontext)) { + $categorynode->add(get_string('cohorts', 'cohort'), new url( + '/cohort/index.php', + ['contextid' => $catcontext->id] + ), self::TYPE_SETTING, null, 'cohort', new pix_icon('i/cohort', '')); } - // Manage filters + // Manage filters. if (has_capability('moodle/filter:manage', $catcontext) && count(filter_get_available_in_context($catcontext)) > 0) { - $url = new url('/filter/manage.php', array('contextid' => $catcontext->id)); - $categorynode->add(get_string('filters', 'admin'), $url, self::TYPE_SETTING, null, 'filters', new pix_icon('i/filter', '')); + $url = new url('/filter/manage.php', ['contextid' => $catcontext->id]); + $categorynode->add( + get_string('filters', 'admin'), + $url, + self::TYPE_SETTING, + null, + 'filters', + new pix_icon('i/filter', ''), + ); } // Restore. if (has_capability('moodle/restore:restorecourse', $catcontext)) { - $url = new url('/backup/restorefile.php', array('contextid' => $catcontext->id)); - $categorynode->add(get_string('restorecourse', 'admin'), $url, self::TYPE_SETTING, null, 'restorecourse', new pix_icon('i/restore', '')); + $url = new url('/backup/restorefile.php', ['contextid' => $catcontext->id]); + $categorynode->add( + get_string('restorecourse', 'admin'), + $url, + self::TYPE_SETTING, + null, + 'restorecourse', + new pix_icon('i/restore', ''), + ); } // Let plugins hook into category settings navigation. @@ -1379,11 +1691,19 @@ class settings_navigation extends navigation_node { } $cb = new contentbank(); - if ($cb->is_context_allowed($catcontext) - && has_capability('moodle/contentbank:access', $catcontext)) { + if ( + $cb->is_context_allowed($catcontext) + && has_capability('moodle/contentbank:access', $catcontext) + ) { $url = new url('/contentbank/index.php', ['contextid' => $catcontext->id]); - $categorynode->add(get_string('contentbank'), $url, self::TYPE_CUSTOM, null, - 'contentbank', new pix_icon('i/contentbank', '')); + $categorynode->add( + get_string('contentbank'), + $url, + self::TYPE_CUSTOM, + null, + 'contentbank', + new pix_icon('i/contentbank', '') + ); } return $categorynode; @@ -1405,8 +1725,8 @@ class settings_navigation extends navigation_node { if (!empty($this->page->context) && !empty($USER->access['rsw'][$this->page->context->path])) { return $USER->access['rsw'][$this->page->context->path]; } - foreach ($USER->access['rsw'] as $key=>$role) { - if (strpos($this->context->path,$key)===0) { + foreach ($USER->access['rsw'] as $key => $role) { + if (strpos($this->context->path, $key) === 0) { return $role; } } @@ -1425,7 +1745,7 @@ class settings_navigation extends navigation_node { require_once($CFG->dirroot . '/course/lib.php'); $course = clone($SITE); - $coursecontext = context_course::instance($course->id); // Course context + $coursecontext = context_course::instance($course->id); // Course context. $adminoptions = course_get_user_administration_options($course, $coursecontext); $frontpage = $this->add(get_string('frontpagesettings'), null, self::TYPE_SETTING, null, 'frontpage'); @@ -1435,9 +1755,8 @@ class settings_navigation extends navigation_node { $frontpage->id = 'frontpagesettings'; if ($this->page->user_allowed_editing() && !$this->page->theme->haseditswitch) { - - // Add the turn on/off settings - $url = new url('/course/view.php', array('id'=>$course->id, 'sesskey'=>sesskey())); + // Add the turn on/off settings. + $url = new url('/course/view.php', ['id' => $course->id, 'sesskey' => sesskey()]); if ($this->page->user_is_editing()) { $url->param('edit', 'off'); $editstring = get_string('turneditingoff'); @@ -1449,35 +1768,54 @@ class settings_navigation extends navigation_node { } if ($adminoptions->update) { - // Add the course settings link - $url = new url('/admin/settings.php', array('section'=>'frontpagesettings')); - $frontpage->add(get_string('settings'), $url, self::TYPE_SETTING, null, - 'editsettings', new pix_icon('i/settings', '')); + // Add the course settings link. + $url = new url('/admin/settings.php', ['section' => 'frontpagesettings']); + $frontpage->add( + get_string('settings'), + $url, + self::TYPE_SETTING, + null, + 'editsettings', + new pix_icon('i/settings', '') + ); } - // add enrol nodes + // Add enrol nodes. enrol_add_course_navigation($frontpage, $course); - // Manage filters + // Manage filters. if ($adminoptions->filters) { - $url = new url('/filter/manage.php', array('contextid'=>$coursecontext->id)); - $frontpage->add(get_string('filters', 'admin'), $url, self::TYPE_SETTING, - null, 'filtermanagement', new pix_icon('i/filter', '')); + $url = new url('/filter/manage.php', ['contextid' => $coursecontext->id]); + $frontpage->add( + get_string('filters', 'admin'), + $url, + self::TYPE_SETTING, + null, + 'filtermanagement', + new pix_icon('i/filter', '') + ); } // View course reports. if ($adminoptions->reports) { - $frontpagenav = $frontpage->add(get_string('reports'), new url('/report/view.php', - ['courseid' => $coursecontext->instanceid]), - self::TYPE_CONTAINER, null, 'coursereports', - new pix_icon('i/stats', '')); + $frontpagenav = $frontpage->add( + get_string('reports'), + new url( + '/report/view.php', + ['courseid' => $coursecontext->instanceid] + ), + self::TYPE_CONTAINER, + null, + 'coursereports', + new pix_icon('i/stats', '') + ); $coursereports = component::get_plugin_list('coursereport'); - foreach ($coursereports as $report=>$dir) { - $libfile = $CFG->dirroot.'/course/report/'.$report.'/lib.php'; + foreach ($coursereports as $report => $dir) { + $libfile = $CFG->dirroot . '/course/report/' . $report . '/lib.php'; if (file_exists($libfile)) { require_once($libfile); - $reportfunction = $report.'_report_extend_navigation'; - if (function_exists($report.'_report_extend_navigation')) { + $reportfunction = $report . '_report_extend_navigation'; + if (function_exists($report . '_report_extend_navigation')) { $reportfunction($frontpagenav, $course, $coursecontext); } } @@ -1493,15 +1831,15 @@ class settings_navigation extends navigation_node { } } - // Questions + // Questions. require_once($CFG->libdir . '/questionlib.php'); $baseurl = \core_question\local\bank\question_bank_helper::get_url_for_qbank_list($course->id); question_extend_settings_navigation($frontpage, $coursecontext, $baseurl)->trim_if_empty(); - // Manage files + // Manage files. if ($adminoptions->files) { - //hiden in new installs - $url = new url('/files/index.php', array('contextid'=>$coursecontext->id)); + // Hide in new installs. + $url = new url('/files/index.php', ['contextid' => $coursecontext->id]); $frontpage->add(get_string('sitelegacyfiles'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/folder', '')); } @@ -1518,7 +1856,10 @@ class settings_navigation extends navigation_node { $coursereusenav = $frontpage->add( get_string('coursereuse'), new url('/backup/view.php', ['id' => $course->id]), - self::TYPE_CONTAINER, null, 'coursereuse', new pix_icon('t/edit', ''), + self::TYPE_CONTAINER, + null, + 'coursereuse', + new pix_icon('t/edit', ''), ); // Backup this course. diff --git a/public/lib/tests/classes/navigation/exposed_global_navigation.php b/public/lib/tests/classes/navigation/exposed_global_navigation.php index b1152efe29b..f6b3a8b03bf 100644 --- a/public/lib/tests/classes/navigation/exposed_global_navigation.php +++ b/public/lib/tests/classes/navigation/exposed_global_navigation.php @@ -19,13 +19,14 @@ namespace core\tests\navigation; use core\exception\coding_exception; use core\navigation\global_navigation; +// phpcs:disable /** * This is a dummy object that allows us to call protected methods within the * global navigation class by prefixing the methods with `exposed_` */ class exposed_global_navigation extends global_navigation { protected $exposedkey = 'exposed_'; - public function __construct(?\moodle_page $page=null) { + public function __construct(?\moodle_page $page = null) { global $PAGE; if ($page === null) { $page = $PAGE; @@ -37,9 +38,12 @@ class exposed_global_navigation extends global_navigation { $method = substr($method, strlen($this->exposedkey)); } if (method_exists($this, $method)) { - return call_user_func_array(array($this, $method), $arguments); + return call_user_func_array([$this, $method], $arguments); } - throw new coding_exception('You have attempted to access a method that does not exist for the given object '.$method, DEBUG_DEVELOPER); + throw new coding_exception( + 'You have attempted to access a method that does not exist for the given object ' . $method, + DEBUG_DEVELOPER, + ); } public function set_initialised() { $this->initialised = true; diff --git a/public/lib/tests/classes/navigation/exposed_settings_navigation.php b/public/lib/tests/classes/navigation/exposed_settings_navigation.php index 93d02738393..3bbe45ba2f4 100644 --- a/public/lib/tests/classes/navigation/exposed_settings_navigation.php +++ b/public/lib/tests/classes/navigation/exposed_settings_navigation.php @@ -19,6 +19,8 @@ namespace core\tests\navigation; use core\exception\coding_exception; use core\navigation\settings_navigation; +// phpcs:disable + /** * This is a dummy object that allows us to call protected methods within the * global navigation class by prefixing the methods with `exposed_`. @@ -27,7 +29,6 @@ use core\navigation\settings_navigation; * @copyright Andrew Lyons * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ - class exposed_settings_navigation extends settings_navigation { protected string $exposedkey = 'exposed_'; @@ -41,8 +42,11 @@ class exposed_settings_navigation extends settings_navigation { $method = substr($method, strlen($this->exposedkey)); } if (method_exists($this, $method)) { - return call_user_func_array(array($this, $method), $arguments); + return call_user_func_array([$this, $method], $arguments); } - throw new coding_exception('You have attempted to access a method that does not exist for the given object '.$method, DEBUG_DEVELOPER); + throw new coding_exception( + 'You have attempted to access a method that does not exist for the given object ' . $method, + DEBUG_DEVELOPER, + ); } } diff --git a/public/lib/tests/classes/navigation/navigation_testcase.php b/public/lib/tests/classes/navigation/navigation_testcase.php index 080519eaa2b..9f023100da5 100644 --- a/public/lib/tests/classes/navigation/navigation_testcase.php +++ b/public/lib/tests/classes/navigation/navigation_testcase.php @@ -16,9 +16,9 @@ namespace core\tests\navigation; +use core\navigation\navigation_node; use core\output\pix_icon; use core\url; -use navigation_node; /** * TODO describe file navigation_testcase @@ -28,7 +28,7 @@ use navigation_node; * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ abstract class navigation_testcase extends \advanced_testcase { - protected function setup_node(): navigation_node { + protected function setup_node(): navigation_node { // phpcs:ignore global $PAGE, $SITE; // Perform a reset between tests to reset the PAGE. @@ -49,16 +49,36 @@ abstract class navigation_testcase extends \advanced_testcase { $demo1 = $node->add('demo1', $inactiveurl, navigation_node::TYPE_COURSE, null, 'demo1', new pix_icon('i/course', '')); $demo2 = $node->add('demo2', $inactiveurl, navigation_node::TYPE_COURSE, null, 'demo2', new pix_icon('i/course', '')); $demo3 = $node->add('demo3', $inactiveurl, navigation_node::TYPE_CATEGORY, null, 'demo3', new pix_icon('i/course', '')); - $demo4 = $demo3->add('demo4', $inactiveurl, navigation_node::TYPE_COURSE, null, 'demo4', new pix_icon('i/course', '')); + $demo4 = $demo3->add('demo4', $inactiveurl, navigation_node::TYPE_COURSE, null, 'demo4', new pix_icon('i/course', '')); $demo5 = $demo3->add('demo5', $activeurl, navigation_node::TYPE_COURSE, null, 'demo5', new pix_icon('i/course', '')); $demo5->add('activity1', null, navigation_node::TYPE_ACTIVITY, null, 'activity1')->make_active(); $demo6 = $demo3->add('demo6', null, navigation_node::TYPE_CONTAINER, 'container node test', 'demo6'); - $hiddendemo1 = $node->add('hiddendemo1', $inactiveurl, navigation_node::TYPE_CATEGORY, null, 'hiddendemo1', new pix_icon('i/course', '')); + $hiddendemo1 = $node->add( + 'hiddendemo1', + $inactiveurl, + navigation_node::TYPE_CATEGORY, + null, + 'hiddendemo1', + new pix_icon('i/course', '') + ); $hiddendemo1->hidden = true; - $hiddendemo1->add('hiddendemo2', $inactiveurl, navigation_node::TYPE_COURSE, null, 'hiddendemo2', new pix_icon('i/course', ''))->helpbutton = 'Here is a help button'; - $hiddendemo1->add('hiddendemo3', $inactiveurl, navigation_node::TYPE_COURSE, null, 'hiddendemo3', new pix_icon('i/course', ''))->display = false; + $hiddendemo1->add( + 'hiddendemo2', + $inactiveurl, + navigation_node::TYPE_COURSE, + null, + 'hiddendemo2', + new pix_icon('i/course', '') + )->helpbutton = 'Here is a help button'; + $hiddendemo1->add( + 'hiddendemo3', + $inactiveurl, + navigation_node::TYPE_COURSE, + null, + 'hiddendemo3', + new pix_icon('i/course', '') + )->display = false; return $node; } - } diff --git a/public/lib/tests/navigation/navbar_test.php b/public/lib/tests/navigation/navbar_test.php index d0e20536df6..6385d4a90ca 100644 --- a/public/lib/tests/navigation/navbar_test.php +++ b/public/lib/tests/navigation/navbar_test.php @@ -26,7 +26,6 @@ namespace core\navigation; */ #[\PHPUnit\Framework\Attributes\CoversClass(navbar::class)] final class navbar_test extends \advanced_testcase { - public function test_navbar_prepend_and_add(): \moodle_page { global $PAGE; // Unfortunate hack needed because people use global $PAGE around the place. @@ -37,12 +36,12 @@ final class navbar_test extends \advanced_testcase { $generator = self::getDataGenerator(); $cat1 = $generator->create_category(); - $cat2 = $generator->create_category(array('parent' => $cat1->id)); - $course = $generator->create_course(array('category' => $cat2->id)); + $cat2 = $generator->create_category(['parent' => $cat1->id]); + $course = $generator->create_course(['category' => $cat2->id]); $page = new \moodle_page(); $page->set_course($course); - $page->set_url(new \moodle_url('/course/view.php', array('id' => $course->id))); + $page->set_url(new \moodle_url('/course/view.php', ['id' => $course->id])); $page->navbar->prepend('test 1'); $page->navbar->prepend('test 2'); $page->navbar->add('test 3'); @@ -67,10 +66,7 @@ final class navbar_test extends \advanced_testcase { return $page; } - /** - * @depends test_navbar_prepend_and_add - * @param $node - */ + #[\PHPUnit\Framework\Attributes\Depends('test_navbar_prepend_and_add')] public function test_navbar_has_items(\moodle_page $page): void { $this->resetAfterTest(); diff --git a/public/lib/tests/navigation/navigation_cache_test.php b/public/lib/tests/navigation/navigation_cache_test.php index 884b28aaeae..4644284de77 100644 --- a/public/lib/tests/navigation/navigation_cache_test.php +++ b/public/lib/tests/navigation/navigation_cache_test.php @@ -69,5 +69,4 @@ final class navigation_cache_test extends \advanced_testcase { $this->assertTrue($cache->cached('software')); $this->assertEquals($cache->software, 'Moodle'); } - } diff --git a/public/lib/tests/navigation/navigation_node_test.php b/public/lib/tests/navigation/navigation_node_test.php index 8d69a718c36..f45ccc3f1d0 100644 --- a/public/lib/tests/navigation/navigation_node_test.php +++ b/public/lib/tests/navigation/navigation_node_test.php @@ -34,12 +34,12 @@ final class navigation_node_test extends navigation_testcase { public function test_node__construct(): void { $node = $this->setup_node(); - $fakeproperties = array( + $fakeproperties = [ 'text' => 'text', 'shorttext' => 'A very silly extra long short text string, more than 25 characters', 'key' => 'key', 'type' => 'navigation_node::TYPE_COURSE', - 'action' => new \moodle_url('http://www.moodle.org/')); + 'action' => new \moodle_url('http://www.moodle.org/')]; $node = new navigation_node($fakeproperties); $this->assertSame($fakeproperties['text'], $node->text); @@ -53,7 +53,14 @@ final class navigation_node_test extends navigation_testcase { $node = $this->setup_node(); // Add a node with all args set. - $node1 = $node->add('test_add_1', 'http://www.moodle.org/', navigation_node::TYPE_COURSE, 'testadd1', 'key', new pix_icon('i/course', '')); + $node1 = $node->add( + 'test_add_1', + 'http://www.moodle.org/', + navigation_node::TYPE_COURSE, + 'testadd1', + 'key', + new pix_icon('i/course', ''), + ); // Add a node with the minimum args required. $node2 = $node->add('test_add_2', null, navigation_node::TYPE_CUSTOM, 'testadd2'); $node3 = $node->add(str_repeat('moodle ', 15), str_repeat('moodle', 15)); @@ -79,12 +86,27 @@ final class navigation_node_test extends navigation_testcase { $node = $this->setup_node(); // Create 3 nodes. - $node1 = navigation_node::create('test_add_1', null, navigation_node::TYPE_CUSTOM, - 'test 1', 'testadd1'); - $node2 = navigation_node::create('test_add_2', null, navigation_node::TYPE_CUSTOM, - 'test 2', 'testadd2'); - $node3 = navigation_node::create('test_add_3', null, navigation_node::TYPE_CUSTOM, - 'test 3', 'testadd3'); + $node1 = navigation_node::create( + 'test_add_1', + null, + navigation_node::TYPE_CUSTOM, + 'test 1', + 'testadd1' + ); + $node2 = navigation_node::create( + 'test_add_2', + null, + navigation_node::TYPE_CUSTOM, + 'test 2', + 'testadd2' + ); + $node3 = navigation_node::create( + 'test_add_3', + null, + navigation_node::TYPE_CUSTOM, + 'test 3', + 'testadd3' + ); // Add node 2, then node 1 before 2, then node 3 at end. $node->add_node($node2); $node->add_node($node1, 'testadd2'); @@ -93,9 +115,9 @@ final class navigation_node_test extends navigation_testcase { foreach ($node->children as $child) { $keys[] = $child->key; } - $this->assertSame('testadd1', $keys[count($keys)-3]); - $this->assertSame('testadd2', $keys[count($keys)-2]); - $this->assertSame('testadd3', $keys[count($keys)-1]); + $this->assertSame('testadd1', $keys[count($keys) - 3]); + $this->assertSame('testadd2', $keys[count($keys) - 2]); + $this->assertSame('testadd3', $keys[count($keys) - 1]); } public function test_node_add_class(): void { @@ -191,7 +213,7 @@ final class navigation_node_test extends navigation_testcase { public function test_node_find_expandable(): void { $node = $this->setup_node(); - $expandable = array(); + $expandable = []; $node->find_expandable($expandable); $this->assertCount(0, $expandable); @@ -361,15 +383,18 @@ final class navigation_node_test extends navigation_testcase { return [ 'The navigation node has an action link.' => [ - navigation_node::create('Node', new action_link(new \moodle_url('/'), '', - new popup_action('click', new \moodle_url('/'))), navigation_node::TYPE_SETTING), - true + navigation_node::create('Node', new action_link( + new \moodle_url('/'), + '', + new popup_action('click', new \moodle_url('/')) + ), navigation_node::TYPE_SETTING), + true, ], 'The navigation node does not have an action link.' => [ navigation_node::create('Node', new \moodle_url('/'), navigation_node::TYPE_SETTING), - false + false, ], ]; } @@ -393,7 +418,7 @@ final class navigation_node_test extends navigation_testcase { 'id' => $node->action->attributes['id'], 'event' => $node->action->actions[0]->event, 'jsfunction' => $node->action->actions[0]->jsfunction, - 'jsfunctionargs' => json_encode($node->action->actions[0]->jsfunctionargs) + 'jsfunctionargs' => json_encode($node->action->actions[0]->jsfunctionargs), ]; $this->assertEquals($expected, $data['actions'][0]); } else { // There are no actions added to the action link. @@ -414,13 +439,19 @@ final class navigation_node_test extends navigation_testcase { return [ 'The navigation node has an action link with an action attached.' => [ - navigation_node::create('Node', new action_link(new \moodle_url('/'), '', - new popup_action('click', new \moodle_url('/'))), navigation_node::TYPE_SETTING), + navigation_node::create('Node', new action_link( + new \moodle_url('/'), + '', + new popup_action('click', new \moodle_url('/')) + ), navigation_node::TYPE_SETTING), ], 'The navigation node has an action link without an action.' => [ - navigation_node::create('Node', new action_link(new \moodle_url('/'), '', null), - navigation_node::TYPE_SETTING), + navigation_node::create( + 'Node', + new action_link(new \moodle_url('/'), '', null), + navigation_node::TYPE_SETTING + ), ], 'The navigation node does not have an action link.' => [ diff --git a/public/lib/tests/navigation/settings_navigation_test.php b/public/lib/tests/navigation/settings_navigation_test.php index bd087870cc3..125ae19ae84 100644 --- a/public/lib/tests/navigation/settings_navigation_test.php +++ b/public/lib/tests/navigation/settings_navigation_test.php @@ -19,13 +19,14 @@ namespace core\navigation; use core\tests\navigation\exposed_settings_navigation; /** - * Tests for + * Tests for * * @package core * @category test * @copyright 2025 Andrew Lyons * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ +#[\PHPUnit\Framework\Attributes\CoversClass(settings_navigation::class)] final class settings_navigation_test extends \advanced_testcase { public function test_setting___construct(): settings_navigation { global $PAGE, $SITE; @@ -80,7 +81,7 @@ final class settings_navigation_test extends \advanced_testcase { $PAGE->set_course($SITE); // Check that a standard user can not view the preferences page. - $studentrole = $DB->get_record('role', array('shortname' => 'student')); + $studentrole = $DB->get_record('role', ['shortname' => 'student']); $this->getDataGenerator()->role_assign($studentrole->id, $persondoingtheviewing->id); $this->setUser($persondoingtheviewing); $settingsnav = new exposed_settings_navigation(); @@ -89,7 +90,7 @@ final class settings_navigation_test extends \advanced_testcase { $this->assertFalse($settingsnav->can_view_user_preferences($persontoview->id)); // Set persondoingtheviewing as a manager. - $managerrole = $DB->get_record('role', array('shortname' => 'manager')); + $managerrole = $DB->get_record('role', ['shortname' => 'manager']); $this->getDataGenerator()->role_assign($managerrole->id, $persondoingtheviewing->id); $settingsnav = new exposed_settings_navigation(); $settingsnav->initialise(); @@ -104,5 +105,4 @@ final class settings_navigation_test extends \advanced_testcase { $preferencenode = $settingsnav->find('userviewingsettings' . $persontoview->id, null); $this->assertTrue($settingsnav->can_view_user_preferences($persontoview->id)); } - }