MDL-60558 block_calendar_upcoming: Render the template when no events
[moodle.git] / blocks / calendar_upcoming / block_calendar_upcoming.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  * Handles displaying the calendar upcoming events block.
19  *
20  * @package    block_calendar_upcoming
21  * @copyright  2004 Eloy Lafuente (stronk7) {@link http://stronk7.com}
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
24 class block_calendar_upcoming extends block_base {
26     /**
27      * Initialise the block.
28      */
29     public function init() {
30         $this->title = get_string('pluginname', 'block_calendar_upcoming');
31     }
33     /**
34      * Return the content of this block.
35      *
36      * @return stdClass the content
37      */
38     public function get_content() {
39         global $CFG;
41         require_once($CFG->dirroot.'/calendar/lib.php');
43         if ($this->content !== null) {
44             return $this->content;
45         }
46         $this->content = new stdClass;
47         $this->content->text = '';
49         $renderer = $this->page->get_renderer('core_calendar');
50         $courseid = $this->page->course->id;
51         $issite = ($courseid == SITEID);
53         if ($issite) {
54             // Being displayed at site level. This will cause the filter to fall back to auto-detecting
55             // the list of courses it will be grabbing events from.
56             $course = get_site();
57             $courses = calendar_get_default_courses();
58         } else {
59             // Forcibly filter events to include only those from the particular course we are in.
60             $course = $this->page->course;
61             $courses = [$course->id => $course];
62         }
63         $calendar = new calendar_information(0, 0, 0, time());
64         $calendar->set_sources($course, $courses, $this->page->category);
66         list($data, $template) = calendar_get_view($calendar, 'upcoming_mini');
68         $this->content->text .= $renderer->render_from_template($template, $data);
70         $this->content->footer = '<div class="gotocal">
71                 <a href="'.$CFG->wwwroot.'/calendar/view.php?view=upcoming&amp;course='.$courseid.'">'.
72                 get_string('gotocalendar', 'calendar').'</a>...</div>';
74         return $this->content;
75     }
76 }