9e47b35c38430a32e14c15ed711c002f14a9129f
[moodle.git] / course / classes / output / activity_navigation.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  * File containing the class activity navigation renderable.
19  *
20  * @package    core_course
21  * @copyright  2017 Mark Nelson <markn@moodle.com>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
24 namespace core_course\output;
26 defined('MOODLE_INTERNAL') || die();
28 use renderable;
29 use templatable;
31 /**
32  * The class activity navigation renderable.
33  *
34  * @package    core_course
35  * @copyright  2017 Mark Nelson <markn@moodle.com>
36  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37  */
38 class activity_navigation implements renderable, templatable {
40     /**
41      * @var \action_link The action link object for the prev link.
42      */
43     public $prevlink = null;
45     /**
46      * @var \action_link The action link object for the next link.
47      */
48     public $nextlink = null;
50     /**
51      * Constructor.
52      *
53      * @param \cm_info|null $prevmod The previous module to display, null if none.
54      * @param \cm_info|null $nextmod The previous module to display, null if none.
55      */
56     public function __construct($prevmod, $nextmod) {
57         global $OUTPUT;
59         // Check if there is a previous module to display.
60         if ($prevmod) {
61             $linkurl = new \moodle_url($prevmod->url, array('forceview' => 1));
62             $linkname = $prevmod->name;
63             if (!$prevmod->visible) {
64                 $linkname .= ' ' . get_string('hiddenwithbrackets');
65             }
67             $attributes = [
68                 'classes' => 'btn btn-link',
69                 'id' => 'prev-activity-link',
70                 'title' => $linkname,
71             ];
72             $this->prevlink = new \action_link($linkurl, $OUTPUT->larrow() . ' ' . $linkname, null, $attributes);
73         }
75         // Check if there is a next module to display.
76         if ($nextmod) {
77             $linkurl = new \moodle_url($nextmod->url, array('forceview' => 1));
78             $linkname = $nextmod->name;
79             if (!$nextmod->visible) {
80                 $linkname .= ' ' . get_string('hiddenwithbrackets');
81             }
83             $attributes = [
84                 'classes' => 'btn btn-link',
85                 'id' => 'next-activity-link',
86                 'title' => $linkname,
87             ];
88             $this->nextlink = new \action_link($linkurl, $linkname . ' ' . $OUTPUT->rarrow(), null, $attributes);
89         }
90     }
92     /**
93      * Export this data so it can be used as the context for a mustache template.
94      *
95      * @param \renderer_base $output Renderer base.
96      * @return \stdClass
97      */
98     public function export_for_template(\renderer_base $output) {
99         $data = new \stdClass();
100         if ($this->prevlink) {
101             $data->prevlink = $this->prevlink->export_for_template($output);
102         }
104         if ($this->nextlink) {
105             $data->nextlink = $this->nextlink->export_for_template($output);
106         }
108         return $data;
109     }