Proyectos de Subversion Moodle

Rev

| Ultima modificación | Ver Log |

Rev Autor Línea Nro. Línea
1441 ariadna 1
<?php
2
// This file is part of Moodle - http://moodle.org/
3
//
4
// Moodle is free software: you can redistribute it and/or modify
5
// it under the terms of the GNU General Public License as published by
6
// the Free Software Foundation, either version 3 of the License, or
7
// (at your option) any later version.
8
//
9
// Moodle is distributed in the hope that it will be useful,
10
// but WITHOUT ANY WARRANTY; without even the implied warranty of
11
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
// GNU General Public License for more details.
13
//
14
// You should have received a copy of the GNU General Public License
15
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
16
 
17
namespace core_user\hook;
18
 
19
/**
20
 * Hook to modify user menu.
21
 *
22
 * @package    core_user
23
 * @copyright  2024 Guillaume Barat <guillaumebarat@catalyst-au.net>
24
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25
 * @property-read \renderer_base $renderer The page renderer object
26
 */
27
#[\core\attribute\tags('user')]
28
#[\core\attribute\label('Allows plugins to add any elements to the user menu')]
29
final class extend_user_menu {
30
    /**
31
     * Hook to modify user menu.
32
     *
33
     * @param array $navitems Menu item to add.
34
     */
35
    public function __construct(
36
        /** @var array The navigation items */
37
        public array $navitems = [],
38
    ) {
39
    }
40
 
41
    /**
42
     * Add navigation item.
43
     *
44
     * @param null|\stdClass $output
45
     */
46
    public function add_navitem(?\stdClass $output): void {
47
        if ($output) {
48
            if (property_exists($output, 'itemtype')) {
49
                $this->navitems[] = $output;
50
            }
51
        }
52
    }
53
 
54
    /**
55
     * Returns a class with the detail for the menu.
56
     *
57
     * @return array
58
     */
59
    public function get_navitems(): array {
60
        return $this->navitems;
61
    }
62
}