Merge branch 'MDL-55188-master' of git://github.com/abgreeve/moodle
[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      * Renders an action menu component.
1523      *
1524      * ARIA references:
1525      *   - http://www.w3.org/WAI/GL/wiki/Using_ARIA_menus
1526      *   - http://stackoverflow.com/questions/12279113/recommended-wai-aria-implementation-for-navigation-bar-menu
1527      *
1528      * @param action_menu $menu
1529      * @return string HTML
1530      */
1531     public function render_action_menu(action_menu $menu) {
1532         $context = $menu->export_for_template($this);
1533         return $this->render_from_template('core/action_menu', $context);
1534     }
1536     /**
1537      * Renders an action_menu_link item.
1538      *
1539      * @param action_menu_link $action
1540      * @return string HTML fragment
1541      */
1542     protected function render_action_menu_link(action_menu_link $action) {
1543         return $this->render_from_template('core/action_menu_link', $action->export_for_template($this));
1544     }
1546     /**
1547      * Renders a primary action_menu_filler item.
1548      *
1549      * @param action_menu_link_filler $action
1550      * @return string HTML fragment
1551      */
1552     protected function render_action_menu_filler(action_menu_filler $action) {
1553         return html_writer::span('&nbsp;', 'filler');
1554     }
1556     /**
1557      * Renders a primary action_menu_link item.
1558      *
1559      * @param action_menu_link_primary $action
1560      * @return string HTML fragment
1561      */
1562     protected function render_action_menu_link_primary(action_menu_link_primary $action) {
1563         return $this->render_action_menu_link($action);
1564     }
1566     /**
1567      * Renders a secondary action_menu_link item.
1568      *
1569      * @param action_menu_link_secondary $action
1570      * @return string HTML fragment
1571      */
1572     protected function render_action_menu_link_secondary(action_menu_link_secondary $action) {
1573         return $this->render_action_menu_link($action);
1574     }
1576     /**
1577      * Prints a nice side block with an optional header.
1578      *
1579      * The content is described
1580      * by a {@link core_renderer::block_contents} object.
1581      *
1582      * <div id="inst{$instanceid}" class="block_{$blockname} block">
1583      *      <div class="header"></div>
1584      *      <div class="content">
1585      *          ...CONTENT...
1586      *          <div class="footer">
1587      *          </div>
1588      *      </div>
1589      *      <div class="annotation">
1590      *      </div>
1591      * </div>
1592      *
1593      * @param block_contents $bc HTML for the content
1594      * @param string $region the region the block is appearing in.
1595      * @return string the HTML to be output.
1596      */
1597     public function block(block_contents $bc, $region) {
1598         $bc = clone($bc); // Avoid messing up the object passed in.
1599         if (empty($bc->blockinstanceid) || !strip_tags($bc->title)) {
1600             $bc->collapsible = block_contents::NOT_HIDEABLE;
1601         }
1602         if (!empty($bc->blockinstanceid)) {
1603             $bc->attributes['data-instanceid'] = $bc->blockinstanceid;
1604         }
1605         $skiptitle = strip_tags($bc->title);
1606         if ($bc->blockinstanceid && !empty($skiptitle)) {
1607             $bc->attributes['aria-labelledby'] = 'instance-'.$bc->blockinstanceid.'-header';
1608         } else if (!empty($bc->arialabel)) {
1609             $bc->attributes['aria-label'] = $bc->arialabel;
1610         }
1611         if ($bc->dockable) {
1612             $bc->attributes['data-dockable'] = 1;
1613         }
1614         if ($bc->collapsible == block_contents::HIDDEN) {
1615             $bc->add_class('hidden');
1616         }
1617         if (!empty($bc->controls)) {
1618             $bc->add_class('block_with_controls');
1619         }
1622         if (empty($skiptitle)) {
1623             $output = '';
1624             $skipdest = '';
1625         } else {
1626             $output = html_writer::link('#sb-'.$bc->skipid, get_string('skipa', 'access', $skiptitle),
1627                       array('class' => 'skip skip-block', 'id' => 'fsb-' . $bc->skipid));
1628             $skipdest = html_writer::span('', 'skip-block-to',
1629                       array('id' => 'sb-' . $bc->skipid));
1630         }
1632         $output .= html_writer::start_tag('div', $bc->attributes);
1634         $output .= $this->block_header($bc);
1635         $output .= $this->block_content($bc);
1637         $output .= html_writer::end_tag('div');
1639         $output .= $this->block_annotation($bc);
1641         $output .= $skipdest;
1643         $this->init_block_hider_js($bc);
1644         return $output;
1645     }
1647     /**
1648      * Produces a header for a block
1649      *
1650      * @param block_contents $bc
1651      * @return string
1652      */
1653     protected function block_header(block_contents $bc) {
1655         $title = '';
1656         if ($bc->title) {
1657             $attributes = array();
1658             if ($bc->blockinstanceid) {
1659                 $attributes['id'] = 'instance-'.$bc->blockinstanceid.'-header';
1660             }
1661             $title = html_writer::tag('h2', $bc->title, $attributes);
1662         }
1664         $blockid = null;
1665         if (isset($bc->attributes['id'])) {
1666             $blockid = $bc->attributes['id'];
1667         }
1668         $controlshtml = $this->block_controls($bc->controls, $blockid);
1670         $output = '';
1671         if ($title || $controlshtml) {
1672             $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'));
1673         }
1674         return $output;
1675     }
1677     /**
1678      * Produces the content area for a block
1679      *
1680      * @param block_contents $bc
1681      * @return string
1682      */
1683     protected function block_content(block_contents $bc) {
1684         $output = html_writer::start_tag('div', array('class' => 'content'));
1685         if (!$bc->title && !$this->block_controls($bc->controls)) {
1686             $output .= html_writer::tag('div', '', array('class'=>'block_action notitle'));
1687         }
1688         $output .= $bc->content;
1689         $output .= $this->block_footer($bc);
1690         $output .= html_writer::end_tag('div');
1692         return $output;
1693     }
1695     /**
1696      * Produces the footer for a block
1697      *
1698      * @param block_contents $bc
1699      * @return string
1700      */
1701     protected function block_footer(block_contents $bc) {
1702         $output = '';
1703         if ($bc->footer) {
1704             $output .= html_writer::tag('div', $bc->footer, array('class' => 'footer'));
1705         }
1706         return $output;
1707     }
1709     /**
1710      * Produces the annotation for a block
1711      *
1712      * @param block_contents $bc
1713      * @return string
1714      */
1715     protected function block_annotation(block_contents $bc) {
1716         $output = '';
1717         if ($bc->annotation) {
1718             $output .= html_writer::tag('div', $bc->annotation, array('class' => 'blockannotation'));
1719         }
1720         return $output;
1721     }
1723     /**
1724      * Calls the JS require function to hide a block.
1725      *
1726      * @param block_contents $bc A block_contents object
1727      */
1728     protected function init_block_hider_js(block_contents $bc) {
1729         if (!empty($bc->attributes['id']) and $bc->collapsible != block_contents::NOT_HIDEABLE) {
1730             $config = new stdClass;
1731             $config->id = $bc->attributes['id'];
1732             $config->title = strip_tags($bc->title);
1733             $config->preference = 'block' . $bc->blockinstanceid . 'hidden';
1734             $config->tooltipVisible = get_string('hideblocka', 'access', $config->title);
1735             $config->tooltipHidden = get_string('showblocka', 'access', $config->title);
1737             $this->page->requires->js_init_call('M.util.init_block_hider', array($config));
1738             user_preference_allow_ajax_update($config->preference, PARAM_BOOL);
1739         }
1740     }
1742     /**
1743      * Render the contents of a block_list.
1744      *
1745      * @param array $icons the icon for each item.
1746      * @param array $items the content of each item.
1747      * @return string HTML
1748      */
1749     public function list_block_contents($icons, $items) {
1750         $row = 0;
1751         $lis = array();
1752         foreach ($items as $key => $string) {
1753             $item = html_writer::start_tag('li', array('class' => 'r' . $row));
1754             if (!empty($icons[$key])) { //test if the content has an assigned icon
1755                 $item .= html_writer::tag('div', $icons[$key], array('class' => 'icon column c0'));
1756             }
1757             $item .= html_writer::tag('div', $string, array('class' => 'column c1'));
1758             $item .= html_writer::end_tag('li');
1759             $lis[] = $item;
1760             $row = 1 - $row; // Flip even/odd.
1761         }
1762         return html_writer::tag('ul', implode("\n", $lis), array('class' => 'unlist'));
1763     }
1765     /**
1766      * Output all the blocks in a particular region.
1767      *
1768      * @param string $region the name of a region on this page.
1769      * @return string the HTML to be output.
1770      */
1771     public function blocks_for_region($region) {
1772         $blockcontents = $this->page->blocks->get_content_for_region($region, $this);
1773         $blocks = $this->page->blocks->get_blocks_for_region($region);
1774         $lastblock = null;
1775         $zones = array();
1776         foreach ($blocks as $block) {
1777             $zones[] = $block->title;
1778         }
1779         $output = '';
1781         foreach ($blockcontents as $bc) {
1782             if ($bc instanceof block_contents) {
1783                 $output .= $this->block($bc, $region);
1784                 $lastblock = $bc->title;
1785             } else if ($bc instanceof block_move_target) {
1786                 $output .= $this->block_move_target($bc, $zones, $lastblock, $region);
1787             } else {
1788                 throw new coding_exception('Unexpected type of thing (' . get_class($bc) . ') found in list of block contents.');
1789             }
1790         }
1791         return $output;
1792     }
1794     /**
1795      * Output a place where the block that is currently being moved can be dropped.
1796      *
1797      * @param block_move_target $target with the necessary details.
1798      * @param array $zones array of areas where the block can be moved to
1799      * @param string $previous the block located before the area currently being rendered.
1800      * @param string $region the name of the region
1801      * @return string the HTML to be output.
1802      */
1803     public function block_move_target($target, $zones, $previous, $region) {
1804         if ($previous == null) {
1805             if (empty($zones)) {
1806                 // There are no zones, probably because there are no blocks.
1807                 $regions = $this->page->theme->get_all_block_regions();
1808                 $position = get_string('moveblockinregion', 'block', $regions[$region]);
1809             } else {
1810                 $position = get_string('moveblockbefore', 'block', $zones[0]);
1811             }
1812         } else {
1813             $position = get_string('moveblockafter', 'block', $previous);
1814         }
1815         return html_writer::tag('a', html_writer::tag('span', $position, array('class' => 'accesshide')), array('href' => $target->url, 'class' => 'blockmovetarget'));
1816     }
1818     /**
1819      * Renders a special html link with attached action
1820      *
1821      * Theme developers: DO NOT OVERRIDE! Please override function
1822      * {@link core_renderer::render_action_link()} instead.
1823      *
1824      * @param string|moodle_url $url
1825      * @param string $text HTML fragment
1826      * @param component_action $action
1827      * @param array $attributes associative array of html link attributes + disabled
1828      * @param pix_icon optional pix icon to render with the link
1829      * @return string HTML fragment
1830      */
1831     public function action_link($url, $text, component_action $action = null, array $attributes = null, $icon = null) {
1832         if (!($url instanceof moodle_url)) {
1833             $url = new moodle_url($url);
1834         }
1835         $link = new action_link($url, $text, $action, $attributes, $icon);
1837         return $this->render($link);
1838     }
1840     /**
1841      * Renders an action_link object.
1842      *
1843      * The provided link is renderer and the HTML returned. At the same time the
1844      * associated actions are setup in JS by {@link core_renderer::add_action_handler()}
1845      *
1846      * @param action_link $link
1847      * @return string HTML fragment
1848      */
1849     protected function render_action_link(action_link $link) {
1850         return $this->render_from_template('core/action_link', $link->export_for_template($this));
1851     }
1853     /**
1854      * Renders an action_icon.
1855      *
1856      * This function uses the {@link core_renderer::action_link()} method for the
1857      * most part. What it does different is prepare the icon as HTML and use it
1858      * as the link text.
1859      *
1860      * Theme developers: If you want to change how action links and/or icons are rendered,
1861      * consider overriding function {@link core_renderer::render_action_link()} and
1862      * {@link core_renderer::render_pix_icon()}.
1863      *
1864      * @param string|moodle_url $url A string URL or moodel_url
1865      * @param pix_icon $pixicon
1866      * @param component_action $action
1867      * @param array $attributes associative array of html link attributes + disabled
1868      * @param bool $linktext show title next to image in link
1869      * @return string HTML fragment
1870      */
1871     public function action_icon($url, pix_icon $pixicon, component_action $action = null, array $attributes = null, $linktext=false) {
1872         if (!($url instanceof moodle_url)) {
1873             $url = new moodle_url($url);
1874         }
1875         $attributes = (array)$attributes;
1877         if (empty($attributes['class'])) {
1878             // let ppl override the class via $options
1879             $attributes['class'] = 'action-icon';
1880         }
1882         $icon = $this->render($pixicon);
1884         if ($linktext) {
1885             $text = $pixicon->attributes['alt'];
1886         } else {
1887             $text = '';
1888         }
1890         return $this->action_link($url, $text.$icon, $action, $attributes);
1891     }
1893    /**
1894     * Print a message along with button choices for Continue/Cancel
1895     *
1896     * If a string or moodle_url is given instead of a single_button, method defaults to post.
1897     *
1898     * @param string $message The question to ask the user
1899     * @param single_button|moodle_url|string $continue The single_button component representing the Continue answer. Can also be a moodle_url or string URL
1900     * @param single_button|moodle_url|string $cancel The single_button component representing the Cancel answer. Can also be a moodle_url or string URL
1901     * @return string HTML fragment
1902     */
1903     public function confirm($message, $continue, $cancel) {
1904         if ($continue instanceof single_button) {
1905             // ok
1906             $continue->primary = true;
1907         } else if (is_string($continue)) {
1908             $continue = new single_button(new moodle_url($continue), get_string('continue'), 'post', true);
1909         } else if ($continue instanceof moodle_url) {
1910             $continue = new single_button($continue, get_string('continue'), 'post', true);
1911         } else {
1912             throw new coding_exception('The continue param to $OUTPUT->confirm() must be either a URL (string/moodle_url) or a single_button instance.');
1913         }
1915         if ($cancel instanceof single_button) {
1916             // ok
1917         } else if (is_string($cancel)) {
1918             $cancel = new single_button(new moodle_url($cancel), get_string('cancel'), 'get');
1919         } else if ($cancel instanceof moodle_url) {
1920             $cancel = new single_button($cancel, get_string('cancel'), 'get');
1921         } else {
1922             throw new coding_exception('The cancel param to $OUTPUT->confirm() must be either a URL (string/moodle_url) or a single_button instance.');
1923         }
1925         $output = $this->box_start('generalbox modal modal-dialog modal-in-page show', 'notice');
1926         $output .= $this->box_start('modal-content', 'modal-content');
1927         $output .= $this->box_start('modal-header p-x-1', 'modal-header');
1928         $output .= html_writer::tag('h4', get_string('confirm'));
1929         $output .= $this->box_end();
1930         $output .= $this->box_start('modal-body', 'modal-body');
1931         $output .= html_writer::tag('p', $message);
1932         $output .= $this->box_end();
1933         $output .= $this->box_start('modal-footer', 'modal-footer');
1934         $output .= html_writer::tag('div', $this->render($continue) . $this->render($cancel), array('class' => 'buttons'));
1935         $output .= $this->box_end();
1936         $output .= $this->box_end();
1937         $output .= $this->box_end();
1938         return $output;
1939     }
1941     /**
1942      * Returns a form with a single button.
1943      *
1944      * Theme developers: DO NOT OVERRIDE! Please override function
1945      * {@link core_renderer::render_single_button()} instead.
1946      *
1947      * @param string|moodle_url $url
1948      * @param string $label button text
1949      * @param string $method get or post submit method
1950      * @param array $options associative array {disabled, title, etc.}
1951      * @return string HTML fragment
1952      */
1953     public function single_button($url, $label, $method='post', array $options=null) {
1954         if (!($url instanceof moodle_url)) {
1955             $url = new moodle_url($url);
1956         }
1957         $button = new single_button($url, $label, $method);
1959         foreach ((array)$options as $key=>$value) {
1960             if (array_key_exists($key, $button)) {
1961                 $button->$key = $value;
1962             }
1963         }
1965         return $this->render($button);
1966     }
1968     /**
1969      * Renders a single button widget.
1970      *
1971      * This will return HTML to display a form containing a single button.
1972      *
1973      * @param single_button $button
1974      * @return string HTML fragment
1975      */
1976     protected function render_single_button(single_button $button) {
1977         $attributes = array('type'     => 'submit',
1978                             'value'    => $button->label,
1979                             'disabled' => $button->disabled ? 'disabled' : null,
1980                             'title'    => $button->tooltip);
1982         if ($button->actions) {
1983             $id = html_writer::random_id('single_button');
1984             $attributes['id'] = $id;
1985             foreach ($button->actions as $action) {
1986                 $this->add_action_handler($action, $id);
1987             }
1988         }
1990         // first the input element
1991         $output = html_writer::empty_tag('input', $attributes);
1993         // then hidden fields
1994         $params = $button->url->params();
1995         if ($button->method === 'post') {
1996             $params['sesskey'] = sesskey();
1997         }
1998         foreach ($params as $var => $val) {
1999             $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => $var, 'value' => $val));
2000         }
2002         // then div wrapper for xhtml strictness
2003         $output = html_writer::tag('div', $output);
2005         // now the form itself around it
2006         if ($button->method === 'get') {
2007             $url = $button->url->out_omit_querystring(true); // url without params, the anchor part allowed
2008         } else {
2009             $url = $button->url->out_omit_querystring();     // url without params, the anchor part not allowed
2010         }
2011         if ($url === '') {
2012             $url = '#'; // there has to be always some action
2013         }
2014         $attributes = array('method' => $button->method,
2015                             'action' => $url,
2016                             'id'     => $button->formid);
2017         $output = html_writer::tag('form', $output, $attributes);
2019         // and finally one more wrapper with class
2020         return html_writer::tag('div', $output, array('class' => $button->class));
2021     }
2023     /**
2024      * Returns a form with a single select widget.
2025      *
2026      * Theme developers: DO NOT OVERRIDE! Please override function
2027      * {@link core_renderer::render_single_select()} instead.
2028      *
2029      * @param moodle_url $url form action target, includes hidden fields
2030      * @param string $name name of selection field - the changing parameter in url
2031      * @param array $options list of options
2032      * @param string $selected selected element
2033      * @param array $nothing
2034      * @param string $formid
2035      * @param array $attributes other attributes for the single select
2036      * @return string HTML fragment
2037      */
2038     public function single_select($url, $name, array $options, $selected = '',
2039                                 $nothing = array('' => 'choosedots'), $formid = null, $attributes = array()) {
2040         if (!($url instanceof moodle_url)) {
2041             $url = new moodle_url($url);
2042         }
2043         $select = new single_select($url, $name, $options, $selected, $nothing, $formid);
2045         if (array_key_exists('label', $attributes)) {
2046             $select->set_label($attributes['label']);
2047             unset($attributes['label']);
2048         }
2049         $select->attributes = $attributes;
2051         return $this->render($select);
2052     }
2054     /**
2055      * Returns a dataformat selection and download form
2056      *
2057      * @param string $label A text label
2058      * @param moodle_url|string $base The download page url
2059      * @param string $name The query param which will hold the type of the download
2060      * @param array $params Extra params sent to the download page
2061      * @return string HTML fragment
2062      */
2063     public function download_dataformat_selector($label, $base, $name = 'dataformat', $params = array()) {
2065         $formats = core_plugin_manager::instance()->get_plugins_of_type('dataformat');
2066         $options = array();
2067         foreach ($formats as $format) {
2068             if ($format->is_enabled()) {
2069                 $options[] = array(
2070                     'value' => $format->name,
2071                     'label' => get_string('dataformat', $format->component),
2072                 );
2073             }
2074         }
2075         $hiddenparams = array();
2076         foreach ($params as $key => $value) {
2077             $hiddenparams[] = array(
2078                 'name' => $key,
2079                 'value' => $value,
2080             );
2081         }
2082         $data = array(
2083             'label' => $label,
2084             'base' => $base,
2085             'name' => $name,
2086             'params' => $hiddenparams,
2087             'options' => $options,
2088             'sesskey' => sesskey(),
2089             'submit' => get_string('download'),
2090         );
2092         return $this->render_from_template('core/dataformat_selector', $data);
2093     }
2096     /**
2097      * Internal implementation of single_select rendering
2098      *
2099      * @param single_select $select
2100      * @return string HTML fragment
2101      */
2102     protected function render_single_select(single_select $select) {
2103         return $this->render_from_template('core/single_select', $select->export_for_template($this));
2104     }
2106     /**
2107      * Returns a form with a url select widget.
2108      *
2109      * Theme developers: DO NOT OVERRIDE! Please override function
2110      * {@link core_renderer::render_url_select()} instead.
2111      *
2112      * @param array $urls list of urls - array('/course/view.php?id=1'=>'Frontpage', ....)
2113      * @param string $selected selected element
2114      * @param array $nothing
2115      * @param string $formid
2116      * @return string HTML fragment
2117      */
2118     public function url_select(array $urls, $selected, $nothing = array('' => 'choosedots'), $formid = null) {
2119         $select = new url_select($urls, $selected, $nothing, $formid);
2120         return $this->render($select);
2121     }
2123     /**
2124      * Internal implementation of url_select rendering
2125      *
2126      * @param url_select $select
2127      * @return string HTML fragment
2128      */
2129     protected function render_url_select(url_select $select) {
2130         return $this->render_from_template('core/url_select', $select->export_for_template($this));
2131     }
2133     /**
2134      * Returns a string containing a link to the user documentation.
2135      * Also contains an icon by default. Shown to teachers and admin only.
2136      *
2137      * @param string $path The page link after doc root and language, no leading slash.
2138      * @param string $text The text to be displayed for the link
2139      * @param boolean $forcepopup Whether to force a popup regardless of the value of $CFG->doctonewwindow
2140      * @return string
2141      */
2142     public function doc_link($path, $text = '', $forcepopup = false) {
2143         global $CFG;
2145         $icon = $this->pix_icon('docs', '', 'moodle', array('class'=>'iconhelp icon-pre', 'role'=>'presentation'));
2147         $url = new moodle_url(get_docs_url($path));
2149         $attributes = array('href'=>$url);
2150         if (!empty($CFG->doctonewwindow) || $forcepopup) {
2151             $attributes['class'] = 'helplinkpopup';
2152         }
2154         return html_writer::tag('a', $icon.$text, $attributes);
2155     }
2157     /**
2158      * Return HTML for an image_icon.
2159      *
2160      * Theme developers: DO NOT OVERRIDE! Please override function
2161      * {@link core_renderer::render_image_icon()} instead.
2162      *
2163      * @param string $pix short pix name
2164      * @param string $alt mandatory alt attribute
2165      * @param string $component standard compoennt name like 'moodle', 'mod_forum', etc.
2166      * @param array $attributes htm lattributes
2167      * @return string HTML fragment
2168      */
2169     public function image_icon($pix, $alt, $component='moodle', array $attributes = null) {
2170         $icon = new image_icon($pix, $alt, $component, $attributes);
2171         return $this->render($icon);
2172     }
2174     /**
2175      * Renders a pix_icon widget and returns the HTML to display it.
2176      *
2177      * @param image_icon $icon
2178      * @return string HTML fragment
2179      */
2180     protected function render_image_icon(image_icon $icon) {
2181         $system = \core\output\icon_system::instance(\core\output\icon_system::STANDARD);
2182         return $system->render_pix_icon($this, $icon);
2183     }
2185     /**
2186      * Return HTML for a pix_icon.
2187      *
2188      * Theme developers: DO NOT OVERRIDE! Please override function
2189      * {@link core_renderer::render_pix_icon()} instead.
2190      *
2191      * @param string $pix short pix name
2192      * @param string $alt mandatory alt attribute
2193      * @param string $component standard compoennt name like 'moodle', 'mod_forum', etc.
2194      * @param array $attributes htm lattributes
2195      * @return string HTML fragment
2196      */
2197     public function pix_icon($pix, $alt, $component='moodle', array $attributes = null) {
2198         $icon = new pix_icon($pix, $alt, $component, $attributes);
2199         return $this->render($icon);
2200     }
2202     /**
2203      * Renders a pix_icon widget and returns the HTML to display it.
2204      *
2205      * @param pix_icon $icon
2206      * @return string HTML fragment
2207      */
2208     protected function render_pix_icon(pix_icon $icon) {
2209         $system = \core\output\icon_system::instance();
2210         return $system->render_pix_icon($this, $icon);
2211     }
2213     /**
2214      * Return HTML to display an emoticon icon.
2215      *
2216      * @param pix_emoticon $emoticon
2217      * @return string HTML fragment
2218      */
2219     protected function render_pix_emoticon(pix_emoticon $emoticon) {
2220         $system = \core\output\icon_system::instance(\core\output\icon_system::STANDARD);
2221         return $system->render_pix_icon($this, $emoticon);
2222     }
2224     /**
2225      * Produces the html that represents this rating in the UI
2226      *
2227      * @param rating $rating the page object on which this rating will appear
2228      * @return string
2229      */
2230     function render_rating(rating $rating) {
2231         global $CFG, $USER;
2233         if ($rating->settings->aggregationmethod == RATING_AGGREGATE_NONE) {
2234             return null;//ratings are turned off
2235         }
2237         $ratingmanager = new rating_manager();
2238         // Initialise the JavaScript so ratings can be done by AJAX.
2239         $ratingmanager->initialise_rating_javascript($this->page);
2241         $strrate = get_string("rate", "rating");
2242         $ratinghtml = ''; //the string we'll return
2244         // permissions check - can they view the aggregate?
2245         if ($rating->user_can_view_aggregate()) {
2247             $aggregatelabel = $ratingmanager->get_aggregate_label($rating->settings->aggregationmethod);
2248             $aggregatestr   = $rating->get_aggregate_string();
2250             $aggregatehtml  = html_writer::tag('span', $aggregatestr, array('id' => 'ratingaggregate'.$rating->itemid, 'class' => 'ratingaggregate')).' ';
2251             if ($rating->count > 0) {
2252                 $countstr = "({$rating->count})";
2253             } else {
2254                 $countstr = '-';
2255             }
2256             $aggregatehtml .= html_writer::tag('span', $countstr, array('id'=>"ratingcount{$rating->itemid}", 'class' => 'ratingcount')).' ';
2258             $ratinghtml .= html_writer::tag('span', $aggregatelabel, array('class'=>'rating-aggregate-label'));
2259             if ($rating->settings->permissions->viewall && $rating->settings->pluginpermissions->viewall) {
2261                 $nonpopuplink = $rating->get_view_ratings_url();
2262                 $popuplink = $rating->get_view_ratings_url(true);
2264                 $action = new popup_action('click', $popuplink, 'ratings', array('height' => 400, 'width' => 600));
2265                 $ratinghtml .= $this->action_link($nonpopuplink, $aggregatehtml, $action);
2266             } else {
2267                 $ratinghtml .= $aggregatehtml;
2268             }
2269         }
2271         $formstart = null;
2272         // if the item doesn't belong to the current user, the user has permission to rate
2273         // and we're within the assessable period
2274         if ($rating->user_can_rate()) {
2276             $rateurl = $rating->get_rate_url();
2277             $inputs = $rateurl->params();
2279             //start the rating form
2280             $formattrs = array(
2281                 'id'     => "postrating{$rating->itemid}",
2282                 'class'  => 'postratingform',
2283                 'method' => 'post',
2284                 'action' => $rateurl->out_omit_querystring()
2285             );
2286             $formstart  = html_writer::start_tag('form', $formattrs);
2287             $formstart .= html_writer::start_tag('div', array('class' => 'ratingform'));
2289             // add the hidden inputs
2290             foreach ($inputs as $name => $value) {
2291                 $attributes = array('type' => 'hidden', 'class' => 'ratinginput', 'name' => $name, 'value' => $value);
2292                 $formstart .= html_writer::empty_tag('input', $attributes);
2293             }
2295             if (empty($ratinghtml)) {
2296                 $ratinghtml .= $strrate.': ';
2297             }
2298             $ratinghtml = $formstart.$ratinghtml;
2300             $scalearray = array(RATING_UNSET_RATING => $strrate.'...') + $rating->settings->scale->scaleitems;
2301             $scaleattrs = array('class'=>'postratingmenu ratinginput','id'=>'menurating'.$rating->itemid);
2302             $ratinghtml .= html_writer::label($rating->rating, 'menurating'.$rating->itemid, false, array('class' => 'accesshide'));
2303             $ratinghtml .= html_writer::select($scalearray, 'rating', $rating->rating, false, $scaleattrs);
2305             //output submit button
2306             $ratinghtml .= html_writer::start_tag('span', array('class'=>"ratingsubmit"));
2308             $attributes = array('type' => 'submit', 'class' => 'postratingmenusubmit', 'id' => 'postratingsubmit'.$rating->itemid, 'value' => s(get_string('rate', 'rating')));
2309             $ratinghtml .= html_writer::empty_tag('input', $attributes);
2311             if (!$rating->settings->scale->isnumeric) {
2312                 // If a global scale, try to find current course ID from the context
2313                 if (empty($rating->settings->scale->courseid) and $coursecontext = $rating->context->get_course_context(false)) {
2314                     $courseid = $coursecontext->instanceid;
2315                 } else {
2316                     $courseid = $rating->settings->scale->courseid;
2317                 }
2318                 $ratinghtml .= $this->help_icon_scale($courseid, $rating->settings->scale);
2319             }
2320             $ratinghtml .= html_writer::end_tag('span');
2321             $ratinghtml .= html_writer::end_tag('div');
2322             $ratinghtml .= html_writer::end_tag('form');
2323         }
2325         return $ratinghtml;
2326     }
2328     /**
2329      * Centered heading with attached help button (same title text)
2330      * and optional icon attached.
2331      *
2332      * @param string $text A heading text
2333      * @param string $helpidentifier The keyword that defines a help page
2334      * @param string $component component name
2335      * @param string|moodle_url $icon
2336      * @param string $iconalt icon alt text
2337      * @param int $level The level of importance of the heading. Defaulting to 2
2338      * @param string $classnames A space-separated list of CSS classes. Defaulting to null
2339      * @return string HTML fragment
2340      */
2341     public function heading_with_help($text, $helpidentifier, $component = 'moodle', $icon = '', $iconalt = '', $level = 2, $classnames = null) {
2342         $image = '';
2343         if ($icon) {
2344             $image = $this->pix_icon($icon, $iconalt, $component, array('class'=>'icon iconlarge'));
2345         }
2347         $help = '';
2348         if ($helpidentifier) {
2349             $help = $this->help_icon($helpidentifier, $component);
2350         }
2352         return $this->heading($image.$text.$help, $level, $classnames);
2353     }
2355     /**
2356      * Returns HTML to display a help icon.
2357      *
2358      * @deprecated since Moodle 2.0
2359      */
2360     public function old_help_icon($helpidentifier, $title, $component = 'moodle', $linktext = '') {
2361         throw new coding_exception('old_help_icon() can not be used any more, please see help_icon().');
2362     }
2364     /**
2365      * Returns HTML to display a help icon.
2366      *
2367      * Theme developers: DO NOT OVERRIDE! Please override function
2368      * {@link core_renderer::render_help_icon()} instead.
2369      *
2370      * @param string $identifier The keyword that defines a help page
2371      * @param string $component component name
2372      * @param string|bool $linktext true means use $title as link text, string means link text value
2373      * @return string HTML fragment
2374      */
2375     public function help_icon($identifier, $component = 'moodle', $linktext = '') {
2376         $icon = new help_icon($identifier, $component);
2377         $icon->diag_strings();
2378         if ($linktext === true) {
2379             $icon->linktext = get_string($icon->identifier, $icon->component);
2380         } else if (!empty($linktext)) {
2381             $icon->linktext = $linktext;
2382         }
2383         return $this->render($icon);
2384     }
2386     /**
2387      * Implementation of user image rendering.
2388      *
2389      * @param help_icon $helpicon A help icon instance
2390      * @return string HTML fragment
2391      */
2392     protected function render_help_icon(help_icon $helpicon) {
2393         return $this->render_from_template('core/help_icon', $helpicon->export_for_template($this));
2394     }
2396     /**
2397      * Returns HTML to display a scale help icon.
2398      *
2399      * @param int $courseid
2400      * @param stdClass $scale instance
2401      * @return string HTML fragment
2402      */
2403     public function help_icon_scale($courseid, stdClass $scale) {
2404         global $CFG;
2406         $title = get_string('helpprefix2', '', $scale->name) .' ('.get_string('newwindow').')';
2408         $icon = $this->pix_icon('help', get_string('scales'), 'moodle', array('class'=>'iconhelp'));
2410         $scaleid = abs($scale->id);
2412         $link = new moodle_url('/course/scales.php', array('id' => $courseid, 'list' => true, 'scaleid' => $scaleid));
2413         $action = new popup_action('click', $link, 'ratingscale');
2415         return html_writer::tag('span', $this->action_link($link, $icon, $action), array('class' => 'helplink'));
2416     }
2418     /**
2419      * Creates and returns a spacer image with optional line break.
2420      *
2421      * @param array $attributes Any HTML attributes to add to the spaced.
2422      * @param bool $br Include a BR after the spacer.... DON'T USE THIS. Don't be
2423      *     laxy do it with CSS which is a much better solution.
2424      * @return string HTML fragment
2425      */
2426     public function spacer(array $attributes = null, $br = false) {
2427         $attributes = (array)$attributes;
2428         if (empty($attributes['width'])) {
2429             $attributes['width'] = 1;
2430         }
2431         if (empty($attributes['height'])) {
2432             $attributes['height'] = 1;
2433         }
2434         $attributes['class'] = 'spacer';
2436         $output = $this->pix_icon('spacer', '', 'moodle', $attributes);
2438         if (!empty($br)) {
2439             $output .= '<br />';
2440         }
2442         return $output;
2443     }
2445     /**
2446      * Returns HTML to display the specified user's avatar.
2447      *
2448      * User avatar may be obtained in two ways:
2449      * <pre>
2450      * // Option 1: (shortcut for simple cases, preferred way)
2451      * // $user has come from the DB and has fields id, picture, imagealt, firstname and lastname
2452      * $OUTPUT->user_picture($user, array('popup'=>true));
2453      *
2454      * // Option 2:
2455      * $userpic = new user_picture($user);
2456      * // Set properties of $userpic
2457      * $userpic->popup = true;
2458      * $OUTPUT->render($userpic);
2459      * </pre>
2460      *
2461      * Theme developers: DO NOT OVERRIDE! Please override function
2462      * {@link core_renderer::render_user_picture()} instead.
2463      *
2464      * @param stdClass $user Object with at least fields id, picture, imagealt, firstname, lastname
2465      *     If any of these are missing, the database is queried. Avoid this
2466      *     if at all possible, particularly for reports. It is very bad for performance.
2467      * @param array $options associative array with user picture options, used only if not a user_picture object,
2468      *     options are:
2469      *     - courseid=$this->page->course->id (course id of user profile in link)
2470      *     - size=35 (size of image)
2471      *     - link=true (make image clickable - the link leads to user profile)
2472      *     - popup=false (open in popup)
2473      *     - alttext=true (add image alt attribute)
2474      *     - class = image class attribute (default 'userpicture')
2475      *     - visibletoscreenreaders=true (whether to be visible to screen readers)
2476      *     - includefullname=false (whether to include the user's full name together with the user picture)
2477      * @return string HTML fragment
2478      */
2479     public function user_picture(stdClass $user, array $options = null) {
2480         $userpicture = new user_picture($user);
2481         foreach ((array)$options as $key=>$value) {
2482             if (array_key_exists($key, $userpicture)) {
2483                 $userpicture->$key = $value;
2484             }
2485         }
2486         return $this->render($userpicture);
2487     }
2489     /**
2490      * Internal implementation of user image rendering.
2491      *
2492      * @param user_picture $userpicture
2493      * @return string
2494      */
2495     protected function render_user_picture(user_picture $userpicture) {
2496         global $CFG, $DB;
2498         $user = $userpicture->user;
2499         $canviewfullnames = has_capability('moodle/site:viewfullnames', context_system::instance());
2501         if ($userpicture->alttext) {
2502             if (!empty($user->imagealt)) {
2503                 $alt = $user->imagealt;
2504             } else {
2505                 $alt = get_string('pictureof', '', fullname($user, $canviewfullnames));
2506             }
2507         } else {
2508             $alt = '';
2509         }
2511         if (empty($userpicture->size)) {
2512             $size = 35;
2513         } else if ($userpicture->size === true or $userpicture->size == 1) {
2514             $size = 100;
2515         } else {
2516             $size = $userpicture->size;
2517         }
2519         $class = $userpicture->class;
2521         if ($user->picture == 0) {
2522             $class .= ' defaultuserpic';
2523         }
2525         $src = $userpicture->get_url($this->page, $this);
2527         $attributes = array('src'=>$src, 'alt'=>$alt, 'title'=>$alt, 'class'=>$class, 'width'=>$size, 'height'=>$size);
2528         if (!$userpicture->visibletoscreenreaders) {
2529             $attributes['role'] = 'presentation';
2530         }
2532         // get the image html output fisrt
2533         $output = html_writer::empty_tag('img', $attributes);
2535         // Show fullname together with the picture when desired.
2536         if ($userpicture->includefullname) {
2537             $output .= fullname($userpicture->user, $canviewfullnames);
2538         }
2540         // then wrap it in link if needed
2541         if (!$userpicture->link) {
2542             return $output;
2543         }
2545         if (empty($userpicture->courseid)) {
2546             $courseid = $this->page->course->id;
2547         } else {
2548             $courseid = $userpicture->courseid;
2549         }
2551         if ($courseid == SITEID) {
2552             $url = new moodle_url('/user/profile.php', array('id' => $user->id));
2553         } else {
2554             $url = new moodle_url('/user/view.php', array('id' => $user->id, 'course' => $courseid));
2555         }
2557         $attributes = array('href'=>$url);
2558         if (!$userpicture->visibletoscreenreaders) {
2559             $attributes['tabindex'] = '-1';
2560             $attributes['aria-hidden'] = 'true';
2561         }
2563         if ($userpicture->popup) {
2564             $id = html_writer::random_id('userpicture');
2565             $attributes['id'] = $id;
2566             $this->add_action_handler(new popup_action('click', $url), $id);
2567         }
2569         return html_writer::tag('a', $output, $attributes);
2570     }
2572     /**
2573      * Internal implementation of file tree viewer items rendering.
2574      *
2575      * @param array $dir
2576      * @return string
2577      */
2578     public function htmllize_file_tree($dir) {
2579         if (empty($dir['subdirs']) and empty($dir['files'])) {
2580             return '';
2581         }
2582         $result = '<ul>';
2583         foreach ($dir['subdirs'] as $subdir) {
2584             $result .= '<li>'.s($subdir['dirname']).' '.$this->htmllize_file_tree($subdir).'</li>';
2585         }
2586         foreach ($dir['files'] as $file) {
2587             $filename = $file->get_filename();
2588             $result .= '<li><span>'.html_writer::link($file->fileurl, $filename).'</span></li>';
2589         }
2590         $result .= '</ul>';
2592         return $result;
2593     }
2595     /**
2596      * Returns HTML to display the file picker
2597      *
2598      * <pre>
2599      * $OUTPUT->file_picker($options);
2600      * </pre>
2601      *
2602      * Theme developers: DO NOT OVERRIDE! Please override function
2603      * {@link core_renderer::render_file_picker()} instead.
2604      *
2605      * @param array $options associative array with file manager options
2606      *   options are:
2607      *       maxbytes=>-1,
2608      *       itemid=>0,
2609      *       client_id=>uniqid(),
2610      *       acepted_types=>'*',
2611      *       return_types=>FILE_INTERNAL,
2612      *       context=>$PAGE->context
2613      * @return string HTML fragment
2614      */
2615     public function file_picker($options) {
2616         $fp = new file_picker($options);
2617         return $this->render($fp);
2618     }
2620     /**
2621      * Internal implementation of file picker rendering.
2622      *
2623      * @param file_picker $fp
2624      * @return string
2625      */
2626     public function render_file_picker(file_picker $fp) {
2627         global $CFG, $OUTPUT, $USER;
2628         $options = $fp->options;
2629         $client_id = $options->client_id;
2630         $strsaved = get_string('filesaved', 'repository');
2631         $straddfile = get_string('openpicker', 'repository');
2632         $strloading  = get_string('loading', 'repository');
2633         $strdndenabled = get_string('dndenabled_inbox', 'moodle');
2634         $strdroptoupload = get_string('droptoupload', 'moodle');
2635         $icon_progress = $OUTPUT->pix_icon('i/loading_small', $strloading).'';
2637         $currentfile = $options->currentfile;
2638         if (empty($currentfile)) {
2639             $currentfile = '';
2640         } else {
2641             $currentfile .= ' - ';
2642         }
2643         if ($options->maxbytes) {
2644             $size = $options->maxbytes;
2645         } else {
2646             $size = get_max_upload_file_size();
2647         }
2648         if ($size == -1) {
2649             $maxsize = '';
2650         } else {
2651             $maxsize = get_string('maxfilesize', 'moodle', display_size($size));
2652         }
2653         if ($options->buttonname) {
2654             $buttonname = ' name="' . $options->buttonname . '"';
2655         } else {
2656             $buttonname = '';
2657         }
2658         $html = <<<EOD
2659 <div class="filemanager-loading mdl-align" id='filepicker-loading-{$client_id}'>
2660 $icon_progress
2661 </div>
2662 <div id="filepicker-wrapper-{$client_id}" class="mdl-left w-100" style="display:none">
2663     <div>
2664         <input type="button" class="btn btn-secondary fp-btn-choose" id="filepicker-button-{$client_id}" value="{$straddfile}"{$buttonname}/>
2665         <span> $maxsize </span>
2666     </div>
2667 EOD;
2668         if ($options->env != 'url') {
2669             $html .= <<<EOD
2670     <div id="file_info_{$client_id}" class="mdl-left filepicker-filelist" style="position: relative">
2671     <div class="filepicker-filename">
2672         <div class="filepicker-container">$currentfile<div class="dndupload-message">$strdndenabled <br/><div class="dndupload-arrow"></div></div></div>
2673         <div class="dndupload-progressbars"></div>
2674     </div>
2675     <div><div class="dndupload-target">{$strdroptoupload}<br/><div class="dndupload-arrow"></div></div></div>
2676     </div>
2677 EOD;
2678         }
2679         $html .= '</div>';
2680         return $html;
2681     }
2683     /**
2684      * @deprecated since Moodle 3.2
2685      */
2686     public function update_module_button() {
2687         throw new coding_exception('core_renderer::update_module_button() can not be used anymore. Activity ' .
2688             'modules should not add the edit module button, the link is already available in the Administration block. ' .
2689             'Themes can choose to display the link in the buttons row consistently for all module types.');
2690     }
2692     /**
2693      * Returns HTML to display a "Turn editing on/off" button in a form.
2694      *
2695      * @param moodle_url $url The URL + params to send through when clicking the button
2696      * @return string HTML the button
2697      */
2698     public function edit_button(moodle_url $url) {
2700         $url->param('sesskey', sesskey());
2701         if ($this->page->user_is_editing()) {
2702             $url->param('edit', 'off');
2703             $editstring = get_string('turneditingoff');
2704         } else {
2705             $url->param('edit', 'on');
2706             $editstring = get_string('turneditingon');
2707         }
2709         return $this->single_button($url, $editstring);
2710     }
2712     /**
2713      * Returns HTML to display a simple button to close a window
2714      *
2715      * @param string $text The lang string for the button's label (already output from get_string())
2716      * @return string html fragment
2717      */
2718     public function close_window_button($text='') {
2719         if (empty($text)) {
2720             $text = get_string('closewindow');
2721         }
2722         $button = new single_button(new moodle_url('#'), $text, 'get');
2723         $button->add_action(new component_action('click', 'close_window'));
2725         return $this->container($this->render($button), 'closewindow');
2726     }
2728     /**
2729      * Output an error message. By default wraps the error message in <span class="error">.
2730      * If the error message is blank, nothing is output.
2731      *
2732      * @param string $message the error message.
2733      * @return string the HTML to output.
2734      */
2735     public function error_text($message) {
2736         if (empty($message)) {
2737             return '';
2738         }
2739         $message = $this->pix_icon('i/warning', get_string('error'), '', array('class' => 'icon icon-pre', 'title'=>'')) . $message;
2740         return html_writer::tag('span', $message, array('class' => 'error'));
2741     }
2743     /**
2744      * Do not call this function directly.
2745      *
2746      * To terminate the current script with a fatal error, call the {@link print_error}
2747      * function, or throw an exception. Doing either of those things will then call this
2748      * function to display the error, before terminating the execution.
2749      *
2750      * @param string $message The message to output
2751      * @param string $moreinfourl URL where more info can be found about the error
2752      * @param string $link Link for the Continue button
2753      * @param array $backtrace The execution backtrace
2754      * @param string $debuginfo Debugging information
2755      * @return string the HTML to output.
2756      */
2757     public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null, $errorcode = "") {
2758         global $CFG;
2760         $output = '';
2761         $obbuffer = '';
2763         if ($this->has_started()) {
2764             // we can not always recover properly here, we have problems with output buffering,
2765             // html tables, etc.
2766             $output .= $this->opencontainers->pop_all_but_last();
2768         } else {
2769             // It is really bad if library code throws exception when output buffering is on,
2770             // because the buffered text would be printed before our start of page.
2771             // NOTE: this hack might be behave unexpectedly in case output buffering is enabled in PHP.ini
2772             error_reporting(0); // disable notices from gzip compression, etc.
2773             while (ob_get_level() > 0) {
2774                 $buff = ob_get_clean();
2775                 if ($buff === false) {
2776                     break;
2777                 }
2778                 $obbuffer .= $buff;
2779             }
2780             error_reporting($CFG->debug);
2782             // Output not yet started.
2783             $protocol = (isset($_SERVER['SERVER_PROTOCOL']) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0');
2784             if (empty($_SERVER['HTTP_RANGE'])) {
2785                 @header($protocol . ' 404 Not Found');
2786             } else if (core_useragent::check_safari_ios_version(602) && !empty($_SERVER['HTTP_X_PLAYBACK_SESSION_ID'])) {
2787                 // Coax iOS 10 into sending the session cookie.
2788                 @header($protocol . ' 403 Forbidden');
2789             } else {
2790                 // Must stop byteserving attempts somehow,
2791                 // this is weird but Chrome PDF viewer can be stopped only with 407!
2792                 @header($protocol . ' 407 Proxy Authentication Required');
2793             }
2795             $this->page->set_context(null); // ugly hack - make sure page context is set to something, we do not want bogus warnings here
2796             $this->page->set_url('/'); // no url
2797             //$this->page->set_pagelayout('base'); //TODO: MDL-20676 blocks on error pages are weird, unfortunately it somehow detect the pagelayout from URL :-(
2798             $this->page->set_title(get_string('error'));
2799             $this->page->set_heading($this->page->course->fullname);
2800             $output .= $this->header();
2801         }
2803         $message = '<p class="errormessage">' . $message . '</p>'.
2804                 '<p class="errorcode"><a href="' . $moreinfourl . '">' .
2805                 get_string('moreinformation') . '</a></p>';
2806         if (empty($CFG->rolesactive)) {
2807             $message .= '<p class="errormessage">' . get_string('installproblem', 'error') . '</p>';
2808             //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.
2809         }
2810         $output .= $this->box($message, 'errorbox alert alert-danger', null, array('data-rel' => 'fatalerror'));
2812         if ($CFG->debugdeveloper) {
2813             if (!empty($debuginfo)) {
2814                 $debuginfo = s($debuginfo); // removes all nasty JS
2815                 $debuginfo = str_replace("\n", '<br />', $debuginfo); // keep newlines
2816                 $output .= $this->notification('<strong>Debug info:</strong> '.$debuginfo, 'notifytiny');
2817             }
2818             if (!empty($backtrace)) {
2819                 $output .= $this->notification('<strong>Stack trace:</strong> '.format_backtrace($backtrace), 'notifytiny');
2820             }
2821             if ($obbuffer !== '' ) {
2822                 $output .= $this->notification('<strong>Output buffer:</strong> '.s($obbuffer), 'notifytiny');
2823             }
2824         }
2826         if (empty($CFG->rolesactive)) {
2827             // continue does not make much sense if moodle is not installed yet because error is most probably not recoverable
2828         } else if (!empty($link)) {
2829             $output .= $this->continue_button($link);
2830         }
2832         $output .= $this->footer();
2834         // Padding to encourage IE to display our error page, rather than its own.
2835         $output .= str_repeat(' ', 512);
2837         return $output;
2838     }
2840     /**
2841      * Output a notification (that is, a status message about something that has just happened).
2842      *
2843      * Note: \core\notification::add() may be more suitable for your usage.
2844      *
2845      * @param string $message The message to print out.
2846      * @param string $type    The type of notification. See constants on \core\output\notification.
2847      * @return string the HTML to output.
2848      */
2849     public function notification($message, $type = null) {
2850         $typemappings = [
2851             // Valid types.
2852             'success'           => \core\output\notification::NOTIFY_SUCCESS,
2853             'info'              => \core\output\notification::NOTIFY_INFO,
2854             'warning'           => \core\output\notification::NOTIFY_WARNING,
2855             'error'             => \core\output\notification::NOTIFY_ERROR,
2857             // Legacy types mapped to current types.
2858             'notifyproblem'     => \core\output\notification::NOTIFY_ERROR,
2859             'notifytiny'        => \core\output\notification::NOTIFY_ERROR,
2860             'notifyerror'       => \core\output\notification::NOTIFY_ERROR,
2861             'notifysuccess'     => \core\output\notification::NOTIFY_SUCCESS,
2862             'notifymessage'     => \core\output\notification::NOTIFY_INFO,
2863             'notifyredirect'    => \core\output\notification::NOTIFY_INFO,
2864             'redirectmessage'   => \core\output\notification::NOTIFY_INFO,
2865         ];
2867         $extraclasses = [];
2869         if ($type) {
2870             if (strpos($type, ' ') === false) {
2871                 // No spaces in the list of classes, therefore no need to loop over and determine the class.
2872                 if (isset($typemappings[$type])) {
2873                     $type = $typemappings[$type];
2874                 } else {
2875                     // The value provided did not match a known type. It must be an extra class.
2876                     $extraclasses = [$type];
2877                 }
2878             } else {
2879                 // Identify what type of notification this is.
2880                 $classarray = explode(' ', self::prepare_classes($type));
2882                 // Separate out the type of notification from the extra classes.
2883                 foreach ($classarray as $class) {
2884                     if (isset($typemappings[$class])) {
2885                         $type = $typemappings[$class];
2886                     } else {
2887                         $extraclasses[] = $class;
2888                     }
2889                 }
2890             }
2891         }
2893         $notification = new \core\output\notification($message, $type);
2894         if (count($extraclasses)) {
2895             $notification->set_extra_classes($extraclasses);
2896         }
2898         // Return the rendered template.
2899         return $this->render_from_template($notification->get_template_name(), $notification->export_for_template($this));
2900     }
2902     /**
2903      * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more.
2904      */
2905     public function notify_problem() {
2906         throw new coding_exception('core_renderer::notify_problem() can not be used any more, '.
2907             'please use \core\notification::add(), or \core\output\notification as required.');
2908     }
2910     /**
2911      * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more.
2912      */
2913     public function notify_success() {
2914         throw new coding_exception('core_renderer::notify_success() can not be used any more, '.
2915             'please use \core\notification::add(), or \core\output\notification as required.');
2916     }
2918     /**
2919      * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more.
2920      */
2921     public function notify_message() {
2922         throw new coding_exception('core_renderer::notify_message() can not be used any more, '.
2923             'please use \core\notification::add(), or \core\output\notification as required.');
2924     }
2926     /**
2927      * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more.
2928      */
2929     public function notify_redirect() {
2930         throw new coding_exception('core_renderer::notify_redirect() can not be used any more, '.
2931             'please use \core\notification::add(), or \core\output\notification as required.');
2932     }
2934     /**
2935      * Render a notification (that is, a status message about something that has
2936      * just happened).
2937      *
2938      * @param \core\output\notification $notification the notification to print out
2939      * @return string the HTML to output.
2940      */
2941     protected function render_notification(\core\output\notification $notification) {
2942         return $this->render_from_template($notification->get_template_name(), $notification->export_for_template($this));
2943     }
2945     /**
2946      * Returns HTML to display a continue button that goes to a particular URL.
2947      *
2948      * @param string|moodle_url $url The url the button goes to.
2949      * @return string the HTML to output.
2950      */
2951     public function continue_button($url) {
2952         if (!($url instanceof moodle_url)) {
2953             $url = new moodle_url($url);
2954         }
2955         $button = new single_button($url, get_string('continue'), 'get', true);
2956         $button->class = 'continuebutton';
2958         return $this->render($button);
2959     }
2961     /**
2962      * Returns HTML to display a single paging bar to provide access to other pages  (usually in a search)
2963      *
2964      * Theme developers: DO NOT OVERRIDE! Please override function
2965      * {@link core_renderer::render_paging_bar()} instead.
2966      *
2967      * @param int $totalcount The total number of entries available to be paged through
2968      * @param int $page The page you are currently viewing
2969      * @param int $perpage The number of entries that should be shown per page
2970      * @param string|moodle_url $baseurl url of the current page, the $pagevar parameter is added
2971      * @param string $pagevar name of page parameter that holds the page number
2972      * @return string the HTML to output.
2973      */
2974     public function paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar = 'page') {
2975         $pb = new paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar);
2976         return $this->render($pb);
2977     }
2979     /**
2980      * Internal implementation of paging bar rendering.
2981      *
2982      * @param paging_bar $pagingbar
2983      * @return string
2984      */
2985     protected function render_paging_bar(paging_bar $pagingbar) {
2986         $output = '';
2987         $pagingbar = clone($pagingbar);
2988         $pagingbar->prepare($this, $this->page, $this->target);
2990         if ($pagingbar->totalcount > $pagingbar->perpage) {
2991             $output .= get_string('page') . ':';
2993             if (!empty($pagingbar->previouslink)) {
2994                 $output .= ' (' . $pagingbar->previouslink . ') ';
2995             }
2997             if (!empty($pagingbar->firstlink)) {
2998                 $output .= ' ' . $pagingbar->firstlink . ' ...';
2999             }
3001             foreach ($pagingbar->pagelinks as $link) {
3002                 $output .= "  $link";
3003             }
3005             if (!empty($pagingbar->lastlink)) {
3006                 $output .= ' ... ' . $pagingbar->lastlink . ' ';
3007             }
3009             if (!empty($pagingbar->nextlink)) {
3010                 $output .= '  (' . $pagingbar->nextlink . ')';
3011             }
3012         }
3014         return html_writer::tag('div', $output, array('class' => 'paging'));
3015     }
3017     /**
3018      * Returns HTML to display initials bar to provide access to other pages  (usually in a search)
3019      *
3020      * @param string $current the currently selected letter.
3021      * @param string $class class name to add to this initial bar.
3022      * @param string $title the name to put in front of this initial bar.
3023      * @param string $urlvar URL parameter name for this initial.
3024      * @param string $url URL object.
3025      * @param array $alpha of letters in the alphabet.
3026      * @return string the HTML to output.
3027      */
3028     public function initials_bar($current, $class, $title, $urlvar, $url, $alpha = null) {
3029         $ib = new initials_bar($current, $class, $title, $urlvar, $url, $alpha);
3030         return $this->render($ib);
3031     }
3033     /**
3034      * Internal implementation of initials bar rendering.
3035      *
3036      * @param initials_bar $initialsbar
3037      * @return string
3038      */
3039     protected function render_initials_bar(initials_bar $initialsbar) {
3040         return $this->render_from_template('core/initials_bar', $initialsbar->export_for_template($this));
3041     }
3043     /**
3044      * Output the place a skip link goes to.
3045      *
3046      * @param string $id The target name from the corresponding $PAGE->requires->skip_link_to($target) call.
3047      * @return string the HTML to output.
3048      */
3049     public function skip_link_target($id = null) {
3050         return html_writer::span('', '', array('id' => $id));
3051     }
3053     /**
3054      * Outputs a heading
3055      *
3056      * @param string $text The text of the heading
3057      * @param int $level The level of importance of the heading. Defaulting to 2
3058      * @param string $classes A space-separated list of CSS classes. Defaulting to null
3059      * @param string $id An optional ID
3060      * @return string the HTML to output.
3061      */
3062     public function heading($text, $level = 2, $classes = null, $id = null) {
3063         $level = (integer) $level;
3064         if ($level < 1 or $level > 6) {
3065             throw new coding_exception('Heading level must be an integer between 1 and 6.');
3066         }
3067         return html_writer::tag('h' . $level, $text, array('id' => $id, 'class' => renderer_base::prepare_classes($classes)));
3068     }
3070     /**
3071      * Outputs a box.
3072      *
3073      * @param string $contents The contents of the box
3074      * @param string $classes A space-separated list of CSS classes
3075      * @param string $id An optional ID
3076      * @param array $attributes An array of other attributes to give the box.
3077      * @return string the HTML to output.
3078      */
3079     public function box($contents, $classes = 'generalbox', $id = null, $attributes = array()) {
3080         return $this->box_start($classes, $id, $attributes) . $contents . $this->box_end();
3081     }
3083     /**
3084      * Outputs the opening section of a box.
3085      *
3086      * @param string $classes A space-separated list of CSS classes
3087      * @param string $id An optional ID
3088      * @param array $attributes An array of other attributes to give the box.
3089      * @return string the HTML to output.
3090      */
3091     public function box_start($classes = 'generalbox', $id = null, $attributes = array()) {
3092         $this->opencontainers->push('box', html_writer::end_tag('div'));
3093         $attributes['id'] = $id;
3094         $attributes['class'] = 'box ' . renderer_base::prepare_classes($classes);
3095         return html_writer::start_tag('div', $attributes);
3096     }
3098     /**
3099      * Outputs the closing section of a box.
3100      *
3101      * @return string the HTML to output.
3102      */
3103     public function box_end() {
3104         return $this->opencontainers->pop('box');
3105     }
3107     /**
3108      * Outputs a container.
3109      *
3110      * @param string $contents The contents of the box
3111      * @param string $classes A space-separated list of CSS classes
3112      * @param string $id An optional ID
3113      * @return string the HTML to output.
3114      */
3115     public function container($contents, $classes = null, $id = null) {
3116         return $this->container_start($classes, $id) . $contents . $this->container_end();
3117     }
3119     /**
3120      * Outputs the opening section of a container.
3121      *
3122      * @param string $classes A space-separated list of CSS classes
3123      * @param string $id An optional ID
3124      * @return string the HTML to output.
3125      */
3126     public function container_start($classes = null, $id = null) {
3127         $this->opencontainers->push('container', html_writer::end_tag('div'));
3128         return html_writer::start_tag('div', array('id' => $id,
3129                 'class' => renderer_base::prepare_classes($classes)));
3130     }
3132     /**
3133      * Outputs the closing section of a container.
3134      *
3135      * @return string the HTML to output.
3136      */
3137     public function container_end() {
3138         return $this->opencontainers->pop('container');
3139     }
3141     /**
3142      * Make nested HTML lists out of the items
3143      *
3144      * The resulting list will look something like this:
3145      *
3146      * <pre>
3147      * <<ul>>
3148      * <<li>><div class='tree_item parent'>(item contents)</div>
3149      *      <<ul>
3150      *      <<li>><div class='tree_item'>(item contents)</div><</li>>
3151      *      <</ul>>
3152      * <</li>>
3153      * <</ul>>
3154      * </pre>
3155      *
3156      * @param array $items
3157      * @param array $attrs html attributes passed to the top ofs the list
3158      * @return string HTML
3159      */
3160     public function tree_block_contents($items, $attrs = array()) {
3161         // exit if empty, we don't want an empty ul element
3162         if (empty($items)) {
3163             return '';
3164         }
3165         // array of nested li elements
3166         $lis = array();
3167         foreach ($items as $item) {
3168             // this applies to the li item which contains all child lists too
3169             $content = $item->content($this);
3170             $liclasses = array($item->get_css_type());
3171             if (!$item->forceopen || (!$item->forceopen && $item->collapse) || ($item->children->count()==0  && $item->nodetype==navigation_node::NODETYPE_BRANCH)) {
3172                 $liclasses[] = 'collapsed';
3173             }
3174             if ($item->isactive === true) {
3175                 $liclasses[] = 'current_branch';
3176             }
3177             $liattr = array('class'=>join(' ',$liclasses));
3178             // class attribute on the div item which only contains the item content
3179             $divclasses = array('tree_item');
3180             if ($item->children->count()>0  || $item->nodetype==navigation_node::NODETYPE_BRANCH) {
3181                 $divclasses[] = 'branch';
3182             } else {
3183                 $divclasses[] = 'leaf';
3184             }
3185             if (!empty($item->classes) && count($item->classes)>0) {
3186                 $divclasses[] = join(' ', $item->classes);
3187             }
3188             $divattr = array('class'=>join(' ', $divclasses));
3189             if (!empty($item->id)) {
3190                 $divattr['id'] = $item->id;
3191             }
3192             $content = html_writer::tag('p', $content, $divattr) . $this->tree_block_contents($item->children);
3193             if (!empty($item->preceedwithhr) && $item->preceedwithhr===true) {
3194                 $content = html_writer::empty_tag('hr') . $content;
3195             }
3196             $content = html_writer::tag('li', $content, $liattr);
3197             $lis[] = $content;
3198         }
3199         return html_writer::tag('ul', implode("\n", $lis), $attrs);
3200     }
3202     /**
3203      * Returns a search box.
3204      *
3205      * @param  string $id     The search box wrapper div id, defaults to an autogenerated one.
3206      * @return string         HTML with the search form hidden by default.
3207      */
3208     public function search_box($id = false) {
3209         global $CFG;
3211         // Accessing $CFG directly as using \core_search::is_global_search_enabled would
3212         // result in an extra included file for each site, even the ones where global search
3213         // is disabled.
3214         if (empty($CFG->enableglobalsearch) || !has_capability('moodle/search:query', context_system::instance())) {
3215             return '';
3216         }
3218         if ($id == false) {
3219             $id = uniqid();
3220         } else {
3221             // Needs to be cleaned, we use it for the input id.
3222             $id = clean_param($id, PARAM_ALPHANUMEXT);
3223         }
3225         // JS to animate the form.
3226         $this->page->requires->js_call_amd('core/search-input', 'init', array($id));
3228         $searchicon = html_writer::tag('div', $this->pix_icon('a/search', get_string('search', 'search'), 'moodle'),
3229             array('role' => 'button', 'tabindex' => 0));
3230         $formattrs = array('class' => 'search-input-form', 'action' => $CFG->wwwroot . '/search/index.php');
3231         $inputattrs = array('type' => 'text', 'name' => 'q', 'placeholder' => get_string('search', 'search'),
3232             'size' => 13, 'tabindex' => -1, 'id' => 'id_q_' . $id, 'class' => 'form-control');
3234         $contents = html_writer::tag('label', get_string('enteryoursearchquery', 'search'),
3235             array('for' => 'id_q_' . $id, 'class' => 'accesshide')) . html_writer::tag('input', '', $inputattrs);
3236         if ($this->page->context && $this->page->context->contextlevel !== CONTEXT_SYSTEM) {
3237             $contents .= html_writer::empty_tag('input', ['type' => 'hidden',
3238                     'name' => 'context', 'value' => $this->page->context->id]);
3239         }
3240         $searchinput = html_writer::tag('form', $contents, $formattrs);
3242         return html_writer::tag('div', $searchicon . $searchinput, array('class' => 'search-input-wrapper nav-link', 'id' => $id));
3243     }
3245     /**
3246      * Allow plugins to provide some content to be rendered in the navbar.
3247      * The plugin must define a PLUGIN_render_navbar_output function that returns
3248      * the HTML they wish to add to the navbar.
3249      *
3250      * @return string HTML for the navbar
3251      */
3252     public function navbar_plugin_output() {
3253         $output = '';
3255         if ($pluginsfunction = get_plugins_with_function('render_navbar_output')) {
3256             foreach ($pluginsfunction as $plugintype => $plugins) {
3257                 foreach ($plugins as $pluginfunction) {
3258                     $output .= $pluginfunction($this);
3259                 }
3260             }
3261         }
3263         return $output;
3264     }
3266     /**
3267      * Construct a user menu, returning HTML that can be echoed out by a
3268      * layout file.
3269      *
3270      * @param stdClass $user A user object, usually $USER.
3271      * @param bool $withlinks true if a dropdown should be built.
3272      * @return string HTML fragment.
3273      */
3274     public function user_menu($user = null, $withlinks = null) {
3275         global $USER, $CFG;
3276         require_once($CFG->dirroot . '/user/lib.php');
3278         if (is_null($user)) {
3279             $user = $USER;
3280         }
3282         // Note: this behaviour is intended to match that of core_renderer::login_info,
3283         // but should not be considered to be good practice; layout options are
3284         // intended to be theme-specific. Please don't copy this snippet anywhere else.
3285         if (is_null($withlinks)) {
3286             $withlinks = empty($this->page->layout_options['nologinlinks']);
3287         }
3289         // Add a class for when $withlinks is false.
3290         $usermenuclasses = 'usermenu';
3291         if (!$withlinks) {
3292             $usermenuclasses .= ' withoutlinks';
3293         }
3295         $returnstr = "";
3297         // If during initial install, return the empty return string.
3298         if (during_initial_install()) {
3299             return $returnstr;
3300         }
3302         $loginpage = $this->is_login_page();
3303         $loginurl = get_login_url();
3304         // If not logged in, show the typical not-logged-in string.
3305         if (!isloggedin()) {
3306             $returnstr = get_string('loggedinnot', 'moodle');
3307             if (!$loginpage) {
3308                 $returnstr .= " (<a href=\"$loginurl\">" . get_string('login') . '</a>)';
3309             }
3310             return html_writer::div(
3311                 html_writer::span(
3312                     $returnstr,
3313                     'login'
3314                 ),
3315                 $usermenuclasses
3316             );
3318         }
3320         // If logged in as a guest user, show a string to that effect.
3321         if (isguestuser()) {
3322             $returnstr = get_string('loggedinasguest');
3323             if (!$loginpage && $withlinks) {
3324                 $returnstr .= " (<a href=\"$loginurl\">".get_string('login').'</a>)';
3325             }
3327             return html_writer::div(
3328                 html_writer::span(
3329                     $returnstr,
3330                     'login'
3331                 ),
3332                 $usermenuclasses
3333             );
3334         }
3336         // Get some navigation opts.
3337         $opts = user_get_user_navigation_info($user, $this->page);
3339         $avatarclasses = "avatars";
3340         $avatarcontents = html_writer::span($opts->metadata['useravatar'], 'avatar current');
3341         $usertextcontents = $opts->metadata['userfullname'];
3343         // Other user.
3344         if (!empty($opts->metadata['asotheruser'])) {
3345             $avatarcontents .= html_writer::span(
3346                 $opts->metadata['realuseravatar'],
3347                 'avatar realuser'
3348             );
3349             $usertextcontents = $opts->metadata['realuserfullname'];
3350             $usertextcontents .= html_writer::tag(
3351                 'span',
3352                 get_string(
3353                     'loggedinas',
3354                     'moodle',
3355                     html_writer::span(
3356                         $opts->metadata['userfullname'],
3357                         'value'
3358                     )
3359                 ),
3360                 array('class' => 'meta viewingas')
3361             );
3362         }
3364         // Role.
3365         if (!empty($opts->metadata['asotherrole'])) {
3366             $role = core_text::strtolower(preg_replace('#[ ]+#', '-', trim($opts->metadata['rolename'])));
3367             $usertextcontents .= html_writer::span(
3368                 $opts->metadata['rolename'],
3369                 'meta role role-' . $role
3370             );
3371         }
3373         // User login failures.
3374         if (!empty($opts->metadata['userloginfail'])) {
3375             $usertextcontents .= html_writer::span(
3376                 $opts->metadata['userloginfail'],
3377                 'meta loginfailures'
3378             );
3379         }
3381         // MNet.
3382         if (!empty($opts->metadata['asmnetuser'])) {
3383             $mne