| 1 |
efrain |
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 |
* Behaviour for a base abstract layout.
|
|
|
19 |
*
|
|
|
20 |
* @package block_multiblock
|
|
|
21 |
* @copyright 2020 Peter Spicer <peter.spicer@catalyst-eu.net>
|
|
|
22 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
23 |
*/
|
|
|
24 |
|
|
|
25 |
namespace block_multiblock\layout;
|
|
|
26 |
|
|
|
27 |
/**
|
|
|
28 |
* Behaviour for a base abstract layout.
|
|
|
29 |
*
|
|
|
30 |
* @package block_multiblock
|
|
|
31 |
* @copyright 2020 Peter Spicer <peter.spicer@catalyst-eu.net>
|
|
|
32 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
33 |
*/
|
|
|
34 |
abstract class abstract_layout {
|
|
|
35 |
|
|
|
36 |
/**
|
|
|
37 |
* Returns the recommended uses for this block.
|
|
|
38 |
*
|
|
|
39 |
* @return string 'sidebar' or 'main' to suggest which is recommended for this block.
|
|
|
40 |
*/
|
|
|
41 |
abstract public function get_suggested_use() : string;
|
|
|
42 |
|
|
|
43 |
/**
|
|
|
44 |
* Returns the internal ID that this layout would use and be identified by.
|
|
|
45 |
*
|
|
|
46 |
* Defaults to the class name.
|
|
|
47 |
*
|
|
|
48 |
* @return string The layout ID.
|
|
|
49 |
*/
|
|
|
50 |
public function get_layout_id() : string {
|
|
|
51 |
return substr(strrchr(get_class($this), '\\'), 1);
|
|
|
52 |
}
|
|
|
53 |
|
|
|
54 |
/**
|
|
|
55 |
* Returns the block layout's name.
|
|
|
56 |
*
|
|
|
57 |
* @return string The layout's name.
|
|
|
58 |
*/
|
|
|
59 |
public function get_name() : string {
|
|
|
60 |
return get_string('presentation:' . $this->get_layout_id(), 'block_multiblock');
|
|
|
61 |
}
|
|
|
62 |
|
|
|
63 |
/**
|
|
|
64 |
* Returns whether this block layout requires a title for sub-blocks.
|
|
|
65 |
*
|
|
|
66 |
* @return bool True if the sub-block title is required.
|
|
|
67 |
*/
|
|
|
68 |
public function requires_title() : bool {
|
|
|
69 |
return true;
|
|
|
70 |
}
|
|
|
71 |
|
|
|
72 |
/**
|
|
|
73 |
* Returns the Mustache template required to render this block.
|
|
|
74 |
*
|
|
|
75 |
* @return string The Mustache template.
|
|
|
76 |
*/
|
|
|
77 |
public function get_template() : string {
|
|
|
78 |
return 'block_multiblock/' . $this->get_layout_id();
|
|
|
79 |
}
|
|
|
80 |
}
|