2 // This file is part of Moodle - http://moodle.org/
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.
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.
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/>.
18 * Functions for generating the HTML that Moodle should output.
20 * Please see http://docs.moodle.org/en/Developement:How_Moodle_outputs_HTML
23 * @copyright 2009 Tim Hunt
24 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
29 defined('MOODLE_INTERNAL') ||
die();
31 require_once($CFG->libdir
.'/outputcomponents.php');
32 require_once($CFG->libdir
.'/outputactions.php');
33 require_once($CFG->libdir
.'/outputfactories.php');
34 require_once($CFG->libdir
.'/outputrenderers.php');
35 require_once($CFG->libdir
.'/outputrequirementslib.php');
38 * Returns current theme revision number.
42 function theme_get_revision() {
45 if (empty($CFG->themedesignermode
)) {
46 if (empty($CFG->themerev
)) {
47 // This only happens during install. It doesn't matter what themerev we use as long as it's positive.
50 return $CFG->themerev
;
59 * Returns current theme sub revision number. This is the revision for
60 * this theme exclusively, not the global theme revision.
62 * @param string $themename The non-frankenstyle name of the theme
65 function theme_get_sub_revision_for_theme($themename) {
68 if (empty($CFG->themedesignermode
)) {
69 $pluginname = "theme_{$themename}";
70 $revision = during_initial_install() ?
null : get_config($pluginname, 'themerev');
72 if (empty($revision)) {
73 // This only happens during install. It doesn't matter what themerev we use as long as it's positive.
84 * Calculates and returns the next theme revision number.
88 function theme_get_next_revision() {
92 if (isset($CFG->themerev
) and $next <= $CFG->themerev
and $CFG->themerev
- $next < 60*60) {
93 // This resolves problems when reset is requested repeatedly within 1s,
94 // the < 1h condition prevents accidental switching to future dates
95 // because we might not recover from it.
96 $next = $CFG->themerev+
1;
103 * Calculates and returns the next theme revision number.
105 * @param string $themename The non-frankenstyle name of the theme
108 function theme_get_next_sub_revision_for_theme($themename) {
112 $current = theme_get_sub_revision_for_theme($themename);
113 if ($next <= $current and $current - $next < 60 * 60) {
114 // This resolves problems when reset is requested repeatedly within 1s,
115 // the < 1h condition prevents accidental switching to future dates
116 // because we might not recover from it.
117 $next = $current +
1;
124 * Sets the current theme revision number.
126 * @param int $revision The new theme revision number
128 function theme_set_revision($revision) {
129 set_config('themerev', $revision);
133 * Sets the current theme revision number for a specific theme.
134 * This does not affect the global themerev value.
136 * @param string $themename The non-frankenstyle name of the theme
137 * @param int $revision The new theme revision number
139 function theme_set_sub_revision_for_theme($themename, $revision) {
140 set_config('themerev', $revision, "theme_{$themename}");
144 * Get the path to a theme config.php file.
146 * @param string $themename The non-frankenstyle name of the theme to check
148 function theme_get_config_file_path($themename) {
151 if (file_exists("{$CFG->dirroot}/theme/{$themename}/config.php")) {
152 return "{$CFG->dirroot}/theme/{$themename}/config.php";
153 } else if (!empty($CFG->themedir
) and file_exists("{$CFG->themedir}/{$themename}/config.php")) {
154 return "{$CFG->themedir}/{$themename}/config.php";
161 * Get the path to the local cached CSS file.
163 * @param string $themename The non-frankenstyle theme name.
164 * @param int $globalrevision The global theme revision.
165 * @param int $themerevision The theme specific revision.
166 * @param string $direction Either 'ltr' or 'rtl' (case sensitive).
168 function theme_get_css_filename($themename, $globalrevision, $themerevision, $direction) {
171 $path = "{$CFG->localcachedir}/theme/{$globalrevision}/{$themename}/css";
172 $filename = $direction == 'rtl' ?
"all-rtl_{$themerevision}" : "all_{$themerevision}";
173 return "{$path}/{$filename}.css";
177 * Generates and saves the CSS files for the given theme configs.
179 * @param theme_config[] $themeconfigs An array of theme_config instances.
180 * @param array $directions Must be a subset of ['rtl', 'ltr'].
181 * @param bool $cache Should the generated files be stored in local cache.
183 function theme_build_css_for_themes($themeconfigs = [], $directions = ['rtl', 'ltr'], $cache = true) {
186 if (empty($themeconfigs)) {
190 require_once("{$CFG->libdir}/csslib.php");
193 $themerev = theme_get_revision();
194 // Make sure the local cache directory exists.
195 make_localcache_directory('theme');
197 foreach ($themeconfigs as $themeconfig) {
199 $oldrevision = theme_get_sub_revision_for_theme($themeconfig->name
);
200 $newrevision = theme_get_next_sub_revision_for_theme($themeconfig->name
);
202 // First generate all the new css.
203 foreach ($directions as $direction) {
204 // Lock it on. Technically we should build all themes for SVG and no SVG - but ie9 is out of support.
205 $themeconfig->force_svg_use(true);
206 $themeconfig->set_rtl_mode(($direction === 'rtl'));
208 $themecss[$direction] = $themeconfig->get_css_content();
210 $themeconfig->set_css_content_cache($themecss[$direction]);
211 $filename = theme_get_css_filename($themeconfig->name
, $themerev, $newrevision, $direction);
212 css_store_css($themeconfig, $filename, $themecss[$direction]);
215 $themescss[] = $themecss;
218 // Only update the theme revision after we've successfully created the
220 theme_set_sub_revision_for_theme($themeconfig->name
, $newrevision);
222 // Now purge old files. We must purge all old files in the local cache
223 // because we've incremented the theme sub revision. This will leave any
224 // files with the old revision inaccessbile so we might as well removed
226 foreach (['ltr', 'rtl'] as $direction) {
227 $oldcss = theme_get_css_filename($themeconfig->name
, $themerev, $oldrevision, $direction);
228 if (file_exists($oldcss)) {
239 * Invalidate all server and client side caches.
241 * This method deletes the physical directory that is used to cache the theme
242 * files used for serving.
243 * Because it deletes the main theme cache directory all themes are reset by
246 function theme_reset_all_caches() {
249 $next = theme_get_next_revision();
250 theme_set_revision($next);
252 if (!empty($CFG->themedesignermode
)) {
253 $cache = cache
::make_from_params(cache_store
::MODE_APPLICATION
, 'core', 'themedesigner');
257 // Purge compiled post processed css.
258 cache
::make('core', 'postprocessedcss')->purge();
261 $PAGE->reload_theme();
266 * Enable or disable theme designer mode.
270 function theme_set_designer_mod($state) {
271 set_config('themedesignermode', (int)!empty($state));
272 // Reset caches after switching mode so that any designer mode caches get purged too.
273 theme_reset_all_caches();
277 * Checks if the given device has a theme defined in config.php.
281 function theme_is_device_locked($device) {
283 $themeconfigname = core_useragent
::get_device_type_cfg_var_name($device);
284 return isset($CFG->config_php_settings
[$themeconfigname]);
288 * Returns the theme named defined in config.php for the given device.
290 * @return string or null
292 function theme_get_locked_theme_for_device($device) {
295 if (!theme_is_device_locked($device)) {
299 $themeconfigname = core_useragent
::get_device_type_cfg_var_name($device);
300 return $CFG->config_php_settings
[$themeconfigname];
304 * This class represents the configuration variables of a Moodle theme.
306 * All the variables with access: public below (with a few exceptions that are marked)
307 * are the properties you can set in your themes config.php file.
309 * There are also some methods and protected variables that are part of the inner
310 * workings of Moodle's themes system. If you are just editing a themes config.php
311 * file, you can just ignore those, and the following information for developers.
313 * Normally, to create an instance of this class, you should use the
314 * {@link theme_config::load()} factory method to load a themes config.php file.
315 * However, normally you don't need to bother, because moodle_page (that is, $PAGE)
316 * will create one for you, accessible as $PAGE->theme.
318 * @copyright 2009 Tim Hunt
319 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
327 * @var string Default theme, used when requested theme not found.
329 const DEFAULT_THEME
= 'boost';
331 /** The key under which the SCSS file is stored amongst the CSS files. */
332 const SCSS_KEY
= '__SCSS__';
335 * @var array You can base your theme on other themes by linking to the other theme as
336 * parents. This lets you use the CSS and layouts from the other themes
337 * (see {@link theme_config::$layouts}).
338 * That makes it easy to create a new theme that is similar to another one
339 * but with a few changes. In this themes CSS you only need to override
340 * those rules you want to change.
345 * @var array The names of all the stylesheets from this theme that you would
346 * like included, in order. Give the names of the files without .css.
348 public $sheets = array();
351 * @var array The names of all the stylesheets from parents that should be excluded.
352 * true value may be used to specify all parents or all themes from one parent.
353 * If no value specified value from parent theme used.
355 public $parents_exclude_sheets = null;
358 * @var array List of plugin sheets to be excluded.
359 * If no value specified value from parent theme used.
361 public $plugins_exclude_sheets = null;
364 * @var array List of style sheets that are included in the text editor bodies.
365 * Sheets from parent themes are used automatically and can not be excluded.
367 public $editor_sheets = array();
370 * @var bool Whether a fallback version of the stylesheet will be used
371 * whilst the final version is generated.
373 public $usefallback = false;
376 * @var array The names of all the javascript files this theme that you would
377 * like included from head, in order. Give the names of the files without .js.
379 public $javascripts = array();
382 * @var array The names of all the javascript files this theme that you would
383 * like included from footer, in order. Give the names of the files without .js.
385 public $javascripts_footer = array();
388 * @var array The names of all the javascript files from parents that should
389 * be excluded. true value may be used to specify all parents or all themes
391 * If no value specified value from parent theme used.
393 public $parents_exclude_javascripts = null;
396 * @var array Which file to use for each page layout.
398 * This is an array of arrays. The keys of the outer array are the different layouts.
399 * Pages in Moodle are using several different layouts like 'normal', 'course', 'home',
400 * 'popup', 'form', .... The most reliable way to get a complete list is to look at
401 * {@link http://cvs.moodle.org/moodle/theme/base/config.php?view=markup the base theme config.php file}.
402 * That file also has a good example of how to set this setting.
404 * For each layout, the value in the outer array is an array that describes
405 * how you want that type of page to look. For example
407 * $THEME->layouts = array(
408 * // Most pages - if we encounter an unknown or a missing page type, this one is used.
409 * 'standard' => array(
410 * 'theme' = 'mytheme',
411 * 'file' => 'normal.php',
412 * 'regions' => array('side-pre', 'side-post'),
413 * 'defaultregion' => 'side-post'
415 * // The site home page.
417 * 'theme' = 'mytheme',
418 * 'file' => 'home.php',
419 * 'regions' => array('side-pre', 'side-post'),
420 * 'defaultregion' => 'side-post'
426 * 'theme' name of the theme where is the layout located
427 * 'file' is the layout file to use for this type of page.
428 * layout files are stored in layout subfolder
429 * 'regions' This lists the regions on the page where blocks may appear. For
430 * each region you list here, your layout file must include a call to
432 * echo $OUTPUT->blocks_for_region($regionname);
434 * or equivalent so that the blocks are actually visible.
436 * 'defaultregion' If the list of regions is non-empty, then you must pick
437 * one of the one of them as 'default'. This has two meanings. First, this is
438 * where new blocks are added. Second, if there are any blocks associated with
439 * the page, but in non-existent regions, they appear here. (Imaging, for example,
440 * that someone added blocks using a different theme that used different region
441 * names, and then switched to this theme.)
443 public $layouts = array();
446 * @var string Name of the renderer factory class to use. Must implement the
447 * {@link renderer_factory} interface.
449 * This is an advanced feature. Moodle output is generated by 'renderers',
450 * you can customise the HTML that is output by writing custom renderers,
451 * and then you need to specify 'renderer factory' so that Moodle can find
454 * There are some renderer factories supplied with Moodle. Please follow these
455 * links to see what they do.
457 * <li>{@link standard_renderer_factory} - the default.</li>
458 * <li>{@link theme_overridden_renderer_factory} - use this if you want to write
459 * your own custom renderers in a lib.php file in this theme (or the parent theme).</li>
462 public $rendererfactory = 'standard_renderer_factory';
465 * @var string Function to do custom CSS post-processing.
467 * This is an advanced feature. If you want to do custom post-processing on the
468 * CSS before it is output (for example, to replace certain variable names
469 * with particular values) you can give the name of a function here.
471 public $csspostprocess = null;
474 * @var string Function to do custom CSS post-processing on a parsed CSS tree.
476 * This is an advanced feature. If you want to do custom post-processing on the
477 * CSS before it is output, you can provide the name of the function here. The
478 * function will receive a CSS tree document as first parameter, and the theme_config
479 * object as second parameter. A return value is not required, the tree can
480 * be edited in place.
482 public $csstreepostprocessor = null;
485 * @var string Accessibility: Right arrow-like character is
486 * used in the breadcrumb trail, course navigation menu
487 * (previous/next activity), calendar, and search forum block.
488 * If the theme does not set characters, appropriate defaults
489 * are set automatically. Please DO NOT
490 * use < > » - these are confusing for blind users.
492 public $rarrow = null;
495 * @var string Accessibility: Left arrow-like character is
496 * used in the breadcrumb trail, course navigation menu
497 * (previous/next activity), calendar, and search forum block.
498 * If the theme does not set characters, appropriate defaults
499 * are set automatically. Please DO NOT
500 * use < > » - these are confusing for blind users.
502 public $larrow = null;
505 * @var string Accessibility: Up arrow-like character is used in
506 * the book heirarchical navigation.
507 * If the theme does not set characters, appropriate defaults
508 * are set automatically. Please DO NOT
509 * use ^ - this is confusing for blind users.
511 public $uarrow = null;
514 * @var string Accessibility: Down arrow-like character.
515 * If the theme does not set characters, appropriate defaults
516 * are set automatically.
518 public $darrow = null;
521 * @var bool Some themes may want to disable ajax course editing.
523 public $enablecourseajax = true;
526 * @var string Determines served document types
527 * - 'html5' the only officially supported doctype in Moodle
528 * - 'xhtml5' may be used in development for validation (not intended for production servers!)
529 * - 'xhtml' XHTML 1.0 Strict for legacy themes only
531 public $doctype = 'html5';
534 * @var string requiredblocks If set to a string, will list the block types that cannot be deleted. Defaults to
535 * navigation and settings.
537 public $requiredblocks = false;
539 //==Following properties are not configurable from theme config.php==
542 * @var string The name of this theme. Set automatically when this theme is
543 * loaded. This can not be set in theme config.php
548 * @var string The folder where this themes files are stored. This is set
549 * automatically. This can not be set in theme config.php
554 * @var stdClass Theme settings stored in config_plugins table.
555 * This can not be set in theme config.php
557 public $settings = null;
560 * @var bool If set to true and the theme enables the dock then blocks will be able
561 * to be moved to the special dock
563 public $enable_dock = false;
566 * @var bool If set to true then this theme will not be shown in the theme selector unless
567 * theme designer mode is turned on.
569 public $hidefromselector = false;
572 * @var array list of YUI CSS modules to be included on each page. This may be used
573 * to remove cssreset and use cssnormalise module instead.
575 public $yuicssmodules = array('cssreset', 'cssfonts', 'cssgrids', 'cssbase');
578 * An associative array of block manipulations that should be made if the user is using an rtl language.
579 * The key is the original block region, and the value is the block region to change to.
580 * This is used when displaying blocks for regions only.
583 public $blockrtlmanipulations = array();
586 * @var renderer_factory Instance of the renderer_factory implementation
587 * we are using. Implementation detail.
589 protected $rf = null;
592 * @var array List of parent config objects.
594 protected $parent_configs = array();
597 * Used to determine whether we can serve SVG images or not.
600 private $usesvg = null;
603 * Whether in RTL mode or not.
606 protected $rtlmode = false;
609 * The LESS file to compile. When set, the theme will attempt to compile the file itself.
612 public $lessfile = false;
615 * The SCSS file to compile (without .scss), located in the scss/ folder of the theme.
616 * Or a Closure, which receives the theme_config as argument and must
617 * return the SCSS content. This setting takes precedence over self::$lessfile.
618 * @var string|Closure
620 public $scss = false;
623 * Local cache of the SCSS property.
626 protected $scsscache = null;
629 * The name of the function to call to get the LESS code to inject.
632 public $extralesscallback = null;
635 * The name of the function to call to get the SCSS code to inject.
638 public $extrascsscallback = null;
641 * The name of the function to call to get extra LESS variables.
644 public $lessvariablescallback = null;
647 * The name of the function to call to get SCSS to prepend.
650 public $prescsscallback = null;
653 * Sets the render method that should be used for rendering custom block regions by scripts such as my/index.php
654 * Defaults to {@link core_renderer::blocks_for_region()}
657 public $blockrendermethod = null;
660 * Remember the results of icon remapping for the current page.
663 public $remapiconcache = [];
666 * Load the config.php file for a particular theme, and return an instance
667 * of this class. (That is, this is a factory method.)
669 * @param string $themename the name of the theme.
670 * @return theme_config an instance of this class.
672 public static function load($themename) {
675 // load theme settings from db
677 $settings = get_config('theme_'.$themename);
678 } catch (dml_exception
$e) {
679 // most probably moodle tables not created yet
680 $settings = new stdClass();
683 if ($config = theme_config
::find_theme_config($themename, $settings)) {
684 return new theme_config($config);
686 } else if ($themename == theme_config
::DEFAULT_THEME
) {
687 throw new coding_exception('Default theme '.theme_config
::DEFAULT_THEME
.' not available or broken!');
689 } else if ($config = theme_config
::find_theme_config($CFG->theme
, $settings)) {
690 debugging('This page should be using theme ' . $themename .
691 ' which cannot be initialised. Falling back to the site theme ' . $CFG->theme
, DEBUG_NORMAL
);
692 return new theme_config($config);
695 // bad luck, the requested theme has some problems - admin see details in theme config
696 debugging('This page should be using theme ' . $themename .
697 ' which cannot be initialised. Nor can the site theme ' . $CFG->theme
.
698 '. Falling back to ' . theme_config
::DEFAULT_THEME
, DEBUG_NORMAL
);
699 return new theme_config(theme_config
::find_theme_config(theme_config
::DEFAULT_THEME
, $settings));
704 * Theme diagnostic code. It is very problematic to send debug output
705 * to the actual CSS file, instead this functions is supposed to
706 * diagnose given theme and highlights all potential problems.
707 * This information should be available from the theme selection page
708 * or some other debug page for theme designers.
710 * @param string $themename
711 * @return array description of problems
713 public static function diagnose($themename) {
719 * Private constructor, can be called only from the factory method.
720 * @param stdClass $config
722 private function __construct($config) {
723 global $CFG; //needed for included lib.php files
725 $this->settings
= $config->settings
;
726 $this->name
= $config->name
;
727 $this->dir
= $config->dir
;
729 if ($this->name
!= 'bootstrapbase') {
730 $baseconfig = theme_config
::find_theme_config('bootstrapbase', $this->settings
);
732 $baseconfig = $config;
735 $configurable = array(
736 'parents', 'sheets', 'parents_exclude_sheets', 'plugins_exclude_sheets', 'usefallback',
737 'javascripts', 'javascripts_footer', 'parents_exclude_javascripts',
738 'layouts', 'enable_dock', 'enablecourseajax', 'requiredblocks',
739 'rendererfactory', 'csspostprocess', 'editor_sheets', 'rarrow', 'larrow', 'uarrow', 'darrow',
740 'hidefromselector', 'doctype', 'yuicssmodules', 'blockrtlmanipulations',
741 'lessfile', 'extralesscallback', 'lessvariablescallback', 'blockrendermethod',
742 'scss', 'extrascsscallback', 'prescsscallback', 'csstreepostprocessor', 'addblockposition', 'iconsystem');
744 foreach ($config as $key=>$value) {
745 if (in_array($key, $configurable)) {
746 $this->$key = $value;
750 // verify all parents and load configs and renderers
751 foreach ($this->parents
as $parent) {
752 if (!$parent_config = theme_config
::find_theme_config($parent, $this->settings
)) {
753 // this is not good - better exclude faulty parents
756 $libfile = $parent_config->dir
.'/lib.php';
757 if (is_readable($libfile)) {
758 // theme may store various function here
759 include_once($libfile);
761 $renderersfile = $parent_config->dir
.'/renderers.php';
762 if (is_readable($renderersfile)) {
763 // may contain core and plugin renderers and renderer factory
764 include_once($renderersfile);
766 $this->parent_configs
[$parent] = $parent_config;
768 $libfile = $this->dir
.'/lib.php';
769 if (is_readable($libfile)) {
770 // theme may store various function here
771 include_once($libfile);
773 $rendererfile = $this->dir
.'/renderers.php';
774 if (is_readable($rendererfile)) {
775 // may contain core and plugin renderers and renderer factory
776 include_once($rendererfile);
778 // check if renderers.php file is missnamed renderer.php
779 if (is_readable($this->dir
.'/renderer.php')) {
780 debugging('Developer hint: '.$this->dir
.'/renderer.php should be renamed to ' . $this->dir
."/renderers.php.
781 See: http://docs.moodle.org/dev/Output_renderers#Theme_renderers.", DEBUG_DEVELOPER
);
785 // cascade all layouts properly
786 foreach ($baseconfig->layouts
as $layout=>$value) {
787 if (!isset($this->layouts
[$layout])) {
788 foreach ($this->parent_configs
as $parent_config) {
789 if (isset($parent_config->layouts
[$layout])) {
790 $this->layouts
[$layout] = $parent_config->layouts
[$layout];
794 $this->layouts
[$layout] = $value;
798 //fix arrows if needed
799 $this->check_theme_arrows();
803 * Let the theme initialise the page object (usually $PAGE).
805 * This may be used for example to request jQuery in add-ons.
807 * @param moodle_page $page
809 public function init_page(moodle_page
$page) {
810 $themeinitfunction = 'theme_'.$this->name
.'_page_init';
811 if (function_exists($themeinitfunction)) {
812 $themeinitfunction($page);
817 * Checks if arrows $THEME->rarrow, $THEME->larrow, $THEME->uarrow, $THEME->darrow have been set (theme/-/config.php).
818 * If not it applies sensible defaults.
820 * Accessibility: right and left arrow Unicode characters for breadcrumb, calendar,
821 * search forum block, etc. Important: these are 'silent' in a screen-reader
822 * (unlike > »), and must be accompanied by text.
824 private function check_theme_arrows() {
825 if (!isset($this->rarrow
) and !isset($this->larrow
)) {
826 // Default, looks good in Win XP/IE 6, Win/Firefox 1.5, Win/Netscape 8...
827 // Also OK in Win 9x/2K/IE 5.x
828 $this->rarrow
= '►';
829 $this->larrow
= '◄';
830 $this->uarrow
= '▲';
831 $this->darrow
= '▼';
832 if (empty($_SERVER['HTTP_USER_AGENT'])) {
835 $uagent = $_SERVER['HTTP_USER_AGENT'];
837 if (false !== strpos($uagent, 'Opera')
838 ||
false !== strpos($uagent, 'Mac')) {
839 // Looks good in Win XP/Mac/Opera 8/9, Mac/Firefox 2, Camino, Safari.
840 // Not broken in Mac/IE 5, Mac/Netscape 7 (?).
841 $this->rarrow
= '▶︎';
842 $this->larrow
= '◀︎';
844 elseif ((false !== strpos($uagent, 'Konqueror'))
845 ||
(false !== strpos($uagent, 'Android'))) {
846 // The fonts on Android don't include the characters required for this to work as expected.
847 // So we use the same ones Konqueror uses.
848 $this->rarrow
= '→';
849 $this->larrow
= '←';
850 $this->uarrow
= '↑';
851 $this->darrow
= '↓';
853 elseif (isset($_SERVER['HTTP_ACCEPT_CHARSET'])
854 && false === stripos($_SERVER['HTTP_ACCEPT_CHARSET'], 'utf-8')) {
855 // (Win/IE 5 doesn't set ACCEPT_CHARSET, but handles Unicode.)
856 // To be safe, non-Unicode browsers!
857 $this->rarrow
= '>';
858 $this->larrow
= '<';
863 // RTL support - in RTL languages, swap r and l arrows
864 if (right_to_left()) {
866 $this->rarrow
= $this->larrow
;
873 * Returns output renderer prefixes, these are used when looking
874 * for the overridden renderers in themes.
878 public function renderer_prefixes() {
879 global $CFG; // just in case the included files need it
881 $prefixes = array('theme_'.$this->name
);
883 foreach ($this->parent_configs
as $parent) {
884 $prefixes[] = 'theme_'.$parent->name
;
891 * Returns the stylesheet URL of this editor content
893 * @param bool $encoded false means use & and true use & in URLs
896 public function editor_css_url($encoded=true) {
898 $rev = theme_get_revision();
900 $url = new moodle_url("/theme/styles.php");
901 if (!empty($CFG->slasharguments
)) {
902 $url->set_slashargument('/'.$this->name
.'/'.$rev.'/editor', 'noparam', true);
904 $url->params(array('theme'=>$this->name
,'rev'=>$rev, 'type'=>'editor'));
907 $params = array('theme'=>$this->name
, 'type'=>'editor');
908 $url = new moodle_url('/theme/styles_debug.php', $params);
914 * Returns the content of the CSS to be used in editor content
918 public function editor_css_files() {
921 // First editor plugins.
922 $plugins = core_component
::get_plugin_list('editor');
923 foreach ($plugins as $plugin=>$fulldir) {
924 $sheetfile = "$fulldir/editor_styles.css";
925 if (is_readable($sheetfile)) {
926 $files['plugin_'.$plugin] = $sheetfile;
929 // Then parent themes - base first, the immediate parent last.
930 foreach (array_reverse($this->parent_configs
) as $parent_config) {
931 if (empty($parent_config->editor_sheets
)) {
934 foreach ($parent_config->editor_sheets
as $sheet) {
935 $sheetfile = "$parent_config->dir/style/$sheet.css";
936 if (is_readable($sheetfile)) {
937 $files['parent_'.$parent_config->name
.'_'.$sheet] = $sheetfile;
941 // Finally this theme.
942 if (!empty($this->editor_sheets
)) {
943 foreach ($this->editor_sheets
as $sheet) {
944 $sheetfile = "$this->dir/style/$sheet.css";
945 if (is_readable($sheetfile)) {
946 $files['theme_'.$sheet] = $sheetfile;
955 * Get the stylesheet URL of this theme.
957 * @param moodle_page $page Not used... deprecated?
958 * @return moodle_url[]
960 public function css_urls(moodle_page
$page) {
963 $rev = theme_get_revision();
967 $svg = $this->use_svg_icons();
968 $separate = (core_useragent
::is_ie() && !core_useragent
::check_ie_version('10'));
971 $filename = right_to_left() ?
'all-rtl' : 'all';
972 $url = new moodle_url("/theme/styles.php");
973 $themesubrevision = theme_get_sub_revision_for_theme($this->name
);
975 // Provide the sub revision to allow us to invalidate cached theme CSS
976 // on a per theme basis, rather than globally.
977 if ($themesubrevision && $themesubrevision > 0) {
978 $rev .= "_{$themesubrevision}";
981 if (!empty($CFG->slasharguments
)) {
984 // We add a simple /_s to the start of the path.
985 // The underscore is used to ensure that it isn't a valid theme name.
986 $slashargs .= '/_s'.$slashargs;
988 $slashargs .= '/'.$this->name
.'/'.$rev.'/'.$filename;
990 $slashargs .= '/chunk0';
992 $url->set_slashargument($slashargs, 'noparam', true);
994 $params = array('theme' => $this->name
, 'rev' => $rev, 'type' => $filename);
996 // We add an SVG param so that we know not to serve SVG images.
997 // We do this because all modern browsers support SVG and this param will one day be removed.
998 $params['svg'] = '0';
1001 $params['chunk'] = '0';
1003 $url->params($params);
1008 $baseurl = new moodle_url('/theme/styles_debug.php');
1010 $css = $this->get_css_files(true);
1012 // We add an SVG param so that we know not to serve SVG images.
1013 // We do this because all modern browsers support SVG and this param will one day be removed.
1014 $baseurl->param('svg', '0');
1016 if (right_to_left()) {
1017 $baseurl->param('rtl', 1);
1020 // We might need to chunk long files.
1021 $baseurl->param('chunk', '0');
1023 if (core_useragent
::is_ie()) {
1024 // Lalala, IE does not allow more than 31 linked CSS files from main document.
1025 $urls[] = new moodle_url($baseurl, array('theme'=>$this->name
, 'type'=>'ie', 'subtype'=>'plugins'));
1026 foreach ($css['parents'] as $parent=>$sheets) {
1027 // We need to serve parents individually otherwise we may easily exceed the style limit IE imposes (4096).
1028 $urls[] = new moodle_url($baseurl, array('theme'=>$this->name
,'type'=>'ie', 'subtype'=>'parents', 'sheet'=>$parent));
1030 if ($this->get_scss_property()) {
1031 // No need to define the type as IE here.
1032 $urls[] = new moodle_url($baseurl, array('theme' => $this->name
, 'type' => 'scss'));
1033 } else if (!empty($this->lessfile
)) {
1034 // No need to define the type as IE here.
1035 $urls[] = new moodle_url($baseurl, array('theme' => $this->name
, 'type' => 'less'));
1037 $urls[] = new moodle_url($baseurl, array('theme'=>$this->name
, 'type'=>'ie', 'subtype'=>'theme'));
1040 foreach ($css['plugins'] as $plugin=>$unused) {
1041 $urls[] = new moodle_url($baseurl, array('theme'=>$this->name
,'type'=>'plugin', 'subtype'=>$plugin));
1043 foreach ($css['parents'] as $parent=>$sheets) {
1044 foreach ($sheets as $sheet=>$unused2) {
1045 $urls[] = new moodle_url($baseurl, array('theme'=>$this->name
,'type'=>'parent', 'subtype'=>$parent, 'sheet'=>$sheet));
1048 foreach ($css['theme'] as $sheet => $filename) {
1049 if ($sheet === self
::SCSS_KEY
) {
1050 // This is the theme SCSS file.
1051 $urls[] = new moodle_url($baseurl, array('theme' => $this->name
, 'type' => 'scss'));
1052 } else if ($sheet === $this->lessfile
) {
1053 // This is the theme LESS file.
1054 $urls[] = new moodle_url($baseurl, array('theme' => $this->name
, 'type' => 'less'));
1056 // Sheet first in order to make long urls easier to read.
1057 $urls[] = new moodle_url($baseurl, array('sheet'=>$sheet, 'theme'=>$this->name
, 'type'=>'theme'));
1067 * Get the whole css stylesheet for production mode.
1069 * NOTE: this method is not expected to be used from any addons.
1071 * @return string CSS markup compressed
1073 public function get_css_content() {
1076 foreach ($this->get_css_files(false) as $type => $value) {
1077 foreach ($value as $identifier => $val) {
1078 if (is_array($val)) {
1079 foreach ($val as $v) {
1080 $csscontent .= file_get_contents($v) . "\n";
1083 if ($type === 'theme' && $identifier === self
::SCSS_KEY
) {
1084 // We need the content from SCSS because this is the SCSS file from the theme.
1085 $csscontent .= $this->get_css_content_from_scss(false);
1086 } else if ($type === 'theme' && $identifier === $this->lessfile
) {
1087 // We need the content from LESS because this is the LESS file from the theme.
1088 $csscontent .= $this->get_css_content_from_less(false);
1090 $csscontent .= file_get_contents($val) . "\n";
1095 $csscontent = $this->post_process($csscontent);
1096 $csscontent = core_minify
::css($csscontent);
1101 * Set post processed CSS content cache.
1103 * @param string $csscontent The post processed CSS content.
1104 * @return bool True if the content was successfully cached.
1106 public function set_css_content_cache($csscontent) {
1108 $cache = cache
::make('core', 'postprocessedcss');
1109 $key = $this->get_css_cache_key();
1111 return $cache->set($key, $csscontent);
1115 * Return whether the post processed CSS content has been cached.
1117 * @return bool Whether the post-processed CSS is available in the cache.
1119 public function has_css_cached_content() {
1121 $key = $this->get_css_cache_key();
1122 $cache = cache
::make('core', 'postprocessedcss');
1124 return $cache->has($key);
1128 * Return cached post processed CSS content.
1130 * @return bool|string The cached css content or false if not found.
1132 public function get_css_cached_content() {
1134 $key = $this->get_css_cache_key();
1135 $cache = cache
::make('core', 'postprocessedcss');
1137 return $cache->get($key);
1141 * Generate the css content cache key.
1143 * @return string The post processed css cache key.
1145 public function get_css_cache_key() {
1146 $nosvg = (!$this->use_svg_icons()) ?
'nosvg_' : '';
1147 $rtlmode = ($this->rtlmode
== true) ?
'rtl' : 'ltr';
1149 return $nosvg . $this->name
. '_' . $rtlmode;
1153 * Get the theme designer css markup,
1154 * the parameters are coming from css_urls().
1156 * NOTE: this method is not expected to be used from any addons.
1158 * @param string $type
1159 * @param string $subtype
1160 * @param string $sheet
1161 * @return string CSS markup
1163 public function get_css_content_debug($type, $subtype, $sheet) {
1165 if ($type === 'scss') {
1166 // The SCSS file of the theme is requested.
1167 $csscontent = $this->get_css_content_from_scss(true);
1168 if ($csscontent !== false) {
1169 return $this->post_process($csscontent);
1172 } else if ($type === 'less') {
1173 // The LESS file of the theme is requested.
1174 $csscontent = $this->get_css_content_from_less(true);
1175 if ($csscontent !== false) {
1176 return $this->post_process($csscontent);
1181 $cssfiles = array();
1182 $css = $this->get_css_files(true);
1184 if ($type === 'ie') {
1185 // IE is a sloppy browser with weird limits, sorry.
1186 if ($subtype === 'plugins') {
1187 $cssfiles = $css['plugins'];
1189 } else if ($subtype === 'parents') {
1190 if (empty($sheet)) {
1191 // Do not bother with the empty parent here.
1193 // Build up the CSS for that parent so we can serve it as one file.
1194 foreach ($css[$subtype][$sheet] as $parent => $css) {
1198 } else if ($subtype === 'theme') {
1199 $cssfiles = $css['theme'];
1200 foreach ($cssfiles as $key => $value) {
1201 if (in_array($key, [$this->lessfile
, self
::SCSS_KEY
])) {
1202 // Remove the LESS/SCSS file from the theme CSS files.
1203 // The LESS/SCSS files use the type 'less' or 'scss', not 'ie'.
1204 unset($cssfiles[$key]);
1209 } else if ($type === 'plugin') {
1210 if (isset($css['plugins'][$subtype])) {
1211 $cssfiles[] = $css['plugins'][$subtype];
1214 } else if ($type === 'parent') {
1215 if (isset($css['parents'][$subtype][$sheet])) {
1216 $cssfiles[] = $css['parents'][$subtype][$sheet];
1219 } else if ($type === 'theme') {
1220 if (isset($css['theme'][$sheet])) {
1221 $cssfiles[] = $css['theme'][$sheet];
1226 foreach ($cssfiles as $file) {
1227 $contents = file_get_contents($file);
1228 $contents = $this->post_process($contents);
1229 $comment = "/** Path: $type $subtype $sheet.' **/\n";
1231 $csscontent .= $comment.$stats.$contents."\n\n";
1238 * Get the whole css stylesheet for editor iframe.
1240 * NOTE: this method is not expected to be used from any addons.
1242 * @return string CSS markup
1244 public function get_css_content_editor() {
1245 // Do not bother to optimise anything here, just very basic stuff.
1246 $cssfiles = $this->editor_css_files();
1248 foreach ($cssfiles as $file) {
1249 $css .= file_get_contents($file)."\n";
1251 return $this->post_process($css);
1255 * Returns an array of organised CSS files required for this output.
1257 * @param bool $themedesigner
1258 * @return array nested array of file paths
1260 protected function get_css_files($themedesigner) {
1264 $cachekey = 'cssfiles';
1265 if ($themedesigner) {
1266 require_once($CFG->dirroot
.'/lib/csslib.php');
1267 // We need some kind of caching here because otherwise the page navigation becomes
1268 // way too slow in theme designer mode. Feel free to create full cache definition later...
1269 $cache = cache
::make_from_params(cache_store
::MODE_APPLICATION
, 'core', 'themedesigner', array('theme' => $this->name
));
1270 if ($files = $cache->get($cachekey)) {
1271 if ($files['created'] > time() - THEME_DESIGNER_CACHE_LIFETIME
) {
1272 unset($files['created']);
1278 $cssfiles = array('plugins'=>array(), 'parents'=>array(), 'theme'=>array());
1280 // Get all plugin sheets.
1281 $excludes = $this->resolve_excludes('plugins_exclude_sheets');
1282 if ($excludes !== true) {
1283 foreach (core_component
::get_plugin_types() as $type=>$unused) {
1284 if ($type === 'theme' ||
(!empty($excludes[$type]) and $excludes[$type] === true)) {
1287 $plugins = core_component
::get_plugin_list($type);
1288 foreach ($plugins as $plugin=>$fulldir) {
1289 if (!empty($excludes[$type]) and is_array($excludes[$type])
1290 and in_array($plugin, $excludes[$type])) {
1294 // Get the CSS from the plugin.
1295 $sheetfile = "$fulldir/styles.css";
1296 if (is_readable($sheetfile)) {
1297 $cssfiles['plugins'][$type.'_'.$plugin] = $sheetfile;
1300 // Create a list of candidate sheets from parents (direct parent last) and current theme.
1301 $candidates = array();
1302 foreach (array_reverse($this->parent_configs
) as $parent_config) {
1303 $candidates[] = $parent_config->name
;
1305 $candidates[] = $this->name
;
1307 // Add the sheets found.
1308 foreach ($candidates as $candidate) {
1309 $sheetthemefile = "$fulldir/styles_{$candidate}.css";
1310 if (is_readable($sheetthemefile)) {
1311 $cssfiles['plugins'][$type.'_'.$plugin.'_'.$candidate] = $sheetthemefile;
1318 // Find out wanted parent sheets.
1319 $excludes = $this->resolve_excludes('parents_exclude_sheets');
1320 if ($excludes !== true) {
1321 foreach (array_reverse($this->parent_configs
) as $parent_config) { // Base first, the immediate parent last.
1322 $parent = $parent_config->name
;
1323 if (empty($parent_config->sheets
) ||
(!empty($excludes[$parent]) and $excludes[$parent] === true)) {
1326 foreach ($parent_config->sheets
as $sheet) {
1327 if (!empty($excludes[$parent]) && is_array($excludes[$parent])
1328 && in_array($sheet, $excludes[$parent])) {
1332 // We never refer to the parent LESS files.
1333 $sheetfile = "$parent_config->dir/style/$sheet.css";
1334 if (is_readable($sheetfile)) {
1335 $cssfiles['parents'][$parent][$sheet] = $sheetfile;
1342 // Current theme sheets and less file.
1343 // We first add the SCSS, or LESS file because we want the CSS ones to
1344 // be included after the SCSS/LESS code. However, if both the LESS file
1345 // and a CSS file share the same name, the CSS file is ignored.
1346 if ($this->get_scss_property()) {
1347 $cssfiles['theme'][self
::SCSS_KEY
] = true;
1348 } else if (!empty($this->lessfile
)) {
1349 $sheetfile = "{$this->dir}/less/{$this->lessfile}.less";
1350 if (is_readable($sheetfile)) {
1351 $cssfiles['theme'][$this->lessfile
] = $sheetfile;
1354 if (is_array($this->sheets
)) {
1355 foreach ($this->sheets
as $sheet) {
1356 $sheetfile = "$this->dir/style/$sheet.css";
1357 if (is_readable($sheetfile) && !isset($cssfiles['theme'][$sheet])) {
1358 $cssfiles['theme'][$sheet] = $sheetfile;
1365 $files['created'] = time();
1366 $cache->set($cachekey, $files);
1372 * Return the CSS content generated from LESS the file.
1374 * @param bool $themedesigner True if theme designer is enabled.
1375 * @return bool|string Return false when the compilation failed. Else the compiled string.
1377 protected function get_css_content_from_less($themedesigner) {
1380 $lessfile = $this->lessfile
;
1381 if (!$lessfile ||
!is_readable($this->dir
. '/less/' . $lessfile . '.less')) {
1382 throw new coding_exception('The theme did not define a LESS file, or it is not readable.');
1385 // We might need more memory/time to do this, so let's play safe.
1386 raise_memory_limit(MEMORY_EXTRA
);
1387 core_php_time_limit
::raise(300);
1390 $files = $this->get_css_files($themedesigner);
1392 // Get the LESS file path.
1393 $themelessfile = $files['theme'][$lessfile];
1395 // Setup compiler options.
1397 // We need to set the import directory to where $lessfile is.
1398 'import_dirs' => array(dirname($themelessfile) => '/'),
1399 // Always disable default caching.
1400 'cache_method' => false,
1401 // Disable the relative URLs, we have post_process() to handle that.
1402 'relativeUrls' => false,
1405 if ($themedesigner) {
1406 // Add the sourceMap inline to ensure that it is atomically generated.
1407 $options['sourceMap'] = true;
1408 $options['sourceMapBasepath'] = $CFG->dirroot
;
1409 $options['sourceMapRootpath'] = $CFG->wwwroot
;
1412 // Instantiate the compiler.
1413 $compiler = new core_lessc($options);
1416 $compiler->parse_file_content($themelessfile);
1418 // Get the callbacks.
1419 $compiler->parse($this->get_extra_less_code());
1420 $compiler->ModifyVars($this->get_less_variables());
1423 $compiled = $compiler->getCss();
1425 } catch (Less_Exception_Parser
$e) {
1427 debugging('Error while compiling LESS ' . $lessfile . ' file: ' . $e->getMessage(), DEBUG_DEVELOPER
);
1430 // Try to save memory.
1438 * Return the CSS content generated from the SCSS file.
1440 * @param bool $themedesigner True if theme designer is enabled.
1441 * @return bool|string Return false when the compilation failed. Else the compiled string.
1443 protected function get_css_content_from_scss($themedesigner) {
1446 list($paths, $scss) = $this->get_scss_property();
1448 throw new coding_exception('The theme did not define a SCSS file, or it is not readable.');
1451 // We might need more memory/time to do this, so let's play safe.
1452 raise_memory_limit(MEMORY_EXTRA
);
1453 core_php_time_limit
::raise(300);
1455 // Set-up the compiler.
1456 $compiler = new core_scss();
1457 $compiler->prepend_raw_scss($this->get_pre_scss_code());
1458 if (is_string($scss)) {
1459 $compiler->set_file($scss);
1461 $compiler->append_raw_scss($scss($this));
1462 $compiler->setImportPaths($paths);
1464 $compiler->append_raw_scss($this->get_extra_scss_code());
1468 $compiled = $compiler->to_css();
1470 } catch (\Leafo\ScssPhp\Exception
$e) {
1472 debugging('Error while compiling SCSS: ' . $e->getMessage(), DEBUG_DEVELOPER
);
1475 // Try to save memory.
1483 * Get the icon system to use.
1487 public function get_icon_system() {
1489 // Getting all the candidate functions.
1491 if (isset($this->iconsystem
) && \core\output\icon_system
::is_valid_system($this->iconsystem
)) {
1492 return $this->iconsystem
;
1494 foreach ($this->parent_configs
as $parent_config) {
1495 if (isset($parent_config->iconsystem
) && \core\output\icon_system
::is_valid_system($parent_config->iconsystem
)) {
1496 return $parent_config->iconsystem
;
1499 return \core\output\icon_system
::STANDARD
;
1503 * Return extra LESS variables to use when compiling.
1505 * @return array Where keys are the variable names (omitting the @), and the values are the value.
1507 protected function get_less_variables() {
1508 $variables = array();
1510 // Getting all the candidate functions.
1511 $candidates = array();
1512 foreach ($this->parent_configs
as $parent_config) {
1513 if (!isset($parent_config->lessvariablescallback
)) {
1516 $candidates[] = $parent_config->lessvariablescallback
;
1518 $candidates[] = $this->lessvariablescallback
;
1520 // Calling the functions.
1521 foreach ($candidates as $function) {
1522 if (function_exists($function)) {
1523 $vars = $function($this);
1524 if (!is_array($vars)) {
1525 debugging('Callback ' . $function . ' did not return an array() as expected', DEBUG_DEVELOPER
);
1528 $variables = array_merge($variables, $vars);
1536 * Return extra LESS code to add when compiling.
1538 * This is intended to be used by themes to inject some LESS code
1539 * before it gets compiled. If you want to inject variables you
1540 * should use {@link self::get_less_variables()}.
1542 * @return string The LESS code to inject.
1544 protected function get_extra_less_code() {
1547 // Getting all the candidate functions.
1548 $candidates = array();
1549 foreach ($this->parent_configs
as $parent_config) {
1550 if (!isset($parent_config->extralesscallback
)) {
1553 $candidates[] = $parent_config->extralesscallback
;
1555 $candidates[] = $this->extralesscallback
;
1557 // Calling the functions.
1558 foreach ($candidates as $function) {
1559 if (function_exists($function)) {
1560 $content .= "\n/** Extra LESS from $function **/\n" . $function($this) . "\n";
1568 * Return extra SCSS code to add when compiling.
1570 * This is intended to be used by themes to inject some SCSS code
1571 * before it gets compiled. If you want to inject variables you
1572 * should use {@link self::get_scss_variables()}.
1574 * @return string The SCSS code to inject.
1576 protected function get_extra_scss_code() {
1579 // Getting all the candidate functions.
1580 $candidates = array();
1581 foreach ($this->parent_configs
as $parent_config) {
1582 if (!isset($parent_config->extrascsscallback
)) {
1585 $candidates[] = $parent_config->extrascsscallback
;
1587 $candidates[] = $this->extrascsscallback
;
1589 // Calling the functions.
1590 foreach ($candidates as $function) {
1591 if (function_exists($function)) {
1592 $content .= "\n/** Extra SCSS from $function **/\n" . $function($this) . "\n";
1600 * SCSS code to prepend when compiling.
1602 * This is intended to be used by themes to inject SCSS code before it gets compiled.
1604 * @return string The SCSS code to inject.
1606 protected function get_pre_scss_code() {
1609 // Getting all the candidate functions.
1610 $candidates = array();
1611 foreach ($this->parent_configs
as $parent_config) {
1612 if (!isset($parent_config->prescsscallback
)) {
1615 $candidates[] = $parent_config->prescsscallback
;
1617 $candidates[] = $this->prescsscallback
;
1619 // Calling the functions.
1620 foreach ($candidates as $function) {
1621 if (function_exists($function)) {
1622 $content .= "\n/** Pre-SCSS from $function **/\n" . $function($this) . "\n";
1630 * Get the SCSS property.
1632 * This resolves whether a SCSS file (or content) has to be used when generating
1633 * the stylesheet for the theme. It will look at parents themes and check the
1634 * SCSS properties there.
1636 * @return False when SCSS is not used.
1637 * An array with the import paths, and the path to the SCSS file or Closure as second.
1639 public function get_scss_property() {
1640 if ($this->scsscache
=== null) {
1641 $configs = [$this] +
$this->parent_configs
;
1644 foreach ($configs as $config) {
1645 $path = "{$config->dir}/scss";
1647 // We collect the SCSS property until we've found one.
1648 if (empty($scss) && !empty($config->scss
)) {
1649 $candidate = is_string($config->scss
) ?
"{$path}/{$config->scss}.scss" : $config->scss
;
1650 if ($candidate instanceof Closure
) {
1652 } else if (is_string($candidate) && is_readable($candidate)) {
1657 // We collect the import paths once we've found a SCSS property.
1658 if ($scss && is_dir($path)) {
1664 $this->scsscache
= $scss !== null ?
[$paths, $scss] : false;
1667 return $this->scsscache
;
1671 * Generate a URL to the file that serves theme JavaScript files.
1673 * If we determine that the theme has no relevant files, then we return
1674 * early with a null value.
1676 * @param bool $inhead true means head url, false means footer
1677 * @return moodle_url|null
1679 public function javascript_url($inhead) {
1682 $rev = theme_get_revision();
1683 $params = array('theme'=>$this->name
,'rev'=>$rev);
1684 $params['type'] = $inhead ?
'head' : 'footer';
1686 // Return early if there are no files to serve
1687 if (count($this->javascript_files($params['type'])) === 0) {
1691 if (!empty($CFG->slasharguments
) and $rev > 0) {
1692 $url = new moodle_url("/theme/javascript.php");
1693 $url->set_slashargument('/'.$this->name
.'/'.$rev.'/'.$params['type'], 'noparam', true);
1696 return new moodle_url('/theme/javascript.php', $params);
1701 * Get the URL's for the JavaScript files used by this theme.
1702 * They won't be served directly, instead they'll be mediated through
1703 * theme/javascript.php.
1705 * @param string $type Either javascripts_footer, or javascripts
1708 public function javascript_files($type) {
1709 if ($type === 'footer') {
1710 $type = 'javascripts_footer';
1712 $type = 'javascripts';
1716 // find out wanted parent javascripts
1717 $excludes = $this->resolve_excludes('parents_exclude_javascripts');
1718 if ($excludes !== true) {
1719 foreach (array_reverse($this->parent_configs
) as $parent_config) { // base first, the immediate parent last
1720 $parent = $parent_config->name
;
1721 if (empty($parent_config->$type)) {
1724 if (!empty($excludes[$parent]) and $excludes[$parent] === true) {
1727 foreach ($parent_config->$type as $javascript) {
1728 if (!empty($excludes[$parent]) and is_array($excludes[$parent])
1729 and in_array($javascript, $excludes[$parent])) {
1732 $javascriptfile = "$parent_config->dir/javascript/$javascript.js";
1733 if (is_readable($javascriptfile)) {
1734 $js[] = $javascriptfile;
1740 // current theme javascripts
1741 if (is_array($this->$type)) {
1742 foreach ($this->$type as $javascript) {
1743 $javascriptfile = "$this->dir/javascript/$javascript.js";
1744 if (is_readable($javascriptfile)) {
1745 $js[] = $javascriptfile;
1753 * Resolves an exclude setting to the themes setting is applicable or the
1754 * setting of its closest parent.
1756 * @param string $variable The name of the setting the exclude setting to resolve
1757 * @param string $default
1760 protected function resolve_excludes($variable, $default = null) {
1761 $setting = $default;
1762 if (is_array($this->{$variable}) or $this->{$variable} === true) {
1763 $setting = $this->{$variable};
1765 foreach ($this->parent_configs
as $parent_config) { // the immediate parent first, base last
1766 if (!isset($parent_config->{$variable})) {
1769 if (is_array($parent_config->{$variable}) or $parent_config->{$variable} === true) {
1770 $setting = $parent_config->{$variable};
1779 * Returns the content of the one huge javascript file merged from all theme javascript files.
1784 public function javascript_content($type) {
1785 $jsfiles = $this->javascript_files($type);
1787 foreach ($jsfiles as $jsfile) {
1788 $js .= file_get_contents($jsfile)."\n";
1794 * Post processes CSS.
1796 * This method post processes all of the CSS before it is served for this theme.
1797 * This is done so that things such as image URL's can be swapped in and to
1798 * run any specific CSS post process method the theme has requested.
1799 * This allows themes to use CSS settings.
1801 * @param string $css The CSS to process.
1802 * @return string The processed CSS.
1804 public function post_process($css) {
1805 // now resolve all image locations
1806 if (preg_match_all('/\[\[pix:([a-z0-9_]+\|)?([^\]]+)\]\]/', $css, $matches, PREG_SET_ORDER
)) {
1807 $replaced = array();
1808 foreach ($matches as $match) {
1809 if (isset($replaced[$match[0]])) {
1812 $replaced[$match[0]] = true;
1813 $imagename = $match[2];
1814 $component = rtrim($match[1], '|');
1815 $imageurl = $this->image_url($imagename, $component)->out(false);
1816 // we do not need full url because the image.php is always in the same dir
1817 $imageurl = preg_replace('|^http.?://[^/]+|', '', $imageurl);
1818 $css = str_replace($match[0], $imageurl, $css);
1822 // Now resolve all font locations.
1823 if (preg_match_all('/\[\[font:([a-z0-9_]+\|)?([^\]]+)\]\]/', $css, $matches, PREG_SET_ORDER
)) {
1824 $replaced = array();
1825 foreach ($matches as $match) {
1826 if (isset($replaced[$match[0]])) {
1829 $replaced[$match[0]] = true;
1830 $fontname = $match[2];
1831 $component = rtrim($match[1], '|');
1832 $fonturl = $this->font_url($fontname, $component)->out(false);
1833 // We do not need full url because the font.php is always in the same dir.
1834 $fonturl = preg_replace('|^http.?://[^/]+|', '', $fonturl);
1835 $css = str_replace($match[0], $fonturl, $css);
1839 // Now resolve all theme settings or do any other postprocessing.
1840 // This needs to be done before calling core parser, since the parser strips [[settings]] tags.
1841 $csspostprocess = $this->csspostprocess
;
1842 if (function_exists($csspostprocess)) {
1843 $css = $csspostprocess($css, $this);
1846 // Post processing using an object representation of CSS.
1847 $treeprocessor = $this->get_css_tree_post_processor();
1848 $needsparsing = !empty($treeprocessor) ||
!empty($this->rtlmode
);
1849 if ($needsparsing) {
1851 // We might need more memory/time to do this, so let's play safe.
1852 raise_memory_limit(MEMORY_EXTRA
);
1853 core_php_time_limit
::raise(300);
1855 $parser = new core_cssparser($css);
1856 $csstree = $parser->parse();
1859 if ($this->rtlmode
) {
1860 $this->rtlize($csstree);
1863 if ($treeprocessor) {
1864 $treeprocessor($csstree, $this);
1867 $css = $csstree->render();
1875 * Flip a stylesheet to RTL.
1877 * @param Object $csstree The parsed CSS tree structure to flip.
1880 protected function rtlize($csstree) {
1881 $rtlcss = new core_rtlcss($csstree);
1886 * Return the direct URL for an image from the pix folder.
1888 * Use this function sparingly and never for icons. For icons use pix_icon or the pix helper in a mustache template.
1890 * @deprecated since Moodle 3.3
1891 * @param string $imagename the name of the icon.
1892 * @param string $component specification of one plugin like in get_string()
1893 * @return moodle_url
1895 public function pix_url($imagename, $component) {
1896 debugging('pix_url is deprecated. Use image_url for images and pix_icon for icons.', DEBUG_DEVELOPER
);
1897 return $this->image_url($imagename, $component);
1901 * Return the direct URL for an image from the pix folder.
1903 * Use this function sparingly and never for icons. For icons use pix_icon or the pix helper in a mustache template.
1905 * @param string $imagename the name of the icon.
1906 * @param string $component specification of one plugin like in get_string()
1907 * @return moodle_url
1909 public function image_url($imagename, $component) {
1912 $params = array('theme'=>$this->name
);
1913 $svg = $this->use_svg_icons();
1915 if (empty($component) or $component === 'moodle' or $component === 'core') {
1916 $params['component'] = 'core';
1918 $params['component'] = $component;
1921 $rev = theme_get_revision();
1923 $params['rev'] = $rev;
1926 $params['image'] = $imagename;
1928 $url = new moodle_url("/theme/image.php");
1929 if (!empty($CFG->slasharguments
) and $rev > 0) {
1930 $path = '/'.$params['theme'].'/'.$params['component'].'/'.$params['rev'].'/'.$params['image'];
1932 // We add a simple /_s to the start of the path.
1933 // The underscore is used to ensure that it isn't a valid theme name.
1934 $path = '/_s'.$path;
1936 $url->set_slashargument($path, 'noparam', true);
1939 // We add an SVG param so that we know not to serve SVG images.
1940 // We do this because all modern browsers support SVG and this param will one day be removed.
1941 $params['svg'] = '0';
1943 $url->params($params);
1950 * Return the URL for a font
1952 * @param string $font the name of the font (including extension).
1953 * @param string $component specification of one plugin like in get_string()
1954 * @return moodle_url
1956 public function font_url($font, $component) {
1959 $params = array('theme'=>$this->name
);
1961 if (empty($component) or $component === 'moodle' or $component === 'core') {
1962 $params['component'] = 'core';
1964 $params['component'] = $component;
1967 $rev = theme_get_revision();
1969 $params['rev'] = $rev;
1972 $params['font'] = $font;
1974 $url = new moodle_url("/theme/font.php");
1975 if (!empty($CFG->slasharguments
) and $rev > 0) {
1976 $path = '/'.$params['theme'].'/'.$params['component'].'/'.$params['rev'].'/'.$params['font'];
1977 $url->set_slashargument($path, 'noparam', true);
1979 $url->params($params);
1986 * Returns URL to the stored file via pluginfile.php.
1988 * Note the theme must also implement pluginfile.php handler,
1989 * theme revision is used instead of the itemid.
1991 * @param string $setting
1992 * @param string $filearea
1993 * @return string protocol relative URL or null if not present
1995 public function setting_file_url($setting, $filearea) {
1998 if (empty($this->settings
->$setting)) {
2002 $component = 'theme_'.$this->name
;
2003 $itemid = theme_get_revision();
2004 $filepath = $this->settings
->$setting;
2005 $syscontext = context_system
::instance();
2007 $url = moodle_url
::make_file_url("$CFG->wwwroot/pluginfile.php", "/$syscontext->id/$component/$filearea/$itemid".$filepath);
2009 // Now this is tricky because the we can not hardcode http or https here, lets use the relative link.
2010 // Note: unfortunately moodle_url does not support //urls yet.
2012 $url = preg_replace('|^https?://|i', '//', $url->out(false));
2018 * Serve the theme setting file.
2020 * @param string $filearea
2021 * @param array $args
2022 * @param bool $forcedownload
2023 * @param array $options
2024 * @return bool may terminate if file not found or donotdie not specified
2026 public function setting_file_serve($filearea, $args, $forcedownload, $options) {
2028 require_once("$CFG->libdir/filelib.php");
2030 $syscontext = context_system
::instance();
2031 $component = 'theme_'.$this->name
;
2033 $revision = array_shift($args);
2034 if ($revision < 0) {
2037 $lifetime = 60*60*24*60;
2038 // By default, theme files must be cache-able by both browsers and proxies.
2039 if (!array_key_exists('cacheability', $options)) {
2040 $options['cacheability'] = 'public';
2044 $fs = get_file_storage();
2045 $relativepath = implode('/', $args);
2047 $fullpath = "/{$syscontext->id}/{$component}/{$filearea}/0/{$relativepath}";
2048 $fullpath = rtrim($fullpath, '/');
2049 if ($file = $fs->get_file_by_hash(sha1($fullpath))) {
2050 send_stored_file($file, $lifetime, 0, $forcedownload, $options);
2053 send_file_not_found();
2058 * Resolves the real image location.
2060 * $svg was introduced as an arg in 2.4. It is important because not all supported browsers support the use of SVG
2061 * and we need a way in which to turn it off.
2062 * By default SVG won't be used unless asked for. This is done for two reasons:
2063 * 1. It ensures that we don't serve svg images unless we really want to. The admin has selected to force them, of the users
2064 * browser supports SVG.
2065 * 2. We only serve SVG images from locations we trust. This must NOT include any areas where the image may have been uploaded
2066 * by the user due to security concerns.
2068 * @param string $image name of image, may contain relative path
2069 * @param string $component
2070 * @param bool $svg|null Should SVG images also be looked for? If null, resorts to $CFG->svgicons if that is set; falls back to
2071 * auto-detection of browser support otherwise
2072 * @return string full file path
2074 public function resolve_image_location($image, $component, $svg = false) {
2077 if (!is_bool($svg)) {
2078 // If $svg isn't a bool then we need to decide for ourselves.
2079 $svg = $this->use_svg_icons();
2082 if ($component === 'moodle' or $component === 'core' or empty($component)) {
2083 if ($imagefile = $this->image_exists("$this->dir/pix_core/$image", $svg)) {
2086 foreach (array_reverse($this->parent_configs
) as $parent_config) { // base first, the immediate parent last
2087 if ($imagefile = $this->image_exists("$parent_config->dir/pix_core/$image", $svg)) {
2091 if ($imagefile = $this->image_exists("$CFG->dataroot/pix/$image", $svg)) {
2094 if ($imagefile = $this->image_exists("$CFG->dirroot/pix/$image", $svg)) {
2099 } else if ($component === 'theme') { //exception
2100 if ($image === 'favicon') {
2101 return "$this->dir/pix/favicon.ico";
2103 if ($imagefile = $this->image_exists("$this->dir/pix/$image", $svg)) {
2106 foreach (array_reverse($this->parent_configs
) as $parent_config) { // base first, the immediate parent last
2107 if ($imagefile = $this->image_exists("$parent_config->dir/pix/$image", $svg)) {
2114 if (strpos($component, '_') === false) {
2115 $component = 'mod_'.$component;
2117 list($type, $plugin) = explode('_', $component, 2);
2119 if ($imagefile = $this->image_exists("$this->dir/pix_plugins/$type/$plugin/$image", $svg)) {
2122 foreach (array_reverse($this->parent_configs
) as $parent_config) { // base first, the immediate parent last
2123 if ($imagefile = $this->image_exists("$parent_config->dir/pix_plugins/$type/$plugin/$image", $svg)) {
2127 if ($imagefile = $this->image_exists("$CFG->dataroot/pix_plugins/$type/$plugin/$image", $svg)) {
2130 $dir = core_component
::get_plugin_directory($type, $plugin);
2131 if ($imagefile = $this->image_exists("$dir/pix/$image", $svg)) {
2139 * Resolves the real font location.
2141 * @param string $font name of font file
2142 * @param string $component
2143 * @return string full file path
2145 public function resolve_font_location($font, $component) {
2148 if ($component === 'moodle' or $component === 'core' or empty($component)) {
2149 if (file_exists("$this->dir/fonts_core/$font")) {
2150 return "$this->dir/fonts_core/$font";
2152 foreach (array_reverse($this->parent_configs
) as $parent_config) { // Base first, the immediate parent last.
2153 if (file_exists("$parent_config->dir/fonts_core/$font")) {
2154 return "$parent_config->dir/fonts_core/$font";
2157 if (file_exists("$CFG->dataroot/fonts/$font")) {
2158 return "$CFG->dataroot/fonts/$font";
2160 if (file_exists("$CFG->dirroot/lib/fonts/$font")) {
2161 return "$CFG->dirroot/lib/fonts/$font";
2165 } else if ($component === 'theme') { // Exception.
2166 if (file_exists("$this->dir/fonts/$font")) {
2167 return "$this->dir/fonts/$font";
2169 foreach (array_reverse($this->parent_configs
) as $parent_config) { // Base first, the immediate parent last.
2170 if (file_exists("$parent_config->dir/fonts/$font")) {
2171 return "$parent_config->dir/fonts/$font";
2177 if (strpos($component, '_') === false) {
2178 $component = 'mod_'.$component;
2180 list($type, $plugin) = explode('_', $component, 2);
2182 if (file_exists("$this->dir/fonts_plugins/$type/$plugin/$font")) {
2183 return "$this->dir/fonts_plugins/$type/$plugin/$font";
2185 foreach (array_reverse($this->parent_configs
) as $parent_config) { // Base first, the immediate parent last.
2186 if (file_exists("$parent_config->dir/fonts_plugins/$type/$plugin/$font")) {
2187 return "$parent_config->dir/fonts_plugins/$type/$plugin/$font";
2190 if (file_exists("$CFG->dataroot/fonts_plugins/$type/$plugin/$font")) {
2191 return "$CFG->dataroot/fonts_plugins/$type/$plugin/$font";
2193 $dir = core_component
::get_plugin_directory($type, $plugin);
2194 if (file_exists("$dir/fonts/$font")) {
2195 return "$dir/fonts/$font";
2202 * Return true if we should look for SVG images as well.
2206 public function use_svg_icons() {
2208 if ($this->usesvg
=== null) {
2210 if (!isset($CFG->svgicons
)) {
2211 $this->usesvg
= core_useragent
::supports_svg();
2213 // Force them on/off depending upon the setting.
2214 $this->usesvg
= (bool)$CFG->svgicons
;
2217 return $this->usesvg
;
2221 * Forces the usesvg setting to either true or false, avoiding any decision making.
2223 * This function should only ever be used when absolutely required, and before any generation of image URL's has occurred.
2224 * DO NOT ABUSE THIS FUNCTION... not that you'd want to right ;)
2226 * @param bool $setting True to force the use of svg when available, null otherwise.
2228 public function force_svg_use($setting) {
2229 $this->usesvg
= (bool)$setting;
2233 * Set to be in RTL mode.
2235 * This will likely be used when post processing the CSS before serving it.
2237 * @param bool $inrtl True when in RTL mode.
2239 public function set_rtl_mode($inrtl = true) {
2240 $this->rtlmode
= $inrtl;
2244 * Whether the theme is being served in RTL mode.
2246 * @return bool True when in RTL mode.
2248 public function get_rtl_mode() {
2249 return $this->rtlmode
;
2253 * Checks if file with any image extension exists.
2255 * The order to these images was adjusted prior to the release of 2.4
2256 * At that point the were the following image counts in Moodle core:
2258 * - png = 667 in pix dirs (1499 total)
2259 * - gif = 385 in pix dirs (606 total)
2260 * - jpg = 62 in pix dirs (74 total)
2261 * - jpeg = 0 in pix dirs (1 total)
2263 * There is work in progress to move towards SVG presently hence that has been prioritiesed.
2265 * @param string $filepath
2266 * @param bool $svg If set to true SVG images will also be looked for.
2267 * @return string image name with extension
2269 private static function image_exists($filepath, $svg = false) {
2270 if ($svg && file_exists("$filepath.svg")) {
2271 return "$filepath.svg";
2272 } else if (file_exists("$filepath.png")) {
2273 return "$filepath.png";
2274 } else if (file_exists("$filepath.gif")) {
2275 return "$filepath.gif";
2276 } else if (file_exists("$filepath.jpg")) {
2277 return "$filepath.jpg";
2278 } else if (file_exists("$filepath.jpeg")) {
2279 return "$filepath.jpeg";
2286 * Loads the theme config from config.php file.
2288 * @param string $themename
2289 * @param stdClass $settings from config_plugins table
2290 * @param boolean $parentscheck true to also check the parents. .
2291 * @return stdClass The theme configuration
2293 private static function find_theme_config($themename, $settings, $parentscheck = true) {
2294 // We have to use the variable name $THEME (upper case) because that
2295 // is what is used in theme config.php files.
2297 if (!$dir = theme_config
::find_theme_location($themename)) {
2301 $THEME = new stdClass();
2302 $THEME->name
= $themename;
2304 $THEME->settings
= $settings;
2306 global $CFG; // just in case somebody tries to use $CFG in theme config
2307 include("$THEME->dir/config.php");
2309 // verify the theme configuration is OK
2310 if (!is_array($THEME->parents
)) {
2311 // parents option is mandatory now
2314 // We use $parentscheck to only check the direct parents (avoid infinite loop).
2315 if ($parentscheck) {
2316 // Find all parent theme configs.
2317 foreach ($THEME->parents
as $parent) {
2318 $parentconfig = theme_config
::find_theme_config($parent, $settings, false);
2319 if (empty($parentconfig)) {
2330 * Finds the theme location and verifies the theme has all needed files
2331 * and is not obsoleted.
2333 * @param string $themename
2334 * @return string full dir path or null if not found
2336 private static function find_theme_location($themename) {
2339 if (file_exists("$CFG->dirroot/theme/$themename/config.php")) {
2340 $dir = "$CFG->dirroot/theme/$themename";
2342 } else if (!empty($CFG->themedir
) and file_exists("$CFG->themedir/$themename/config.php")) {
2343 $dir = "$CFG->themedir/$themename";
2349 if (file_exists("$dir/styles.php")) {
2350 //legacy theme - needs to be upgraded - upgrade info is displayed on the admin settings page
2358 * Get the renderer for a part of Moodle for this theme.
2360 * @param moodle_page $page the page we are rendering
2361 * @param string $component the name of part of moodle. E.g. 'core', 'quiz', 'qtype_multichoice'.
2362 * @param string $subtype optional subtype such as 'news' resulting to 'mod_forum_news'
2363 * @param string $target one of rendering target constants
2364 * @return renderer_base the requested renderer.
2366 public function get_renderer(moodle_page
$page, $component, $subtype = null, $target = null) {
2367 if (is_null($this->rf
)) {
2368 $classname = $this->rendererfactory
;
2369 $this->rf
= new $classname($this);
2372 return $this->rf
->get_renderer($page, $component, $subtype, $target);
2376 * Get the information from {@link $layouts} for this type of page.
2378 * @param string $pagelayout the the page layout name.
2379 * @return array the appropriate part of {@link $layouts}.
2381 protected function layout_info_for_page($pagelayout) {
2382 if (array_key_exists($pagelayout, $this->layouts
)) {
2383 return $this->layouts
[$pagelayout];
2385 debugging('Invalid page layout specified: ' . $pagelayout);
2386 return $this->layouts
['standard'];
2391 * Given the settings of this theme, and the page pagelayout, return the
2392 * full path of the page layout file to use.
2394 * Used by {@link core_renderer::header()}.
2396 * @param string $pagelayout the the page layout name.
2397 * @return string Full path to the lyout file to use
2399 public function layout_file($pagelayout) {
2402 $layoutinfo = $this->layout_info_for_page($pagelayout);
2403 $layoutfile = $layoutinfo['file'];
2405 if (array_key_exists('theme', $layoutinfo)) {
2406 $themes = array($layoutinfo['theme']);
2408 $themes = array_merge(array($this->name
),$this->parents
);
2411 foreach ($themes as $theme) {
2412 if ($dir = $this->find_theme_location($theme)) {
2413 $path = "$dir/layout/$layoutfile";
2415 // Check the template exists, return general base theme template if not.
2416 if (is_readable($path)) {
2422 debugging('Can not find layout file for: ' . $pagelayout);
2423 // fallback to standard normal layout
2424 return "$CFG->dirroot/theme/base/layout/general.php";
2428 * Returns auxiliary page layout options specified in layout configuration array.
2430 * @param string $pagelayout
2433 public function pagelayout_options($pagelayout) {
2434 $info = $this->layout_info_for_page($pagelayout);
2435 if (!empty($info['options'])) {
2436 return $info['options'];
2442 * Inform a block_manager about the block regions this theme wants on this
2445 * @param string $pagelayout the general type of the page.
2446 * @param block_manager $blockmanager the block_manger to set up.
2448 public function setup_blocks($pagelayout, $blockmanager) {
2449 $layoutinfo = $this->layout_info_for_page($pagelayout);
2450 if (!empty($layoutinfo['regions'])) {
2451 $blockmanager->add_regions($layoutinfo['regions'], false);
2452 $blockmanager->set_default_region($layoutinfo['defaultregion']);
2457 * Gets the visible name for the requested block region.
2459 * @param string $region The region name to get
2460 * @param string $theme The theme the region belongs to (may come from the parent theme)
2463 protected function get_region_name($region, $theme) {
2464 $regionstring = get_string('region-' . $region, 'theme_' . $theme);
2465 // A name exists in this theme, so use it
2466 if (substr($regionstring, 0, 1) != '[') {
2467 return $regionstring;
2470 // Otherwise, try to find one elsewhere
2471 // Check parents, if any
2472 foreach ($this->parents
as $parentthemename) {
2473 $regionstring = get_string('region-' . $region, 'theme_' . $parentthemename);
2474 if (substr($regionstring, 0, 1) != '[') {
2475 return $regionstring;
2479 // Last resort, try the bootstrapbase theme for names
2480 return get_string('region-' . $region, 'theme_bootstrapbase');
2484 * Get the list of all block regions known to this theme in all templates.
2486 * @return array internal region name => human readable name.
2488 public function get_all_block_regions() {
2490 foreach ($this->layouts
as $layoutinfo) {
2491 foreach ($layoutinfo['regions'] as $region) {
2492 $regions[$region] = $this->get_region_name($region, $this->name
);
2499 * Returns the human readable name of the theme
2503 public function get_theme_name() {
2504 return get_string('pluginname', 'theme_'.$this->name
);
2508 * Returns the block render method.
2510 * It is set by the theme via:
2511 * $THEME->blockrendermethod = '...';
2513 * It can be one of two values, blocks or blocks_for_region.
2514 * It should be set to the method being used by the theme layouts.
2518 public function get_block_render_method() {
2519 if ($this->blockrendermethod
) {
2520 // Return the specified block render method.
2521 return $this->blockrendermethod
;
2523 // Its not explicitly set, check the parent theme configs.
2524 foreach ($this->parent_configs
as $config) {
2525 if (isset($config->blockrendermethod
)) {
2526 return $config->blockrendermethod
;
2529 // Default it to blocks.
2534 * Get the callable for CSS tree post processing.
2536 * @return string|null
2538 public function get_css_tree_post_processor() {
2539 $configs = [$this] +
$this->parent_configs
;
2540 foreach ($configs as $config) {
2541 if (!empty($config->csstreepostprocessor
) && is_callable($config->csstreepostprocessor
)) {
2542 return $config->csstreepostprocessor
;
2551 * This class keeps track of which HTML tags are currently open.
2553 * This makes it much easier to always generate well formed XHTML output, even
2554 * if execution terminates abruptly. Any time you output some opening HTML
2555 * without the matching closing HTML, you should push the necessary close tags
2558 * @copyright 2009 Tim Hunt
2559 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2564 class xhtml_container_stack
{
2567 * @var array Stores the list of open containers.
2569 protected $opencontainers = array();
2572 * @var array In developer debug mode, stores a stack trace of all opens and
2573 * closes, so we can output helpful error messages when there is a mismatch.
2575 protected $log = array();
2578 * @var boolean Store whether we are developer debug mode. We need this in
2579 * several places including in the destructor where we may not have access to $CFG.
2581 protected $isdebugging;
2586 public function __construct() {
2588 $this->isdebugging
= $CFG->debugdeveloper
;
2592 * Push the close HTML for a recently opened container onto the stack.
2594 * @param string $type The type of container. This is checked when {@link pop()}
2595 * is called and must match, otherwise a developer debug warning is output.
2596 * @param string $closehtml The HTML required to close the container.
2598 public function push($type, $closehtml) {
2599 $container = new stdClass
;
2600 $container->type
= $type;
2601 $container->closehtml
= $closehtml;
2602 if ($this->isdebugging
) {
2603 $this->log('Open', $type);
2605 array_push($this->opencontainers
, $container);
2609 * Pop the HTML for the next closing container from the stack. The $type
2610 * must match the type passed when the container was opened, otherwise a
2611 * warning will be output.
2613 * @param string $type The type of container.
2614 * @return string the HTML required to close the container.
2616 public function pop($type) {
2617 if (empty($this->opencontainers
)) {
2618 debugging('<p>There are no more open containers. This suggests there is a nesting problem.</p>' .
2619 $this->output_log(), DEBUG_DEVELOPER
);
2623 $container = array_pop($this->opencontainers
);
2624 if ($container->type
!= $type) {
2625 debugging('<p>The type of container to be closed (' . $container->type
.
2626 ') does not match the type of the next open container (' . $type .
2627 '). This suggests there is a nesting problem.</p>' .
2628 $this->output_log(), DEBUG_DEVELOPER
);
2630 if ($this->isdebugging
) {
2631 $this->log('Close', $type);
2633 return $container->closehtml
;
2637 * Close all but the last open container. This is useful in places like error
2638 * handling, where you want to close all the open containers (apart from <body>)
2639 * before outputting the error message.
2641 * @param bool $shouldbenone assert that the stack should be empty now - causes a
2642 * developer debug warning if it isn't.
2643 * @return string the HTML required to close any open containers inside <body>.
2645 public function pop_all_but_last($shouldbenone = false) {
2646 if ($shouldbenone && count($this->opencontainers
) != 1) {
2647 debugging('<p>Some HTML tags were opened in the body of the page but not closed.</p>' .
2648 $this->output_log(), DEBUG_DEVELOPER
);
2651 while (count($this->opencontainers
) > 1) {
2652 $container = array_pop($this->opencontainers
);
2653 $output .= $container->closehtml
;
2659 * You can call this function if you want to throw away an instance of this
2660 * class without properly emptying the stack (for example, in a unit test).
2661 * Calling this method stops the destruct method from outputting a developer
2662 * debug warning. After calling this method, the instance can no longer be used.
2664 public function discard() {
2665 $this->opencontainers
= null;
2669 * Adds an entry to the log.
2671 * @param string $action The name of the action
2672 * @param string $type The type of action
2674 protected function log($action, $type) {
2675 $this->log
[] = '<li>' . $action . ' ' . $type . ' at:' .
2676 format_backtrace(debug_backtrace()) . '</li>';
2680 * Outputs the log's contents as a HTML list.
2682 * @return string HTML list of the log
2684 protected function output_log() {
2685 return '<ul>' . implode("\n", $this->log
) . '</ul>';