MDL-49854 core: User navigation refinements
[moodle.git] / user / classes / output / myprofile / manager.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Defines Manager class for my profile navigation tree.
19  *
20  * @package   core_user
21  * @copyright 2015 onwards Ankit Agarwal
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace core_user\output\myprofile;
26 defined('MOODLE_INTERNAL') || die();
28 global $CFG;
29 require_once($CFG->libdir . "/myprofilelib.php");
31 /**
32  * Defines MAnager class for myprofile navigation tree.
33  *
34  * @since     Moodle 2.9
35  * @package   core_user
36  * @copyright 2015 onwards Ankit Agarwal
37  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
38  */
39 class manager {
40     /**
41      * Parse all callbacks and builds the tree.
42      *
43      * @param integer   $user ID of the user for which the profile is displayed.
44      * @param bool      $iscurrentuser true if the profile being viewed is of current user, else false.
45      * @param \stdClass $course Course object
46      *
47      * @return tree Fully build tree to be rendered on my profile page.
48      */
49     public static function build_tree($user, $iscurrentuser, $course = null) {
50         $tree = new tree();
52         // Add core nodes.
53         core_myprofile_navigation($tree, $user, $iscurrentuser, $course);
55         // Core components.
56         $components = \core_component::get_core_subsystems();
57         foreach ($components as $component => $directory) {
58             if (empty($directory)) {
59                 continue;
60             }
61             $file = $directory . "/lib.php";
62             if (is_readable($file)) {
63                 require_once($file);
64                 $function = "core_" . $component . "_myprofile_navigation";
65                 if (function_exists($function)) {
66                     $function($tree, $user, $iscurrentuser, $course);
67                 }
68             }
69         }
71         // Plugins.
72         $types = \core_component::get_plugin_types();
73         foreach ($types as $type => $dir) {
74             $pluginlist = get_plugin_list_with_function($type, "myprofile_navigation", "lib.php");
75             foreach ($pluginlist as $function) {
76                 $function($tree, $user, $iscurrentuser, $course);
77             }
78         }
79         $tree->sort_categories();
80         return $tree;
81     }
82 }