MDL-63044 block_timeline: add timeline block
[moodle.git] / blocks / timeline / block_timeline.php
CommitLineData
1e44de35
RW
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 the class for the Timeline block.
19 *
20 * @package block_timeline
21 * @copyright 2018 Ryan Wyllie <ryan@moodle.com>
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 */
24
25defined('MOODLE_INTERNAL') || die();
26
27/**
28 * Timeline block class.
29 *
30 * @package block_timeline
31 * @copyright 2018 Ryan Wyllie <ryan@moodle.com>
32 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
33 */
34class block_timeline extends block_base {
35
36 /**
37 * Init.
38 */
39 public function init() {
40 $this->title = get_string('pluginname', 'block_timeline');
41 }
42
43 /**
44 * Returns the contents.
45 *
46 * @return stdClass contents of block
47 */
48 public function get_content() {
49 if (isset($this->content)) {
50 return $this->content;
51 }
52
53 $renderable = new \block_timeline\output\main();
54 $renderer = $this->page->get_renderer('block_timeline');
55
56 $this->content = (object) [
57 'text' => $renderer->render($renderable),
58 'footer' => ''
59 ];
60
61 return $this->content;
62 }
63
64 /**
65 * Locations where block can be displayed.
66 *
67 * @return array
68 */
69 public function applicable_formats() {
70 return array('my' => true);
71 }
72}