a0748576b645cc971a866804fbc700d0ee33be02
[moodle.git] / lib / outputrenderers.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Classes for rendering HTML output for Moodle.
19  *
20  * Please see {@link http://docs.moodle.org/en/Developement:How_Moodle_outputs_HTML}
21  * for an overview.
22  *
23  * Included in this file are the primary renderer classes:
24  *     - renderer_base:         The renderer outline class that all renderers
25  *                              should inherit from.
26  *     - core_renderer:         The standard HTML renderer.
27  *     - core_renderer_cli:     An adaption of the standard renderer for CLI scripts.
28  *     - core_renderer_ajax:    An adaption of the standard renderer for AJAX scripts.
29  *     - plugin_renderer_base:  A renderer class that should be extended by all
30  *                              plugin renderers.
31  *
32  * @package core
33  * @category output
34  * @copyright  2009 Tim Hunt
35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
38 defined('MOODLE_INTERNAL') || die();
40 /**
41  * Simple base class for Moodle renderers.
42  *
43  * Tracks the xhtml_container_stack to use, which is passed in in the constructor.
44  *
45  * Also has methods to facilitate generating HTML output.
46  *
47  * @copyright 2009 Tim Hunt
48  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
49  * @since Moodle 2.0
50  * @package core
51  * @category output
52  */
53 class renderer_base {
54     /**
55      * @var xhtml_container_stack The xhtml_container_stack to use.
56      */
57     protected $opencontainers;
59     /**
60      * @var moodle_page The Moodle page the renderer has been created to assist with.
61      */
62     protected $page;
64     /**
65      * @var string The requested rendering target.
66      */
67     protected $target;
69     /**
70      * @var Mustache_Engine $mustache The mustache template compiler
71      */
72     private $mustache;
74     /**
75      * Return an instance of the mustache class.
76      *
77      * @since 2.9
78      * @return Mustache_Engine
79      */
80     protected function get_mustache() {
81         global $CFG;
83         if ($this->mustache === null) {
84             require_once("{$CFG->libdir}/filelib.php");
86             $themename = $this->page->theme->name;
87             $themerev = theme_get_revision();
89             // Create new localcache directory.
90             $cachedir = make_localcache_directory("mustache/$themerev/$themename");
92             // Remove old localcache directories.
93             $mustachecachedirs = glob("{$CFG->localcachedir}/mustache/*", GLOB_ONLYDIR);
94             foreach ($mustachecachedirs as $localcachedir) {
95                 $cachedrev = [];
96                 preg_match("/\/mustache\/([0-9]+)$/", $localcachedir, $cachedrev);
97                 $cachedrev = isset($cachedrev[1]) ? intval($cachedrev[1]) : 0;
98                 if ($cachedrev > 0 && $cachedrev < $themerev) {
99                     fulldelete($localcachedir);
100                 }
101             }
103             $loader = new \core\output\mustache_filesystem_loader();
104             $stringhelper = new \core\output\mustache_string_helper();
105             $quotehelper = new \core\output\mustache_quote_helper();
106             $jshelper = new \core\output\mustache_javascript_helper($this->page);
107             $pixhelper = new \core\output\mustache_pix_helper($this);
108             $shortentexthelper = new \core\output\mustache_shorten_text_helper();
109             $userdatehelper = new \core\output\mustache_user_date_helper();
111             // We only expose the variables that are exposed to JS templates.
112             $safeconfig = $this->page->requires->get_config_for_javascript($this->page, $this);
114             $helpers = array('config' => $safeconfig,
115                              'str' => array($stringhelper, 'str'),
116                              'quote' => array($quotehelper, 'quote'),
117                              'js' => array($jshelper, 'help'),
118                              'pix' => array($pixhelper, 'pix'),
119                              'shortentext' => array($shortentexthelper, 'shorten'),
120                              'userdate' => array($userdatehelper, 'transform'),
121                          );
123             $this->mustache = new Mustache_Engine(array(
124                 'cache' => $cachedir,
125                 'escape' => 's',
126                 'loader' => $loader,
127                 'helpers' => $helpers,
128                 'pragmas' => [Mustache_Engine::PRAGMA_BLOCKS]));
130         }
132         return $this->mustache;
133     }
136     /**
137      * Constructor
138      *
139      * The constructor takes two arguments. The first is the page that the renderer
140      * has been created to assist with, and the second is the target.
141      * The target is an additional identifier that can be used to load different
142      * renderers for different options.
143      *
144      * @param moodle_page $page the page we are doing output for.
145      * @param string $target one of rendering target constants
146      */
147     public function __construct(moodle_page $page, $target) {
148         $this->opencontainers = $page->opencontainers;
149         $this->page = $page;
150         $this->target = $target;
151     }
153     /**
154      * Renders a template by name with the given context.
155      *
156      * The provided data needs to be array/stdClass made up of only simple types.
157      * Simple types are array,stdClass,bool,int,float,string
158      *
159      * @since 2.9
160      * @param array|stdClass $context Context containing data for the template.
161      * @return string|boolean
162      */
163     public function render_from_template($templatename, $context) {
164         static $templatecache = array();
165         $mustache = $this->get_mustache();
167         try {
168             // Grab a copy of the existing helper to be restored later.
169             $uniqidhelper = $mustache->getHelper('uniqid');
170         } catch (Mustache_Exception_UnknownHelperException $e) {
171             // Helper doesn't exist.
172             $uniqidhelper = null;
173         }
175         // Provide 1 random value that will not change within a template
176         // but will be different from template to template. This is useful for
177         // e.g. aria attributes that only work with id attributes and must be
178         // unique in a page.
179         $mustache->addHelper('uniqid', new \core\output\mustache_uniqid_helper());
180         if (isset($templatecache[$templatename])) {
181             $template = $templatecache[$templatename];
182         } else {
183             try {
184                 $template = $mustache->loadTemplate($templatename);
185                 $templatecache[$templatename] = $template;
186             } catch (Mustache_Exception_UnknownTemplateException $e) {
187                 throw new moodle_exception('Unknown template: ' . $templatename);
188             }
189         }
191         $renderedtemplate = trim($template->render($context));
193         // If we had an existing uniqid helper then we need to restore it to allow
194         // handle nested calls of render_from_template.
195         if ($uniqidhelper) {
196             $mustache->addHelper('uniqid', $uniqidhelper);
197         }
199         return $renderedtemplate;
200     }
203     /**
204      * Returns rendered widget.
205      *
206      * The provided widget needs to be an object that extends the renderable
207      * interface.
208      * If will then be rendered by a method based upon the classname for the widget.
209      * For instance a widget of class `crazywidget` will be rendered by a protected
210      * render_crazywidget method of this renderer.
211      * If no render_crazywidget method exists and crazywidget implements templatable,
212      * look for the 'crazywidget' template in the same component and render that.
213      *
214      * @param renderable $widget instance with renderable interface
215      * @return string
216      */
217     public function render(renderable $widget) {
218         $classparts = explode('\\', get_class($widget));
219         // Strip namespaces.
220         $classname = array_pop($classparts);
221         // Remove _renderable suffixes
222         $classname = preg_replace('/_renderable$/', '', $classname);
224         $rendermethod = 'render_'.$classname;
225         if (method_exists($this, $rendermethod)) {
226             return $this->$rendermethod($widget);
227         }
228         if ($widget instanceof templatable) {
229             $component = array_shift($classparts);
230             if (!$component) {
231                 $component = 'core';
232             }
233             $template = $component . '/' . $classname;
234             $context = $widget->export_for_template($this);
235             return $this->render_from_template($template, $context);
236         }
237         throw new coding_exception('Can not render widget, renderer method ('.$rendermethod.') not found.');
238     }
240     /**
241      * Adds a JS action for the element with the provided id.
242      *
243      * This method adds a JS event for the provided component action to the page
244      * and then returns the id that the event has been attached to.
245      * If no id has been provided then a new ID is generated by {@link html_writer::random_id()}
246      *
247      * @param component_action $action
248      * @param string $id
249      * @return string id of element, either original submitted or random new if not supplied
250      */
251     public function add_action_handler(component_action $action, $id = null) {
252         if (!$id) {
253             $id = html_writer::random_id($action->event);
254         }
255         $this->page->requires->event_handler("#$id", $action->event, $action->jsfunction, $action->jsfunctionargs);
256         return $id;
257     }
259     /**
260      * Returns true is output has already started, and false if not.
261      *
262      * @return boolean true if the header has been printed.
263      */
264     public function has_started() {
265         return $this->page->state >= moodle_page::STATE_IN_BODY;
266     }
268     /**
269      * Given an array or space-separated list of classes, prepares and returns the HTML class attribute value
270      *
271      * @param mixed $classes Space-separated string or array of classes
272      * @return string HTML class attribute value
273      */
274     public static function prepare_classes($classes) {
275         if (is_array($classes)) {
276             return implode(' ', array_unique($classes));
277         }
278         return $classes;
279     }
281     /**
282      * Return the direct URL for an image from the pix folder.
283      *
284      * Use this function sparingly and never for icons. For icons use pix_icon or the pix helper in a mustache template.
285      *
286      * @deprecated since Moodle 3.3
287      * @param string $imagename the name of the icon.
288      * @param string $component specification of one plugin like in get_string()
289      * @return moodle_url
290      */
291     public function pix_url($imagename, $component = 'moodle') {
292         debugging('pix_url is deprecated. Use image_url for images and pix_icon for icons.', DEBUG_DEVELOPER);
293         return $this->page->theme->image_url($imagename, $component);
294     }
296     /**
297      * Return the moodle_url for an image.
298      *
299      * The exact image location and extension is determined
300      * automatically by searching for gif|png|jpg|jpeg, please
301      * note there can not be diferent images with the different
302      * extension. The imagename is for historical reasons
303      * a relative path name, it may be changed later for core
304      * images. It is recommended to not use subdirectories
305      * in plugin and theme pix directories.
306      *
307      * There are three types of images:
308      * 1/ theme images  - stored in theme/mytheme/pix/,
309      *                    use component 'theme'
310      * 2/ core images   - stored in /pix/,
311      *                    overridden via theme/mytheme/pix_core/
312      * 3/ plugin images - stored in mod/mymodule/pix,
313      *                    overridden via theme/mytheme/pix_plugins/mod/mymodule/,
314      *                    example: image_url('comment', 'mod_glossary')
315      *
316      * @param string $imagename the pathname of the image
317      * @param string $component full plugin name (aka component) or 'theme'
318      * @return moodle_url
319      */
320     public function image_url($imagename, $component = 'moodle') {
321         return $this->page->theme->image_url($imagename, $component);
322     }
324     /**
325      * Return the site's logo URL, if any.
326      *
327      * @param int $maxwidth The maximum width, or null when the maximum width does not matter.
328      * @param int $maxheight The maximum height, or null when the maximum height does not matter.
329      * @return moodle_url|false
330      */
331     public function get_logo_url($maxwidth = null, $maxheight = 200) {
332         global $CFG;
333         $logo = get_config('core_admin', 'logo');
334         if (empty($logo)) {
335             return false;
336         }
338         // 200px high is the default image size which should be displayed at 100px in the page to account for retina displays.
339         // It's not worth the overhead of detecting and serving 2 different images based on the device.
341         // Hide the requested size in the file path.
342         $filepath = ((int) $maxwidth . 'x' . (int) $maxheight) . '/';
344         // Use $CFG->themerev to prevent browser caching when the file changes.
345         return moodle_url::make_pluginfile_url(context_system::instance()->id, 'core_admin', 'logo', $filepath,
346             theme_get_revision(), $logo);
347     }
349     /**
350      * Return the site's compact logo URL, if any.
351      *
352      * @param int $maxwidth The maximum width, or null when the maximum width does not matter.
353      * @param int $maxheight The maximum height, or null when the maximum height does not matter.
354      * @return moodle_url|false
355      */
356     public function get_compact_logo_url($maxwidth = 100, $maxheight = 100) {
357         global $CFG;
358         $logo = get_config('core_admin', 'logocompact');
359         if (empty($logo)) {
360             return false;
361         }
363         // Hide the requested size in the file path.
364         $filepath = ((int) $maxwidth . 'x' . (int) $maxheight) . '/';
366         // Use $CFG->themerev to prevent browser caching when the file changes.
367         return moodle_url::make_pluginfile_url(context_system::instance()->id, 'core_admin', 'logocompact', $filepath,
368             theme_get_revision(), $logo);
369     }
374 /**
375  * Basis for all plugin renderers.
376  *
377  * @copyright Petr Skoda (skodak)
378  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
379  * @since Moodle 2.0
380  * @package core
381  * @category output
382  */
383 class plugin_renderer_base extends renderer_base {
385     /**
386      * @var renderer_base|core_renderer A reference to the current renderer.
387      * The renderer provided here will be determined by the page but will in 90%
388      * of cases by the {@link core_renderer}
389      */
390     protected $output;
392     /**
393      * Constructor method, calls the parent constructor
394      *
395      * @param moodle_page $page
396      * @param string $target one of rendering target constants
397      */
398     public function __construct(moodle_page $page, $target) {
399         if (empty($target) && $page->pagelayout === 'maintenance') {
400             // If the page is using the maintenance layout then we're going to force the target to maintenance.
401             // This way we'll get a special maintenance renderer that is designed to block access to API's that are likely
402             // unavailable for this page layout.
403             $target = RENDERER_TARGET_MAINTENANCE;
404         }
405         $this->output = $page->get_renderer('core', null, $target);
406         parent::__construct($page, $target);
407     }
409     /**
410      * Renders the provided widget and returns the HTML to display it.
411      *
412      * @param renderable $widget instance with renderable interface
413      * @return string
414      */
415     public function render(renderable $widget) {
416         $classname = get_class($widget);
417         // Strip namespaces.
418         $classname = preg_replace('/^.*\\\/', '', $classname);
419         // Keep a copy at this point, we may need to look for a deprecated method.
420         $deprecatedmethod = 'render_'.$classname;
421         // Remove _renderable suffixes
422         $classname = preg_replace('/_renderable$/', '', $classname);
424         $rendermethod = 'render_'.$classname;
425         if (method_exists($this, $rendermethod)) {
426             return $this->$rendermethod($widget);
427         }
428         if ($rendermethod !== $deprecatedmethod && method_exists($this, $deprecatedmethod)) {
429             // This is exactly where we don't want to be.
430             // If you have arrived here you have a renderable component within your plugin that has the name
431             // blah_renderable, and you have a render method render_blah_renderable on your plugin.
432             // In 2.8 we revamped output, as part of this change we changed slightly how renderables got rendered
433             // and the _renderable suffix now gets removed when looking for a render method.
434             // You need to change your renderers render_blah_renderable to render_blah.
435             // Until you do this it will not be possible for a theme to override the renderer to override your method.
436             // Please do it ASAP.
437             static $debugged = array();
438             if (!isset($debugged[$deprecatedmethod])) {
439                 debugging(sprintf('Deprecated call. Please rename your renderables render method from %s to %s.',
440                     $deprecatedmethod, $rendermethod), DEBUG_DEVELOPER);
441                 $debugged[$deprecatedmethod] = true;
442             }
443             return $this->$deprecatedmethod($widget);
444         }
445         // pass to core renderer if method not found here
446         return $this->output->render($widget);
447     }
449     /**
450      * Magic method used to pass calls otherwise meant for the standard renderer
451      * to it to ensure we don't go causing unnecessary grief.
452      *
453      * @param string $method
454      * @param array $arguments
455      * @return mixed
456      */
457     public function __call($method, $arguments) {
458         if (method_exists('renderer_base', $method)) {
459             throw new coding_exception('Protected method called against '.get_class($this).' :: '.$method);
460         }
461         if (method_exists($this->output, $method)) {
462             return call_user_func_array(array($this->output, $method), $arguments);
463         } else {
464             throw new coding_exception('Unknown method called against '.get_class($this).' :: '.$method);
465         }
466     }
470 /**
471  * The standard implementation of the core_renderer interface.
472  *
473  * @copyright 2009 Tim Hunt
474  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
475  * @since Moodle 2.0
476  * @package core
477  * @category output
478  */
479 class core_renderer extends renderer_base {
480     /**
481      * Do NOT use, please use <?php echo $OUTPUT->main_content() ?>
482      * in layout files instead.
483      * @deprecated
484      * @var string used in {@link core_renderer::header()}.
485      */
486     const MAIN_CONTENT_TOKEN = '[MAIN CONTENT GOES HERE]';
488     /**
489      * @var string Used to pass information from {@link core_renderer::doctype()} to
490      * {@link core_renderer::standard_head_html()}.
491      */
492     protected $contenttype;
494     /**
495      * @var string Used by {@link core_renderer::redirect_message()} method to communicate
496      * with {@link core_renderer::header()}.
497      */
498     protected $metarefreshtag = '';
500     /**
501      * @var string Unique token for the closing HTML
502      */
503     protected $unique_end_html_token;
505     /**
506      * @var string Unique token for performance information
507      */
508     protected $unique_performance_info_token;
510     /**
511      * @var string Unique token for the main content.
512      */
513     protected $unique_main_content_token;
515     /**
516      * Constructor
517      *
518      * @param moodle_page $page the page we are doing output for.
519      * @param string $target one of rendering target constants
520      */
521     public function __construct(moodle_page $page, $target) {
522         $this->opencontainers = $page->opencontainers;
523         $this->page = $page;
524         $this->target = $target;
526         $this->unique_end_html_token = '%%ENDHTML-'.sesskey().'%%';
527         $this->unique_performance_info_token = '%%PERFORMANCEINFO-'.sesskey().'%%';
528         $this->unique_main_content_token = '[MAIN CONTENT GOES HERE - '.sesskey().']';
529     }
531     /**
532      * Get the DOCTYPE declaration that should be used with this page. Designed to
533      * be called in theme layout.php files.
534      *
535      * @return string the DOCTYPE declaration that should be used.
536      */
537     public function doctype() {
538         if ($this->page->theme->doctype === 'html5') {
539             $this->contenttype = 'text/html; charset=utf-8';
540             return "<!DOCTYPE html>\n";
542         } else if ($this->page->theme->doctype === 'xhtml5') {
543             $this->contenttype = 'application/xhtml+xml; charset=utf-8';
544             return "<!DOCTYPE html>\n";
546         } else {
547             // legacy xhtml 1.0
548             $this->contenttype = 'text/html; charset=utf-8';
549             return ('<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">' . "\n");
550         }
551     }
553     /**
554      * The attributes that should be added to the <html> tag. Designed to
555      * be called in theme layout.php files.
556      *
557      * @return string HTML fragment.
558      */
559     public function htmlattributes() {
560         $return = get_html_lang(true);
561         $attributes = array();
562         if ($this->page->theme->doctype !== 'html5') {
563             $attributes['xmlns'] = 'http://www.w3.org/1999/xhtml';
564         }
566         // Give plugins an opportunity to add things like xml namespaces to the html element.
567         // This function should return an array of html attribute names => values.
568         $pluginswithfunction = get_plugins_with_function('add_htmlattributes', 'lib.php');
569         foreach ($pluginswithfunction as $plugins) {
570             foreach ($plugins as $function) {
571                 $newattrs = $function();
572                 unset($newattrs['dir']);
573                 unset($newattrs['lang']);
574                 unset($newattrs['xmlns']);
575                 unset($newattrs['xml:lang']);
576                 $attributes += $newattrs;
577             }
578         }
580         foreach ($attributes as $key => $val) {
581             $val = s($val);
582             $return .= " $key=\"$val\"";
583         }
585         return $return;
586     }
588     /**
589      * The standard tags (meta tags, links to stylesheets and JavaScript, etc.)
590      * that should be included in the <head> tag. Designed to be called in theme
591      * layout.php files.
592      *
593      * @return string HTML fragment.
594      */
595     public function standard_head_html() {
596         global $CFG, $SESSION;
598         // Before we output any content, we need to ensure that certain
599         // page components are set up.
601         // Blocks must be set up early as they may require javascript which
602         // has to be included in the page header before output is created.
603         foreach ($this->page->blocks->get_regions() as $region) {
604             $this->page->blocks->ensure_content_created($region, $this);
605         }
607         $output = '';
609         // Give plugins an opportunity to add any head elements. The callback
610         // must always return a string containing valid html head content.
611         $pluginswithfunction = get_plugins_with_function('before_standard_html_head', 'lib.php');
612         foreach ($pluginswithfunction as $plugins) {
613             foreach ($plugins as $function) {
614                 $output .= $function();
615             }
616         }
618         // Allow a url_rewrite plugin to setup any dynamic head content.
619         if (isset($CFG->urlrewriteclass) && !isset($CFG->upgraderunning)) {
620             $class = $CFG->urlrewriteclass;
621             $output .= $class::html_head_setup();
622         }
624         $output .= '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />' . "\n";
625         $output .= '<meta name="keywords" content="moodle, ' . $this->page->title . '" />' . "\n";
626         // This is only set by the {@link redirect()} method
627         $output .= $this->metarefreshtag;
629         // Check if a periodic refresh delay has been set and make sure we arn't
630         // already meta refreshing
631         if ($this->metarefreshtag=='' && $this->page->periodicrefreshdelay!==null) {
632             $output .= '<meta http-equiv="refresh" content="'.$this->page->periodicrefreshdelay.';url='.$this->page->url->out().'" />';
633         }
635         // Set up help link popups for all links with the helptooltip class
636         $this->page->requires->js_init_call('M.util.help_popups.setup');
638         $focus = $this->page->focuscontrol;
639         if (!empty($focus)) {
640             if (preg_match("#forms\['([a-zA-Z0-9]+)'\].elements\['([a-zA-Z0-9]+)'\]#", $focus, $matches)) {
641                 // This is a horrifically bad way to handle focus but it is passed in
642                 // through messy formslib::moodleform
643                 $this->page->requires->js_function_call('old_onload_focus', array($matches[1], $matches[2]));
644             } else if (strpos($focus, '.')!==false) {
645                 // Old style of focus, bad way to do it
646                 debugging('This code is using the old style focus event, Please update this code to focus on an element id or the moodleform focus method.', DEBUG_DEVELOPER);
647                 $this->page->requires->js_function_call('old_onload_focus', explode('.', $focus, 2));
648             } else {
649                 // Focus element with given id
650                 $this->page->requires->js_function_call('focuscontrol', array($focus));
651             }
652         }
654         // Get the theme stylesheet - this has to be always first CSS, this loads also styles.css from all plugins;
655         // any other custom CSS can not be overridden via themes and is highly discouraged
656         $urls = $this->page->theme->css_urls($this->page);
657         foreach ($urls as $url) {
658             $this->page->requires->css_theme($url);
659         }
661         // Get the theme javascript head and footer
662         if ($jsurl = $this->page->theme->javascript_url(true)) {
663             $this->page->requires->js($jsurl, true);
664         }
665         if ($jsurl = $this->page->theme->javascript_url(false)) {
666             $this->page->requires->js($jsurl);
667         }
669         // Get any HTML from the page_requirements_manager.
670         $output .= $this->page->requires->get_head_code($this->page, $this);
672         // List alternate versions.
673         foreach ($this->page->alternateversions as $type => $alt) {
674             $output .= html_writer::empty_tag('link', array('rel' => 'alternate',
675                     'type' => $type, 'title' => $alt->title, 'href' => $alt->url));
676         }
678         // Add noindex tag if relevant page and setting applied.
679         $allowindexing = isset($CFG->allowindexing) ? $CFG->allowindexing : 0;
680         $loginpages = array('login-index', 'login-signup');
681         if ($allowindexing == 2 || ($allowindexing == 0 && in_array($this->page->pagetype, $loginpages))) {
682             if (!isset($CFG->additionalhtmlhead)) {
683                 $CFG->additionalhtmlhead = '';
684             }
685             $CFG->additionalhtmlhead .= '<meta name="robots" content="noindex" />';
686         }
688         if (!empty($CFG->additionalhtmlhead)) {
689             $output .= "\n".$CFG->additionalhtmlhead;
690         }
692         return $output;
693     }
695     /**
696      * The standard tags (typically skip links) that should be output just inside
697      * the start of the <body> tag. Designed to be called in theme layout.php files.
698      *
699      * @return string HTML fragment.
700      */
701     public function standard_top_of_body_html() {
702         global $CFG;
703         $output = $this->page->requires->get_top_of_body_code($this);
704         if ($this->page->pagelayout !== 'embedded' && !empty($CFG->additionalhtmltopofbody)) {
705             $output .= "\n".$CFG->additionalhtmltopofbody;
706         }
708         // Give plugins an opportunity to inject extra html content. The callback
709         // must always return a string containing valid html.
710         $pluginswithfunction = get_plugins_with_function('before_standard_top_of_body_html', 'lib.php');
711         foreach ($pluginswithfunction as $plugins) {
712             foreach ($plugins as $function) {
713                 $output .= $function();
714             }
715         }
717         $output .= $this->maintenance_warning();
719         return $output;
720     }
722     /**
723      * Scheduled maintenance warning message.
724      *
725      * Note: This is a nasty hack to display maintenance notice, this should be moved
726      *       to some general notification area once we have it.
727      *
728      * @return string
729      */
730     public function maintenance_warning() {
731         global $CFG;
733         $output = '';
734         if (isset($CFG->maintenance_later) and $CFG->maintenance_later > time()) {
735             $timeleft = $CFG->maintenance_later - time();
736             // If timeleft less than 30 sec, set the class on block to error to highlight.
737             $errorclass = ($timeleft < 30) ? 'alert-error alert-danger' : 'alert-warning';
738             $output .= $this->box_start($errorclass . ' moodle-has-zindex maintenancewarning m-a-1 alert');
739             $a = new stdClass();
740             $a->hour = (int)($timeleft / 3600);
741             $a->min = (int)(($timeleft / 60) % 60);
742             $a->sec = (int)($timeleft % 60);
743             if ($a->hour > 0) {
744                 $output .= get_string('maintenancemodeisscheduledlong', 'admin', $a);
745             } else {
746                 $output .= get_string('maintenancemodeisscheduled', 'admin', $a);
747             }
749             $output .= $this->box_end();
750             $this->page->requires->yui_module('moodle-core-maintenancemodetimer', 'M.core.maintenancemodetimer',
751                     array(array('timeleftinsec' => $timeleft)));
752             $this->page->requires->strings_for_js(
753                     array('maintenancemodeisscheduled', 'maintenancemodeisscheduledlong', 'sitemaintenance'),
754                     'admin');
755         }
756         return $output;
757     }
759     /**
760      * The standard tags (typically performance information and validation links,
761      * if we are in developer debug mode) that should be output in the footer area
762      * of the page. Designed to be called in theme layout.php files.
763      *
764      * @return string HTML fragment.
765      */
766     public function standard_footer_html() {
767         global $CFG, $SCRIPT;
769         $output = '';
770         if (during_initial_install()) {
771             // Debugging info can not work before install is finished,
772             // in any case we do not want any links during installation!
773             return $output;
774         }
776         // Give plugins an opportunity to add any footer elements.
777         // The callback must always return a string containing valid html footer content.
778         $pluginswithfunction = get_plugins_with_function('standard_footer_html', 'lib.php');
779         foreach ($pluginswithfunction as $plugins) {
780             foreach ($plugins as $function) {
781                 $output .= $function();
782             }
783         }
785         // This function is normally called from a layout.php file in {@link core_renderer::header()}
786         // but some of the content won't be known until later, so we return a placeholder
787         // for now. This will be replaced with the real content in {@link core_renderer::footer()}.
788         $output .= $this->unique_performance_info_token;
789         if ($this->page->devicetypeinuse == 'legacy') {
790             // The legacy theme is in use print the notification
791             $output .= html_writer::tag('div', get_string('legacythemeinuse'), array('class'=>'legacythemeinuse'));
792         }
794         // Get links to switch device types (only shown for users not on a default device)
795         $output .= $this->theme_switch_links();
797         if (!empty($CFG->debugpageinfo)) {
798             $output .= '<div class="performanceinfo pageinfo">' . get_string('pageinfodebugsummary', 'core_admin',
799                 $this->page->debug_summary()) . '</div>';
800         }
801         if (debugging(null, DEBUG_DEVELOPER) and has_capability('moodle/site:config', context_system::instance())) {  // Only in developer mode
802             // Add link to profiling report if necessary
803             if (function_exists('profiling_is_running') && profiling_is_running()) {
804                 $txt = get_string('profiledscript', 'admin');
805                 $title = get_string('profiledscriptview', 'admin');
806                 $url = $CFG->wwwroot . '/admin/tool/profiling/index.php?script=' . urlencode($SCRIPT);
807                 $link= '<a title="' . $title . '" href="' . $url . '">' . $txt . '</a>';
808                 $output .= '<div class="profilingfooter">' . $link . '</div>';
809             }
810             $purgeurl = new moodle_url('/admin/purgecaches.php', array('confirm' => 1,
811                 'sesskey' => sesskey(), 'returnurl' => $this->page->url->out_as_local_url(false)));
812             $output .= '<div class="purgecaches">' .
813                     html_writer::link($purgeurl, get_string('purgecaches', 'admin')) . '</div>';
814         }
815         if (!empty($CFG->debugvalidators)) {
816             // NOTE: this is not a nice hack, $PAGE->url is not always accurate and $FULLME neither, it is not a bug if it fails. --skodak
817             $output .= '<div class="validators"><ul class="list-unstyled m-l-1">
818               <li><a href="http://validator.w3.org/check?verbose=1&amp;ss=1&amp;uri=' . urlencode(qualified_me()) . '">Validate HTML</a></li>
819               <li><a href="http://www.contentquality.com/mynewtester/cynthia.exe?rptmode=-1&amp;url1=' . urlencode(qualified_me()) . '">Section 508 Check</a></li>
820               <li><a href="http://www.contentquality.com/mynewtester/cynthia.exe?rptmode=0&amp;warnp2n3e=1&amp;url1=' . urlencode(qualified_me()) . '">WCAG 1 (2,3) Check</a></li>
821             </ul></div>';
822         }
823         return $output;
824     }
826     /**
827      * Returns standard main content placeholder.
828      * Designed to be called in theme layout.php files.
829      *
830      * @return string HTML fragment.
831      */
832     public function main_content() {
833         // This is here because it is the only place we can inject the "main" role over the entire main content area
834         // without requiring all theme's to manually do it, and without creating yet another thing people need to
835         // remember in the theme.
836         // This is an unfortunate hack. DO NO EVER add anything more here.
837         // DO NOT add classes.
838         // DO NOT add an id.
839         return '<div role="main">'.$this->unique_main_content_token.'</div>';
840     }
842     /**
843      * Returns standard navigation between activities in a course.
844      *
845      * @return string the navigation HTML.
846      */
847     public function activity_navigation() {
848         // First we should check if we want to add navigation.
849         $context = $this->page->context;
850         if (($this->page->pagelayout !== 'incourse' && $this->page->pagelayout !== 'frametop')
851             || $context->contextlevel != CONTEXT_MODULE) {
852             return '';
853         }
855         // If the activity is in stealth mode, show no links.
856         if ($this->page->cm->is_stealth()) {
857             return '';
858         }
860         // Get a list of all the activities in the course.
861         $course = $this->page->cm->get_course();
862         $modules = get_fast_modinfo($course->id)->get_cms();
864         // Put the modules into an array in order by the position they are shown in the course.
865         $mods = [];
866         $activitylist = [];
867         foreach ($modules as $module) {
868             // Only add activities the user can access, aren't in stealth mode and have a url (eg. mod_label does not).
869             if (!$module->uservisible || $module->is_stealth() || empty($module->url)) {
870                 continue;
871             }
872             $mods[$module->id] = $module;
874             // No need to add the current module to the list for the activity dropdown menu.
875             if ($module->id == $this->page->cm->id) {
876                 continue;
877             }
878             // Module name.
879             $modname = $module->get_formatted_name();
880             // Display the hidden text if necessary.
881             if (!$module->visible) {
882                 $modname .= ' ' . get_string('hiddenwithbrackets');
883             }
884             // Module URL.
885             $linkurl = new moodle_url($module->url, array('forceview' => 1));
886             // Add module URL (as key) and name (as value) to the activity list array.
887             $activitylist[$linkurl->out(false)] = $modname;
888         }
890         $nummods = count($mods);
892         // If there is only one mod then do nothing.
893         if ($nummods == 1) {
894             return '';
895         }
897         // Get an array of just the course module ids used to get the cmid value based on their position in the course.
898         $modids = array_keys($mods);
900         // Get the position in the array of the course module we are viewing.
901         $position = array_search($this->page->cm->id, $modids);
903         $prevmod = null;
904         $nextmod = null;
906         // Check if we have a previous mod to show.
907         if ($position > 0) {
908             $prevmod = $mods[$modids[$position - 1]];
909         }
911         // Check if we have a next mod to show.
912         if ($position < ($nummods - 1)) {
913             $nextmod = $mods[$modids[$position + 1]];
914         }
916         $activitynav = new \core_course\output\activity_navigation($prevmod, $nextmod, $activitylist);
917         $renderer = $this->page->get_renderer('core', 'course');
918         return $renderer->render($activitynav);
919     }
921     /**
922      * The standard tags (typically script tags that are not needed earlier) that
923      * should be output after everything else. Designed to be called in theme layout.php files.
924      *
925      * @return string HTML fragment.
926      */
927     public function standard_end_of_body_html() {
928         global $CFG;
930         // This function is normally called from a layout.php file in {@link core_renderer::header()}
931         // but some of the content won't be known until later, so we return a placeholder
932         // for now. This will be replaced with the real content in {@link core_renderer::footer()}.
933         $output = '';
934         if ($this->page->pagelayout !== 'embedded' && !empty($CFG->additionalhtmlfooter)) {
935             $output .= "\n".$CFG->additionalhtmlfooter;
936         }
937         $output .= $this->unique_end_html_token;
938         return $output;
939     }
941     /**
942      * Return the standard string that says whether you are logged in (and switched
943      * roles/logged in as another user).
944      * @param bool $withlinks if false, then don't include any links in the HTML produced.
945      * If not set, the default is the nologinlinks option from the theme config.php file,
946      * and if that is not set, then links are included.
947      * @return string HTML fragment.
948      */
949     public function login_info($withlinks = null) {
950         global $USER, $CFG, $DB, $SESSION;
952         if (during_initial_install()) {
953             return '';
954         }
956         if (is_null($withlinks)) {
957             $withlinks = empty($this->page->layout_options['nologinlinks']);
958         }
960         $course = $this->page->course;
961         if (\core\session\manager::is_loggedinas()) {
962             $realuser = \core\session\manager::get_realuser();
963             $fullname = fullname($realuser, true);
964             if ($withlinks) {
965                 $loginastitle = get_string('loginas');
966                 $realuserinfo = " [<a href=\"$CFG->wwwroot/course/loginas.php?id=$course->id&amp;sesskey=".sesskey()."\"";
967                 $realuserinfo .= "title =\"".$loginastitle."\">$fullname</a>] ";
968             } else {
969                 $realuserinfo = " [$fullname] ";
970             }
971         } else {
972             $realuserinfo = '';
973         }
975         $loginpage = $this->is_login_page();
976         $loginurl = get_login_url();
978         if (empty($course->id)) {
979             // $course->id is not defined during installation
980             return '';
981         } else if (isloggedin()) {
982             $context = context_course::instance($course->id);
984             $fullname = fullname($USER, true);
985             // Since Moodle 2.0 this link always goes to the public profile page (not the course profile page)
986             if ($withlinks) {
987                 $linktitle = get_string('viewprofile');
988                 $username = "<a href=\"$CFG->wwwroot/user/profile.php?id=$USER->id\" title=\"$linktitle\">$fullname</a>";
989             } else {
990                 $username = $fullname;
991             }
992             if (is_mnet_remote_user($USER) and $idprovider = $DB->get_record('mnet_host', array('id'=>$USER->mnethostid))) {
993                 if ($withlinks) {
994                     $username .= " from <a href=\"{$idprovider->wwwroot}\">{$idprovider->name}</a>";
995                 } else {
996                     $username .= " from {$idprovider->name}";
997                 }
998             }
999             if (isguestuser()) {
1000                 $loggedinas = $realuserinfo.get_string('loggedinasguest');
1001                 if (!$loginpage && $withlinks) {
1002                     $loggedinas .= " (<a href=\"$loginurl\">".get_string('login').'</a>)';
1003                 }
1004             } else if (is_role_switched($course->id)) { // Has switched roles
1005                 $rolename = '';
1006                 if ($role = $DB->get_record('role', array('id'=>$USER->access['rsw'][$context->path]))) {
1007                     $rolename = ': '.role_get_name($role, $context);
1008                 }
1009                 $loggedinas = get_string('loggedinas', 'moodle', $username).$rolename;
1010                 if ($withlinks) {
1011                     $url = new moodle_url('/course/switchrole.php', array('id'=>$course->id,'sesskey'=>sesskey(), 'switchrole'=>0, 'returnurl'=>$this->page->url->out_as_local_url(false)));
1012                     $loggedinas .= ' ('.html_writer::tag('a', get_string('switchrolereturn'), array('href' => $url)).')';
1013                 }
1014             } else {
1015                 $loggedinas = $realuserinfo.get_string('loggedinas', 'moodle', $username);
1016                 if ($withlinks) {
1017                     $loggedinas .= " (<a href=\"$CFG->wwwroot/login/logout.php?sesskey=".sesskey()."\">".get_string('logout').'</a>)';
1018                 }
1019             }
1020         } else {
1021             $loggedinas = get_string('loggedinnot', 'moodle');
1022             if (!$loginpage && $withlinks) {
1023                 $loggedinas .= " (<a href=\"$loginurl\">".get_string('login').'</a>)';
1024             }
1025         }
1027         $loggedinas = '<div class="logininfo">'.$loggedinas.'</div>';
1029         if (isset($SESSION->justloggedin)) {
1030             unset($SESSION->justloggedin);
1031             if (!empty($CFG->displayloginfailures)) {
1032                 if (!isguestuser()) {
1033                     // Include this file only when required.
1034                     require_once($CFG->dirroot . '/user/lib.php');
1035                     if ($count = user_count_login_failures($USER)) {
1036                         $loggedinas .= '<div class="loginfailures">';
1037                         $a = new stdClass();
1038                         $a->attempts = $count;
1039                         $loggedinas .= get_string('failedloginattempts', '', $a);
1040                         if (file_exists("$CFG->dirroot/report/log/index.php") and has_capability('report/log:view', context_system::instance())) {
1041                             $loggedinas .= ' ('.html_writer::link(new moodle_url('/report/log/index.php', array('chooselog' => 1,
1042                                     'id' => 0 , 'modid' => 'site_errors')), get_string('logs')).')';
1043                         }
1044                         $loggedinas .= '</div>';
1045                     }
1046                 }
1047             }
1048         }
1050         return $loggedinas;
1051     }
1053     /**
1054      * Check whether the current page is a login page.
1055      *
1056      * @since Moodle 2.9
1057      * @return bool
1058      */
1059     protected function is_login_page() {
1060         // This is a real bit of a hack, but its a rarety that we need to do something like this.
1061         // In fact the login pages should be only these two pages and as exposing this as an option for all pages
1062         // could lead to abuse (or at least unneedingly complex code) the hack is the way to go.
1063         return in_array(
1064             $this->page->url->out_as_local_url(false, array()),
1065             array(
1066                 '/login/index.php',
1067                 '/login/forgot_password.php',
1068             )
1069         );
1070     }
1072     /**
1073      * Return the 'back' link that normally appears in the footer.
1074      *
1075      * @return string HTML fragment.
1076      */
1077     public function home_link() {
1078         global $CFG, $SITE;
1080         if ($this->page->pagetype == 'site-index') {
1081             // Special case for site home page - please do not remove
1082             return '<div class="sitelink">' .
1083                    '<a title="Moodle" href="http://moodle.org/">' .
1084                    '<img src="' . $this->image_url('moodlelogo') . '" alt="'.get_string('moodlelogo').'" /></a></div>';
1086         } else if (!empty($CFG->target_release) && $CFG->target_release != $CFG->release) {
1087             // Special case for during install/upgrade.
1088             return '<div class="sitelink">'.
1089                    '<a title="Moodle" href="http://docs.moodle.org/en/Administrator_documentation" onclick="this.target=\'_blank\'">' .
1090                    '<img src="' . $this->image_url('moodlelogo') . '" alt="'.get_string('moodlelogo').'" /></a></div>';
1092         } else if ($this->page->course->id == $SITE->id || strpos($this->page->pagetype, 'course-view') === 0) {
1093             return '<div class="homelink"><a href="' . $CFG->wwwroot . '/">' .
1094                     get_string('home') . '</a></div>';
1096         } else {
1097             return '<div class="homelink"><a href="' . $CFG->wwwroot . '/course/view.php?id=' . $this->page->course->id . '">' .
1098                     format_string($this->page->course->shortname, true, array('context' => $this->page->context)) . '</a></div>';
1099         }
1100     }
1102     /**
1103      * Redirects the user by any means possible given the current state
1104      *
1105      * This function should not be called directly, it should always be called using
1106      * the redirect function in lib/weblib.php
1107      *
1108      * The redirect function should really only be called before page output has started
1109      * however it will allow itself to be called during the state STATE_IN_BODY
1110      *
1111      * @param string $encodedurl The URL to send to encoded if required
1112      * @param string $message The message to display to the user if any
1113      * @param int $delay The delay before redirecting a user, if $message has been
1114      *         set this is a requirement and defaults to 3, set to 0 no delay
1115      * @param boolean $debugdisableredirect this redirect has been disabled for
1116      *         debugging purposes. Display a message that explains, and don't
1117      *         trigger the redirect.
1118      * @param string $messagetype The type of notification to show the message in.
1119      *         See constants on \core\output\notification.
1120      * @return string The HTML to display to the user before dying, may contain
1121      *         meta refresh, javascript refresh, and may have set header redirects
1122      */
1123     public function redirect_message($encodedurl, $message, $delay, $debugdisableredirect,
1124                                      $messagetype = \core\output\notification::NOTIFY_INFO) {
1125         global $CFG;
1126         $url = str_replace('&amp;', '&', $encodedurl);
1128         switch ($this->page->state) {
1129             case moodle_page::STATE_BEFORE_HEADER :
1130                 // No output yet it is safe to delivery the full arsenal of redirect methods
1131                 if (!$debugdisableredirect) {
1132                     // Don't use exactly the same time here, it can cause problems when both redirects fire at the same time.
1133                     $this->metarefreshtag = '<meta http-equiv="refresh" content="'. $delay .'; url='. $encodedurl .'" />'."\n";
1134                     $this->page->requires->js_function_call('document.location.replace', array($url), false, ($delay + 3));
1135                 }
1136                 $output = $this->header();
1137                 break;
1138             case moodle_page::STATE_PRINTING_HEADER :
1139                 // We should hopefully never get here
1140                 throw new coding_exception('You cannot redirect while printing the page header');
1141                 break;
1142             case moodle_page::STATE_IN_BODY :
1143                 // We really shouldn't be here but we can deal with this
1144                 debugging("You should really redirect before you start page output");
1145                 if (!$debugdisableredirect) {
1146                     $this->page->requires->js_function_call('document.location.replace', array($url), false, $delay);
1147                 }
1148                 $output = $this->opencontainers->pop_all_but_last();
1149                 break;
1150             case moodle_page::STATE_DONE :
1151                 // Too late to be calling redirect now
1152                 throw new coding_exception('You cannot redirect after the entire page has been generated');
1153                 break;
1154         }
1155         $output .= $this->notification($message, $messagetype);
1156         $output .= '<div class="continuebutton">(<a href="'. $encodedurl .'">'. get_string('continue') .'</a>)</div>';
1157         if ($debugdisableredirect) {
1158             $output .= '<p><strong>'.get_string('erroroutput', 'error').'</strong></p>';
1159         }
1160         $output .= $this->footer();
1161         return $output;
1162     }
1164     /**
1165      * Start output by sending the HTTP headers, and printing the HTML <head>
1166      * and the start of the <body>.
1167      *
1168      * To control what is printed, you should set properties on $PAGE. If you
1169      * are familiar with the old {@link print_header()} function from Moodle 1.9
1170      * you will find that there are properties on $PAGE that correspond to most
1171      * of the old parameters to could be passed to print_header.
1172      *
1173      * Not that, in due course, the remaining $navigation, $menu parameters here
1174      * will be replaced by more properties of $PAGE, but that is still to do.
1175      *
1176      * @return string HTML that you must output this, preferably immediately.
1177      */
1178     public function header() {
1179         global $USER, $CFG, $SESSION;
1181         // Give plugins an opportunity touch things before the http headers are sent
1182         // such as adding additional headers. The return value is ignored.
1183         $pluginswithfunction = get_plugins_with_function('before_http_headers', 'lib.php');
1184         foreach ($pluginswithfunction as $plugins) {
1185             foreach ($plugins as $function) {
1186                 $function();
1187             }
1188         }
1190         if (\core\session\manager::is_loggedinas()) {
1191             $this->page->add_body_class('userloggedinas');
1192         }
1194         if (isset($SESSION->justloggedin) && !empty($CFG->displayloginfailures)) {
1195             require_once($CFG->dirroot . '/user/lib.php');
1196             // Set second parameter to false as we do not want reset the counter, the same message appears on footer.
1197             if ($count = user_count_login_failures($USER, false)) {
1198                 $this->page->add_body_class('loginfailures');
1199             }
1200         }
1202         // If the user is logged in, and we're not in initial install,
1203         // check to see if the user is role-switched and add the appropriate
1204         // CSS class to the body element.
1205         if (!during_initial_install() && isloggedin() && is_role_switched($this->page->course->id)) {
1206             $this->page->add_body_class('userswitchedrole');
1207         }
1209         // Give themes a chance to init/alter the page object.
1210         $this->page->theme->init_page($this->page);
1212         $this->page->set_state(moodle_page::STATE_PRINTING_HEADER);
1214         // Find the appropriate page layout file, based on $this->page->pagelayout.
1215         $layoutfile = $this->page->theme->layout_file($this->page->pagelayout);
1216         // Render the layout using the layout file.
1217         $rendered = $this->render_page_layout($layoutfile);
1219         // Slice the rendered output into header and footer.
1220         $cutpos = strpos($rendered, $this->unique_main_content_token);
1221         if ($cutpos === false) {
1222             $cutpos = strpos($rendered, self::MAIN_CONTENT_TOKEN);
1223             $token = self::MAIN_CONTENT_TOKEN;
1224         } else {
1225             $token = $this->unique_main_content_token;
1226         }
1228         if ($cutpos === false) {
1229             throw new coding_exception('page layout file ' . $layoutfile . ' does not contain the main content placeholder, please include "<?php echo $OUTPUT->main_content() ?>" in theme layout file.');
1230         }
1231         $header = substr($rendered, 0, $cutpos);
1232         $footer = substr($rendered, $cutpos + strlen($token));
1234         if (empty($this->contenttype)) {
1235             debugging('The page layout file did not call $OUTPUT->doctype()');
1236             $header = $this->doctype() . $header;
1237         }
1239         // If this theme version is below 2.4 release and this is a course view page
1240         if ((!isset($this->page->theme->settings->version) || $this->page->theme->settings->version < 2012101500) &&
1241                 $this->page->pagelayout === 'course' && $this->page->url->compare(new moodle_url('/course/view.php'), URL_MATCH_BASE)) {
1242             // check if course content header/footer have not been output during render of theme layout
1243             $coursecontentheader = $this->course_content_header(true);
1244             $coursecontentfooter = $this->course_content_footer(true);
1245             if (!empty($coursecontentheader)) {
1246                 // display debug message and add header and footer right above and below main content
1247                 // Please note that course header and footer (to be displayed above and below the whole page)
1248                 // are not displayed in this case at all.
1249                 // Besides the content header and footer are not displayed on any other course page
1250                 debugging('The current theme is not optimised for 2.4, the course-specific header and footer defined in course format will not be output', DEBUG_DEVELOPER);
1251                 $header .= $coursecontentheader;
1252                 $footer = $coursecontentfooter. $footer;
1253             }
1254         }
1256         send_headers($this->contenttype, $this->page->cacheable);
1258         $this->opencontainers->push('header/footer', $footer);
1259         $this->page->set_state(moodle_page::STATE_IN_BODY);
1261         return $header . $this->skip_link_target('maincontent');
1262     }
1264     /**
1265      * Renders and outputs the page layout file.
1266      *
1267      * This is done by preparing the normal globals available to a script, and
1268      * then including the layout file provided by the current theme for the
1269      * requested layout.
1270      *
1271      * @param string $layoutfile The name of the layout file
1272      * @return string HTML code
1273      */
1274     protected function render_page_layout($layoutfile) {
1275         global $CFG, $SITE, $USER;
1276         // The next lines are a bit tricky. The point is, here we are in a method
1277         // of a renderer class, and this object may, or may not, be the same as
1278         // the global $OUTPUT object. When rendering the page layout file, we want to use
1279         // this object. However, people writing Moodle code expect the current
1280         // renderer to be called $OUTPUT, not $this, so define a variable called
1281         // $OUTPUT pointing at $this. The same comment applies to $PAGE and $COURSE.
1282         $OUTPUT = $this;
1283         $PAGE = $this->page;
1284         $COURSE = $this->page->course;
1286         ob_start();
1287         include($layoutfile);
1288         $rendered = ob_get_contents();
1289         ob_end_clean();
1290         return $rendered;
1291     }
1293     /**
1294      * Outputs the page's footer
1295      *
1296      * @return string HTML fragment
1297      */
1298     public function footer() {
1299         global $CFG, $DB, $PAGE;
1301         // Give plugins an opportunity to touch the page before JS is finalized.
1302         $pluginswithfunction = get_plugins_with_function('before_footer', 'lib.php');
1303         foreach ($pluginswithfunction as $plugins) {
1304             foreach ($plugins as $function) {
1305                 $function();
1306             }
1307         }
1309         $output = $this->container_end_all(true);
1311         $footer = $this->opencontainers->pop('header/footer');
1313         if (debugging() and $DB and $DB->is_transaction_started()) {
1314             // TODO: MDL-20625 print warning - transaction will be rolled back
1315         }
1317         // Provide some performance info if required
1318         $performanceinfo = '';
1319         if (defined('MDL_PERF') || (!empty($CFG->perfdebug) and $CFG->perfdebug > 7)) {
1320             $perf = get_performance_info();
1321             if (defined('MDL_PERFTOFOOT') || debugging() || $CFG->perfdebug > 7) {
1322                 $performanceinfo = $perf['html'];
1323             }
1324         }
1326         // We always want performance data when running a performance test, even if the user is redirected to another page.
1327         if (MDL_PERF_TEST && strpos($footer, $this->unique_performance_info_token) === false) {
1328             $footer = $this->unique_performance_info_token . $footer;
1329         }
1330         $footer = str_replace($this->unique_performance_info_token, $performanceinfo, $footer);
1332         // Only show notifications when we have a $PAGE context id.
1333         if (!empty($PAGE->context->id)) {
1334             $this->page->requires->js_call_amd('core/notification', 'init', array(
1335                 $PAGE->context->id,
1336                 \core\notification::fetch_as_array($this)
1337             ));
1338         }
1339         $footer = str_replace($this->unique_end_html_token, $this->page->requires->get_end_code(), $footer);
1341         $this->page->set_state(moodle_page::STATE_DONE);
1343         return $output . $footer;
1344     }
1346     /**
1347      * Close all but the last open container. This is useful in places like error
1348      * handling, where you want to close all the open containers (apart from <body>)
1349      * before outputting the error message.
1350      *
1351      * @param bool $shouldbenone assert that the stack should be empty now - causes a
1352      *      developer debug warning if it isn't.
1353      * @return string the HTML required to close any open containers inside <body>.
1354      */
1355     public function container_end_all($shouldbenone = false) {
1356         return $this->opencontainers->pop_all_but_last($shouldbenone);
1357     }
1359     /**
1360      * Returns course-specific information to be output immediately above content on any course page
1361      * (for the current course)
1362      *
1363      * @param bool $onlyifnotcalledbefore output content only if it has not been output before
1364      * @return string
1365      */
1366     public function course_content_header($onlyifnotcalledbefore = false) {
1367         global $CFG;
1368         static $functioncalled = false;
1369         if ($functioncalled && $onlyifnotcalledbefore) {
1370             // we have already output the content header
1371             return '';
1372         }
1374         // Output any session notification.
1375         $notifications = \core\notification::fetch();
1377         $bodynotifications = '';
1378         foreach ($notifications as $notification) {
1379             $bodynotifications .= $this->render_from_template(
1380                     $notification->get_template_name(),
1381                     $notification->export_for_template($this)
1382                 );
1383         }
1385         $output = html_writer::span($bodynotifications, 'notifications', array('id' => 'user-notifications'));
1387         if ($this->page->course->id == SITEID) {
1388             // return immediately and do not include /course/lib.php if not necessary
1389             return $output;
1390         }
1392         require_once($CFG->dirroot.'/course/lib.php');
1393         $functioncalled = true;
1394         $courseformat = course_get_format($this->page->course);
1395         if (($obj = $courseformat->course_content_header()) !== null) {
1396             $output .= html_writer::div($courseformat->get_renderer($this->page)->render($obj), 'course-content-header');
1397         }
1398         return $output;
1399     }
1401     /**
1402      * Returns course-specific information to be output immediately below content on any course page
1403      * (for the current course)
1404      *
1405      * @param bool $onlyifnotcalledbefore output content only if it has not been output before
1406      * @return string
1407      */
1408     public function course_content_footer($onlyifnotcalledbefore = false) {
1409         global $CFG;
1410         if ($this->page->course->id == SITEID) {
1411             // return immediately and do not include /course/lib.php if not necessary
1412             return '';
1413         }
1414         static $functioncalled = false;
1415         if ($functioncalled && $onlyifnotcalledbefore) {
1416             // we have already output the content footer
1417             return '';
1418         }
1419         $functioncalled = true;
1420         require_once($CFG->dirroot.'/course/lib.php');
1421         $courseformat = course_get_format($this->page->course);
1422         if (($obj = $courseformat->course_content_footer()) !== null) {
1423             return html_writer::div($courseformat->get_renderer($this->page)->render($obj), 'course-content-footer');
1424         }
1425         return '';
1426     }
1428     /**
1429      * Returns course-specific information to be output on any course page in the header area
1430      * (for the current course)
1431      *
1432      * @return string
1433      */
1434     public function course_header() {
1435         global $CFG;
1436         if ($this->page->course->id == SITEID) {
1437             // return immediately and do not include /course/lib.php if not necessary
1438             return '';
1439         }
1440         require_once($CFG->dirroot.'/course/lib.php');
1441         $courseformat = course_get_format($this->page->course);
1442         if (($obj = $courseformat->course_header()) !== null) {
1443             return $courseformat->get_renderer($this->page)->render($obj);
1444         }
1445         return '';
1446     }
1448     /**
1449      * Returns course-specific information to be output on any course page in the footer area
1450      * (for the current course)
1451      *
1452      * @return string
1453      */
1454     public function course_footer() {
1455         global $CFG;
1456         if ($this->page->course->id == SITEID) {
1457             // return immediately and do not include /course/lib.php if not necessary
1458             return '';
1459         }
1460         require_once($CFG->dirroot.'/course/lib.php');
1461         $courseformat = course_get_format($this->page->course);
1462         if (($obj = $courseformat->course_footer()) !== null) {
1463             return $courseformat->get_renderer($this->page)->render($obj);
1464         }
1465         return '';
1466     }
1468     /**
1469      * Returns lang menu or '', this method also checks forcing of languages in courses.
1470      *
1471      * This function calls {@link core_renderer::render_single_select()} to actually display the language menu.
1472      *
1473      * @return string The lang menu HTML or empty string
1474      */
1475     public function lang_menu() {
1476         global $CFG;
1478         if (empty($CFG->langmenu)) {
1479             return '';
1480         }
1482         if ($this->page->course != SITEID and !empty($this->page->course->lang)) {
1483             // do not show lang menu if language forced
1484             return '';
1485         }
1487         $currlang = current_language();
1488         $langs = get_string_manager()->get_list_of_translations();
1490         if (count($langs) < 2) {
1491             return '';
1492         }
1494         $s = new single_select($this->page->url, 'lang', $langs, $currlang, null);
1495         $s->label = get_accesshide(get_string('language'));
1496         $s->class = 'langmenu';
1497         return $this->render($s);
1498     }
1500     /**
1501      * Output the row of editing icons for a block, as defined by the controls array.
1502      *
1503      * @param array $controls an array like {@link block_contents::$controls}.
1504      * @param string $blockid The ID given to the block.
1505      * @return string HTML fragment.
1506      */
1507     public function block_controls($actions, $blockid = null) {
1508         global $CFG;
1509         if (empty($actions)) {
1510             return '';
1511         }
1512         $menu = new action_menu($actions);
1513         if ($blockid !== null) {
1514             $menu->set_owner_selector('#'.$blockid);
1515         }
1516         $menu->set_constraint('.block-region');
1517         $menu->attributes['class'] .= ' block-control-actions commands';
1518         return $this->render($menu);
1519     }
1521     /**
1522      * Returns the HTML for a basic textarea field.
1523      *
1524      * @param string $name Name to use for the textarea element
1525      * @param string $id The id to use fort he textarea element
1526      * @param string $value Initial content to display in the textarea
1527      * @param int $rows Number of rows to display
1528      * @param int $cols Number of columns to display
1529      * @return string the HTML to display
1530      */
1531     public function print_textarea($name, $id, $value, $rows, $cols) {
1532         global $OUTPUT;
1534         editors_head_setup();
1535         $editor = editors_get_preferred_editor(FORMAT_HTML);
1536         $editor->set_text($value);
1537         $editor->use_editor($id, []);
1539         $context = [
1540             'id' => $id,
1541             'name' => $name,
1542             'value' => $value,
1543             'rows' => $rows,
1544             'cols' => $cols
1545         ];
1547         return $OUTPUT->render_from_template('core_form/editor_textarea', $context);
1548     }
1550     /**
1551      * Renders an action menu component.
1552      *
1553      * ARIA references:
1554      *   - http://www.w3.org/WAI/GL/wiki/Using_ARIA_menus
1555      *   - http://stackoverflow.com/questions/12279113/recommended-wai-aria-implementation-for-navigation-bar-menu
1556      *
1557      * @param action_menu $menu
1558      * @return string HTML
1559      */
1560     public function render_action_menu(action_menu $menu) {
1561         $context = $menu->export_for_template($this);
1562         return $this->render_from_template('core/action_menu', $context);
1563     }
1565     /**
1566      * Renders an action_menu_link item.
1567      *
1568      * @param action_menu_link $action
1569      * @return string HTML fragment
1570      */
1571     protected function render_action_menu_link(action_menu_link $action) {
1572         return $this->render_from_template('core/action_menu_link', $action->export_for_template($this));
1573     }
1575     /**
1576      * Renders a primary action_menu_filler item.
1577      *
1578      * @param action_menu_link_filler $action
1579      * @return string HTML fragment
1580      */
1581     protected function render_action_menu_filler(action_menu_filler $action) {
1582         return html_writer::span('&nbsp;', 'filler');
1583     }
1585     /**
1586      * Renders a primary action_menu_link item.
1587      *
1588      * @param action_menu_link_primary $action
1589      * @return string HTML fragment
1590      */
1591     protected function render_action_menu_link_primary(action_menu_link_primary $action) {
1592         return $this->render_action_menu_link($action);
1593     }
1595     /**
1596      * Renders a secondary action_menu_link item.
1597      *
1598      * @param action_menu_link_secondary $action
1599      * @return string HTML fragment
1600      */
1601     protected function render_action_menu_link_secondary(action_menu_link_secondary $action) {
1602         return $this->render_action_menu_link($action);
1603     }
1605     /**
1606      * Prints a nice side block with an optional header.
1607      *
1608      * The content is described
1609      * by a {@link core_renderer::block_contents} object.
1610      *
1611      * <div id="inst{$instanceid}" class="block_{$blockname} block">
1612      *      <div class="header"></div>
1613      *      <div class="content">
1614      *          ...CONTENT...
1615      *          <div class="footer">
1616      *          </div>
1617      *      </div>
1618      *      <div class="annotation">
1619      *      </div>
1620      * </div>
1621      *
1622      * @param block_contents $bc HTML for the content
1623      * @param string $region the region the block is appearing in.
1624      * @return string the HTML to be output.
1625      */
1626     public function block(block_contents $bc, $region) {
1627         $bc = clone($bc); // Avoid messing up the object passed in.
1628         if (empty($bc->blockinstanceid) || !strip_tags($bc->title)) {
1629             $bc->collapsible = block_contents::NOT_HIDEABLE;
1630         }
1631         if (!empty($bc->blockinstanceid)) {
1632             $bc->attributes['data-instanceid'] = $bc->blockinstanceid;
1633         }
1634         $skiptitle = strip_tags($bc->title);
1635         if ($bc->blockinstanceid && !empty($skiptitle)) {
1636             $bc->attributes['aria-labelledby'] = 'instance-'.$bc->blockinstanceid.'-header';
1637         } else if (!empty($bc->arialabel)) {
1638             $bc->attributes['aria-label'] = $bc->arialabel;
1639         }
1640         if ($bc->dockable) {
1641             $bc->attributes['data-dockable'] = 1;
1642         }
1643         if ($bc->collapsible == block_contents::HIDDEN) {
1644             $bc->add_class('hidden');
1645         }
1646         if (!empty($bc->controls)) {
1647             $bc->add_class('block_with_controls');
1648         }
1651         if (empty($skiptitle)) {
1652             $output = '';
1653             $skipdest = '';
1654         } else {
1655             $output = html_writer::link('#sb-'.$bc->skipid, get_string('skipa', 'access', $skiptitle),
1656                       array('class' => 'skip skip-block', 'id' => 'fsb-' . $bc->skipid));
1657             $skipdest = html_writer::span('', 'skip-block-to',
1658                       array('id' => 'sb-' . $bc->skipid));
1659         }
1661         $output .= html_writer::start_tag('div', $bc->attributes);
1663         $output .= $this->block_header($bc);
1664         $output .= $this->block_content($bc);
1666         $output .= html_writer::end_tag('div');
1668         $output .= $this->block_annotation($bc);
1670         $output .= $skipdest;
1672         $this->init_block_hider_js($bc);
1673         return $output;
1674     }
1676     /**
1677      * Produces a header for a block
1678      *
1679      * @param block_contents $bc
1680      * @return string
1681      */
1682     protected function block_header(block_contents $bc) {
1684         $title = '';
1685         if ($bc->title) {
1686             $attributes = array();
1687             if ($bc->blockinstanceid) {
1688                 $attributes['id'] = 'instance-'.$bc->blockinstanceid.'-header';
1689             }
1690             $title = html_writer::tag('h2', $bc->title, $attributes);
1691         }
1693         $blockid = null;
1694         if (isset($bc->attributes['id'])) {
1695             $blockid = $bc->attributes['id'];
1696         }
1697         $controlshtml = $this->block_controls($bc->controls, $blockid);
1699         $output = '';
1700         if ($title || $controlshtml) {
1701             $output .= html_writer::tag('div', html_writer::tag('div', html_writer::tag('div', '', array('class'=>'block_action')). $title . $controlshtml, array('class' => 'title')), array('class' => 'header'));
1702         }
1703         return $output;
1704     }
1706     /**
1707      * Produces the content area for a block
1708      *
1709      * @param block_contents $bc
1710      * @return string
1711      */
1712     protected function block_content(block_contents $bc) {
1713         $output = html_writer::start_tag('div', array('class' => 'content'));
1714         if (!$bc->title && !$this->block_controls($bc->controls)) {
1715             $output .= html_writer::tag('div', '', array('class'=>'block_action notitle'));
1716         }
1717         $output .= $bc->content;
1718         $output .= $this->block_footer($bc);
1719         $output .= html_writer::end_tag('div');
1721         return $output;
1722     }
1724     /**
1725      * Produces the footer for a block
1726      *
1727      * @param block_contents $bc
1728      * @return string
1729      */
1730     protected function block_footer(block_contents $bc) {
1731         $output = '';
1732         if ($bc->footer) {
1733             $output .= html_writer::tag('div', $bc->footer, array('class' => 'footer'));
1734         }
1735         return $output;
1736     }
1738     /**
1739      * Produces the annotation for a block
1740      *
1741      * @param block_contents $bc
1742      * @return string
1743      */
1744     protected function block_annotation(block_contents $bc) {
1745         $output = '';
1746         if ($bc->annotation) {
1747             $output .= html_writer::tag('div', $bc->annotation, array('class' => 'blockannotation'));
1748         }
1749         return $output;
1750     }
1752     /**
1753      * Calls the JS require function to hide a block.
1754      *
1755      * @param block_contents $bc A block_contents object
1756      */
1757     protected function init_block_hider_js(block_contents $bc) {
1758         if (!empty($bc->attributes['id']) and $bc->collapsible != block_contents::NOT_HIDEABLE) {
1759             $config = new stdClass;
1760             $config->id = $bc->attributes['id'];
1761             $config->title = strip_tags($bc->title);
1762             $config->preference = 'block' . $bc->blockinstanceid . 'hidden';
1763             $config->tooltipVisible = get_string('hideblocka', 'access', $config->title);
1764             $config->tooltipHidden = get_string('showblocka', 'access', $config->title);
1766             $this->page->requires->js_init_call('M.util.init_block_hider', array($config));
1767             user_preference_allow_ajax_update($config->preference, PARAM_BOOL);
1768         }
1769     }
1771     /**
1772      * Render the contents of a block_list.
1773      *
1774      * @param array $icons the icon for each item.
1775      * @param array $items the content of each item.
1776      * @return string HTML
1777      */
1778     public function list_block_contents($icons, $items) {
1779         $row = 0;
1780         $lis = array();
1781         foreach ($items as $key => $string) {
1782             $item = html_writer::start_tag('li', array('class' => 'r' . $row));
1783             if (!empty($icons[$key])) { //test if the content has an assigned icon
1784                 $item .= html_writer::tag('div', $icons[$key], array('class' => 'icon column c0'));
1785             }
1786             $item .= html_writer::tag('div', $string, array('class' => 'column c1'));
1787             $item .= html_writer::end_tag('li');
1788             $lis[] = $item;
1789             $row = 1 - $row; // Flip even/odd.
1790         }
1791         return html_writer::tag('ul', implode("\n", $lis), array('class' => 'unlist'));
1792     }
1794     /**
1795      * Output all the blocks in a particular region.
1796      *
1797      * @param string $region the name of a region on this page.
1798      * @return string the HTML to be output.
1799      */
1800     public function blocks_for_region($region) {
1801         $blockcontents = $this->page->blocks->get_content_for_region($region, $this);
1802         $blocks = $this->page->blocks->get_blocks_for_region($region);
1803         $lastblock = null;
1804         $zones = array();
1805         foreach ($blocks as $block) {
1806             $zones[] = $block->title;
1807         }
1808         $output = '';
1810         foreach ($blockcontents as $bc) {
1811             if ($bc instanceof block_contents) {
1812                 $output .= $this->block($bc, $region);
1813                 $lastblock = $bc->title;
1814             } else if ($bc instanceof block_move_target) {
1815                 $output .= $this->block_move_target($bc, $zones, $lastblock, $region);
1816             } else {
1817                 throw new coding_exception('Unexpected type of thing (' . get_class($bc) . ') found in list of block contents.');
1818             }
1819         }
1820         return $output;
1821     }
1823     /**
1824      * Output a place where the block that is currently being moved can be dropped.
1825      *
1826      * @param block_move_target $target with the necessary details.
1827      * @param array $zones array of areas where the block can be moved to
1828      * @param string $previous the block located before the area currently being rendered.
1829      * @param string $region the name of the region
1830      * @return string the HTML to be output.
1831      */
1832     public function block_move_target($target, $zones, $previous, $region) {
1833         if ($previous == null) {
1834             if (empty($zones)) {
1835                 // There are no zones, probably because there are no blocks.
1836                 $regions = $this->page->theme->get_all_block_regions();
1837                 $position = get_string('moveblockinregion', 'block', $regions[$region]);
1838             } else {
1839                 $position = get_string('moveblockbefore', 'block', $zones[0]);
1840             }
1841         } else {
1842             $position = get_string('moveblockafter', 'block', $previous);
1843         }
1844         return html_writer::tag('a', html_writer::tag('span', $position, array('class' => 'accesshide')), array('href' => $target->url, 'class' => 'blockmovetarget'));
1845     }
1847     /**
1848      * Renders a special html link with attached action
1849      *
1850      * Theme developers: DO NOT OVERRIDE! Please override function
1851      * {@link core_renderer::render_action_link()} instead.
1852      *
1853      * @param string|moodle_url $url
1854      * @param string $text HTML fragment
1855      * @param component_action $action
1856      * @param array $attributes associative array of html link attributes + disabled
1857      * @param pix_icon optional pix icon to render with the link
1858      * @return string HTML fragment
1859      */
1860     public function action_link($url, $text, component_action $action = null, array $attributes = null, $icon = null) {
1861         if (!($url instanceof moodle_url)) {
1862             $url = new moodle_url($url);
1863         }
1864         $link = new action_link($url, $text, $action, $attributes, $icon);
1866         return $this->render($link);
1867     }
1869     /**
1870      * Renders an action_link object.
1871      *
1872      * The provided link is renderer and the HTML returned. At the same time the
1873      * associated actions are setup in JS by {@link core_renderer::add_action_handler()}
1874      *
1875      * @param action_link $link
1876      * @return string HTML fragment
1877      */
1878     protected function render_action_link(action_link $link) {
1879         return $this->render_from_template('core/action_link', $link->export_for_template($this));
1880     }
1882     /**
1883      * Renders an action_icon.
1884      *
1885      * This function uses the {@link core_renderer::action_link()} method for the
1886      * most part. What it does different is prepare the icon as HTML and use it
1887      * as the link text.
1888      *
1889      * Theme developers: If you want to change how action links and/or icons are rendered,
1890      * consider overriding function {@link core_renderer::render_action_link()} and
1891      * {@link core_renderer::render_pix_icon()}.
1892      *
1893      * @param string|moodle_url $url A string URL or moodel_url
1894      * @param pix_icon $pixicon
1895      * @param component_action $action
1896      * @param array $attributes associative array of html link attributes + disabled
1897      * @param bool $linktext show title next to image in link
1898      * @return string HTML fragment
1899      */
1900     public function action_icon($url, pix_icon $pixicon, component_action $action = null, array $attributes = null, $linktext=false) {
1901         if (!($url instanceof moodle_url)) {
1902             $url = new moodle_url($url);
1903         }
1904         $attributes = (array)$attributes;
1906         if (empty($attributes['class'])) {
1907             // let ppl override the class via $options
1908             $attributes['class'] = 'action-icon';
1909         }
1911         $icon = $this->render($pixicon);
1913         if ($linktext) {
1914             $text = $pixicon->attributes['alt'];
1915         } else {
1916             $text = '';
1917         }
1919         return $this->action_link($url, $text.$icon, $action, $attributes);
1920     }
1922    /**
1923     * Print a message along with button choices for Continue/Cancel
1924     *
1925     * If a string or moodle_url is given instead of a single_button, method defaults to post.
1926     *
1927     * @param string $message The question to ask the user
1928     * @param single_button|moodle_url|string $continue The single_button component representing the Continue answer. Can also be a moodle_url or string URL
1929     * @param single_button|moodle_url|string $cancel The single_button component representing the Cancel answer. Can also be a moodle_url or string URL
1930     * @return string HTML fragment
1931     */
1932     public function confirm($message, $continue, $cancel) {
1933         if ($continue instanceof single_button) {
1934             // ok
1935             $continue->primary = true;
1936         } else if (is_string($continue)) {
1937             $continue = new single_button(new moodle_url($continue), get_string('continue'), 'post', true);
1938         } else if ($continue instanceof moodle_url) {
1939             $continue = new single_button($continue, get_string('continue'), 'post', true);
1940         } else {
1941             throw new coding_exception('The continue param to $OUTPUT->confirm() must be either a URL (string/moodle_url) or a single_button instance.');
1942         }
1944         if ($cancel instanceof single_button) {
1945             // ok
1946         } else if (is_string($cancel)) {
1947             $cancel = new single_button(new moodle_url($cancel), get_string('cancel'), 'get');
1948         } else if ($cancel instanceof moodle_url) {
1949             $cancel = new single_button($cancel, get_string('cancel'), 'get');
1950         } else {
1951             throw new coding_exception('The cancel param to $OUTPUT->confirm() must be either a URL (string/moodle_url) or a single_button instance.');
1952         }
1954         $output = $this->box_start('generalbox modal modal-dialog modal-in-page show', 'notice');
1955         $output .= $this->box_start('modal-content', 'modal-content');
1956         $output .= $this->box_start('modal-header p-x-1', 'modal-header');
1957         $output .= html_writer::tag('h4', get_string('confirm'));
1958         $output .= $this->box_end();
1959         $output .= $this->box_start('modal-body', 'modal-body');
1960         $output .= html_writer::tag('p', $message);
1961         $output .= $this->box_end();
1962         $output .= $this->box_start('modal-footer', 'modal-footer');
1963         $output .= html_writer::tag('div', $this->render($continue) . $this->render($cancel), array('class' => 'buttons'));
1964         $output .= $this->box_end();
1965         $output .= $this->box_end();
1966         $output .= $this->box_end();
1967         return $output;
1968     }
1970     /**
1971      * Returns a form with a single button.
1972      *
1973      * Theme developers: DO NOT OVERRIDE! Please override function
1974      * {@link core_renderer::render_single_button()} instead.
1975      *
1976      * @param string|moodle_url $url
1977      * @param string $label button text
1978      * @param string $method get or post submit method
1979      * @param array $options associative array {disabled, title, etc.}
1980      * @return string HTML fragment
1981      */
1982     public function single_button($url, $label, $method='post', array $options=null) {
1983         if (!($url instanceof moodle_url)) {
1984             $url = new moodle_url($url);
1985         }
1986         $button = new single_button($url, $label, $method);
1988         foreach ((array)$options as $key=>$value) {
1989             if (array_key_exists($key, $button)) {
1990                 $button->$key = $value;
1991             }
1992         }
1994         return $this->render($button);
1995     }
1997     /**
1998      * Renders a single button widget.
1999      *
2000      * This will return HTML to display a form containing a single button.
2001      *
2002      * @param single_button $button
2003      * @return string HTML fragment
2004      */
2005     protected function render_single_button(single_button $button) {
2006         $attributes = array('type'     => 'submit',
2007                             'value'    => $button->label,
2008                             'disabled' => $button->disabled ? 'disabled' : null,
2009                             'title'    => $button->tooltip);
2011         if ($button->actions) {
2012             $id = html_writer::random_id('single_button');
2013             $attributes['id'] = $id;
2014             foreach ($button->actions as $action) {
2015                 $this->add_action_handler($action, $id);
2016             }
2017         }
2019         // first the input element
2020         $output = html_writer::empty_tag('input', $attributes);
2022         // then hidden fields
2023         $params = $button->url->params();
2024         if ($button->method === 'post') {
2025             $params['sesskey'] = sesskey();
2026         }
2027         foreach ($params as $var => $val) {
2028             $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => $var, 'value' => $val));
2029         }
2031         // then div wrapper for xhtml strictness
2032         $output = html_writer::tag('div', $output);
2034         // now the form itself around it
2035         if ($button->method === 'get') {
2036             $url = $button->url->out_omit_querystring(true); // url without params, the anchor part allowed
2037         } else {
2038             $url = $button->url->out_omit_querystring();     // url without params, the anchor part not allowed
2039         }
2040         if ($url === '') {
2041             $url = '#'; // there has to be always some action
2042         }
2043         $attributes = array('method' => $button->method,
2044                             'action' => $url,
2045                             'id'     => $button->formid);
2046         $output = html_writer::tag('form', $output, $attributes);
2048         // and finally one more wrapper with class
2049         return html_writer::tag('div', $output, array('class' => $button->class));
2050     }
2052     /**
2053      * Returns a form with a single select widget.
2054      *
2055      * Theme developers: DO NOT OVERRIDE! Please override function
2056      * {@link core_renderer::render_single_select()} instead.
2057      *
2058      * @param moodle_url $url form action target, includes hidden fields
2059      * @param string $name name of selection field - the changing parameter in url
2060      * @param array $options list of options
2061      * @param string $selected selected element
2062      * @param array $nothing
2063      * @param string $formid
2064      * @param array $attributes other attributes for the single select
2065      * @return string HTML fragment
2066      */
2067     public function single_select($url, $name, array $options, $selected = '',
2068                                 $nothing = array('' => 'choosedots'), $formid = null, $attributes = array()) {
2069         if (!($url instanceof moodle_url)) {
2070             $url = new moodle_url($url);
2071         }
2072         $select = new single_select($url, $name, $options, $selected, $nothing, $formid);
2074         if (array_key_exists('label', $attributes)) {
2075             $select->set_label($attributes['label']);
2076             unset($attributes['label']);
2077         }
2078         $select->attributes = $attributes;
2080         return $this->render($select);
2081     }
2083     /**
2084      * Returns a dataformat selection and download form
2085      *
2086      * @param string $label A text label
2087      * @param moodle_url|string $base The download page url
2088      * @param string $name The query param which will hold the type of the download
2089      * @param array $params Extra params sent to the download page
2090      * @return string HTML fragment
2091      */
2092     public function download_dataformat_selector($label, $base, $name = 'dataformat', $params = array()) {
2094         $formats = core_plugin_manager::instance()->get_plugins_of_type('dataformat');
2095         $options = array();
2096         foreach ($formats as $format) {
2097             if ($format->is_enabled()) {
2098                 $options[] = array(
2099                     'value' => $format->name,
2100                     'label' => get_string('dataformat', $format->component),
2101                 );
2102             }
2103         }
2104         $hiddenparams = array();
2105         foreach ($params as $key => $value) {
2106             $hiddenparams[] = array(
2107                 'name' => $key,
2108                 'value' => $value,
2109             );
2110         }
2111         $data = array(
2112             'label' => $label,
2113             'base' => $base,
2114             'name' => $name,
2115             'params' => $hiddenparams,
2116             'options' => $options,
2117             'sesskey' => sesskey(),
2118             'submit' => get_string('download'),
2119         );
2121         return $this->render_from_template('core/dataformat_selector', $data);
2122     }
2125     /**
2126      * Internal implementation of single_select rendering
2127      *
2128      * @param single_select $select
2129      * @return string HTML fragment
2130      */
2131     protected function render_single_select(single_select $select) {
2132         return $this->render_from_template('core/single_select', $select->export_for_template($this));
2133     }
2135     /**
2136      * Returns a form with a url select widget.
2137      *
2138      * Theme developers: DO NOT OVERRIDE! Please override function
2139      * {@link core_renderer::render_url_select()} instead.
2140      *
2141      * @param array $urls list of urls - array('/course/view.php?id=1'=>'Frontpage', ....)
2142      * @param string $selected selected element
2143      * @param array $nothing
2144      * @param string $formid
2145      * @return string HTML fragment
2146      */
2147     public function url_select(array $urls, $selected, $nothing = array('' => 'choosedots'), $formid = null) {
2148         $select = new url_select($urls, $selected, $nothing, $formid);
2149         return $this->render($select);
2150     }
2152     /**
2153      * Internal implementation of url_select rendering
2154      *
2155      * @param url_select $select
2156      * @return string HTML fragment
2157      */
2158     protected function render_url_select(url_select $select) {
2159         return $this->render_from_template('core/url_select', $select->export_for_template($this));
2160     }
2162     /**
2163      * Returns a string containing a link to the user documentation.
2164      * Also contains an icon by default. Shown to teachers and admin only.
2165      *
2166      * @param string $path The page link after doc root and language, no leading slash.
2167      * @param string $text The text to be displayed for the link
2168      * @param boolean $forcepopup Whether to force a popup regardless of the value of $CFG->doctonewwindow
2169      * @return string
2170      */
2171     public function doc_link($path, $text = '', $forcepopup = false) {
2172         global $CFG;
2174         $icon = $this->pix_icon('docs', '', 'moodle', array('class'=>'iconhelp icon-pre', 'role'=>'presentation'));
2176         $url = new moodle_url(get_docs_url($path));
2178         $attributes = array('href'=>$url);
2179         if (!empty($CFG->doctonewwindow) || $forcepopup) {
2180             $attributes['class'] = 'helplinkpopup';
2181         }
2183         return html_writer::tag('a', $icon.$text, $attributes);
2184     }
2186     /**
2187      * Return HTML for an image_icon.
2188      *
2189      * Theme developers: DO NOT OVERRIDE! Please override function
2190      * {@link core_renderer::render_image_icon()} instead.
2191      *
2192      * @param string $pix short pix name
2193      * @param string $alt mandatory alt attribute
2194      * @param string $component standard compoennt name like 'moodle', 'mod_forum', etc.
2195      * @param array $attributes htm lattributes
2196      * @return string HTML fragment
2197      */
2198     public function image_icon($pix, $alt, $component='moodle', array $attributes = null) {
2199         $icon = new image_icon($pix, $alt, $component, $attributes);
2200         return $this->render($icon);
2201     }
2203     /**
2204      * Renders a pix_icon widget and returns the HTML to display it.
2205      *
2206      * @param image_icon $icon
2207      * @return string HTML fragment
2208      */
2209     protected function render_image_icon(image_icon $icon) {
2210         $system = \core\output\icon_system::instance(\core\output\icon_system::STANDARD);
2211         return $system->render_pix_icon($this, $icon);
2212     }
2214     /**
2215      * Return HTML for a pix_icon.
2216      *
2217      * Theme developers: DO NOT OVERRIDE! Please override function
2218      * {@link core_renderer::render_pix_icon()} instead.
2219      *
2220      * @param string $pix short pix name
2221      * @param string $alt mandatory alt attribute
2222      * @param string $component standard compoennt name like 'moodle', 'mod_forum', etc.
2223      * @param array $attributes htm lattributes
2224      * @return string HTML fragment
2225      */
2226     public function pix_icon($pix, $alt, $component='moodle', array $attributes = null) {
2227         $icon = new pix_icon($pix, $alt, $component, $attributes);
2228         return $this->render($icon);
2229     }
2231     /**
2232      * Renders a pix_icon widget and returns the HTML to display it.
2233      *
2234      * @param pix_icon $icon
2235      * @return string HTML fragment
2236      */
2237     protected function render_pix_icon(pix_icon $icon) {
2238         $system = \core\output\icon_system::instance();
2239         return $system->render_pix_icon($this, $icon);
2240     }
2242     /**
2243      * Return HTML to display an emoticon icon.
2244      *
2245      * @param pix_emoticon $emoticon
2246      * @return string HTML fragment
2247      */
2248     protected function render_pix_emoticon(pix_emoticon $emoticon) {
2249         $system = \core\output\icon_system::instance(\core\output\icon_system::STANDARD);
2250         return $system->render_pix_icon($this, $emoticon);
2251     }
2253     /**
2254      * Produces the html that represents this rating in the UI
2255      *
2256      * @param rating $rating the page object on which this rating will appear
2257      * @return string
2258      */
2259     function render_rating(rating $rating) {
2260         global $CFG, $USER;
2262         if ($rating->settings->aggregationmethod == RATING_AGGREGATE_NONE) {
2263             return null;//ratings are turned off
2264         }
2266         $ratingmanager = new rating_manager();
2267         // Initialise the JavaScript so ratings can be done by AJAX.
2268         $ratingmanager->initialise_rating_javascript($this->page);
2270         $strrate = get_string("rate", "rating");
2271         $ratinghtml = ''; //the string we'll return
2273         // permissions check - can they view the aggregate?
2274         if ($rating->user_can_view_aggregate()) {
2276             $aggregatelabel = $ratingmanager->get_aggregate_label($rating->settings->aggregationmethod);
2277             $aggregatestr   = $rating->get_aggregate_string();
2279             $aggregatehtml  = html_writer::tag('span', $aggregatestr, array('id' => 'ratingaggregate'.$rating->itemid, 'class' => 'ratingaggregate')).' ';
2280             if ($rating->count > 0) {
2281                 $countstr = "({$rating->count})";
2282             } else {
2283                 $countstr = '-';
2284             }
2285             $aggregatehtml .= html_writer::tag('span', $countstr, array('id'=>"ratingcount{$rating->itemid}", 'class' => 'ratingcount')).' ';
2287             $ratinghtml .= html_writer::tag('span', $aggregatelabel, array('class'=>'rating-aggregate-label'));
2288             if ($rating->settings->permissions->viewall && $rating->settings->pluginpermissions->viewall) {
2290                 $nonpopuplink = $rating->get_view_ratings_url();
2291                 $popuplink = $rating->get_view_ratings_url(true);
2293                 $action = new popup_action('click', $popuplink, 'ratings', array('height' => 400, 'width' => 600));
2294                 $ratinghtml .= $this->action_link($nonpopuplink, $aggregatehtml, $action);
2295             } else {
2296                 $ratinghtml .= $aggregatehtml;
2297             }
2298         }
2300         $formstart = null;
2301         // if the item doesn't belong to the current user, the user has permission to rate
2302         // and we're within the assessable period
2303         if ($rating->user_can_rate()) {
2305             $rateurl = $rating->get_rate_url();
2306             $inputs = $rateurl->params();
2308             //start the rating form
2309             $formattrs = array(
2310                 'id'     => "postrating{$rating->itemid}",
2311                 'class'  => 'postratingform',
2312                 'method' => 'post',
2313                 'action' => $rateurl->out_omit_querystring()
2314             );
2315             $formstart  = html_writer::start_tag('form', $formattrs);
2316             $formstart .= html_writer::start_tag('div', array('class' => 'ratingform'));
2318             // add the hidden inputs
2319             foreach ($inputs as $name => $value) {
2320                 $attributes = array('type' => 'hidden', 'class' => 'ratinginput', 'name' => $name, 'value' => $value);
2321                 $formstart .= html_writer::empty_tag('input', $attributes);
2322             }
2324             if (empty($ratinghtml)) {
2325                 $ratinghtml .= $strrate.': ';
2326             }
2327             $ratinghtml = $formstart.$ratinghtml;
2329             $scalearray = array(RATING_UNSET_RATING => $strrate.'...') + $rating->settings->scale->scaleitems;
2330             $scaleattrs = array('class'=>'postratingmenu ratinginput','id'=>'menurating'.$rating->itemid);
2331             $ratinghtml .= html_writer::label($rating->rating, 'menurating'.$rating->itemid, false, array('class' => 'accesshide'));
2332             $ratinghtml .= html_writer::select($scalearray, 'rating', $rating->rating, false, $scaleattrs);
2334             //output submit button
2335             $ratinghtml .= html_writer::start_tag('span', array('class'=>"ratingsubmit"));
2337             $attributes = array('type' => 'submit', 'class' => 'postratingmenusubmit', 'id' => 'postratingsubmit'.$rating->itemid, 'value' => s(get_string('rate', 'rating')));
2338             $ratinghtml .= html_writer::empty_tag('input', $attributes);
2340             if (!$rating->settings->scale->isnumeric) {
2341                 // If a global scale, try to find current course ID from the context
2342                 if (empty($rating->settings->scale->courseid) and $coursecontext = $rating->context->get_course_context(false)) {
2343                     $courseid = $coursecontext->instanceid;
2344                 } else {
2345                     $courseid = $rating->settings->scale->courseid;
2346                 }
2347                 $ratinghtml .= $this->help_icon_scale($courseid, $rating->settings->scale);
2348             }
2349             $ratinghtml .= html_writer::end_tag('span');
2350             $ratinghtml .= html_writer::end_tag('div');
2351             $ratinghtml .= html_writer::end_tag('form');
2352         }
2354         return $ratinghtml;
2355     }
2357     /**
2358      * Centered heading with attached help button (same title text)
2359      * and optional icon attached.
2360      *
2361      * @param string $text A heading text
2362      * @param string $helpidentifier The keyword that defines a help page
2363      * @param string $component component name
2364      * @param string|moodle_url $icon
2365      * @param string $iconalt icon alt text
2366      * @param int $level The level of importance of the heading. Defaulting to 2
2367      * @param string $classnames A space-separated list of CSS classes. Defaulting to null
2368      * @return string HTML fragment
2369      */
2370     public function heading_with_help($text, $helpidentifier, $component = 'moodle', $icon = '', $iconalt = '', $level = 2, $classnames = null) {
2371         $image = '';
2372         if ($icon) {
2373             $image = $this->pix_icon($icon, $iconalt, $component, array('class'=>'icon iconlarge'));
2374         }
2376         $help = '';
2377         if ($helpidentifier) {
2378             $help = $this->help_icon($helpidentifier, $component);
2379         }
2381         return $this->heading($image.$text.$help, $level, $classnames);
2382     }
2384     /**
2385      * Returns HTML to display a help icon.
2386      *
2387      * @deprecated since Moodle 2.0
2388      */
2389     public function old_help_icon($helpidentifier, $title, $component = 'moodle', $linktext = '') {
2390         throw new coding_exception('old_help_icon() can not be used any more, please see help_icon().');
2391     }
2393     /**
2394      * Returns HTML to display a help icon.
2395      *
2396      * Theme developers: DO NOT OVERRIDE! Please override function
2397      * {@link core_renderer::render_help_icon()} instead.
2398      *
2399      * @param string $identifier The keyword that defines a help page
2400      * @param string $component component name
2401      * @param string|bool $linktext true means use $title as link text, string means link text value
2402      * @return string HTML fragment
2403      */
2404     public function help_icon($identifier, $component = 'moodle', $linktext = '') {
2405         $icon = new help_icon($identifier, $component);
2406         $icon->diag_strings();
2407         if ($linktext === true) {
2408             $icon->linktext = get_string($icon->identifier, $icon->component);
2409         } else if (!empty($linktext)) {
2410             $icon->linktext = $linktext;
2411         }
2412         return $this->render($icon);
2413     }
2415     /**
2416      * Implementation of user image rendering.
2417      *
2418      * @param help_icon $helpicon A help icon instance
2419      * @return string HTML fragment
2420      */
2421     protected function render_help_icon(help_icon $helpicon) {
2422         return $this->render_from_template('core/help_icon', $helpicon->export_for_template($this));
2423     }
2425     /**
2426      * Returns HTML to display a scale help icon.
2427      *
2428      * @param int $courseid
2429      * @param stdClass $scale instance
2430      * @return string HTML fragment
2431      */
2432     public function help_icon_scale($courseid, stdClass $scale) {
2433         global $CFG;
2435         $title = get_string('helpprefix2', '', $scale->name) .' ('.get_string('newwindow').')';
2437         $icon = $this->pix_icon('help', get_string('scales'), 'moodle', array('class'=>'iconhelp'));
2439         $scaleid = abs($scale->id);
2441         $link = new moodle_url('/course/scales.php', array('id' => $courseid, 'list' => true, 'scaleid' => $scaleid));
2442         $action = new popup_action('click', $link, 'ratingscale');
2444         return html_writer::tag('span', $this->action_link($link, $icon, $action), array('class' => 'helplink'));
2445     }
2447     /**
2448      * Creates and returns a spacer image with optional line break.
2449      *
2450      * @param array $attributes Any HTML attributes to add to the spaced.
2451      * @param bool $br Include a BR after the spacer.... DON'T USE THIS. Don't be
2452      *     laxy do it with CSS which is a much better solution.
2453      * @return string HTML fragment
2454      */
2455     public function spacer(array $attributes = null, $br = false) {
2456         $attributes = (array)$attributes;
2457         if (empty($attributes['width'])) {
2458             $attributes['width'] = 1;
2459         }
2460         if (empty($attributes['height'])) {
2461             $attributes['height'] = 1;
2462         }
2463         $attributes['class'] = 'spacer';
2465         $output = $this->pix_icon('spacer', '', 'moodle', $attributes);
2467         if (!empty($br)) {
2468             $output .= '<br />';
2469         }
2471         return $output;
2472     }
2474     /**
2475      * Returns HTML to display the specified user's avatar.
2476      *
2477      * User avatar may be obtained in two ways:
2478      * <pre>
2479      * // Option 1: (shortcut for simple cases, preferred way)
2480      * // $user has come from the DB and has fields id, picture, imagealt, firstname and lastname
2481      * $OUTPUT->user_picture($user, array('popup'=>true));
2482      *
2483      * // Option 2:
2484      * $userpic = new user_picture($user);
2485      * // Set properties of $userpic
2486      * $userpic->popup = true;
2487      * $OUTPUT->render($userpic);
2488      * </pre>
2489      *
2490      * Theme developers: DO NOT OVERRIDE! Please override function
2491      * {@link core_renderer::render_user_picture()} instead.
2492      *
2493      * @param stdClass $user Object with at least fields id, picture, imagealt, firstname, lastname
2494      *     If any of these are missing, the database is queried. Avoid this
2495      *     if at all possible, particularly for reports. It is very bad for performance.
2496      * @param array $options associative array with user picture options, used only if not a user_picture object,
2497      *     options are:
2498      *     - courseid=$this->page->course->id (course id of user profile in link)
2499      *     - size=35 (size of image)
2500      *     - link=true (make image clickable - the link leads to user profile)
2501      *     - popup=false (open in popup)
2502      *     - alttext=true (add image alt attribute)
2503      *     - class = image class attribute (default 'userpicture')
2504      *     - visibletoscreenreaders=true (whether to be visible to screen readers)
2505      *     - includefullname=false (whether to include the user's full name together with the user picture)
2506      *     - includetoken = false
2507      * @return string HTML fragment
2508      */
2509     public function user_picture(stdClass $user, array $options = null) {
2510         $userpicture = new user_picture($user);
2511         foreach ((array)$options as $key=>$value) {
2512             if (array_key_exists($key, $userpicture)) {
2513                 $userpicture->$key = $value;
2514             }
2515         }
2516         return $this->render($userpicture);
2517     }
2519     /**
2520      * Internal implementation of user image rendering.
2521      *
2522      * @param user_picture $userpicture
2523      * @return string
2524      */
2525     protected function render_user_picture(user_picture $userpicture) {
2526         global $CFG, $DB;
2528         $user = $userpicture->user;
2529         $canviewfullnames = has_capability('moodle/site:viewfullnames', context_system::instance());
2531         if ($userpicture->alttext) {
2532             if (!empty($user->imagealt)) {
2533                 $alt = $user->imagealt;
2534             } else {
2535                 $alt = get_string('pictureof', '', fullname($user, $canviewfullnames));
2536             }
2537         } else {
2538             $alt = '';
2539         }
2541         if (empty($userpicture->size)) {
2542             $size = 35;
2543         } else if ($userpicture->size === true or $userpicture->size == 1) {
2544             $size = 100;
2545         } else {
2546             $size = $userpicture->size;
2547         }
2549         $class = $userpicture->class;
2551         if ($user->picture == 0) {
2552             $class .= ' defaultuserpic';
2553         }
2555         $src = $userpicture->get_url($this->page, $this);
2557         $attributes = array('src'=>$src, 'alt'=>$alt, 'title'=>$alt, 'class'=>$class, 'width'=>$size, 'height'=>$size);
2558         if (!$userpicture->visibletoscreenreaders) {
2559             $attributes['role'] = 'presentation';
2560         }
2562         // get the image html output fisrt
2563         $output = html_writer::empty_tag('img', $attributes);
2565         // Show fullname together with the picture when desired.
2566         if ($userpicture->includefullname) {
2567             $output .= fullname($userpicture->user, $canviewfullnames);
2568         }
2570         // then wrap it in link if needed
2571         if (!$userpicture->link) {
2572             return $output;
2573         }
2575         if (empty($userpicture->courseid)) {
2576             $courseid = $this->page->course->id;
2577         } else {
2578             $courseid = $userpicture->courseid;
2579         }
2581         if ($courseid == SITEID) {
2582             $url = new moodle_url('/user/profile.php', array('id' => $user->id));
2583         } else {
2584             $url = new moodle_url('/user/view.php', array('id' => $user->id, 'course' => $courseid));
2585         }
2587         $attributes = array('href'=>$url);
2588         if (!$userpicture->visibletoscreenreaders) {
2589             $attributes['tabindex'] = '-1';
2590             $attributes['aria-hidden'] = 'true';
2591         }
2593         if ($userpicture->popup) {
2594             $id = html_writer::random_id('userpicture');
2595             $attributes['id'] = $id;
2596             $this->add_action_handler(new popup_action('click', $url), $id);
2597         }
2599         return html_writer::tag('a', $output, $attributes);
2600     }
2602     /**
2603      * Internal implementation of file tree viewer items rendering.
2604      *
2605      * @param array $dir
2606      * @return string
2607      */
2608     public function htmllize_file_tree($dir) {
2609         if (empty($dir['subdirs']) and empty($dir['files'])) {
2610             return '';
2611         }
2612         $result = '<ul>';
2613         foreach ($dir['subdirs'] as $subdir) {
2614             $result .= '<li>'.s($subdir['dirname']).' '.$this->htmllize_file_tree($subdir).'</li>';
2615         }
2616         foreach ($dir['files'] as $file) {
2617             $filename = $file->get_filename();
2618             $result .= '<li><span>'.html_writer::link($file->fileurl, $filename).'</span></li>';
2619         }
2620         $result .= '</ul>';
2622         return $result;
2623     }
2625     /**
2626      * Returns HTML to display the file picker
2627      *
2628      * <pre>
2629      * $OUTPUT->file_picker($options);
2630      * </pre>
2631      *
2632      * Theme developers: DO NOT OVERRIDE! Please override function
2633      * {@link core_renderer::render_file_picker()} instead.
2634      *
2635      * @param array $options associative array with file manager options
2636      *   options are:
2637      *       maxbytes=>-1,
2638      *       itemid=>0,
2639      *       client_id=>uniqid(),
2640      *       acepted_types=>'*',
2641      *       return_types=>FILE_INTERNAL,
2642      *       context=>$PAGE->context
2643      * @return string HTML fragment
2644      */
2645     public function file_picker($options) {
2646         $fp = new file_picker($options);
2647         return $this->render($fp);
2648     }
2650     /**
2651      * Internal implementation of file picker rendering.
2652      *
2653      * @param file_picker $fp
2654      * @return string
2655      */
2656     public function render_file_picker(file_picker $fp) {
2657         global $CFG, $OUTPUT, $USER;
2658         $options = $fp->options;
2659         $client_id = $options->client_id;
2660         $strsaved = get_string('filesaved', 'repository');
2661         $straddfile = get_string('openpicker', 'repository');
2662         $strloading  = get_string('loading', 'repository');
2663         $strdndenabled = get_string('dndenabled_inbox', 'moodle');
2664         $strdroptoupload = get_string('droptoupload', 'moodle');
2665         $icon_progress = $OUTPUT->pix_icon('i/loading_small', $strloading).'';
2667         $currentfile = $options->currentfile;
2668         if (empty($currentfile)) {
2669             $currentfile = '';
2670         } else {
2671             $currentfile .= ' - ';
2672         }
2673         if ($options->maxbytes) {
2674             $size = $options->maxbytes;
2675         } else {
2676             $size = get_max_upload_file_size();
2677         }
2678         if ($size == -1) {
2679             $maxsize = '';
2680         } else {
2681             $maxsize = get_string('maxfilesize', 'moodle', display_size($size));
2682         }
2683         if ($options->buttonname) {
2684             $buttonname = ' name="' . $options->buttonname . '"';
2685         } else {
2686             $buttonname = '';
2687         }
2688         $html = <<<EOD
2689 <div class="filemanager-loading mdl-align" id='filepicker-loading-{$client_id}'>
2690 $icon_progress
2691 </div>
2692 <div id="filepicker-wrapper-{$client_id}" class="mdl-left w-100" style="display:none">
2693     <div>
2694         <input type="button" class="btn btn-secondary fp-btn-choose" id="filepicker-button-{$client_id}" value="{$straddfile}"{$buttonname}/>
2695         <span> $maxsize </span>
2696     </div>
2697 EOD;
2698         if ($options->env != 'url') {
2699             $html .= <<<EOD
2700     <div id="file_info_{$client_id}" class="mdl-left filepicker-filelist" style="position: relative">
2701     <div class="filepicker-filename">
2702         <div class="filepicker-container">$currentfile<div class="dndupload-message">$strdndenabled <br/><div class="dndupload-arrow"></div></div></div>
2703         <div class="dndupload-progressbars"></div>
2704     </div>
2705     <div><div class="dndupload-target">{$strdroptoupload}<br/><div class="dndupload-arrow"></div></div></div>
2706     </div>
2707 EOD;
2708         }
2709         $html .= '</div>';
2710         return $html;
2711     }
2713     /**
2714      * @deprecated since Moodle 3.2
2715      */
2716     public function update_module_button() {
2717         throw new coding_exception('core_renderer::update_module_button() can not be used anymore. Activity ' .
2718             'modules should not add the edit module button, the link is already available in the Administration block. ' .
2719             'Themes can choose to display the link in the buttons row consistently for all module types.');
2720     }
2722     /**
2723      * Returns HTML to display a "Turn editing on/off" button in a form.
2724      *
2725      * @param moodle_url $url The URL + params to send through when clicking the button
2726      * @return string HTML the button
2727      */
2728     public function edit_button(moodle_url $url) {
2730         $url->param('sesskey', sesskey());
2731         if ($this->page->user_is_editing()) {
2732             $url->param('edit', 'off');
2733             $editstring = get_string('turneditingoff');
2734         } else {
2735             $url->param('edit', 'on');
2736             $editstring = get_string('turneditingon');
2737         }
2739         return $this->single_button($url, $editstring);
2740     }
2742     /**
2743      * Returns HTML to display a simple button to close a window
2744      *
2745      * @param string $text The lang string for the button's label (already output from get_string())
2746      * @return string html fragment
2747      */
2748     public function close_window_button($text='') {
2749         if (empty($text)) {
2750             $text = get_string('closewindow');
2751         }
2752         $button = new single_button(new moodle_url('#'), $text, 'get');
2753         $button->add_action(new component_action('click', 'close_window'));
2755         return $this->container($this->render($button), 'closewindow');
2756     }
2758     /**
2759      * Output an error message. By default wraps the error message in <span class="error">.
2760      * If the error message is blank, nothing is output.
2761      *
2762      * @param string $message the error message.
2763      * @return string the HTML to output.
2764      */
2765     public function error_text($message) {
2766         if (empty($message)) {
2767             return '';
2768         }
2769         $message = $this->pix_icon('i/warning', get_string('error'), '', array('class' => 'icon icon-pre', 'title'=>'')) . $message;
2770         return html_writer::tag('span', $message, array('class' => 'error'));
2771     }
2773     /**
2774      * Do not call this function directly.
2775      *
2776      * To terminate the current script with a fatal error, call the {@link print_error}
2777      * function, or throw an exception. Doing either of those things will then call this
2778      * function to display the error, before terminating the execution.
2779      *
2780      * @param string $message The message to output
2781      * @param string $moreinfourl URL where more info can be found about the error
2782      * @param string $link Link for the Continue button
2783      * @param array $backtrace The execution backtrace
2784      * @param string $debuginfo Debugging information
2785      * @return string the HTML to output.
2786      */
2787     public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null, $errorcode = "") {
2788         global $CFG;
2790         $output = '';
2791         $obbuffer = '';
2793         if ($this->has_started()) {
2794             // we can not always recover properly here, we have problems with output buffering,
2795             // html tables, etc.
2796             $output .= $this->opencontainers->pop_all_but_last();
2798         } else {
2799             // It is really bad if library code throws exception when output buffering is on,
2800             // because the buffered text would be printed before our start of page.
2801             // NOTE: this hack might be behave unexpectedly in case output buffering is enabled in PHP.ini
2802             error_reporting(0); // disable notices from gzip compression, etc.
2803             while (ob_get_level() > 0) {
2804                 $buff = ob_get_clean();
2805                 if ($buff === false) {
2806                     break;
2807                 }
2808                 $obbuffer .= $buff;
2809             }
2810             error_reporting($CFG->debug);
2812             // Output not yet started.
2813             $protocol = (isset($_SERVER['SERVER_PROTOCOL']) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0');
2814             if (empty($_SERVER['HTTP_RANGE'])) {
2815                 @header($protocol . ' 404 Not Found');
2816             } else if (core_useragent::check_safari_ios_version(602) && !empty($_SERVER['HTTP_X_PLAYBACK_SESSION_ID'])) {
2817                 // Coax iOS 10 into sending the session cookie.
2818                 @header($protocol . ' 403 Forbidden');
2819             } else {
2820                 // Must stop byteserving attempts somehow,
2821                 // this is weird but Chrome PDF viewer can be stopped only with 407!
2822                 @header($protocol . ' 407 Proxy Authentication Required');
2823             }
2825             $this->page->set_context(null); // ugly hack - make sure page context is set to something, we do not want bogus warnings here
2826             $this->page->set_url('/'); // no url
2827             //$this->page->set_pagelayout('base'); //TODO: MDL-20676 blocks on error pages are weird, unfortunately it somehow detect the pagelayout from URL :-(
2828             $this->page->set_title(get_string('error'));
2829             $this->page->set_heading($this->page->course->fullname);
2830             $output .= $this->header();
2831         }
2833         $message = '<p class="errormessage">' . $message . '</p>'.
2834                 '<p class="errorcode"><a href="' . $moreinfourl . '">' .
2835                 get_string('moreinformation') . '</a></p>';
2836         if (empty($CFG->rolesactive)) {
2837             $message .= '<p class="errormessage">' . get_string('installproblem', 'error') . '</p>';
2838             //It is usually not possible to recover from errors triggered during installation, you may need to create a new database or use a different database prefix for new installation.
2839         }
2840         $output .= $this->box($message, 'errorbox alert alert-danger', null, array('data-rel' => 'fatalerror'));
2842         if ($CFG->debugdeveloper) {
2843             if (!empty($debuginfo)) {
2844                 $debuginfo = s($debuginfo); // removes all nasty JS
2845                 $debuginfo = str_replace("\n", '<br />', $debuginfo); // keep newlines
2846                 $output .= $this->notification('<strong>Debug info:</strong> '.$debuginfo, 'notifytiny');
2847             }
2848             if (!empty($backtrace)) {
2849                 $output .= $this->notification('<strong>Stack trace:</strong> '.format_backtrace($backtrace), 'notifytiny');
2850             }
2851             if ($obbuffer !== '' ) {
2852                 $output .= $this->notification('<strong>Output buffer:</strong> '.s($obbuffer), 'notifytiny');
2853             }
2854         }
2856         if (empty($CFG->rolesactive)) {
2857             // continue does not make much sense if moodle is not installed yet because error is most probably not recoverable
2858         } else if (!empty($link)) {
2859             $output .= $this->continue_button($link);
2860         }
2862         $output .= $this->footer();
2864         // Padding to encourage IE to display our error page, rather than its own.
2865         $output .= str_repeat(' ', 512);
2867         return $output;
2868     }
2870     /**
2871      * Output a notification (that is, a status message about something that has just happened).
2872      *
2873      * Note: \core\notification::add() may be more suitable for your usage.
2874      *
2875      * @param string $message The message to print out.
2876      * @param string $type    The type of notification. See constants on \core\output\notification.
2877      * @return string the HTML to output.
2878      */
2879     public function notification($message, $type = null) {
2880         $typemappings = [
2881             // Valid types.
2882             'success'           => \core\output\notification::NOTIFY_SUCCESS,
2883             'info'              => \core\output\notification::NOTIFY_INFO,
2884             'warning'           => \core\output\notification::NOTIFY_WARNING,
2885             'error'             => \core\output\notification::NOTIFY_ERROR,
2887             // Legacy types mapped to current types.
2888             'notifyproblem'     => \core\output\notification::NOTIFY_ERROR,
2889             'notifytiny'        => \core\output\notification::NOTIFY_ERROR,
2890             'notifyerror'       => \core\output\notification::NOTIFY_ERROR,
2891             'notifysuccess'     => \core\output\notification::NOTIFY_SUCCESS,
2892             'notifymessage'     => \core\output\notification::NOTIFY_INFO,
2893             'notifyredirect'    => \core\output\notification::NOTIFY_INFO,
2894             'redirectmessage'   => \core\output\notification::NOTIFY_INFO,
2895         ];
2897         $extraclasses = [];
2899         if ($type) {
2900             if (strpos($type, ' ') === false) {
2901                 // No spaces in the list of classes, therefore no need to loop over and determine the class.
2902                 if (isset($typemappings[$type])) {
2903                     $type = $typemappings[$type];
2904                 } else {
2905                     // The value provided did not match a known type. It must be an extra class.
2906                     $extraclasses = [$type];
2907                 }
2908             } else {
2909                 // Identify what type of notification this is.
2910                 $classarray = explode(' ', self::prepare_classes($type));
2912                 // Separate out the type of notification from the extra classes.
2913                 foreach ($classarray as $class) {
2914                     if (isset($typemappings[$class])) {
2915                         $type = $typemappings[$class];
2916                     } else {
2917                         $extraclasses[] = $class;
2918                     }
2919                 }
2920             }
2921         }
2923         $notification = new \core\output\notification($message, $type);
2924         if (count($extraclasses)) {
2925             $notification->set_extra_classes($extraclasses);
2926         }
2928         // Return the rendered template.
2929         return $this->render_from_template($notification->get_template_name(), $notification->export_for_template($this));
2930     }
2932     /**
2933      * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more.
2934      */
2935     public function notify_problem() {
2936         throw new coding_exception('core_renderer::notify_problem() can not be used any more, '.
2937             'please use \core\notification::add(), or \core\output\notification as required.');
2938     }
2940     /**
2941      * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more.
2942      */
2943     public function notify_success() {
2944         throw new coding_exception('core_renderer::notify_success() can not be used any more, '.
2945             'please use \core\notification::add(), or \core\output\notification as required.');
2946     }
2948     /**
2949      * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more.
2950      */
2951     public function notify_message() {
2952         throw new coding_exception('core_renderer::notify_message() can not be used any more, '.
2953             'please use \core\notification::add(), or \core\output\notification as required.');
2954     }
2956     /**
2957      * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more.
2958      */
2959     public function notify_redirect() {
2960         throw new coding_exception('core_renderer::notify_redirect() can not be used any more, '.
2961             'please use \core\notification::add(), or \core\output\notification as required.');
2962     }
2964     /**
2965      * Render a notification (that is, a status message about something that has
2966      * just happened).
2967      *
2968      * @param \core\output\notification $notification the notification to print out
2969      * @return string the HTML to output.
2970      */
2971     protected function render_notification(\core\output\notification $notification) {
2972         return $this->render_from_template($notification->get_template_name(), $notification->export_for_template($this));
2973     }
2975     /**
2976      * Returns HTML to display a continue button that goes to a particular URL.
2977      *
2978      * @param string|moodle_url $url The url the button goes to.
2979      * @return string the HTML to output.
2980      */
2981     public function continue_button($url) {
2982         if (!($url instanceof moodle_url)) {
2983             $url = new moodle_url($url);
2984         }
2985         $button = new single_button($url, get_string('continue'), 'get', true);
2986         $button->class = 'continuebutton';
2988         return $this->render($button);
2989     }
2991     /**
2992      * Returns HTML to display a single paging bar to provide access to other pages  (usually in a search)
2993      *
2994      * Theme developers: DO NOT OVERRIDE! Please override function
2995      * {@link core_renderer::render_paging_bar()} instead.
2996      *
2997      * @param int $totalcount The total number of entries available to be paged through
2998      * @param int $page The page you are currently viewing
2999      * @param int $perpage The number of entries that should be shown per page
3000      * @param string|moodle_url $baseurl url of the current page, the $pagevar parameter is added
3001      * @param string $pagevar name of page parameter that holds the page number
3002      * @return string the HTML to output.
3003      */
3004     public function paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar = 'page') {
3005         $pb = new paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar);
3006         return $this->render($pb);
3007     }
3009     /**
3010      * Returns HTML to display the paging bar.
3011      *
3012      * @param paging_bar $pagingbar
3013      * @return string the HTML to output.
3014      */
3015     protected function render_paging_bar(paging_bar $pagingbar) {
3016         // Any more than 10 is not usable and causes weird wrapping of the pagination.
3017         $pagingbar->maxdisplay = 10;
3018         return $this->render_from_template('core/paging_bar', $pagingbar->export_for_template($this));
3019     }
3021     /**
3022      * Returns HTML to display initials bar to provide access to other pages  (usually in a search)
3023      *
3024      * @param string $current the currently selected letter.
3025      * @param string $class class name to add to this initial bar.
3026      * @param string $title the name to put in front of this initial bar.
3027      * @param string $urlvar URL parameter name for this initial.
3028      * @param string $url URL object.
3029      * @param array $alpha of letters in the alphabet.
3030      * @return string the HTML to output.
3031      */
3032     public function initials_bar($current, $class, $title, $urlvar, $url, $alpha = null) {
3033         $ib = new initials_bar($current, $class, $title, $urlvar, $url, $alpha);
3034         return $this->render($ib);
3035     }
3037     /**
3038      * Internal implementation of initials bar rendering.
3039      *
3040      * @param initials_bar $initialsbar
3041      * @return string
3042      */
3043     protected function render_initials_bar(initials_bar $initialsbar) {
3044         return $this->render_from_template('core/initials_bar', $initialsbar->export_for_template($this));
3045     }
3047     /**
3048      * Output the place a skip link goes to.
3049      *
3050      * @param string $id The target name from the corresponding $PAGE->requires->skip_link_to($target) call.
3051      * @return string the HTML to output.
3052      */
3053     public function skip_link_target($id = null) {
3054         return html_writer::span('', '', array('id' => $id));
3055     }
3057     /**
3058      * Outputs a heading
3059      *
3060      * @param string $text The text of the heading
3061      * @param int $level The level of importance of the heading. Defaulting to 2
3062      * @param string $classes A space-separated list of CSS classes. Defaulting to null
3063      * @param string $id An optional ID
3064      * @return string the HTML to output.
3065      */
3066     public function heading($text, $level = 2, $classes = null, $id = null) {
3067         $level = (integer) $level;
3068         if ($level < 1 or $level > 6) {
3069             throw new coding_exception('Heading level must be an integer between 1 and 6.');
3070         }
3071         return html_writer::tag('h' . $level, $text, array('id' => $id, 'class' => renderer_base::prepare_classes($classes)));
3072     }
3074     /**
3075      * Outputs a box.
3076      *
3077      * @param string $contents The contents of the box
3078      * @param string $classes A space-separated list of CSS classes
3079      * @param string $id An optional ID
3080      * @param array $attributes An array of other attributes to give the box.
3081      * @return string the HTML to output.
3082      */
3083     public function box($contents, $classes = 'generalbox', $id = null, $attributes = array()) {
3084         return $this->box_start($classes, $id, $attributes) . $contents . $this->box_end();
3085     }
3087     /**
3088      * Outputs the opening section of a box.
3089      *
3090      * @param string $classes A space-separated list of CSS classes
3091      * @param string $id An optional ID
3092      * @param array $attributes An array of other attributes to give the box.
3093      * @return string the HTML to output.
3094      */
3095     public function box_start($classes = 'generalbox', $id = null, $attributes = array()) {
3096         $this->opencontainers->push('box', html_writer::end_tag('div'));
3097         $attributes['id'] = $id;
3098         $attributes['class'] = 'box ' . renderer_base::prepare_classes($classes);
3099         return html_writer::start_tag('div', $attributes);
3100     }
3102     /**
3103      * Outputs the closing section of a box.
3104      *
3105      * @return string the HTML to output.
3106      */
3107     public function box_end() {
3108         return $this->opencontainers->pop('box');
3109     }
3111     /**
3112      * Outputs a container.
3113      *
3114      * @param string $contents The contents of the box
3115      * @param string $classes A space-separated list of CSS classes
3116      * @param string $id An optional ID
3117      * @return string the HTML to output.
3118      */
3119     public function container($contents, $classes = null, $id = null) {
3120         return $this->container_start($classes, $id) . $contents . $this->container_end();
3121     }
3123     /**
3124      * Outputs the opening section of a container.
3125      *
3126      * @param string $classes A space-separated list of CSS classes
3127      * @param string $id An optional ID
3128      * @return string the HTML to output.
3129      */
3130     public function container_start($classes = null, $id = null) {
3131         $this->opencontainers->push('container', html_writer::end_tag('div'));
3132         return html_writer::start_tag('div', array('id' => $id,
3133                 'class' => renderer_base::prepare_classes($classes)));
3134     }
3136     /**
3137      * Outputs the closing section of a container.
3138      *
3139      * @return string the HTML to output.
3140      */
3141     public function container_end() {
3142         return $this->opencontainers->pop('container');
3143     }
3145     /**
3146      * Make nested HTML lists out of the items
3147      *
3148      * The resulting list will look something like this:
3149      *
3150      * <pre>
3151      * <<ul>>
3152      * <<li>><div class='tree_item parent'>(item contents)</div>
3153      *      <<ul>
3154      *      <<li>><div class='tree_item'>(item contents)</div><</li>>
3155      *      <</ul>>
3156      * <</li>>
3157      * <</ul>>
3158      * </pre>
3159      *
3160      * @param array $items
3161      * @param array $attrs html attributes passed to the top ofs the list
3162      * @return string HTML
3163      */
3164     public function tree_block_contents($items, $attrs = array()) {
3165         // exit if empty, we don't want an empty ul element
3166         if (empty($items)) {
3167             return '';
3168         }
3169         // array of nested li elements
3170         $lis = array();
3171         foreach ($items as $item) {
3172             // this applies to the li item which contains all child lists too
3173             $content = $item->content($this);
3174             $liclasses = array($item->get_css_type());
3175             if (!$item->forceopen || (!$item->forceopen && $item->collapse) || ($item->children->count()==0  && $item->nodetype==navigation_node::NODETYPE_BRANCH)) {
3176                 $liclasses[] = 'collapsed';
3177             }
3178             if ($item->isactive === true) {
3179                 $liclasses[] = 'current_branch';
3180             }
3181             $liattr = array('class'=>join(' ',$liclasses));
3182             // class attribute on the div item which only contains the item content
3183             $divclasses = array('tree_item');
3184             if ($item->children->count()>0  || $item->nodetype==navigation_node::NODETYPE_BRANCH) {
3185                 $divclasses[] = 'branch';
3186             } else {
3187                 $divclasses[] = 'leaf';
3188             }
3189             if (!empty($item->classes) && count($item->classes)>0) {
3190                 $divclasses[] = join(' ', $item->classes);
3191             }
3192             $divattr = array('class'=>join(' ', $divclasses));
3193             if (!empty($item->id)) {
3194                 $divattr['id'] = $item->id;
3195             }
3196             $content = html_writer::tag('p', $content, $divattr) . $this->tree_block_contents($item->children);
3197             if (!empty($item->preceedwithhr) && $item->preceedwithhr===true) {
3198                 $content = html_writer::empty_tag('hr') . $content;
3199             }
3200             $content = html_writer::tag('li', $content, $liattr);
3201             $lis[] = $content;
3202         }
3203         return html_writer::tag('ul', implode("\n", $lis), $attrs);
3204     }
3206     /**
3207      * Returns a search box.
3208      *
3209      * @param  string $id     The search box wrapper div id, defaults to an autogenerated one.
3210      * @return string         HTML with the search form hidden by default.
3211      */
3212     public function search_box($id = false) {
3213         global $CFG;
3215         // Accessing $CFG directly as using \core_search::is_global_search_enabled would
3216         // result in an extra included file for each site, even the ones where global search
3217         // is disabled.
3218         if (empty($CFG->enableglobalsearch) || !has_capability('moodle/search:query', context_system::instance())) {
3219             return '';
3220         }
3222         if ($id == false) {
3223             $id = uniqid();
3224         } else {
3225             // Needs to be cleaned, we use it for the input id.
3226             $id = clean_param($id, PARAM_ALPHANUMEXT);
3227         }
3229         // JS to animate the form.
3230         $this->page->requires->js_call_amd('core/search-input', 'init', array($id));
3232         $searchicon = html_writer::tag('div', $this->pix_icon('a/search', get_string('search', 'search'), 'moodle'),
3233             array('role' => 'button', 'tabindex' => 0));
3234         $formattrs = array('class' => 'search-input-form', 'action' => $CFG->wwwroot . '/search/index.php');
3235         $inputattrs = array('type' => 'text', 'name' => 'q', 'placeholder' => get_string('search', 'search'),
3236             'size' => 13, 'tabindex' => -1, 'id' => 'id_q_' . $id, 'class' => 'form-control');
3238         $contents = html_writer::tag('label', get_string('enteryoursearchquery', 'search'),
3239             array('for' => 'id_q_' . $id, 'class' => 'accesshide')) . html_writer::tag('input', '', $inputattrs);
3240         if ($this->page->context && $this->page->context->contextlevel !== CONTEXT_SYSTEM) {
3241             $contents .= html_writer::empty_tag('input', ['type' => 'hidden',
3242                     'name' => 'context', 'value' => $this->page->context->id]);
3243         }
3244         $searchinput = html_writer::tag('form', $contents, $formattrs);
3246         return html_writer::tag('div', $searchicon . $searchinput, array('class' => 'search-input-wrapper nav-link', 'id' => $id));
3247     }
3249     /**
3250      * Allow plugins to provide some content to be rendered in the navbar.
3251      * The plugin must define a PLUGIN_render_navbar_output function that returns
3252      * the HTML they wish to add to the navbar.
3253      *
3254      * @return string HTML for the navbar
3255      */
3256     public function navbar_plugin_output() {
3257         $output = '';
3259         if ($pluginsfunction = get_plugins_with_function('render_navbar_output')) {
3260             foreach ($pluginsfunction as $plugintype => $plugins) {
3261                 foreach ($plugins as $pluginfunction) {
3262                     $output .= $pluginfunction($this);
3263                 }
3264             }
3265         }
3267         return $output;
3268     }
3270     /**
3271      * Construct a user menu, returning HTML that can be echoed out by a
3272      * layout file.
3273      *
3274      * @param stdClass $user A user object, usually $USER.
3275      * @param bool $withlinks true if a dropdown should be built.
3276      * @return string HTML fragment.
3277      */
3278     public function user_menu($user = null, $withlinks = null) {
3279         global $USER, $CFG;
3280         require_once($CFG->dirroot . '/user/lib.php');
3282         if (is_null($user)) {
3283             $user = $USER;
3284         }
3286         // Note: this behaviour is intended to match that of core_renderer::login_info,
3287         // but should not be considered to be good practice; layout options are
3288         // intended to be theme-specific. Please don't copy this snippet anywhere else.
3289         if (is_null($withlinks)) {
3290             $withlinks = empty($this->page->layout_options['nologinlinks']);
3291         }
3293         // Add a class for when $withlinks is false.
3294         $usermenuclasses = 'usermenu';
3295         if (!$withlinks) {
3296             $usermenuclasses .= ' withoutlinks';
3297         }
3299         $returnstr = "";
3301         // If during initial install, return the empty return string.
3302         if (during_initial_install()) {
3303             return $returnstr;
3304         }
3306         $loginpage = $this->is_login_page();
3307         $loginurl = get_login_url();
3308         // If not logged in, show the typical not-logged-in string.
3309         if (!isloggedin()) {
3310             $returnstr = get_string('loggedinnot', 'moodle');
3311             if (!$loginpage) {
3312                 $returnstr .= " (<a href=\"$loginurl\">" . get_string('login') . '</a>)';
3313             }
3314             return html_writer::div(
3315                 html_writer::span(
3316                     $returnstr,
3317                     'login'
3318                 ),
3319                 $usermenuclasses
3320             );
3322         }
3324         // If logged in as a guest user, show a string to that effect.
3325         if (isguestuser()) {
3326             $returnstr = get_string('loggedinasguest');
3327             if (!$loginpage && $withlinks) {
3328                 $returnstr .= " (<a href=\"$loginurl\">".get_string('login').'</a>)';
3329             }
3331             return html_writer::div(
3332                 html_writer::span(
3333                     $returnstr,
3334                     'login'
3335                 ),
3336                 $usermenuclasses
3337             );
3338         }
3340         // Get some navigation opts.
3341         $opts = user_get_user_navigation_info($user, $this->page);
3343         $avatarclasses = "avatars";
3344         $avatarcontents = html_writer::span($opts->metadata['useravatar'], 'avatar current');
3345         $usertextcontents = $opts->metadata['userfullname'];
3347         // Other user.
3348         if (!empty($opts->metadata['asotheruser'])) {
3349             $avatarcontents .= html_writer::span(
3350                 $opts->metadata['realuseravatar'],
3351                 'avatar realuser'
3352             );
3353             $usertextcontents = $opts->metadata['realuserfullname'];
3354             $usertextcontents .= html_writer::tag(
3355                 'span',
3356                 get_string(
3357                     'loggedinas',
3358                     'moodle',
3359                     html_writer::span(
3360                         $opts->metadata['userfullname'],
3361                         'value'
3362                     )
3363                 ),
3364                 array('class' => 'meta viewingas')
3365             );
3366         }
3368         // Role.
3369         if (!empty($opts->metadata['asotherrole'])) {
3370             $role = core_text::strtolower(preg_replace('#[ ]+#', '-', trim($opts->metadata['rolename'])));
3371             $usertextcontents .= html_writer::span(
3372                 $opts->metadata['rolename'],
3373                 'meta role role-' . $role
3374             );
3375         }
3377         // User login failures.
3378         if (!empty($opts->metadata['userloginfail'])) {
3379             $usertextcontents .= html_writer::span(
3380                 $opts->metadata['userloginfail'],
3381                 'meta loginfailures'
3382             );
3383         }
3385         // MNet.
3386         if (!empty($opts->metadata['asmnetuser'])) {
3387             $mnet = strtolower(preg_replace('#[ ]+#', '-', trim($opts->metadata['mnetidprovidername'])));
3388             $usertextcontents .= html_writer::span(
3389                 $opts->metadata['mnetidprovidername'],
3390                 'meta mnet mnet-' . $mnet
3391             );
3392         }
3394         $returnstr .= html_writer::span(
3395             html_writer::span($usertextcontents, 'usertext mr-1') .
3396             html_writer::span($avatarcontents, $avatarclasses),
3397             'userbutton'
3398         );
3400         // Create a divider (well, a filler).
3401         $divider = new action_menu_filler();
3402         $divider->primary = false;
3404         $am = new action_menu();
3405         $am->set_menu_trigger(
3406             $returnstr
3407         );
3408         $am->set_alignment(action_menu::TR, action_menu::BR);
3409         $am->set_nowrap_on_items();
3410         if ($withlinks) {
3411             $navitemcount = count($opts->navitems);
3412             $idx = 0;
3413             foreach ($opts->navitems as $key => $value) {
3415                 switch ($value->itemtype) {
3416                     case 'divider':
3417                         // If the nav item is a divider, add one and skip link processing.
3418                         $am->add($divider);
3419                         break;
3421                     case 'invalid':
3422                         // Silently skip invalid entries (should we post a notification?).
3423                         break;
3425                     case 'link':
3426                         // Process this as a link item.
3427                         $pix = null;
3428                         if (isset($value->pix) && !empty($value->pix)) {
3429                             $pix = new pix_icon($value->pix, $value->title, null, array('class' => 'iconsmall'));
3430                         } else if (isset($value->imgsrc) && !empty($value->imgsrc)) {
3431                             $value->title = html_writer::img(
3432                                 $value->imgsrc,
3433                                 $value->title,
3434                                 array('class' => 'iconsmall')
3435                             ) . $value->title;
3436                         }
3438                         $al = new action_menu_link_secondary(
3439                             $value->url,
3440                             $pix,
3441                             $value->title,
3442                             array('class' => 'icon')
3443                         );
3444                         if (!empty($value->titleidentifier)) {
3445                             $al->attributes['data-title'] = $value->titleidentifier;
3446                         }
3447                         $am->add($al);
3448                         break;
3449                 }
3451                 $idx++;
3453                 // Add dividers after the first item and before the last item.
3454                 if ($idx == 1 || $idx == $navitemcount - 1) {
3455                     $am->add($divider);
3456                 }
3457             }
3458         }
3460         return html_writer::div(
3461             $this->render($am),
3462             $usermenuclasses
3463         );
3464     }
3466     /**
3467      * Return the navbar content so that it can be echoed out by the layout
3468      *
3469      * @return string XHTML navbar
3470      */
3471     public function navbar() {
3472         $items = $this->page->navbar->get_items();
3473         $itemcount = count($items);
3474         if ($itemcount === 0) {
3475             return '';
3476         }
3478         $htmlblocks = array();
3479         // Iterate the navarray and display each node
3480         $separator = get_separator();
3481         for ($i=0;$i < $itemcount;$i++) {
3482             $item = $items[$i];
3483             $item->hideicon = true;
3484             if ($i===0) {
3485                 $content = html_writer::tag('li', $this->render($item));
3486             } else {
3487                 $content = html_writer::tag('li', $separator.$this->render($item));
3488             }
3489             $htmlblocks[] = $content;
3490         }
3492         //accessibility: heading for navbar list  (MDL-20446)
3493         $navbarcontent = html_writer::tag('span', get_string('pagepath'),
3494                 array('class' => 'accesshide', 'id' => 'navbar-label'));
3495         $navbarcontent .= html_writer::tag('nav',
3496                 html_writer::tag('ul', join('', $htmlblocks)),
3497                 array('aria-labelledby' => 'navbar-label'));
3498         // XHTML
3499         return $navbarcontent;
3500     }
3502     /**
3503      * Renders a breadcrumb navigation node object.
3504      *
3505      * @param breadcrumb_navigation_node $item The navigation node to render.
3506      * @return string HTML fragment
3507      */
3508     protected function render_breadcrumb_navigation_node(breadcrumb_navigation_node $item) {
3510         if ($item->action instanceof moodle_url) {
3511             $content = $item->get_content();
3512             $title = $item->get_title();
3513             $attributes = array();
3514             $attributes['itemprop'] = 'url';
3515             if ($title !== '') {
3516                 $attributes['title'] = $title;
3517             }
3518             if ($item->hidden) {
3519                 $attributes['class'] = 'dimmed_text';
3520             }
3521             $content = html_writer::tag('span', $content, array('itemprop' => 'title'));
3522             $content = html_writer::link($item->action, $content, $attributes);
3524             $attributes = array();
3525             $attributes['itemscope'] = '';
3526             $attributes['itemtype'] = 'http://data-vocabulary.org/Breadcrumb';
3527             $content = html_writer::tag('span', $content, $attributes);
3529         } else {
3530             $content = $this->render_navigation_node($item);
3531         }
3532         return $content;
3533     }
3535     /**
3536      * Renders a navigation node object.
3537      *
3538      * @param navigation_node $item The navigation node to render.
3539      * @return string HTML fragment
3540      */
3541     protected function render_navigation_node(navigation_node $item) {
3542         $content = $item->get_content();
3543         $title = $item->get_title();
3544         if ($item->icon instanceof renderable && !$item->hideicon) {
3545             $icon = $this->render($item->icon);
3546             $content = $icon.$content; // use CSS for spacing of icons
3547         }
3548         if ($item->helpbutton !== null) {
3549             $content = trim($item->helpbutton).html_writer::tag('span', $content, array('class'=>'clearhelpbutton', 'tabindex'=>'0'));
3550         }
3551         if ($content === '') {
3552             return '';
3553         }
3554         if ($item->action instanceof action_link) {
3555             $link = $item->action;
3556             if ($item->hidden) {
3557                 $link->add_class('dimmed');
3558             }
3559             if (!empty($content)) {
3560                 // Providing there is content we will use that for the link content.
3561                 $link->text = $content;
3562             }
3563             $content = $this->render($link);
3564         } else if ($item->action instanceof moodle_url) {
3565             $attributes = array();
3566             if ($title !== '') {
3567                 $attributes['title'] = $title;
3568             }
3569             if ($item->hidden) {
3570                 $attributes['class'] = 'dimmed_text';
3571             }
3572             $content = html_writer::link($item->action, $content, $attributes);
3574         } else if (is_string($item->action) || empty($item->action)) {
3575             $attributes = array('tabindex'=>'0'); //add tab support to span but still maintain character stream sequence.
3576             if ($title !== '') {
3577                 $attributes['title'] = $title;
3578             }
3579             if ($item->hidden) {
3580                 $attributes['class'] = 'dimmed_text';
3581             }
3582             $content = html_writer::tag('span', $content, $attributes);
3583         }
3584         return $content;
3585     }
3587     /**
3588      * Accessibility: Right arrow-like character is
3589      * used in the breadcrumb trail, course navigation menu
3590      * (previous/next activity), calendar, and search forum block.
3591      * If the theme does not set characters, appropriate defaults
3592      * are set automatically. Please DO NOT
3593      * use &lt; &gt; &raquo; - these are confusing for blind users.
3594      *
3595      * @return string
3596      */
3597     public function rarrow() {
3598         return $this->page->theme->rarrow;
3599     }
3601     /**
3602      * Accessibility: Left arrow-like character is
3603      * used in the breadcrumb trail, course navigation menu
3604      * (previous/next activity), calendar, and search forum block.
3605      * If the theme does not set characters, appropriate defaults
3606      * are set automatically. Please DO NOT
3607      * use &lt; &gt; &raquo; - these are confusing for blind users.
3608      *
3609      * @return string
3610      */
3611     public function larrow() {
3612         return $this->page->theme->larrow;
3613     }
3615     /**
3616      * Accessibility: Up arrow-like character is used in
3617      * the book heirarchical navigation.
3618      * If the theme does not set characters, appropriate defaults
3619      * are set automatically. Please DO NOT
3620      * use ^ - this is confusing for blind users.
3621      *
3622      * @return string
3623      */
3624     public function uarrow() {
3625         return $this->page->theme->uarrow;
3626     }
3628     /**
3629      * Accessibility: Down arrow-like character.
3630      * If the theme does not set characters, appropriate defaults
3631      * are set automatically.
3632      *
3633      * @return string
3634      */
3635     public function darrow() {
3636         return $this->page->theme->darrow;
3637     }
3639     /**
3640      * Returns the custom menu if one has been set
3641      *
3642      * A custom menu can be configured by browsing to
3643      *    Settings: Administration > Appearance > Themes > Theme settings
3644      * and then configuring the custommenu config setting as described.
3645      *
3646      * Theme developers: DO NOT OVERRIDE! Please override function
3647      * {@link core_renderer::render_custom_menu()} instead.
3648      *
3649      * @param string $custommenuitems - custom menuitems set by theme instead of global theme settings
3650      * @return string
3651      */
3652     public function custom_menu($custommenuitems = '') {
3653         global $CFG;
3654         if (empty($custommenuitems) && !empty($CFG->custommenuitems)) {
3655             $custommenuitems = $CFG->custommenuitems;
3656         }
3657         if (empty($custommenuitems)) {
3658             return '';
3659         }
3660         $custommenu = new custom_menu($custommenuitems, current_language());
3661         return $this->render($custommenu);
3662     }
3664     /**
3665      * Renders a custom menu object (located in outputcomponents.php)
3666      *
3667      * The custom menu this method produces makes use of the YUI3 menunav widget
3668      * and requires very specific html elements and classes.
3669      *
3670      * @staticvar int $menucount
3671      * @param custom_menu $menu
3672      * @return string
3673      */
3674     protected function render_custom_menu(custom_menu $menu) {
3675         static $menucount = 0;
3676         // If the menu has no children return an empty string
3677         if (!$menu->has_children()) {
3678             return '';
3679         }
3680         // Increment the menu count. This is used for ID's that get worked with
3681         // in JavaScript as is essential
3682         $menucount++;
3683         // Initialise this custom menu (the custom menu object is contained in javascript-static
3684         $jscode = js_writer::function_call_with_Y('M.core_custom_menu.init', array('custom_menu_'.$menucount));
3685         $jscode = "(function(){{$jscode}})";
3686         $this->page->requires->yui_module('node-menunav', $jscode);
3687         // Build the root nodes as required by YUI
3688         $content = html_writer::start_tag('div', array('id'=>'custom_menu_'.$menucount, 'class'=>'yui3-menu yui3-menu-horizontal javascript-disabled custom-menu'));
3689         $content .= html_writer::start_tag('div', array('class'=>'yui3-menu-content'));
3690         $content .= html_writer::start_tag('ul');
3691         // Render each child
3692         foreach ($menu->get_children() as $item) {
3693             $content .= $this->render_custom_menu_item($item);
3694         }
3695         // Close the open tags
3696         $content .= html_writer::end_tag('ul');
3697         $content .= html_writer::end_tag('div');
3698         $content .= html_writer::end_tag('div');
3699         // Return the custom menu
3700         return $content;
3701     }
3703     /**
3704      * Renders a custom menu node as part of a submenu
3705      *
3706      * The custom menu this method produces makes use of the YUI3 menunav widget
3707      * and requires very specific html elements and classes.
3708      *
3709      * @see core:renderer::render_custom_menu()
3710      *
3711      * @staticvar int $submenucount
3712      * @param custom_menu_item $menunode
3713      * @return string
3714      */
3715     protected function render_custom_menu_item(custom_menu_item $menunode) {
3716         // Required to ensure we get unique trackable id's
3717         static $submenucount = 0;
3718         if ($menunode->has_children()) {
3719             // If the child has menus render it as a sub menu
3720             $submenucount++;
3721             $content = html_writer::start_tag('li');
3722             if ($menunode->get_url() !== null) {
3723                 $url = $menunode->get_url();
3724             } else {
3725                 $url = '#cm_submenu_'.$submenucount;
3726             }
3727             $content .= html_writer::link($url, $menunode->get_text(), array('class'=>'yui3-menu-label', 'title'=>$menunode->get_title()));
3728             $content .= html_writer::start_tag('div', array('id'=>'cm_submenu_'.$submenucount, 'class'=>'yui3-menu custom_menu_submenu'));
3729             $content .= html_writer::start_tag('div', array('class'=>'yui3-menu-content'));
3730             $content .= html_writer::start_tag('ul');
3731             foreach ($menunode->get_children() as $menunode) {
3732                 $content .= $this->render_custom_menu_item($menunode);
3733             }
3734             $content .= html_writer::end_tag('ul');
3735             $content .= html_writer::end_tag('div');
3736             $content .= html_writer::end_tag('div');
3737             $content .= html_writer::end_tag('li');
3738         } else {
3739             // The node doesn't have children so produce a final menuitem.
3740             // Also, if the node's text matches '####', add a class so we can treat it as a divider.
3741             $content = '';
3742             if (preg_match("/^#+$/", $menunode->get_text())) {
3744                 // This is a divider.
3745                 $content = html_writer::start_tag('li', array('class' => 'yui3-menuitem divider'));
3746             } else {
3747                 $content = html_writer::start_tag(
3748                     'li',
3749                     array(
3750                         'class' => 'yui3-menuitem'
3751                     )
3752                 );
3753                 if ($menunode->get_url() !== null) {
3754                     $url = $menunode->get_url();
3755                 } else {
3756                     $url = '#';
3757                 }
3758                 $content .= html_writer::link(
3759                     $url,
3760                     $menunode->get_text(),
3761                     array('class' => 'yui3-menuitem-content', 'title' => $menunode->get_title())
3762                 );
3763             }
3764             $content .= html_writer::end_tag('li');
3765         }
3766         // Return the sub menu
3767         return $content;
3768     }
3770     /**
3771      * Renders theme links for switching between default and other themes.
3772      *
3773      * @return string
3774      */
3775     protected function theme_switch_links() {
3777         $actualdevice = core_useragent::get_device_type();
3778         $currentdevice = $this->page->devicetypeinuse;
3779         $switched = ($actualdevice != $currentdevice);
3781         if (!$switched && $currentdevice == 'default' && $actualdevice == 'default') {
3782             // The user is using the a default device and hasn't switched so don't shown the switch
3783             // device links.
3784             return '';
3785         }
3787         if ($switched) {
3788             $linktext = get_string('switchdevicerecommended');
3789             $devicetype = $actualdevice;
3790         } else {
3791             $linktext = get_string('switchdevicedefault');
3792             $devicetype = 'default';
3793         }
3794         $linkurl = new moodle_url('/theme/switchdevice.php', array('url' => $this->page->url, 'device' => $devicetype, 'sesskey' => sesskey()));
3796         $content  = html_writer::start_tag('div', array('id' => 'theme_switch_link'));
3797         $content .= html_writer::link($linkurl, $linktext, array('rel' => 'nofollow'));
3798         $content .= html_writer::end_tag('div');
3800         return $content;
3801     }
3803     /**
3804      * Renders tabs
3805      *
3806      * This function replaces print_tabs() used before Moodle 2.5 but with slightly different arguments
3807      *
3808      * Theme developers: In order to change how tabs are displayed please override functions
3809      * {@link core_renderer::render_tabtree()} and/or {@link core_renderer::render_tabobject()}
3810      *
3811      * @param array $tabs array of tabs, each of them may have it's own ->subtree
3812      * @param string|null $selected which tab to mark as selected, all parent tabs will
3813      *     automatically be marked as activated
3814      * @param array|string|null $inactive list of ids of inactive tabs, regardless of
3815      *     their level. Note that you can as weel specify tabobject::$inactive for separate instances
3816      * @return string
3817      */
3818     public final function tabtree($tabs, $selected = null, $inactive = null) {
3819         return $this->render(new tabtree($tabs, $selected, $inactive));
3820     }
3822     /**
3823      * Renders tabtree
3824      *
3825      * @param tabtree $tabtree
3826      * @return string
3827      */
3828     protected function render_tabtree(tabtree $tabtree) {
3829         if (empty($tabtree->subtree)) {
3830             return '';
3831         }
3832         $str = '';
3833         $str .= html_writer::start_tag('div', array('class' => 'tabtree'));
3834         $str .= $this->render_tabobject($tabtree);
3835         $str .= html_writer::end_tag('div').
3836                 html_writer::tag('div', ' ', array('class' => 'clearer'));
3837         return $str;
3838     }
3840     /**
3841      * Renders tabobject (part of tabtree)
3842      *
3843      * This function is called from {@link core_renderer::render_tabtree()}
3844      * and also it calls itself when printing the $tabobject subtree recursively.
3845      *
3846      * Property $tabobject->level indicates the number of row of tabs.
3847      *
3848      * @param tabobject $tabobject
3849      * @return string HTML fragment
3850      */
3851     protected function render_tabobject(tabobject $tabobject) {
3852         $str = '';
3854         // Print name of the current tab.
3855         if ($tabobject instanceof tabtree) {
3856             // No name for tabtree root.
3857         } else if ($tabobject->inactive || $tabobject->activated || ($tabobject->selected && !$tabobject->linkedwhenselected)) {
3858             // Tab name without a link. The <a> tag is used for styling.
3859             $str .= html_writer::tag('a', html_writer::span($tabobject->text), array('class' => 'nolink moodle-has-zindex'));
3860         } else {
3861             // Tab name with a link.
3862             if (!($tabobject->link instanceof moodle_url)) {
3863                 // backward compartibility when link was passed as quoted string
3864                 $str .= "<a href=\"$tabobject->link\" title=\"$tabobject->title\"><span>$tabobject->text</span></a>";
3865             } else {
3866                 $str .= html_writer::link($tabobject->link, html_writer::span($tabobject->text), array('title' => $tabobject->title));
3867             }
3868         }
3870         if (empty($tabobject->subtree)) {
3871             if ($tabobject->selected) {
3872                 $str .= html_writer::tag('div', '&nbsp;', array('class' => 'tabrow'. ($tabobject->level + 1). ' empty'));
3873             }
3874             return $str;
3875         }
3877         // Print subtree.
3878         if ($tabobject->level == 0 || $tabobject->selected || $tabobject->activated) {
3879             $str .= html_writer::start_tag('ul', array('class' => 'tabrow'. $tabobject->level));
3880             $cnt = 0;
3881             foreach ($tabobject->subtree as $tab) {
3882                 $liclass = '';
3883                 if (!$cnt) {
3884                     $liclass .= ' first';
3885                 }
3886                 if ($cnt == count($tabobject->subtree) - 1) {
3887                     $liclass .= ' last';
3888                 }
3889                 if ((empty($tab->subtree)) && (!empty($tab->selected))) {
3890                     $liclass .= ' onerow';
3891                 }
3893                 if ($tab->selected) {
3894                     $liclass .= ' here selected';
3895                 } else if ($tab->activated) {
3896                     $liclass .= ' here active';
3897                 }
3899                 // This will recursively call function render_tabobject() for each item in subtree.
3900                 $str .= html_writer::tag('li', $this->render($tab), array('class' => trim($liclass)));
3901                 $cnt++;
3902             }
3903             $str .= html_writer::end_tag('ul');
3904         }
3906         return $str;
3907     }
3909     /**
3910      * Get the HTML for blocks in the given region.
3911      *
3912      * @since Moodle 2.5.1 2.6
3913      * @param string $region The region to get HTML for.
3914      * @return string HTML.
3915      */
3916     public function blocks($region, $classes = array(), $tag = 'aside') {
3917         $displayregion = $this->page->apply_theme_region_manipulations($region);
3918         $classes = (array)$classes;
3919         $classes[] = 'block-region';
3920         $attributes = array(
3921             'id' => 'block-region-'.preg_replace('#[^a-zA-Z0-9_\-]+#', '-', $displayregion),
3922             'class' => join(' ', $classes),
3923             'data-blockregion' => $displayregion,
3924             'data-droptarget' => '1'
3925         );
3926         if ($this->page->blocks->region_has_content($displayregion, $this)) {
3927             $content = $this->blocks_for_region($displayregion);
3928         } else {
3929             $content = '';
3930         }
3931         return html_writer::tag($tag, $content, $attributes);
3932     }
3934     /**
3935      * Renders a custom block region.
3936      *
3937      * Use this method if you want to add an additional block region to the content of the page.
3938      * Please note this should only be used in special situations.
3939      * We want to leave the theme is control where ever possible!
3940      *