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
/**
18
 * Contains class before_course_viewed responsible for external course routing
19
 *
20
 * @package    core_course
21
 * @copyright  2024 Jacob Viertel
22
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23
 */
24
 
25
namespace core_course\hook;
26
 
27
use stdClass;
28
use core\hook\described_hook;
29
 
30
/**
31
 * External course redirect hook before_course_viewed
32
 *
33
 */
34
final class before_course_viewed implements described_hook {
35
    /**
36
     * The course being viewed
37
     * @var stdClass
38
     */
39
    public $course;
40
 
41
    /**
42
     * Constructor for the hook.
43
     * @param stdClass $course The course instance.
44
     */
45
    public function __construct(stdClass $course) {
46
        $this->course = $course;
47
    }
48
 
49
    /**
50
     * Hooks description
51
     *
52
     * @return string
53
     */
54
    public static function get_hook_description(): string {
55
        return 'Hook dispatched just before viewing a course in course/view.php.';
56
    }
57
 
58
    /**
59
     * Hooks tags
60
     *
61
     * @return array
62
     */
63
    public static function get_hook_tags(): array {
64
        return ['course', 'view', 'routing', 'navigation'];
65
    }
66
}