forked from willianmano/moodle-theme_moove
-
Notifications
You must be signed in to change notification settings - Fork 0
/
lib.php
297 lines (254 loc) · 10.6 KB
/
lib.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Theme functions.
*
* @package theme_moove
* @copyright 2017 Willian Mano - http://conecti.me
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
/**
* Inject additional SCSS.
*
* @param theme_config $theme The theme config object.
* @return string
*/
function theme_moove_get_extra_scss($theme) {
$scss = $theme->settings->scss;
$scss .= theme_moove_set_headerimg($theme);
$scss .= theme_moove_set_topfooterimg($theme);
$scss .= theme_moove_set_loginbgimg($theme);
return $scss;
}
/**
* Adds the cover to CSS.
*
* @param theme_config $theme The theme config object.
* @return string
*/
function theme_moove_set_headerimg($theme) {
global $OUTPUT;
$headerimg = $theme->setting_file_url('headerimg', 'headerimg');
if (is_null($headerimg)) {
$headerimg = $OUTPUT->image_url('headerimg', 'theme');
}
$headercss = "#page-site-index.notloggedin #page-header {background-image: url('$headerimg');}";
return $headercss;
}
/**
* Adds the footer image to CSS.
*
* @param theme_config $theme The theme config object.
* @return string
*/
function theme_moove_set_topfooterimg($theme) {
global $OUTPUT;
$topfooterimg = $theme->setting_file_url('topfooterimg', 'topfooterimg');
if (is_null($topfooterimg)) {
$topfooterimg = $OUTPUT->image_url('footer-bg', 'theme');
}
$headercss = "#top-footer {background-image: url('$topfooterimg');}";
return $headercss;
}
/**
* Adds the login page background image to CSS.
*
* @param theme_config $theme The theme config object.
* @return string
*/
function theme_moove_set_loginbgimg($theme) {
global $OUTPUT;
$loginbgimg = $theme->setting_file_url('loginbgimg', 'loginbgimg');
if (is_null($loginbgimg)) {
$loginbgimg = $OUTPUT->image_url('login_bg', 'theme');
}
$headercss = "#page-login-index.moove-login #page-wrapper #page {background-image: url('$loginbgimg');}";
return $headercss;
}
/**
* Returns the main SCSS content.
*
* @param theme_config $theme The theme config object.
* @return string
*/
function theme_moove_get_main_scss_content($theme) {
global $CFG;
$scss = '';
$filename = !empty($theme->settings->preset) ? $theme->settings->preset : null;
$fs = get_file_storage();
$context = context_system::instance();
if ($filename == 'default.scss') {
// We still load the default preset files directly from the boost theme. No sense in duplicating them.
$scss .= file_get_contents($CFG->dirroot . '/theme/boost/scss/preset/default.scss');
} else if ($filename == 'plain.scss') {
// We still load the default preset files directly from the boost theme. No sense in duplicating them.
$scss .= file_get_contents($CFG->dirroot . '/theme/boost/scss/preset/plain.scss');
} else if ($filename && ($presetfile = $fs->get_file($context->id, 'theme_moove', 'preset', 0, '/', $filename))) {
// This preset file was fetched from the file area for theme_moove and not theme_boost (see the line above).
$scss .= $presetfile->get_content();
} else {
// Safety fallback - maybe new installs etc.
$scss .= file_get_contents($CFG->dirroot . '/theme/boost/scss/preset/default.scss');
}
// Moove scss.
$moovevariables = file_get_contents($CFG->dirroot . '/theme/moove/scss/moove/_variables.scss');
$moove = file_get_contents($CFG->dirroot . '/theme/moove/scss/moove.scss');
// Combine them together.
return $moovevariables . "\n" . $scss . "\n" . $moove;
}
/**
* Get SCSS to prepend.
*
* @param theme_config $theme The theme config object.
* @return string
*/
function theme_moove_get_pre_scss($theme) {
$scss = '';
$configurable = [
// Config key => [variableName, ...].
'brandcolor' => ['brand-primary'],
'navbarheadercolor' => 'navbar-header-color'
];
// Prepend variables first.
foreach ($configurable as $configkey => $targets) {
$value = isset($theme->settings->{$configkey}) ? $theme->settings->{$configkey} : null;
if (empty($value)) {
continue;
}
array_map(function($target) use (&$scss, $value) {
$scss .= '$' . $target . ': ' . $value . ";\n";
}, (array) $targets);
}
// Prepend pre-scss.
if (!empty($theme->settings->scsspre)) {
$scss .= $theme->settings->scsspre;
}
return $scss;
}
/**
* Serves any files associated with the theme settings.
*
* @param stdClass $course
* @param stdClass $cm
* @param context $context
* @param string $filearea
* @param array $args
* @param bool $forcedownload
* @param array $options
* @return mixed
*/
function theme_moove_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options = array()) {
$theme = theme_config::load('moove');
if ($context->contextlevel == CONTEXT_SYSTEM and $filearea === 'logo') {
return $theme->setting_file_serve('logo', $args, $forcedownload, $options);
} else if ($context->contextlevel == CONTEXT_SYSTEM and $filearea === 'headerimg') {
return $theme->setting_file_serve('headerimg', $args, $forcedownload, $options);
} else if ($context->contextlevel == CONTEXT_SYSTEM and $filearea === 'marketing1icon') {
return $theme->setting_file_serve('marketing1icon', $args, $forcedownload, $options);
} else if ($context->contextlevel == CONTEXT_SYSTEM and $filearea === 'marketing2icon') {
return $theme->setting_file_serve('marketing2icon', $args, $forcedownload, $options);
} else if ($context->contextlevel == CONTEXT_SYSTEM and $filearea === 'marketing3icon') {
return $theme->setting_file_serve('marketing3icon', $args, $forcedownload, $options);
} else if ($context->contextlevel == CONTEXT_SYSTEM and $filearea === 'marketing4icon') {
return $theme->setting_file_serve('marketing4icon', $args, $forcedownload, $options);
} else if ($context->contextlevel == CONTEXT_SYSTEM and $filearea === 'topfooterimg') {
return $theme->setting_file_serve('topfooterimg', $args, $forcedownload, $options);
} else if ($context->contextlevel == CONTEXT_SYSTEM and $filearea === 'loginbgimg') {
return $theme->setting_file_serve('loginbgimg', $args, $forcedownload, $options);
} else if ($context->contextlevel == CONTEXT_SYSTEM and $filearea === 'favicon') {
return $theme->setting_file_serve('favicon', $args, $forcedownload, $options);
} else if ($context->contextlevel == CONTEXT_SYSTEM and preg_match("/^sliderimage[1-9][0-9]?$/", $filearea) !== false) {
return $theme->setting_file_serve($filearea, $args, $forcedownload, $options);
} else {
send_file_not_found();
}
}
/**
* Get theme setting
*
* @param string $setting
* @param bool $format
* @return string
*/
function theme_moove_get_setting($setting, $format = false) {
$theme = theme_config::load('moove');
if (empty($theme->settings->$setting)) {
return false;
} else if (!$format) {
return $theme->settings->$setting;
} else if ($format === 'format_text') {
return format_text($theme->settings->$setting, FORMAT_PLAIN);
} else if ($format === 'format_html') {
return format_text($theme->settings->$setting, FORMAT_HTML, array('trusted' => true, 'noclean' => true));
} else {
return format_string($theme->settings->$setting);
}
}
/**
* Fumble with Moodle's global navigation by leveraging Moodle's *_extend_navigation() hook.
*
* @param global_navigation $navigation
*/
function theme_moove_boostnavigation_extend_navigation(global_navigation $navigation) {
global $CFG;
// Check if admin wanted us to remove the mycourses node from Boost's nav drawer.
if ($mycoursesnode = $navigation->find('mycourses', global_navigation::TYPE_ROOTNODE)) {
// Hide all courses below the mycourses node.
$mycourseschildrennodeskeys = $mycoursesnode->get_children_key_list();
foreach ($mycourseschildrennodeskeys as $k) {
// If the admin decided to display categories, things get slightly complicated.
if ($CFG->navshowmycoursecategories) {
// We need to find all children nodes first.
$allchildrennodes = theme_moove_boostnavigation_get_all_childrenkeys($mycoursesnode->get($k));
// Then we can hide each children node.
// Unfortunately, the children nodes have navigation_node type TYPE_MY_CATEGORY or navigation_node type
// TYPE_COURSE, thus we need to search without a specific navigation_node type.
foreach ($allchildrennodes as $cn) {
$mycoursesnode->find($cn, null)->showinflatnavigation = false;
}
} else {
// Otherwise we have a flat navigation tree and hiding the courses is easy.
$mycoursesnode->get($k)->showinflatnavigation = false;
}
}
}
}
/**
* Moodle core does not have a built-in functionality to get all keys of all children of a navigation node,
* so we need to get these ourselves.
*
* @param navigation_node $navigationnode
* @return array
*/
function theme_moove_boostnavigation_get_all_childrenkeys(navigation_node $navigationnode) {
// Empty array to hold all children.
$allchildren = array();
// No, this node does not have children anymore.
if (count($navigationnode->children) == 0) {
return array();
}
// Get own children keys.
$childrennodeskeys = $navigationnode->get_children_key_list();
// Get all children keys of our children recursively.
foreach ($childrennodeskeys as $ck) {
$allchildren = array_merge($allchildren, theme_moove_boostnavigation_get_all_childrenkeys($navigationnode->get($ck)));
}
// And add our own children keys to the result.
$allchildren = array_merge($allchildren, $childrennodeskeys);
// Return everything.
return $allchildren;
}