weekly release 3.4dev
[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             $themename = $this->page->theme->name;
85             $themerev = theme_get_revision();
87             $cachedir = make_localcache_directory("mustache/$themerev/$themename");
89             $loader = new \core\output\mustache_filesystem_loader();
90             $stringhelper = new \core\output\mustache_string_helper();
91             $quotehelper = new \core\output\mustache_quote_helper();
92             $jshelper = new \core\output\mustache_javascript_helper($this->page->requires);
93             $pixhelper = new \core\output\mustache_pix_helper($this);
94             $shortentexthelper = new \core\output\mustache_shorten_text_helper();
95             $userdatehelper = new \core\output\mustache_user_date_helper();
97             // We only expose the variables that are exposed to JS templates.
98             $safeconfig = $this->page->requires->get_config_for_javascript($this->page, $this);
100             $helpers = array('config' => $safeconfig,
101                              'str' => array($stringhelper, 'str'),
102                              'quote' => array($quotehelper, 'quote'),
103                              'js' => array($jshelper, 'help'),
104                              'pix' => array($pixhelper, 'pix'),
105                              'shortentext' => array($shortentexthelper, 'shorten'),
106                              'userdate' => array($userdatehelper, 'transform'),
107                          );
109             $this->mustache = new Mustache_Engine(array(
110                 'cache' => $cachedir,
111                 'escape' => 's',
112                 'loader' => $loader,
113                 'helpers' => $helpers,
114                 'pragmas' => [Mustache_Engine::PRAGMA_BLOCKS]));
116         }
118         return $this->mustache;
119     }
122     /**
123      * Constructor
124      *
125      * The constructor takes two arguments. The first is the page that the renderer
126      * has been created to assist with, and the second is the target.
127      * The target is an additional identifier that can be used to load different
128      * renderers for different options.
129      *
130      * @param moodle_page $page the page we are doing output for.
131      * @param string $target one of rendering target constants
132      */
133     public function __construct(moodle_page $page, $target) {
134         $this->opencontainers = $page->opencontainers;
135         $this->page = $page;
136         $this->target = $target;
137     }
139     /**
140      * Renders a template by name with the given context.
141      *
142      * The provided data needs to be array/stdClass made up of only simple types.
143      * Simple types are array,stdClass,bool,int,float,string
144      *
145      * @since 2.9
146      * @param array|stdClass $context Context containing data for the template.
147      * @return string|boolean
148      */
149     public function render_from_template($templatename, $context) {
150         static $templatecache = array();
151         $mustache = $this->get_mustache();
153         try {
154             // Grab a copy of the existing helper to be restored later.
155             $uniqidhelper = $mustache->getHelper('uniqid');
156         } catch (Mustache_Exception_UnknownHelperException $e) {
157             // Helper doesn't exist.
158             $uniqidhelper = null;
159         }
161         // Provide 1 random value that will not change within a template
162         // but will be different from template to template. This is useful for
163         // e.g. aria attributes that only work with id attributes and must be
164         // unique in a page.
165         $mustache->addHelper('uniqid', new \core\output\mustache_uniqid_helper());
166         if (isset($templatecache[$templatename])) {
167             $template = $templatecache[$templatename];
168         } else {
169             try {
170                 $template = $mustache->loadTemplate($templatename);
171                 $templatecache[$templatename] = $template;
172             } catch (Mustache_Exception_UnknownTemplateException $e) {
173                 throw new moodle_exception('Unknown template: ' . $templatename);
174             }
175         }
177         $renderedtemplate = trim($template->render($context));
179         // If we had an existing uniqid helper then we need to restore it to allow
180         // handle nested calls of render_from_template.
181         if ($uniqidhelper) {
182             $mustache->addHelper('uniqid', $uniqidhelper);
183         }
185         return $renderedtemplate;
186     }
189     /**
190      * Returns rendered widget.
191      *
192      * The provided widget needs to be an object that extends the renderable
193      * interface.
194      * If will then be rendered by a method based upon the classname for the widget.
195      * For instance a widget of class `crazywidget` will be rendered by a protected
196      * render_crazywidget method of this renderer.
197      *
198      * @param renderable $widget instance with renderable interface
199      * @return string
200      */
201     public function render(renderable $widget) {
202         $classname = get_class($widget);
203         // Strip namespaces.
204         $classname = preg_replace('/^.*\\\/', '', $classname);
205         // Remove _renderable suffixes
206         $classname = preg_replace('/_renderable$/', '', $classname);
208         $rendermethod = 'render_'.$classname;
209         if (method_exists($this, $rendermethod)) {
210             return $this->$rendermethod($widget);
211         }
212         throw new coding_exception('Can not render widget, renderer method ('.$rendermethod.') not found.');
213     }
215     /**
216      * Adds a JS action for the element with the provided id.
217      *
218      * This method adds a JS event for the provided component action to the page
219      * and then returns the id that the event has been attached to.
220      * If no id has been provided then a new ID is generated by {@link html_writer::random_id()}
221      *
222      * @param component_action $action
223      * @param string $id
224      * @return string id of element, either original submitted or random new if not supplied
225      */
226     public function add_action_handler(component_action $action, $id = null) {
227         if (!$id) {
228             $id = html_writer::random_id($action->event);
229         }
230         $this->page->requires->event_handler("#$id", $action->event, $action->jsfunction, $action->jsfunctionargs);
231         return $id;
232     }
234     /**
235      * Returns true is output has already started, and false if not.
236      *
237      * @return boolean true if the header has been printed.
238      */
239     public function has_started() {
240         return $this->page->state >= moodle_page::STATE_IN_BODY;
241     }
243     /**
244      * Given an array or space-separated list of classes, prepares and returns the HTML class attribute value
245      *
246      * @param mixed $classes Space-separated string or array of classes
247      * @return string HTML class attribute value
248      */
249     public static function prepare_classes($classes) {
250         if (is_array($classes)) {
251             return implode(' ', array_unique($classes));
252         }
253         return $classes;
254     }
256     /**
257      * Return the direct URL for an image from the pix folder.
258      *
259      * Use this function sparingly and never for icons. For icons use pix_icon or the pix helper in a mustache template.
260      *
261      * @deprecated since Moodle 3.3
262      * @param string $imagename the name of the icon.
263      * @param string $component specification of one plugin like in get_string()
264      * @return moodle_url
265      */
266     public function pix_url($imagename, $component = 'moodle') {
267         debugging('pix_url is deprecated. Use image_url for images and pix_icon for icons.', DEBUG_DEVELOPER);
268         return $this->page->theme->image_url($imagename, $component);
269     }
271     /**
272      * Return the moodle_url for an image.
273      *
274      * The exact image location and extension is determined
275      * automatically by searching for gif|png|jpg|jpeg, please
276      * note there can not be diferent images with the different
277      * extension. The imagename is for historical reasons
278      * a relative path name, it may be changed later for core
279      * images. It is recommended to not use subdirectories
280      * in plugin and theme pix directories.
281      *
282      * There are three types of images:
283      * 1/ theme images  - stored in theme/mytheme/pix/,
284      *                    use component 'theme'
285      * 2/ core images   - stored in /pix/,
286      *                    overridden via theme/mytheme/pix_core/
287      * 3/ plugin images - stored in mod/mymodule/pix,
288      *                    overridden via theme/mytheme/pix_plugins/mod/mymodule/,
289      *                    example: image_url('comment', 'mod_glossary')
290      *
291      * @param string $imagename the pathname of the image
292      * @param string $component full plugin name (aka component) or 'theme'
293      * @return moodle_url
294      */
295     public function image_url($imagename, $component = 'moodle') {
296         return $this->page->theme->image_url($imagename, $component);
297     }
299     /**
300      * Return the site's logo URL, if any.
301      *
302      * @param int $maxwidth The maximum width, or null when the maximum width does not matter.
303      * @param int $maxheight The maximum height, or null when the maximum height does not matter.
304      * @return moodle_url|false
305      */
306     public function get_logo_url($maxwidth = null, $maxheight = 200) {
307         global $CFG;
308         $logo = get_config('core_admin', 'logo');
309         if (empty($logo)) {
310             return false;
311         }
313         // 200px high is the default image size which should be displayed at 100px in the page to account for retina displays.
314         // It's not worth the overhead of detecting and serving 2 different images based on the device.
316         // Hide the requested size in the file path.
317         $filepath = ((int) $maxwidth . 'x' . (int) $maxheight) . '/';
319         // Use $CFG->themerev to prevent browser caching when the file changes.
320         return moodle_url::make_pluginfile_url(context_system::instance()->id, 'core_admin', 'logo', $filepath,
321             theme_get_revision(), $logo);
322     }
324     /**
325      * Return the site's compact 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_compact_logo_url($maxwidth = 100, $maxheight = 100) {
332         global $CFG;
333         $logo = get_config('core_admin', 'logocompact');
334         if (empty($logo)) {
335             return false;
336         }
338         // Hide the requested size in the file path.
339         $filepath = ((int) $maxwidth . 'x' . (int) $maxheight) . '/';
341         // Use $CFG->themerev to prevent browser caching when the file changes.
342         return moodle_url::make_pluginfile_url(context_system::instance()->id, 'core_admin', 'logocompact', $filepath,
343             theme_get_revision(), $logo);
344     }
349 /**
350  * Basis for all plugin renderers.
351  *
352  * @copyright Petr Skoda (skodak)
353  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
354  * @since Moodle 2.0
355  * @package core
356  * @category output
357  */
358 class plugin_renderer_base extends renderer_base {
360     /**
361      * @var renderer_base|core_renderer A reference to the current renderer.
362      * The renderer provided here will be determined by the page but will in 90%
363      * of cases by the {@link core_renderer}
364      */
365     protected $output;
367     /**
368      * Constructor method, calls the parent constructor
369      *
370      * @param moodle_page $page
371      * @param string $target one of rendering target constants
372      */
373     public function __construct(moodle_page $page, $target) {
374         if (empty($target) && $page->pagelayout === 'maintenance') {
375             // If the page is using the maintenance layout then we're going to force the target to maintenance.
376             // This way we'll get a special maintenance renderer that is designed to block access to API's that are likely
377             // unavailable for this page layout.
378             $target = RENDERER_TARGET_MAINTENANCE;
379         }
380         $this->output = $page->get_renderer('core', null, $target);
381         parent::__construct($page, $target);
382     }
384     /**
385      * Renders the provided widget and returns the HTML to display it.
386      *
387      * @param renderable $widget instance with renderable interface
388      * @return string
389      */
390     public function render(renderable $widget) {
391         $classname = get_class($widget);
392         // Strip namespaces.
393         $classname = preg_replace('/^.*\\\/', '', $classname);
394         // Keep a copy at this point, we may need to look for a deprecated method.
395         $deprecatedmethod = 'render_'.$classname;
396         // Remove _renderable suffixes
397         $classname = preg_replace('/_renderable$/', '', $classname);
399         $rendermethod = 'render_'.$classname;
400         if (method_exists($this, $rendermethod)) {
401             return $this->$rendermethod($widget);
402         }
403         if ($rendermethod !== $deprecatedmethod && method_exists($this, $deprecatedmethod)) {
404             // This is exactly where we don't want to be.
405             // If you have arrived here you have a renderable component within your plugin that has the name
406             // blah_renderable, and you have a render method render_blah_renderable on your plugin.
407             // In 2.8 we revamped output, as part of this change we changed slightly how renderables got rendered
408             // and the _renderable suffix now gets removed when looking for a render method.
409             // You need to change your renderers render_blah_renderable to render_blah.
410             // Until you do this it will not be possible for a theme to override the renderer to override your method.
411             // Please do it ASAP.
412             static $debugged = array();
413             if (!isset($debugged[$deprecatedmethod])) {
414                 debugging(sprintf('Deprecated call. Please rename your renderables render method from %s to %s.',
415                     $deprecatedmethod, $rendermethod), DEBUG_DEVELOPER);
416                 $debugged[$deprecatedmethod] = true;
417             }
418             return $this->$deprecatedmethod($widget);
419         }
420         // pass to core renderer if method not found here
421         return $this->output->render($widget);
422     }
424     /**
425      * Magic method used to pass calls otherwise meant for the standard renderer
426      * to it to ensure we don't go causing unnecessary grief.
427      *
428      * @param string $method
429      * @param array $arguments
430      * @return mixed
431      */
432     public function __call($method, $arguments) {
433         if (method_exists('renderer_base', $method)) {
434             throw new coding_exception('Protected method called against '.get_class($this).' :: '.$method);
435         }
436         if (method_exists($this->output, $method)) {
437             return call_user_func_array(array($this->output, $method), $arguments);
438         } else {
439             throw new coding_exception('Unknown method called against '.get_class($this).' :: '.$method);
440         }
441     }
445 /**
446  * The standard implementation of the core_renderer interface.
447  *
448  * @copyright 2009 Tim Hunt
449  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
450  * @since Moodle 2.0
451  * @package core
452  * @category output
453  */
454 class core_renderer extends renderer_base {
455     /**
456      * Do NOT use, please use <?php echo $OUTPUT->main_content() ?>
457      * in layout files instead.
458      * @deprecated
459      * @var string used in {@link core_renderer::header()}.
460      */
461     const MAIN_CONTENT_TOKEN = '[MAIN CONTENT GOES HERE]';
463     /**
464      * @var string Used to pass information from {@link core_renderer::doctype()} to
465      * {@link core_renderer::standard_head_html()}.
466      */
467     protected $contenttype;
469     /**
470      * @var string Used by {@link core_renderer::redirect_message()} method to communicate
471      * with {@link core_renderer::header()}.
472      */
473     protected $metarefreshtag = '';
475     /**
476      * @var string Unique token for the closing HTML
477      */
478     protected $unique_end_html_token;
480     /**
481      * @var string Unique token for performance information
482      */
483     protected $unique_performance_info_token;
485     /**
486      * @var string Unique token for the main content.
487      */
488     protected $unique_main_content_token;
490     /**
491      * Constructor
492      *
493      * @param moodle_page $page the page we are doing output for.
494      * @param string $target one of rendering target constants
495      */
496     public function __construct(moodle_page $page, $target) {
497         $this->opencontainers = $page->opencontainers;
498         $this->page = $page;
499         $this->target = $target;
501         $this->unique_end_html_token = '%%ENDHTML-'.sesskey().'%%';
502         $this->unique_performance_info_token = '%%PERFORMANCEINFO-'.sesskey().'%%';
503         $this->unique_main_content_token = '[MAIN CONTENT GOES HERE - '.sesskey().']';
504     }
506     /**
507      * Get the DOCTYPE declaration that should be used with this page. Designed to
508      * be called in theme layout.php files.
509      *
510      * @return string the DOCTYPE declaration that should be used.
511      */
512     public function doctype() {
513         if ($this->page->theme->doctype === 'html5') {
514             $this->contenttype = 'text/html; charset=utf-8';
515             return "<!DOCTYPE html>\n";
517         } else if ($this->page->theme->doctype === 'xhtml5') {
518             $this->contenttype = 'application/xhtml+xml; charset=utf-8';
519             return "<!DOCTYPE html>\n";
521         } else {
522             // legacy xhtml 1.0
523             $this->contenttype = 'text/html; charset=utf-8';
524             return ('<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">' . "\n");
525         }
526     }
528     /**
529      * The attributes that should be added to the <html> tag. Designed to
530      * be called in theme layout.php files.
531      *
532      * @return string HTML fragment.
533      */
534     public function htmlattributes() {
535         $return = get_html_lang(true);
536         $attributes = array();
537         if ($this->page->theme->doctype !== 'html5') {
538             $attributes['xmlns'] = 'http://www.w3.org/1999/xhtml';
539         }
541         // Give plugins an opportunity to add things like xml namespaces to the html element.
542         // This function should return an array of html attribute names => values.
543         $pluginswithfunction = get_plugins_with_function('add_htmlattributes', 'lib.php');
544         foreach ($pluginswithfunction as $plugins) {
545             foreach ($plugins as $function) {
546                 $newattrs = $function();
547                 unset($newattrs['dir']);
548                 unset($newattrs['lang']);
549                 unset($newattrs['xmlns']);
550                 unset($newattrs['xml:lang']);
551                 $attributes += $newattrs;
552             }
553         }
555         foreach ($attributes as $key => $val) {
556             $val = s($val);
557             $return .= " $key=\"$val\"";
558         }
560         return $return;
561     }
563     /**
564      * The standard tags (meta tags, links to stylesheets and JavaScript, etc.)
565      * that should be included in the <head> tag. Designed to be called in theme
566      * layout.php files.
567      *
568      * @return string HTML fragment.
569      */
570     public function standard_head_html() {
571         global $CFG, $SESSION;
573         // Before we output any content, we need to ensure that certain
574         // page components are set up.
576         // Blocks must be set up early as they may require javascript which
577         // has to be included in the page header before output is created.
578         foreach ($this->page->blocks->get_regions() as $region) {
579             $this->page->blocks->ensure_content_created($region, $this);
580         }
582         $output = '';
584         // Give plugins an opportunity to add any head elements. The callback
585         // must always return a string containing valid html head content.
586         $pluginswithfunction = get_plugins_with_function('before_standard_html_head', 'lib.php');
587         foreach ($pluginswithfunction as $plugins) {
588             foreach ($plugins as $function) {
589                 $output .= $function();
590             }
591         }
593         // Allow a url_rewrite plugin to setup any dynamic head content.
594         if (isset($CFG->urlrewriteclass) && !isset($CFG->upgraderunning)) {
595             $class = $CFG->urlrewriteclass;
596             $output .= $class::html_head_setup();
597         }
599         $output .= '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />' . "\n";
600         $output .= '<meta name="keywords" content="moodle, ' . $this->page->title . '" />' . "\n";
601         // This is only set by the {@link redirect()} method
602         $output .= $this->metarefreshtag;
604         // Check if a periodic refresh delay has been set and make sure we arn't
605         // already meta refreshing
606         if ($this->metarefreshtag=='' && $this->page->periodicrefreshdelay!==null) {
607             $output .= '<meta http-equiv="refresh" content="'.$this->page->periodicrefreshdelay.';url='.$this->page->url->out().'" />';
608         }
610         // Set up help link popups for all links with the helptooltip class
611         $this->page->requires->js_init_call('M.util.help_popups.setup');
613         $focus = $this->page->focuscontrol;
614         if (!empty($focus)) {
615             if (preg_match("#forms\['([a-zA-Z0-9]+)'\].elements\['([a-zA-Z0-9]+)'\]#", $focus, $matches)) {
616                 // This is a horrifically bad way to handle focus but it is passed in
617                 // through messy formslib::moodleform
618                 $this->page->requires->js_function_call('old_onload_focus', array($matches[1], $matches[2]));
619             } else if (strpos($focus, '.')!==false) {
620                 // Old style of focus, bad way to do it
621                 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);
622                 $this->page->requires->js_function_call('old_onload_focus', explode('.', $focus, 2));
623             } else {
624                 // Focus element with given id
625                 $this->page->requires->js_function_call('focuscontrol', array($focus));
626             }
627         }
629         // Get the theme stylesheet - this has to be always first CSS, this loads also styles.css from all plugins;
630         // any other custom CSS can not be overridden via themes and is highly discouraged
631         $urls = $this->page->theme->css_urls($this->page);
632         foreach ($urls as $url) {
633             $this->page->requires->css_theme($url);
634         }
636         // Get the theme javascript head and footer
637         if ($jsurl = $this->page->theme->javascript_url(true)) {
638             $this->page->requires->js($jsurl, true);
639         }
640         if ($jsurl = $this->page->theme->javascript_url(false)) {
641             $this->page->requires->js($jsurl);
642         }
644         // Get any HTML from the page_requirements_manager.
645         $output .= $this->page->requires->get_head_code($this->page, $this);
647         // List alternate versions.
648         foreach ($this->page->alternateversions as $type => $alt) {
649             $output .= html_writer::empty_tag('link', array('rel' => 'alternate',
650                     'type' => $type, 'title' => $alt->title, 'href' => $alt->url));
651         }
653         // Add noindex tag if relevant page and setting applied.
654         $allowindexing = isset($CFG->allowindexing) ? $CFG->allowindexing : 0;
655         $loginpages = array('login-index', 'login-signup');
656         if ($allowindexing == 2 || ($allowindexing == 0 && in_array($this->page->pagetype, $loginpages))) {
657             if (!isset($CFG->additionalhtmlhead)) {
658                 $CFG->additionalhtmlhead = '';
659             }
660             $CFG->additionalhtmlhead .= '<meta name="robots" content="noindex" />';
661         }
663         if (!empty($CFG->additionalhtmlhead)) {
664             $output .= "\n".$CFG->additionalhtmlhead;
665         }
667         return $output;
668     }
670     /**
671      * The standard tags (typically skip links) that should be output just inside
672      * the start of the <body> tag. Designed to be called in theme layout.php files.
673      *
674      * @return string HTML fragment.
675      */
676     public function standard_top_of_body_html() {
677         global $CFG;
678         $output = $this->page->requires->get_top_of_body_code($this);
679         if ($this->page->pagelayout !== 'embedded' && !empty($CFG->additionalhtmltopofbody)) {
680             $output .= "\n".$CFG->additionalhtmltopofbody;
681         }
683         // Give plugins an opportunity to inject extra html content. The callback
684         // must always return a string containing valid html.
685         $pluginswithfunction = get_plugins_with_function('before_standard_top_of_body_html', 'lib.php');
686         foreach ($pluginswithfunction as $plugins) {
687             foreach ($plugins as $function) {
688                 $output .= $function();
689             }
690         }
692         $output .= $this->maintenance_warning();
694         return $output;
695     }
697     /**
698      * Scheduled maintenance warning message.
699      *
700      * Note: This is a nasty hack to display maintenance notice, this should be moved
701      *       to some general notification area once we have it.
702      *
703      * @return string
704      */
705     public function maintenance_warning() {
706         global $CFG;
708         $output = '';
709         if (isset($CFG->maintenance_later) and $CFG->maintenance_later > time()) {
710             $timeleft = $CFG->maintenance_later - time();
711             // If timeleft less than 30 sec, set the class on block to error to highlight.
712             $errorclass = ($timeleft < 30) ? 'alert-error alert-danger' : 'alert-warning';
713             $output .= $this->box_start($errorclass . ' moodle-has-zindex maintenancewarning m-a-1 alert');
714             $a = new stdClass();
715             $a->hour = (int)($timeleft / 3600);
716             $a->min = (int)(($timeleft / 60) % 60);
717             $a->sec = (int)($timeleft % 60);
718             if ($a->hour > 0) {
719                 $output .= get_string('maintenancemodeisscheduledlong', 'admin', $a);
720             } else {
721                 $output .= get_string('maintenancemodeisscheduled', 'admin', $a);
722             }
724             $output .= $this->box_end();
725             $this->page->requires->yui_module('moodle-core-maintenancemodetimer', 'M.core.maintenancemodetimer',
726                     array(array('timeleftinsec' => $timeleft)));
727             $this->page->requires->strings_for_js(
728                     array('maintenancemodeisscheduled', 'maintenancemodeisscheduledlong', 'sitemaintenance'),
729                     'admin');
730         }
731         return $output;
732     }
734     /**
735      * The standard tags (typically performance information and validation links,
736      * if we are in developer debug mode) that should be output in the footer area
737      * of the page. Designed to be called in theme layout.php files.
738      *
739      * @return string HTML fragment.
740      */
741     public function standard_footer_html() {
742         global $CFG, $SCRIPT;
744         if (during_initial_install()) {
745             // Debugging info can not work before install is finished,
746             // in any case we do not want any links during installation!
747             return '';
748         }
750         // This function is normally called from a layout.php file in {@link core_renderer::header()}
751         // but some of the content won't be known until later, so we return a placeholder
752         // for now. This will be replaced with the real content in {@link core_renderer::footer()}.
753         $output = $this->unique_performance_info_token;
754         if ($this->page->devicetypeinuse == 'legacy') {
755             // The legacy theme is in use print the notification
756             $output .= html_writer::tag('div', get_string('legacythemeinuse'), array('class'=>'legacythemeinuse'));
757         }
759         // Get links to switch device types (only shown for users not on a default device)
760         $output .= $this->theme_switch_links();
762         if (!empty($CFG->debugpageinfo)) {
763             $output .= '<div class="performanceinfo pageinfo">This page is: ' . $this->page->debug_summary() . '</div>';
764         }
765         if (debugging(null, DEBUG_DEVELOPER) and has_capability('moodle/site:config', context_system::instance())) {  // Only in developer mode
766             // Add link to profiling report if necessary
767             if (function_exists('profiling_is_running') && profiling_is_running()) {
768                 $txt = get_string('profiledscript', 'admin');
769                 $title = get_string('profiledscriptview', 'admin');
770                 $url = $CFG->wwwroot . '/admin/tool/profiling/index.php?script=' . urlencode($SCRIPT);
771                 $link= '<a title="' . $title . '" href="' . $url . '">' . $txt . '</a>';
772                 $output .= '<div class="profilingfooter">' . $link . '</div>';
773             }
774             $purgeurl = new moodle_url('/admin/purgecaches.php', array('confirm' => 1,
775                 'sesskey' => sesskey(), 'returnurl' => $this->page->url->out_as_local_url(false)));
776             $output .= '<div class="purgecaches">' .
777                     html_writer::link($purgeurl, get_string('purgecaches', 'admin')) . '</div>';
778         }
779         if (!empty($CFG->debugvalidators)) {
780             // 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
781             $output .= '<div class="validators"><ul class="list-unstyled m-l-1">
782               <li><a href="http://validator.w3.org/check?verbose=1&amp;ss=1&amp;uri=' . urlencode(qualified_me()) . '">Validate HTML</a></li>
783               <li><a href="http://www.contentquality.com/mynewtester/cynthia.exe?rptmode=-1&amp;url1=' . urlencode(qualified_me()) . '">Section 508 Check</a></li>
784               <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>
785             </ul></div>';
786         }
787         return $output;
788     }
790     /**
791      * Returns standard main content placeholder.
792      * Designed to be called in theme layout.php files.
793      *
794      * @return string HTML fragment.
795      */
796     public function main_content() {
797         // This is here because it is the only place we can inject the "main" role over the entire main content area
798         // without requiring all theme's to manually do it, and without creating yet another thing people need to
799         // remember in the theme.
800         // This is an unfortunate hack. DO NO EVER add anything more here.
801         // DO NOT add classes.
802         // DO NOT add an id.
803         return '<div role="main">'.$this->unique_main_content_token.'</div>';
804     }
806     /**
807      * The standard tags (typically script tags that are not needed earlier) that
808      * should be output after everything else. Designed to be called in theme layout.php files.
809      *
810      * @return string HTML fragment.
811      */
812     public function standard_end_of_body_html() {
813         global $CFG;
815         // This function is normally called from a layout.php file in {@link core_renderer::header()}
816         // but some of the content won't be known until later, so we return a placeholder
817         // for now. This will be replaced with the real content in {@link core_renderer::footer()}.
818         $output = '';
819         if ($this->page->pagelayout !== 'embedded' && !empty($CFG->additionalhtmlfooter)) {
820             $output .= "\n".$CFG->additionalhtmlfooter;
821         }
822         $output .= $this->unique_end_html_token;
823         return $output;
824     }
826     /**
827      * Return the standard string that says whether you are logged in (and switched
828      * roles/logged in as another user).
829      * @param bool $withlinks if false, then don't include any links in the HTML produced.
830      * If not set, the default is the nologinlinks option from the theme config.php file,
831      * and if that is not set, then links are included.
832      * @return string HTML fragment.
833      */
834     public function login_info($withlinks = null) {
835         global $USER, $CFG, $DB, $SESSION;
837         if (during_initial_install()) {
838             return '';
839         }
841         if (is_null($withlinks)) {
842             $withlinks = empty($this->page->layout_options['nologinlinks']);
843         }
845         $course = $this->page->course;
846         if (\core\session\manager::is_loggedinas()) {
847             $realuser = \core\session\manager::get_realuser();
848             $fullname = fullname($realuser, true);
849             if ($withlinks) {
850                 $loginastitle = get_string('loginas');
851                 $realuserinfo = " [<a href=\"$CFG->wwwroot/course/loginas.php?id=$course->id&amp;sesskey=".sesskey()."\"";
852                 $realuserinfo .= "title =\"".$loginastitle."\">$fullname</a>] ";
853             } else {
854                 $realuserinfo = " [$fullname] ";
855             }
856         } else {
857             $realuserinfo = '';
858         }
860         $loginpage = $this->is_login_page();
861         $loginurl = get_login_url();
863         if (empty($course->id)) {
864             // $course->id is not defined during installation
865             return '';
866         } else if (isloggedin()) {
867             $context = context_course::instance($course->id);
869             $fullname = fullname($USER, true);
870             // Since Moodle 2.0 this link always goes to the public profile page (not the course profile page)
871             if ($withlinks) {
872                 $linktitle = get_string('viewprofile');
873                 $username = "<a href=\"$CFG->wwwroot/user/profile.php?id=$USER->id\" title=\"$linktitle\">$fullname</a>";
874             } else {
875                 $username = $fullname;
876             }
877             if (is_mnet_remote_user($USER) and $idprovider = $DB->get_record('mnet_host', array('id'=>$USER->mnethostid))) {
878                 if ($withlinks) {
879                     $username .= " from <a href=\"{$idprovider->wwwroot}\">{$idprovider->name}</a>";
880                 } else {
881                     $username .= " from {$idprovider->name}";
882                 }
883             }
884             if (isguestuser()) {
885                 $loggedinas = $realuserinfo.get_string('loggedinasguest');
886                 if (!$loginpage && $withlinks) {
887                     $loggedinas .= " (<a href=\"$loginurl\">".get_string('login').'</a>)';
888                 }
889             } else if (is_role_switched($course->id)) { // Has switched roles
890                 $rolename = '';
891                 if ($role = $DB->get_record('role', array('id'=>$USER->access['rsw'][$context->path]))) {
892                     $rolename = ': '.role_get_name($role, $context);
893                 }
894                 $loggedinas = get_string('loggedinas', 'moodle', $username).$rolename;
895                 if ($withlinks) {
896                     $url = new moodle_url('/course/switchrole.php', array('id'=>$course->id,'sesskey'=>sesskey(), 'switchrole'=>0, 'returnurl'=>$this->page->url->out_as_local_url(false)));
897                     $loggedinas .= ' ('.html_writer::tag('a', get_string('switchrolereturn'), array('href' => $url)).')';
898                 }
899             } else {
900                 $loggedinas = $realuserinfo.get_string('loggedinas', 'moodle', $username);
901                 if ($withlinks) {
902                     $loggedinas .= " (<a href=\"$CFG->wwwroot/login/logout.php?sesskey=".sesskey()."\">".get_string('logout').'</a>)';
903                 }
904             }
905         } else {
906             $loggedinas = get_string('loggedinnot', 'moodle');
907             if (!$loginpage && $withlinks) {
908                 $loggedinas .= " (<a href=\"$loginurl\">".get_string('login').'</a>)';
909             }
910         }
912         $loggedinas = '<div class="logininfo">'.$loggedinas.'</div>';
914         if (isset($SESSION->justloggedin)) {
915             unset($SESSION->justloggedin);
916             if (!empty($CFG->displayloginfailures)) {
917                 if (!isguestuser()) {
918                     // Include this file only when required.
919                     require_once($CFG->dirroot . '/user/lib.php');
920                     if ($count = user_count_login_failures($USER)) {
921                         $loggedinas .= '<div class="loginfailures">';
922                         $a = new stdClass();
923                         $a->attempts = $count;
924                         $loggedinas .= get_string('failedloginattempts', '', $a);
925                         if (file_exists("$CFG->dirroot/report/log/index.php") and has_capability('report/log:view', context_system::instance())) {
926                             $loggedinas .= ' ('.html_writer::link(new moodle_url('/report/log/index.php', array('chooselog' => 1,
927                                     'id' => 0 , 'modid' => 'site_errors')), get_string('logs')).')';
928                         }
929                         $loggedinas .= '</div>';
930                     }
931                 }
932             }
933         }
935         return $loggedinas;
936     }
938     /**
939      * Check whether the current page is a login page.
940      *
941      * @since Moodle 2.9
942      * @return bool
943      */
944     protected function is_login_page() {
945         // This is a real bit of a hack, but its a rarety that we need to do something like this.
946         // In fact the login pages should be only these two pages and as exposing this as an option for all pages
947         // could lead to abuse (or at least unneedingly complex code) the hack is the way to go.
948         return in_array(
949             $this->page->url->out_as_local_url(false, array()),
950             array(
951                 '/login/index.php',
952                 '/login/forgot_password.php',
953             )
954         );
955     }
957     /**
958      * Return the 'back' link that normally appears in the footer.
959      *
960      * @return string HTML fragment.
961      */
962     public function home_link() {
963         global $CFG, $SITE;
965         if ($this->page->pagetype == 'site-index') {
966             // Special case for site home page - please do not remove
967             return '<div class="sitelink">' .
968                    '<a title="Moodle" href="http://moodle.org/">' .
969                    '<img src="' . $this->image_url('moodlelogo') . '" alt="'.get_string('moodlelogo').'" /></a></div>';
971         } else if (!empty($CFG->target_release) && $CFG->target_release != $CFG->release) {
972             // Special case for during install/upgrade.
973             return '<div class="sitelink">'.
974                    '<a title="Moodle" href="http://docs.moodle.org/en/Administrator_documentation" onclick="this.target=\'_blank\'">' .
975                    '<img src="' . $this->image_url('moodlelogo') . '" alt="'.get_string('moodlelogo').'" /></a></div>';
977         } else if ($this->page->course->id == $SITE->id || strpos($this->page->pagetype, 'course-view') === 0) {
978             return '<div class="homelink"><a href="' . $CFG->wwwroot . '/">' .
979                     get_string('home') . '</a></div>';
981         } else {
982             return '<div class="homelink"><a href="' . $CFG->wwwroot . '/course/view.php?id=' . $this->page->course->id . '">' .
983                     format_string($this->page->course->shortname, true, array('context' => $this->page->context)) . '</a></div>';
984         }
985     }
987     /**
988      * Redirects the user by any means possible given the current state
989      *
990      * This function should not be called directly, it should always be called using
991      * the redirect function in lib/weblib.php
992      *
993      * The redirect function should really only be called before page output has started
994      * however it will allow itself to be called during the state STATE_IN_BODY
995      *
996      * @param string $encodedurl The URL to send to encoded if required
997      * @param string $message The message to display to the user if any
998      * @param int $delay The delay before redirecting a user, if $message has been
999      *         set this is a requirement and defaults to 3, set to 0 no delay
1000      * @param boolean $debugdisableredirect this redirect has been disabled for
1001      *         debugging purposes. Display a message that explains, and don't
1002      *         trigger the redirect.
1003      * @param string $messagetype The type of notification to show the message in.
1004      *         See constants on \core\output\notification.
1005      * @return string The HTML to display to the user before dying, may contain
1006      *         meta refresh, javascript refresh, and may have set header redirects
1007      */
1008     public function redirect_message($encodedurl, $message, $delay, $debugdisableredirect,
1009                                      $messagetype = \core\output\notification::NOTIFY_INFO) {
1010         global $CFG;
1011         $url = str_replace('&amp;', '&', $encodedurl);
1013         switch ($this->page->state) {
1014             case moodle_page::STATE_BEFORE_HEADER :
1015                 // No output yet it is safe to delivery the full arsenal of redirect methods
1016                 if (!$debugdisableredirect) {
1017                     // Don't use exactly the same time here, it can cause problems when both redirects fire at the same time.
1018                     $this->metarefreshtag = '<meta http-equiv="refresh" content="'. $delay .'; url='. $encodedurl .'" />'."\n";
1019                     $this->page->requires->js_function_call('document.location.replace', array($url), false, ($delay + 3));
1020                 }
1021                 $output = $this->header();
1022                 break;
1023             case moodle_page::STATE_PRINTING_HEADER :
1024                 // We should hopefully never get here
1025                 throw new coding_exception('You cannot redirect while printing the page header');
1026                 break;
1027             case moodle_page::STATE_IN_BODY :
1028                 // We really shouldn't be here but we can deal with this
1029                 debugging("You should really redirect before you start page output");
1030                 if (!$debugdisableredirect) {
1031                     $this->page->requires->js_function_call('document.location.replace', array($url), false, $delay);
1032                 }
1033                 $output = $this->opencontainers->pop_all_but_last();
1034                 break;
1035             case moodle_page::STATE_DONE :
1036                 // Too late to be calling redirect now
1037                 throw new coding_exception('You cannot redirect after the entire page has been generated');
1038                 break;
1039         }
1040         $output .= $this->notification($message, $messagetype);
1041         $output .= '<div class="continuebutton">(<a href="'. $encodedurl .'">'. get_string('continue') .'</a>)</div>';
1042         if ($debugdisableredirect) {
1043             $output .= '<p><strong>'.get_string('erroroutput', 'error').'</strong></p>';
1044         }
1045         $output .= $this->footer();
1046         return $output;
1047     }
1049     /**
1050      * Start output by sending the HTTP headers, and printing the HTML <head>
1051      * and the start of the <body>.
1052      *
1053      * To control what is printed, you should set properties on $PAGE. If you
1054      * are familiar with the old {@link print_header()} function from Moodle 1.9
1055      * you will find that there are properties on $PAGE that correspond to most
1056      * of the old parameters to could be passed to print_header.
1057      *
1058      * Not that, in due course, the remaining $navigation, $menu parameters here
1059      * will be replaced by more properties of $PAGE, but that is still to do.
1060      *
1061      * @return string HTML that you must output this, preferably immediately.
1062      */
1063     public function header() {
1064         global $USER, $CFG, $SESSION;
1066         // Give plugins an opportunity touch things before the http headers are sent
1067         // such as adding additional headers. The return value is ignored.
1068         $pluginswithfunction = get_plugins_with_function('before_http_headers', 'lib.php');
1069         foreach ($pluginswithfunction as $plugins) {
1070             foreach ($plugins as $function) {
1071                 $function();
1072             }
1073         }
1075         if (\core\session\manager::is_loggedinas()) {
1076             $this->page->add_body_class('userloggedinas');
1077         }
1079         if (isset($SESSION->justloggedin) && !empty($CFG->displayloginfailures)) {
1080             require_once($CFG->dirroot . '/user/lib.php');
1081             // Set second parameter to false as we do not want reset the counter, the same message appears on footer.
1082             if ($count = user_count_login_failures($USER, false)) {
1083                 $this->page->add_body_class('loginfailures');
1084             }
1085         }
1087         // If the user is logged in, and we're not in initial install,
1088         // check to see if the user is role-switched and add the appropriate
1089         // CSS class to the body element.
1090         if (!during_initial_install() && isloggedin() && is_role_switched($this->page->course->id)) {
1091             $this->page->add_body_class('userswitchedrole');
1092         }
1094         // Give themes a chance to init/alter the page object.
1095         $this->page->theme->init_page($this->page);
1097         $this->page->set_state(moodle_page::STATE_PRINTING_HEADER);
1099         // Find the appropriate page layout file, based on $this->page->pagelayout.
1100         $layoutfile = $this->page->theme->layout_file($this->page->pagelayout);
1101         // Render the layout using the layout file.
1102         $rendered = $this->render_page_layout($layoutfile);
1104         // Slice the rendered output into header and footer.
1105         $cutpos = strpos($rendered, $this->unique_main_content_token);
1106         if ($cutpos === false) {
1107             $cutpos = strpos($rendered, self::MAIN_CONTENT_TOKEN);
1108             $token = self::MAIN_CONTENT_TOKEN;
1109         } else {
1110             $token = $this->unique_main_content_token;
1111         }
1113         if ($cutpos === false) {
1114             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.');
1115         }
1116         $header = substr($rendered, 0, $cutpos);
1117         $footer = substr($rendered, $cutpos + strlen($token));
1119         if (empty($this->contenttype)) {
1120             debugging('The page layout file did not call $OUTPUT->doctype()');
1121             $header = $this->doctype() . $header;
1122         }
1124         // If this theme version is below 2.4 release and this is a course view page
1125         if ((!isset($this->page->theme->settings->version) || $this->page->theme->settings->version < 2012101500) &&
1126                 $this->page->pagelayout === 'course' && $this->page->url->compare(new moodle_url('/course/view.php'), URL_MATCH_BASE)) {
1127             // check if course content header/footer have not been output during render of theme layout
1128             $coursecontentheader = $this->course_content_header(true);
1129             $coursecontentfooter = $this->course_content_footer(true);
1130             if (!empty($coursecontentheader)) {
1131                 // display debug message and add header and footer right above and below main content
1132                 // Please note that course header and footer (to be displayed above and below the whole page)
1133                 // are not displayed in this case at all.
1134                 // Besides the content header and footer are not displayed on any other course page
1135                 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);
1136                 $header .= $coursecontentheader;
1137                 $footer = $coursecontentfooter. $footer;
1138             }
1139         }
1141         send_headers($this->contenttype, $this->page->cacheable);
1143         $this->opencontainers->push('header/footer', $footer);
1144         $this->page->set_state(moodle_page::STATE_IN_BODY);
1146         return $header . $this->skip_link_target('maincontent');
1147     }
1149     /**
1150      * Renders and outputs the page layout file.
1151      *
1152      * This is done by preparing the normal globals available to a script, and
1153      * then including the layout file provided by the current theme for the
1154      * requested layout.
1155      *
1156      * @param string $layoutfile The name of the layout file
1157      * @return string HTML code
1158      */
1159     protected function render_page_layout($layoutfile) {
1160         global $CFG, $SITE, $USER;
1161         // The next lines are a bit tricky. The point is, here we are in a method
1162         // of a renderer class, and this object may, or may not, be the same as
1163         // the global $OUTPUT object. When rendering the page layout file, we want to use
1164         // this object. However, people writing Moodle code expect the current
1165         // renderer to be called $OUTPUT, not $this, so define a variable called
1166         // $OUTPUT pointing at $this. The same comment applies to $PAGE and $COURSE.
1167         $OUTPUT = $this;
1168         $PAGE = $this->page;
1169         $COURSE = $this->page->course;
1171         ob_start();
1172         include($layoutfile);
1173         $rendered = ob_get_contents();
1174         ob_end_clean();
1175         return $rendered;
1176     }
1178     /**
1179      * Outputs the page's footer
1180      *
1181      * @return string HTML fragment
1182      */
1183     public function footer() {
1184         global $CFG, $DB, $PAGE;
1186         // Give plugins an opportunity to touch the page before JS is finalized.
1187         $pluginswithfunction = get_plugins_with_function('before_footer', 'lib.php');
1188         foreach ($pluginswithfunction as $plugins) {
1189             foreach ($plugins as $function) {
1190                 $function();
1191             }
1192         }
1194         $output = $this->container_end_all(true);
1196         $footer = $this->opencontainers->pop('header/footer');
1198         if (debugging() and $DB and $DB->is_transaction_started()) {
1199             // TODO: MDL-20625 print warning - transaction will be rolled back
1200         }
1202         // Provide some performance info if required
1203         $performanceinfo = '';
1204         if (defined('MDL_PERF') || (!empty($CFG->perfdebug) and $CFG->perfdebug > 7)) {
1205             $perf = get_performance_info();
1206             if (defined('MDL_PERFTOFOOT') || debugging() || $CFG->perfdebug > 7) {
1207                 $performanceinfo = $perf['html'];
1208             }
1209         }
1211         // We always want performance data when running a performance test, even if the user is redirected to another page.
1212         if (MDL_PERF_TEST && strpos($footer, $this->unique_performance_info_token) === false) {
1213             $footer = $this->unique_performance_info_token . $footer;
1214         }
1215         $footer = str_replace($this->unique_performance_info_token, $performanceinfo, $footer);
1217         // Only show notifications when we have a $PAGE context id.
1218         if (!empty($PAGE->context->id)) {
1219             $this->page->requires->js_call_amd('core/notification', 'init', array(
1220                 $PAGE->context->id,
1221                 \core\notification::fetch_as_array($this)
1222             ));
1223         }
1224         $footer = str_replace($this->unique_end_html_token, $this->page->requires->get_end_code(), $footer);
1226         $this->page->set_state(moodle_page::STATE_DONE);
1228         return $output . $footer;
1229     }
1231     /**
1232      * Close all but the last open container. This is useful in places like error
1233      * handling, where you want to close all the open containers (apart from <body>)
1234      * before outputting the error message.
1235      *
1236      * @param bool $shouldbenone assert that the stack should be empty now - causes a
1237      *      developer debug warning if it isn't.
1238      * @return string the HTML required to close any open containers inside <body>.
1239      */
1240     public function container_end_all($shouldbenone = false) {
1241         return $this->opencontainers->pop_all_but_last($shouldbenone);
1242     }
1244     /**
1245      * Returns course-specific information to be output immediately above content on any course page
1246      * (for the current course)
1247      *
1248      * @param bool $onlyifnotcalledbefore output content only if it has not been output before
1249      * @return string
1250      */
1251     public function course_content_header($onlyifnotcalledbefore = false) {
1252         global $CFG;
1253         static $functioncalled = false;
1254         if ($functioncalled && $onlyifnotcalledbefore) {
1255             // we have already output the content header
1256             return '';
1257         }
1259         // Output any session notification.
1260         $notifications = \core\notification::fetch();
1262         $bodynotifications = '';
1263         foreach ($notifications as $notification) {
1264             $bodynotifications .= $this->render_from_template(
1265                     $notification->get_template_name(),
1266                     $notification->export_for_template($this)
1267                 );
1268         }
1270         $output = html_writer::span($bodynotifications, 'notifications', array('id' => 'user-notifications'));
1272         if ($this->page->course->id == SITEID) {
1273             // return immediately and do not include /course/lib.php if not necessary
1274             return $output;
1275         }
1277         require_once($CFG->dirroot.'/course/lib.php');
1278         $functioncalled = true;
1279         $courseformat = course_get_format($this->page->course);
1280         if (($obj = $courseformat->course_content_header()) !== null) {
1281             $output .= html_writer::div($courseformat->get_renderer($this->page)->render($obj), 'course-content-header');
1282         }
1283         return $output;
1284     }
1286     /**
1287      * Returns course-specific information to be output immediately below content on any course page
1288      * (for the current course)
1289      *
1290      * @param bool $onlyifnotcalledbefore output content only if it has not been output before
1291      * @return string
1292      */
1293     public function course_content_footer($onlyifnotcalledbefore = false) {
1294         global $CFG;
1295         if ($this->page->course->id == SITEID) {
1296             // return immediately and do not include /course/lib.php if not necessary
1297             return '';
1298         }
1299         static $functioncalled = false;
1300         if ($functioncalled && $onlyifnotcalledbefore) {
1301             // we have already output the content footer
1302             return '';
1303         }
1304         $functioncalled = true;
1305         require_once($CFG->dirroot.'/course/lib.php');
1306         $courseformat = course_get_format($this->page->course);
1307         if (($obj = $courseformat->course_content_footer()) !== null) {
1308             return html_writer::div($courseformat->get_renderer($this->page)->render($obj), 'course-content-footer');
1309         }
1310         return '';
1311     }
1313     /**
1314      * Returns course-specific information to be output on any course page in the header area
1315      * (for the current course)
1316      *
1317      * @return string
1318      */
1319     public function course_header() {
1320         global $CFG;
1321         if ($this->page->course->id == SITEID) {
1322             // return immediately and do not include /course/lib.php if not necessary
1323             return '';
1324         }
1325         require_once($CFG->dirroot.'/course/lib.php');
1326         $courseformat = course_get_format($this->page->course);
1327         if (($obj = $courseformat->course_header()) !== null) {
1328             return $courseformat->get_renderer($this->page)->render($obj);
1329         }
1330         return '';
1331     }
1333     /**
1334      * Returns course-specific information to be output on any course page in the footer area
1335      * (for the current course)
1336      *
1337      * @return string
1338      */
1339     public function course_footer() {
1340         global $CFG;
1341         if ($this->page->course->id == SITEID) {
1342             // return immediately and do not include /course/lib.php if not necessary
1343             return '';
1344         }
1345         require_once($CFG->dirroot.'/course/lib.php');
1346         $courseformat = course_get_format($this->page->course);
1347         if (($obj = $courseformat->course_footer()) !== null) {
1348             return $courseformat->get_renderer($this->page)->render($obj);
1349         }
1350         return '';
1351     }
1353     /**
1354      * Returns lang menu or '', this method also checks forcing of languages in courses.
1355      *
1356      * This function calls {@link core_renderer::render_single_select()} to actually display the language menu.
1357      *
1358      * @return string The lang menu HTML or empty string
1359      */
1360     public function lang_menu() {
1361         global $CFG;
1363         if (empty($CFG->langmenu)) {
1364             return '';
1365         }
1367         if ($this->page->course != SITEID and !empty($this->page->course->lang)) {
1368             // do not show lang menu if language forced
1369             return '';
1370         }
1372         $currlang = current_language();
1373         $langs = get_string_manager()->get_list_of_translations();
1375         if (count($langs) < 2) {
1376             return '';
1377         }
1379         $s = new single_select($this->page->url, 'lang', $langs, $currlang, null);
1380         $s->label = get_accesshide(get_string('language'));
1381         $s->class = 'langmenu';
1382         return $this->render($s);
1383     }
1385     /**
1386      * Output the row of editing icons for a block, as defined by the controls array.
1387      *
1388      * @param array $controls an array like {@link block_contents::$controls}.
1389      * @param string $blockid The ID given to the block.
1390      * @return string HTML fragment.
1391      */
1392     public function block_controls($actions, $blockid = null) {
1393         global $CFG;
1394         if (empty($actions)) {
1395             return '';
1396         }
1397         $menu = new action_menu($actions);
1398         if ($blockid !== null) {
1399             $menu->set_owner_selector('#'.$blockid);
1400         }
1401         $menu->set_constraint('.block-region');
1402         $menu->attributes['class'] .= ' block-control-actions commands';
1403         return $this->render($menu);
1404     }
1406     /**
1407      * Renders an action menu component.
1408      *
1409      * ARIA references:
1410      *   - http://www.w3.org/WAI/GL/wiki/Using_ARIA_menus
1411      *   - http://stackoverflow.com/questions/12279113/recommended-wai-aria-implementation-for-navigation-bar-menu
1412      *
1413      * @param action_menu $menu
1414      * @return string HTML
1415      */
1416     public function render_action_menu(action_menu $menu) {
1417         $context = $menu->export_for_template($this);
1418         return $this->render_from_template('core/action_menu', $context);
1419     }
1421     /**
1422      * Renders an action_menu_link item.
1423      *
1424      * @param action_menu_link $action
1425      * @return string HTML fragment
1426      */
1427     protected function render_action_menu_link(action_menu_link $action) {
1428         return $this->render_from_template('core/action_menu_link', $action->export_for_template($this));
1429     }
1431     /**
1432      * Renders a primary action_menu_filler item.
1433      *
1434      * @param action_menu_link_filler $action
1435      * @return string HTML fragment
1436      */
1437     protected function render_action_menu_filler(action_menu_filler $action) {
1438         return html_writer::span('&nbsp;', 'filler');
1439     }
1441     /**
1442      * Renders a primary action_menu_link item.
1443      *
1444      * @param action_menu_link_primary $action
1445      * @return string HTML fragment
1446      */
1447     protected function render_action_menu_link_primary(action_menu_link_primary $action) {
1448         return $this->render_action_menu_link($action);
1449     }
1451     /**
1452      * Renders a secondary action_menu_link item.
1453      *
1454      * @param action_menu_link_secondary $action
1455      * @return string HTML fragment
1456      */
1457     protected function render_action_menu_link_secondary(action_menu_link_secondary $action) {
1458         return $this->render_action_menu_link($action);
1459     }
1461     /**
1462      * Prints a nice side block with an optional header.
1463      *
1464      * The content is described
1465      * by a {@link core_renderer::block_contents} object.
1466      *
1467      * <div id="inst{$instanceid}" class="block_{$blockname} block">
1468      *      <div class="header"></div>
1469      *      <div class="content">
1470      *          ...CONTENT...
1471      *          <div class="footer">
1472      *          </div>
1473      *      </div>
1474      *      <div class="annotation">
1475      *      </div>
1476      * </div>
1477      *
1478      * @param block_contents $bc HTML for the content
1479      * @param string $region the region the block is appearing in.
1480      * @return string the HTML to be output.
1481      */
1482     public function block(block_contents $bc, $region) {
1483         $bc = clone($bc); // Avoid messing up the object passed in.
1484         if (empty($bc->blockinstanceid) || !strip_tags($bc->title)) {
1485             $bc->collapsible = block_contents::NOT_HIDEABLE;
1486         }
1487         if (!empty($bc->blockinstanceid)) {
1488             $bc->attributes['data-instanceid'] = $bc->blockinstanceid;
1489         }
1490         $skiptitle = strip_tags($bc->title);
1491         if ($bc->blockinstanceid && !empty($skiptitle)) {
1492             $bc->attributes['aria-labelledby'] = 'instance-'.$bc->blockinstanceid.'-header';
1493         } else if (!empty($bc->arialabel)) {
1494             $bc->attributes['aria-label'] = $bc->arialabel;
1495         }
1496         if ($bc->dockable) {
1497             $bc->attributes['data-dockable'] = 1;
1498         }
1499         if ($bc->collapsible == block_contents::HIDDEN) {
1500             $bc->add_class('hidden');
1501         }
1502         if (!empty($bc->controls)) {
1503             $bc->add_class('block_with_controls');
1504         }
1507         if (empty($skiptitle)) {
1508             $output = '';
1509             $skipdest = '';
1510         } else {
1511             $output = html_writer::link('#sb-'.$bc->skipid, get_string('skipa', 'access', $skiptitle),
1512                       array('class' => 'skip skip-block', 'id' => 'fsb-' . $bc->skipid));
1513             $skipdest = html_writer::span('', 'skip-block-to',
1514                       array('id' => 'sb-' . $bc->skipid));
1515         }
1517         $output .= html_writer::start_tag('div', $bc->attributes);
1519         $output .= $this->block_header($bc);
1520         $output .= $this->block_content($bc);
1522         $output .= html_writer::end_tag('div');
1524         $output .= $this->block_annotation($bc);
1526         $output .= $skipdest;
1528         $this->init_block_hider_js($bc);
1529         return $output;
1530     }
1532     /**
1533      * Produces a header for a block
1534      *
1535      * @param block_contents $bc
1536      * @return string
1537      */
1538     protected function block_header(block_contents $bc) {
1540         $title = '';
1541         if ($bc->title) {
1542             $attributes = array();
1543             if ($bc->blockinstanceid) {
1544                 $attributes['id'] = 'instance-'.$bc->blockinstanceid.'-header';
1545             }
1546             $title = html_writer::tag('h2', $bc->title, $attributes);
1547         }
1549         $blockid = null;
1550         if (isset($bc->attributes['id'])) {
1551             $blockid = $bc->attributes['id'];
1552         }
1553         $controlshtml = $this->block_controls($bc->controls, $blockid);
1555         $output = '';
1556         if ($title || $controlshtml) {
1557             $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'));
1558         }
1559         return $output;
1560     }
1562     /**
1563      * Produces the content area for a block
1564      *
1565      * @param block_contents $bc
1566      * @return string
1567      */
1568     protected function block_content(block_contents $bc) {
1569         $output = html_writer::start_tag('div', array('class' => 'content'));
1570         if (!$bc->title && !$this->block_controls($bc->controls)) {
1571             $output .= html_writer::tag('div', '', array('class'=>'block_action notitle'));
1572         }
1573         $output .= $bc->content;
1574         $output .= $this->block_footer($bc);
1575         $output .= html_writer::end_tag('div');
1577         return $output;
1578     }
1580     /**
1581      * Produces the footer for a block
1582      *
1583      * @param block_contents $bc
1584      * @return string
1585      */
1586     protected function block_footer(block_contents $bc) {
1587         $output = '';
1588         if ($bc->footer) {
1589             $output .= html_writer::tag('div', $bc->footer, array('class' => 'footer'));
1590         }
1591         return $output;
1592     }
1594     /**
1595      * Produces the annotation for a block
1596      *
1597      * @param block_contents $bc
1598      * @return string
1599      */
1600     protected function block_annotation(block_contents $bc) {
1601         $output = '';
1602         if ($bc->annotation) {
1603             $output .= html_writer::tag('div', $bc->annotation, array('class' => 'blockannotation'));
1604         }
1605         return $output;
1606     }
1608     /**
1609      * Calls the JS require function to hide a block.
1610      *
1611      * @param block_contents $bc A block_contents object
1612      */
1613     protected function init_block_hider_js(block_contents $bc) {
1614         if (!empty($bc->attributes['id']) and $bc->collapsible != block_contents::NOT_HIDEABLE) {
1615             $config = new stdClass;
1616             $config->id = $bc->attributes['id'];
1617             $config->title = strip_tags($bc->title);
1618             $config->preference = 'block' . $bc->blockinstanceid . 'hidden';
1619             $config->tooltipVisible = get_string('hideblocka', 'access', $config->title);
1620             $config->tooltipHidden = get_string('showblocka', 'access', $config->title);
1622             $this->page->requires->js_init_call('M.util.init_block_hider', array($config));
1623             user_preference_allow_ajax_update($config->preference, PARAM_BOOL);
1624         }
1625     }
1627     /**
1628      * Render the contents of a block_list.
1629      *
1630      * @param array $icons the icon for each item.
1631      * @param array $items the content of each item.
1632      * @return string HTML
1633      */
1634     public function list_block_contents($icons, $items) {
1635         $row = 0;
1636         $lis = array();
1637         foreach ($items as $key => $string) {
1638             $item = html_writer::start_tag('li', array('class' => 'r' . $row));
1639             if (!empty($icons[$key])) { //test if the content has an assigned icon
1640                 $item .= html_writer::tag('div', $icons[$key], array('class' => 'icon column c0'));
1641             }
1642             $item .= html_writer::tag('div', $string, array('class' => 'column c1'));
1643             $item .= html_writer::end_tag('li');
1644             $lis[] = $item;
1645             $row = 1 - $row; // Flip even/odd.
1646         }
1647         return html_writer::tag('ul', implode("\n", $lis), array('class' => 'unlist'));
1648     }
1650     /**
1651      * Output all the blocks in a particular region.
1652      *
1653      * @param string $region the name of a region on this page.
1654      * @return string the HTML to be output.
1655      */
1656     public function blocks_for_region($region) {
1657         $blockcontents = $this->page->blocks->get_content_for_region($region, $this);
1658         $blocks = $this->page->blocks->get_blocks_for_region($region);
1659         $lastblock = null;
1660         $zones = array();
1661         foreach ($blocks as $block) {
1662             $zones[] = $block->title;
1663         }
1664         $output = '';
1666         foreach ($blockcontents as $bc) {
1667             if ($bc instanceof block_contents) {
1668                 $output .= $this->block($bc, $region);
1669                 $lastblock = $bc->title;
1670             } else if ($bc instanceof block_move_target) {
1671                 $output .= $this->block_move_target($bc, $zones, $lastblock, $region);
1672             } else {
1673                 throw new coding_exception('Unexpected type of thing (' . get_class($bc) . ') found in list of block contents.');
1674             }
1675         }
1676         return $output;
1677     }
1679     /**
1680      * Output a place where the block that is currently being moved can be dropped.
1681      *
1682      * @param block_move_target $target with the necessary details.
1683      * @param array $zones array of areas where the block can be moved to
1684      * @param string $previous the block located before the area currently being rendered.
1685      * @param string $region the name of the region
1686      * @return string the HTML to be output.
1687      */
1688     public function block_move_target($target, $zones, $previous, $region) {
1689         if ($previous == null) {
1690             if (empty($zones)) {
1691                 // There are no zones, probably because there are no blocks.
1692                 $regions = $this->page->theme->get_all_block_regions();
1693                 $position = get_string('moveblockinregion', 'block', $regions[$region]);
1694             } else {
1695                 $position = get_string('moveblockbefore', 'block', $zones[0]);
1696             }
1697         } else {
1698             $position = get_string('moveblockafter', 'block', $previous);
1699         }
1700         return html_writer::tag('a', html_writer::tag('span', $position, array('class' => 'accesshide')), array('href' => $target->url, 'class' => 'blockmovetarget'));
1701     }
1703     /**
1704      * Renders a special html link with attached action
1705      *
1706      * Theme developers: DO NOT OVERRIDE! Please override function
1707      * {@link core_renderer::render_action_link()} instead.
1708      *
1709      * @param string|moodle_url $url
1710      * @param string $text HTML fragment
1711      * @param component_action $action
1712      * @param array $attributes associative array of html link attributes + disabled
1713      * @param pix_icon optional pix icon to render with the link
1714      * @return string HTML fragment
1715      */
1716     public function action_link($url, $text, component_action $action = null, array $attributes = null, $icon = null) {
1717         if (!($url instanceof moodle_url)) {
1718             $url = new moodle_url($url);
1719         }
1720         $link = new action_link($url, $text, $action, $attributes, $icon);
1722         return $this->render($link);
1723     }
1725     /**
1726      * Renders an action_link object.
1727      *
1728      * The provided link is renderer and the HTML returned. At the same time the
1729      * associated actions are setup in JS by {@link core_renderer::add_action_handler()}
1730      *
1731      * @param action_link $link
1732      * @return string HTML fragment
1733      */
1734     protected function render_action_link(action_link $link) {
1735         return $this->render_from_template('core/action_link', $link->export_for_template($this));
1736     }
1738     /**
1739      * Renders an action_icon.
1740      *
1741      * This function uses the {@link core_renderer::action_link()} method for the
1742      * most part. What it does different is prepare the icon as HTML and use it
1743      * as the link text.
1744      *
1745      * Theme developers: If you want to change how action links and/or icons are rendered,
1746      * consider overriding function {@link core_renderer::render_action_link()} and
1747      * {@link core_renderer::render_pix_icon()}.
1748      *
1749      * @param string|moodle_url $url A string URL or moodel_url
1750      * @param pix_icon $pixicon
1751      * @param component_action $action
1752      * @param array $attributes associative array of html link attributes + disabled
1753      * @param bool $linktext show title next to image in link
1754      * @return string HTML fragment
1755      */
1756     public function action_icon($url, pix_icon $pixicon, component_action $action = null, array $attributes = null, $linktext=false) {
1757         if (!($url instanceof moodle_url)) {
1758             $url = new moodle_url($url);
1759         }
1760         $attributes = (array)$attributes;
1762         if (empty($attributes['class'])) {
1763             // let ppl override the class via $options
1764             $attributes['class'] = 'action-icon';
1765         }
1767         $icon = $this->render($pixicon);
1769         if ($linktext) {
1770             $text = $pixicon->attributes['alt'];
1771         } else {
1772             $text = '';
1773         }
1775         return $this->action_link($url, $text.$icon, $action, $attributes);
1776     }
1778    /**
1779     * Print a message along with button choices for Continue/Cancel
1780     *
1781     * If a string or moodle_url is given instead of a single_button, method defaults to post.
1782     *
1783     * @param string $message The question to ask the user
1784     * @param single_button|moodle_url|string $continue The single_button component representing the Continue answer. Can also be a moodle_url or string URL
1785     * @param single_button|moodle_url|string $cancel The single_button component representing the Cancel answer. Can also be a moodle_url or string URL
1786     * @return string HTML fragment
1787     */
1788     public function confirm($message, $continue, $cancel) {
1789         if ($continue instanceof single_button) {
1790             // ok
1791             $continue->primary = true;
1792         } else if (is_string($continue)) {
1793             $continue = new single_button(new moodle_url($continue), get_string('continue'), 'post', true);
1794         } else if ($continue instanceof moodle_url) {
1795             $continue = new single_button($continue, get_string('continue'), 'post', true);
1796         } else {
1797             throw new coding_exception('The continue param to $OUTPUT->confirm() must be either a URL (string/moodle_url) or a single_button instance.');
1798         }
1800         if ($cancel instanceof single_button) {
1801             // ok
1802         } else if (is_string($cancel)) {
1803             $cancel = new single_button(new moodle_url($cancel), get_string('cancel'), 'get');
1804         } else if ($cancel instanceof moodle_url) {
1805             $cancel = new single_button($cancel, get_string('cancel'), 'get');
1806         } else {
1807             throw new coding_exception('The cancel param to $OUTPUT->confirm() must be either a URL (string/moodle_url) or a single_button instance.');
1808         }
1810         $output = $this->box_start('generalbox modal modal-dialog modal-in-page show', 'notice');
1811         $output .= $this->box_start('modal-content', 'modal-content');
1812         $output .= $this->box_start('modal-header', 'modal-header');
1813         $output .= html_writer::tag('h4', get_string('confirm'));
1814         $output .= $this->box_end();
1815         $output .= $this->box_start('modal-body', 'modal-body');
1816         $output .= html_writer::tag('p', $message);
1817         $output .= $this->box_end();
1818         $output .= $this->box_start('modal-footer', 'modal-footer');
1819         $output .= html_writer::tag('div', $this->render($continue) . $this->render($cancel), array('class' => 'buttons'));
1820         $output .= $this->box_end();
1821         $output .= $this->box_end();
1822         $output .= $this->box_end();
1823         return $output;
1824     }
1826     /**
1827      * Returns a form with a single button.
1828      *
1829      * Theme developers: DO NOT OVERRIDE! Please override function
1830      * {@link core_renderer::render_single_button()} instead.
1831      *
1832      * @param string|moodle_url $url
1833      * @param string $label button text
1834      * @param string $method get or post submit method
1835      * @param array $options associative array {disabled, title, etc.}
1836      * @return string HTML fragment
1837      */
1838     public function single_button($url, $label, $method='post', array $options=null) {
1839         if (!($url instanceof moodle_url)) {
1840             $url = new moodle_url($url);
1841         }
1842         $button = new single_button($url, $label, $method);
1844         foreach ((array)$options as $key=>$value) {
1845             if (array_key_exists($key, $button)) {
1846                 $button->$key = $value;
1847             }
1848         }
1850         return $this->render($button);
1851     }
1853     /**
1854      * Renders a single button widget.
1855      *
1856      * This will return HTML to display a form containing a single button.
1857      *
1858      * @param single_button $button
1859      * @return string HTML fragment
1860      */
1861     protected function render_single_button(single_button $button) {
1862         $attributes = array('type'     => 'submit',
1863                             'value'    => $button->label,
1864                             'disabled' => $button->disabled ? 'disabled' : null,
1865                             'title'    => $button->tooltip);
1867         if ($button->actions) {
1868             $id = html_writer::random_id('single_button');
1869             $attributes['id'] = $id;
1870             foreach ($button->actions as $action) {
1871                 $this->add_action_handler($action, $id);
1872             }
1873         }
1875         // first the input element
1876         $output = html_writer::empty_tag('input', $attributes);
1878         // then hidden fields
1879         $params = $button->url->params();
1880         if ($button->method === 'post') {
1881             $params['sesskey'] = sesskey();
1882         }
1883         foreach ($params as $var => $val) {
1884             $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => $var, 'value' => $val));
1885         }
1887         // then div wrapper for xhtml strictness
1888         $output = html_writer::tag('div', $output);
1890         // now the form itself around it
1891         if ($button->method === 'get') {
1892             $url = $button->url->out_omit_querystring(true); // url without params, the anchor part allowed
1893         } else {
1894             $url = $button->url->out_omit_querystring();     // url without params, the anchor part not allowed
1895         }
1896         if ($url === '') {
1897             $url = '#'; // there has to be always some action
1898         }
1899         $attributes = array('method' => $button->method,
1900                             'action' => $url,
1901                             'id'     => $button->formid);
1902         $output = html_writer::tag('form', $output, $attributes);
1904         // and finally one more wrapper with class
1905         return html_writer::tag('div', $output, array('class' => $button->class));
1906     }
1908     /**
1909      * Returns a form with a single select widget.
1910      *
1911      * Theme developers: DO NOT OVERRIDE! Please override function
1912      * {@link core_renderer::render_single_select()} instead.
1913      *
1914      * @param moodle_url $url form action target, includes hidden fields
1915      * @param string $name name of selection field - the changing parameter in url
1916      * @param array $options list of options
1917      * @param string $selected selected element
1918      * @param array $nothing
1919      * @param string $formid
1920      * @param array $attributes other attributes for the single select
1921      * @return string HTML fragment
1922      */
1923     public function single_select($url, $name, array $options, $selected = '',
1924                                 $nothing = array('' => 'choosedots'), $formid = null, $attributes = array()) {
1925         if (!($url instanceof moodle_url)) {
1926             $url = new moodle_url($url);
1927         }
1928         $select = new single_select($url, $name, $options, $selected, $nothing, $formid);
1930         if (array_key_exists('label', $attributes)) {
1931             $select->set_label($attributes['label']);
1932             unset($attributes['label']);
1933         }
1934         $select->attributes = $attributes;
1936         return $this->render($select);
1937     }
1939     /**
1940      * Returns a dataformat selection and download form
1941      *
1942      * @param string $label A text label
1943      * @param moodle_url|string $base The download page url
1944      * @param string $name The query param which will hold the type of the download
1945      * @param array $params Extra params sent to the download page
1946      * @return string HTML fragment
1947      */
1948     public function download_dataformat_selector($label, $base, $name = 'dataformat', $params = array()) {
1950         $formats = core_plugin_manager::instance()->get_plugins_of_type('dataformat');
1951         $options = array();
1952         foreach ($formats as $format) {
1953             if ($format->is_enabled()) {
1954                 $options[] = array(
1955                     'value' => $format->name,
1956                     'label' => get_string('dataformat', $format->component),
1957                 );
1958             }
1959         }
1960         $hiddenparams = array();
1961         foreach ($params as $key => $value) {
1962             $hiddenparams[] = array(
1963                 'name' => $key,
1964                 'value' => $value,
1965             );
1966         }
1967         $data = array(
1968             'label' => $label,
1969             'base' => $base,
1970             'name' => $name,
1971             'params' => $hiddenparams,
1972             'options' => $options,
1973             'sesskey' => sesskey(),
1974             'submit' => get_string('download'),
1975         );
1977         return $this->render_from_template('core/dataformat_selector', $data);
1978     }
1981     /**
1982      * Internal implementation of single_select rendering
1983      *
1984      * @param single_select $select
1985      * @return string HTML fragment
1986      */
1987     protected function render_single_select(single_select $select) {
1988         return $this->render_from_template('core/single_select', $select->export_for_template($this));
1989     }
1991     /**
1992      * Returns a form with a url select widget.
1993      *
1994      * Theme developers: DO NOT OVERRIDE! Please override function
1995      * {@link core_renderer::render_url_select()} instead.
1996      *
1997      * @param array $urls list of urls - array('/course/view.php?id=1'=>'Frontpage', ....)
1998      * @param string $selected selected element
1999      * @param array $nothing
2000      * @param string $formid
2001      * @return string HTML fragment
2002      */
2003     public function url_select(array $urls, $selected, $nothing = array('' => 'choosedots'), $formid = null) {
2004         $select = new url_select($urls, $selected, $nothing, $formid);
2005         return $this->render($select);
2006     }
2008     /**
2009      * Internal implementation of url_select rendering
2010      *
2011      * @param url_select $select
2012      * @return string HTML fragment
2013      */
2014     protected function render_url_select(url_select $select) {
2015         return $this->render_from_template('core/url_select', $select->export_for_template($this));
2016     }
2018     /**
2019      * Returns a string containing a link to the user documentation.
2020      * Also contains an icon by default. Shown to teachers and admin only.
2021      *
2022      * @param string $path The page link after doc root and language, no leading slash.
2023      * @param string $text The text to be displayed for the link
2024      * @param boolean $forcepopup Whether to force a popup regardless of the value of $CFG->doctonewwindow
2025      * @return string
2026      */
2027     public function doc_link($path, $text = '', $forcepopup = false) {
2028         global $CFG;
2030         $icon = $this->pix_icon('docs', '', 'moodle', array('class'=>'iconhelp icon-pre', 'role'=>'presentation'));
2032         $url = new moodle_url(get_docs_url($path));
2034         $attributes = array('href'=>$url);
2035         if (!empty($CFG->doctonewwindow) || $forcepopup) {
2036             $attributes['class'] = 'helplinkpopup';
2037         }
2039         return html_writer::tag('a', $icon.$text, $attributes);
2040     }
2042     /**
2043      * Return HTML for an image_icon.
2044      *
2045      * Theme developers: DO NOT OVERRIDE! Please override function
2046      * {@link core_renderer::render_image_icon()} instead.
2047      *
2048      * @param string $pix short pix name
2049      * @param string $alt mandatory alt attribute
2050      * @param string $component standard compoennt name like 'moodle', 'mod_forum', etc.
2051      * @param array $attributes htm lattributes
2052      * @return string HTML fragment
2053      */
2054     public function image_icon($pix, $alt, $component='moodle', array $attributes = null) {
2055         $icon = new image_icon($pix, $alt, $component, $attributes);
2056         return $this->render($icon);
2057     }
2059     /**
2060      * Renders a pix_icon widget and returns the HTML to display it.
2061      *
2062      * @param image_icon $icon
2063      * @return string HTML fragment
2064      */
2065     protected function render_image_icon(image_icon $icon) {
2066         $system = \core\output\icon_system::instance(\core\output\icon_system::STANDARD);
2067         return $system->render_pix_icon($this, $icon);
2068     }
2070     /**
2071      * Return HTML for a pix_icon.
2072      *
2073      * Theme developers: DO NOT OVERRIDE! Please override function
2074      * {@link core_renderer::render_pix_icon()} instead.
2075      *
2076      * @param string $pix short pix name
2077      * @param string $alt mandatory alt attribute
2078      * @param string $component standard compoennt name like 'moodle', 'mod_forum', etc.
2079      * @param array $attributes htm lattributes
2080      * @return string HTML fragment
2081      */
2082     public function pix_icon($pix, $alt, $component='moodle', array $attributes = null) {
2083         $icon = new pix_icon($pix, $alt, $component, $attributes);
2084         return $this->render($icon);
2085     }
2087     /**
2088      * Renders a pix_icon widget and returns the HTML to display it.
2089      *
2090      * @param pix_icon $icon
2091      * @return string HTML fragment
2092      */
2093     protected function render_pix_icon(pix_icon $icon) {
2094         $system = \core\output\icon_system::instance();
2095         return $system->render_pix_icon($this, $icon);
2096     }
2098     /**
2099      * Return HTML to display an emoticon icon.
2100      *
2101      * @param pix_emoticon $emoticon
2102      * @return string HTML fragment
2103      */
2104     protected function render_pix_emoticon(pix_emoticon $emoticon) {
2105         $system = \core\output\icon_system::instance(\core\output\icon_system::STANDARD);
2106         return $system->render_pix_icon($this, $emoticon);
2107     }
2109     /**
2110      * Produces the html that represents this rating in the UI
2111      *
2112      * @param rating $rating the page object on which this rating will appear
2113      * @return string
2114      */
2115     function render_rating(rating $rating) {
2116         global $CFG, $USER;
2118         if ($rating->settings->aggregationmethod == RATING_AGGREGATE_NONE) {
2119             return null;//ratings are turned off
2120         }
2122         $ratingmanager = new rating_manager();
2123         // Initialise the JavaScript so ratings can be done by AJAX.
2124         $ratingmanager->initialise_rating_javascript($this->page);
2126         $strrate = get_string("rate", "rating");
2127         $ratinghtml = ''; //the string we'll return
2129         // permissions check - can they view the aggregate?
2130         if ($rating->user_can_view_aggregate()) {
2132             $aggregatelabel = $ratingmanager->get_aggregate_label($rating->settings->aggregationmethod);
2133             $aggregatestr   = $rating->get_aggregate_string();
2135             $aggregatehtml  = html_writer::tag('span', $aggregatestr, array('id' => 'ratingaggregate'.$rating->itemid, 'class' => 'ratingaggregate')).' ';
2136             if ($rating->count > 0) {
2137                 $countstr = "({$rating->count})";
2138             } else {
2139                 $countstr = '-';
2140             }
2141             $aggregatehtml .= html_writer::tag('span', $countstr, array('id'=>"ratingcount{$rating->itemid}", 'class' => 'ratingcount')).' ';
2143             $ratinghtml .= html_writer::tag('span', $aggregatelabel, array('class'=>'rating-aggregate-label'));
2144             if ($rating->settings->permissions->viewall && $rating->settings->pluginpermissions->viewall) {
2146                 $nonpopuplink = $rating->get_view_ratings_url();
2147                 $popuplink = $rating->get_view_ratings_url(true);
2149                 $action = new popup_action('click', $popuplink, 'ratings', array('height' => 400, 'width' => 600));
2150                 $ratinghtml .= $this->action_link($nonpopuplink, $aggregatehtml, $action);
2151             } else {
2152                 $ratinghtml .= $aggregatehtml;
2153             }
2154         }
2156         $formstart = null;
2157         // if the item doesn't belong to the current user, the user has permission to rate
2158         // and we're within the assessable period
2159         if ($rating->user_can_rate()) {
2161             $rateurl = $rating->get_rate_url();
2162             $inputs = $rateurl->params();
2164             //start the rating form
2165             $formattrs = array(
2166                 'id'     => "postrating{$rating->itemid}",
2167                 'class'  => 'postratingform',
2168                 'method' => 'post',
2169                 'action' => $rateurl->out_omit_querystring()
2170             );
2171             $formstart  = html_writer::start_tag('form', $formattrs);
2172             $formstart .= html_writer::start_tag('div', array('class' => 'ratingform'));
2174             // add the hidden inputs
2175             foreach ($inputs as $name => $value) {
2176                 $attributes = array('type' => 'hidden', 'class' => 'ratinginput', 'name' => $name, 'value' => $value);
2177                 $formstart .= html_writer::empty_tag('input', $attributes);
2178             }
2180             if (empty($ratinghtml)) {
2181                 $ratinghtml .= $strrate.': ';
2182             }
2183             $ratinghtml = $formstart.$ratinghtml;
2185             $scalearray = array(RATING_UNSET_RATING => $strrate.'...') + $rating->settings->scale->scaleitems;
2186             $scaleattrs = array('class'=>'postratingmenu ratinginput','id'=>'menurating'.$rating->itemid);
2187             $ratinghtml .= html_writer::label($rating->rating, 'menurating'.$rating->itemid, false, array('class' => 'accesshide'));
2188             $ratinghtml .= html_writer::select($scalearray, 'rating', $rating->rating, false, $scaleattrs);
2190             //output submit button
2191             $ratinghtml .= html_writer::start_tag('span', array('class'=>"ratingsubmit"));
2193             $attributes = array('type' => 'submit', 'class' => 'postratingmenusubmit', 'id' => 'postratingsubmit'.$rating->itemid, 'value' => s(get_string('rate', 'rating')));
2194             $ratinghtml .= html_writer::empty_tag('input', $attributes);
2196             if (!$rating->settings->scale->isnumeric) {
2197                 // If a global scale, try to find current course ID from the context
2198                 if (empty($rating->settings->scale->courseid) and $coursecontext = $rating->context->get_course_context(false)) {
2199                     $courseid = $coursecontext->instanceid;
2200                 } else {
2201                     $courseid = $rating->settings->scale->courseid;
2202                 }
2203                 $ratinghtml .= $this->help_icon_scale($courseid, $rating->settings->scale);
2204             }
2205             $ratinghtml .= html_writer::end_tag('span');
2206             $ratinghtml .= html_writer::end_tag('div');
2207             $ratinghtml .= html_writer::end_tag('form');
2208         }
2210         return $ratinghtml;
2211     }
2213     /**
2214      * Centered heading with attached help button (same title text)
2215      * and optional icon attached.
2216      *
2217      * @param string $text A heading text
2218      * @param string $helpidentifier The keyword that defines a help page
2219      * @param string $component component name
2220      * @param string|moodle_url $icon
2221      * @param string $iconalt icon alt text
2222      * @param int $level The level of importance of the heading. Defaulting to 2
2223      * @param string $classnames A space-separated list of CSS classes. Defaulting to null
2224      * @return string HTML fragment
2225      */
2226     public function heading_with_help($text, $helpidentifier, $component = 'moodle', $icon = '', $iconalt = '', $level = 2, $classnames = null) {
2227         $image = '';
2228         if ($icon) {
2229             $image = $this->pix_icon($icon, $iconalt, $component, array('class'=>'icon iconlarge'));
2230         }
2232         $help = '';
2233         if ($helpidentifier) {
2234             $help = $this->help_icon($helpidentifier, $component);
2235         }
2237         return $this->heading($image.$text.$help, $level, $classnames);
2238     }
2240     /**
2241      * Returns HTML to display a help icon.
2242      *
2243      * @deprecated since Moodle 2.0
2244      */
2245     public function old_help_icon($helpidentifier, $title, $component = 'moodle', $linktext = '') {
2246         throw new coding_exception('old_help_icon() can not be used any more, please see help_icon().');
2247     }
2249     /**
2250      * Returns HTML to display a help icon.
2251      *
2252      * Theme developers: DO NOT OVERRIDE! Please override function
2253      * {@link core_renderer::render_help_icon()} instead.
2254      *
2255      * @param string $identifier The keyword that defines a help page
2256      * @param string $component component name
2257      * @param string|bool $linktext true means use $title as link text, string means link text value
2258      * @return string HTML fragment
2259      */
2260     public function help_icon($identifier, $component = 'moodle', $linktext = '') {
2261         $icon = new help_icon($identifier, $component);
2262         $icon->diag_strings();
2263         if ($linktext === true) {
2264             $icon->linktext = get_string($icon->identifier, $icon->component);
2265         } else if (!empty($linktext)) {
2266             $icon->linktext = $linktext;
2267         }
2268         return $this->render($icon);
2269     }
2271     /**
2272      * Implementation of user image rendering.
2273      *
2274      * @param help_icon $helpicon A help icon instance
2275      * @return string HTML fragment
2276      */
2277     protected function render_help_icon(help_icon $helpicon) {
2278         return $this->render_from_template('core/help_icon', $helpicon->export_for_template($this));
2279     }
2281     /**
2282      * Returns HTML to display a scale help icon.
2283      *
2284      * @param int $courseid
2285      * @param stdClass $scale instance
2286      * @return string HTML fragment
2287      */
2288     public function help_icon_scale($courseid, stdClass $scale) {
2289         global $CFG;
2291         $title = get_string('helpprefix2', '', $scale->name) .' ('.get_string('newwindow').')';
2293         $icon = $this->pix_icon('help', get_string('scales'), 'moodle', array('class'=>'iconhelp'));
2295         $scaleid = abs($scale->id);
2297         $link = new moodle_url('/course/scales.php', array('id' => $courseid, 'list' => true, 'scaleid' => $scaleid));
2298         $action = new popup_action('click', $link, 'ratingscale');
2300         return html_writer::tag('span', $this->action_link($link, $icon, $action), array('class' => 'helplink'));
2301     }
2303     /**
2304      * Creates and returns a spacer image with optional line break.
2305      *
2306      * @param array $attributes Any HTML attributes to add to the spaced.
2307      * @param bool $br Include a BR after the spacer.... DON'T USE THIS. Don't be
2308      *     laxy do it with CSS which is a much better solution.
2309      * @return string HTML fragment
2310      */
2311     public function spacer(array $attributes = null, $br = false) {
2312         $attributes = (array)$attributes;
2313         if (empty($attributes['width'])) {
2314             $attributes['width'] = 1;
2315         }
2316         if (empty($attributes['height'])) {
2317             $attributes['height'] = 1;
2318         }
2319         $attributes['class'] = 'spacer';
2321         $output = $this->pix_icon('spacer', '', 'moodle', $attributes);
2323         if (!empty($br)) {
2324             $output .= '<br />';
2325         }
2327         return $output;
2328     }
2330     /**
2331      * Returns HTML to display the specified user's avatar.
2332      *
2333      * User avatar may be obtained in two ways:
2334      * <pre>
2335      * // Option 1: (shortcut for simple cases, preferred way)
2336      * // $user has come from the DB and has fields id, picture, imagealt, firstname and lastname
2337      * $OUTPUT->user_picture($user, array('popup'=>true));
2338      *
2339      * // Option 2:
2340      * $userpic = new user_picture($user);
2341      * // Set properties of $userpic
2342      * $userpic->popup = true;
2343      * $OUTPUT->render($userpic);
2344      * </pre>
2345      *
2346      * Theme developers: DO NOT OVERRIDE! Please override function
2347      * {@link core_renderer::render_user_picture()} instead.
2348      *
2349      * @param stdClass $user Object with at least fields id, picture, imagealt, firstname, lastname
2350      *     If any of these are missing, the database is queried. Avoid this
2351      *     if at all possible, particularly for reports. It is very bad for performance.
2352      * @param array $options associative array with user picture options, used only if not a user_picture object,
2353      *     options are:
2354      *     - courseid=$this->page->course->id (course id of user profile in link)
2355      *     - size=35 (size of image)
2356      *     - link=true (make image clickable - the link leads to user profile)
2357      *     - popup=false (open in popup)
2358      *     - alttext=true (add image alt attribute)
2359      *     - class = image class attribute (default 'userpicture')
2360      *     - visibletoscreenreaders=true (whether to be visible to screen readers)
2361      * @return string HTML fragment
2362      */
2363     public function user_picture(stdClass $user, array $options = null) {
2364         $userpicture = new user_picture($user);
2365         foreach ((array)$options as $key=>$value) {
2366             if (array_key_exists($key, $userpicture)) {
2367                 $userpicture->$key = $value;
2368             }
2369         }
2370         return $this->render($userpicture);
2371     }
2373     /**
2374      * Internal implementation of user image rendering.
2375      *
2376      * @param user_picture $userpicture
2377      * @return string
2378      */
2379     protected function render_user_picture(user_picture $userpicture) {
2380         global $CFG, $DB;
2382         $user = $userpicture->user;
2384         if ($userpicture->alttext) {
2385             if (!empty($user->imagealt)) {
2386                 $alt = $user->imagealt;
2387             } else {
2388                 $alt = get_string('pictureof', '', fullname($user));
2389             }
2390         } else {
2391             $alt = '';
2392         }
2394         if (empty($userpicture->size)) {
2395             $size = 35;
2396         } else if ($userpicture->size === true or $userpicture->size == 1) {
2397             $size = 100;
2398         } else {
2399             $size = $userpicture->size;
2400         }
2402         $class = $userpicture->class;
2404         if ($user->picture == 0) {
2405             $class .= ' defaultuserpic';
2406         }
2408         $src = $userpicture->get_url($this->page, $this);
2410         $attributes = array('src'=>$src, 'alt'=>$alt, 'title'=>$alt, 'class'=>$class, 'width'=>$size, 'height'=>$size);
2411         if (!$userpicture->visibletoscreenreaders) {
2412             $attributes['role'] = 'presentation';
2413         }
2415         // get the image html output fisrt
2416         $output = html_writer::empty_tag('img', $attributes);
2418         // then wrap it in link if needed
2419         if (!$userpicture->link) {
2420             return $output;
2421         }
2423         if (empty($userpicture->courseid)) {
2424             $courseid = $this->page->course->id;
2425         } else {
2426             $courseid = $userpicture->courseid;
2427         }
2429         if ($courseid == SITEID) {
2430             $url = new moodle_url('/user/profile.php', array('id' => $user->id));
2431         } else {
2432             $url = new moodle_url('/user/view.php', array('id' => $user->id, 'course' => $courseid));
2433         }
2435         $attributes = array('href'=>$url);
2436         if (!$userpicture->visibletoscreenreaders) {
2437             $attributes['tabindex'] = '-1';
2438             $attributes['aria-hidden'] = 'true';
2439         }
2441         if ($userpicture->popup) {
2442             $id = html_writer::random_id('userpicture');
2443             $attributes['id'] = $id;
2444             $this->add_action_handler(new popup_action('click', $url), $id);
2445         }
2447         return html_writer::tag('a', $output, $attributes);
2448     }
2450     /**
2451      * Internal implementation of file tree viewer items rendering.
2452      *
2453      * @param array $dir
2454      * @return string
2455      */
2456     public function htmllize_file_tree($dir) {
2457         if (empty($dir['subdirs']) and empty($dir['files'])) {
2458             return '';
2459         }
2460         $result = '<ul>';
2461         foreach ($dir['subdirs'] as $subdir) {
2462             $result .= '<li>'.s($subdir['dirname']).' '.$this->htmllize_file_tree($subdir).'</li>';
2463         }
2464         foreach ($dir['files'] as $file) {
2465             $filename = $file->get_filename();
2466             $result .= '<li><span>'.html_writer::link($file->fileurl, $filename).'</span></li>';
2467         }
2468         $result .= '</ul>';
2470         return $result;
2471     }
2473     /**
2474      * Returns HTML to display the file picker
2475      *
2476      * <pre>
2477      * $OUTPUT->file_picker($options);
2478      * </pre>
2479      *
2480      * Theme developers: DO NOT OVERRIDE! Please override function
2481      * {@link core_renderer::render_file_picker()} instead.
2482      *
2483      * @param array $options associative array with file manager options
2484      *   options are:
2485      *       maxbytes=>-1,
2486      *       itemid=>0,
2487      *       client_id=>uniqid(),
2488      *       acepted_types=>'*',
2489      *       return_types=>FILE_INTERNAL,
2490      *       context=>$PAGE->context
2491      * @return string HTML fragment
2492      */
2493     public function file_picker($options) {
2494         $fp = new file_picker($options);
2495         return $this->render($fp);
2496     }
2498     /**
2499      * Internal implementation of file picker rendering.
2500      *
2501      * @param file_picker $fp
2502      * @return string
2503      */
2504     public function render_file_picker(file_picker $fp) {
2505         global $CFG, $OUTPUT, $USER;
2506         $options = $fp->options;
2507         $client_id = $options->client_id;
2508         $strsaved = get_string('filesaved', 'repository');
2509         $straddfile = get_string('openpicker', 'repository');
2510         $strloading  = get_string('loading', 'repository');
2511         $strdndenabled = get_string('dndenabled_inbox', 'moodle');
2512         $strdroptoupload = get_string('droptoupload', 'moodle');
2513         $icon_progress = $OUTPUT->pix_icon('i/loading_small', $strloading).'';
2515         $currentfile = $options->currentfile;
2516         if (empty($currentfile)) {
2517             $currentfile = '';
2518         } else {
2519             $currentfile .= ' - ';
2520         }
2521         if ($options->maxbytes) {
2522             $size = $options->maxbytes;
2523         } else {
2524             $size = get_max_upload_file_size();
2525         }
2526         if ($size == -1) {
2527             $maxsize = '';
2528         } else {
2529             $maxsize = get_string('maxfilesize', 'moodle', display_size($size));
2530         }
2531         if ($options->buttonname) {
2532             $buttonname = ' name="' . $options->buttonname . '"';
2533         } else {
2534             $buttonname = '';
2535         }
2536         $html = <<<EOD
2537 <div class="filemanager-loading mdl-align" id='filepicker-loading-{$client_id}'>
2538 $icon_progress
2539 </div>
2540 <div id="filepicker-wrapper-{$client_id}" class="mdl-left" style="display:none">
2541     <div>
2542         <input type="button" class="btn btn-secondary fp-btn-choose" id="filepicker-button-{$client_id}" value="{$straddfile}"{$buttonname}/>
2543         <span> $maxsize </span>
2544     </div>
2545 EOD;
2546         if ($options->env != 'url') {
2547             $html .= <<<EOD
2548     <div id="file_info_{$client_id}" class="mdl-left filepicker-filelist" style="position: relative">
2549     <div class="filepicker-filename">
2550         <div class="filepicker-container">$currentfile<div class="dndupload-message">$strdndenabled <br/><div class="dndupload-arrow"></div></div></div>
2551         <div class="dndupload-progressbars"></div>
2552     </div>
2553     <div><div class="dndupload-target">{$strdroptoupload}<br/><div class="dndupload-arrow"></div></div></div>
2554     </div>
2555 EOD;
2556         }
2557         $html .= '</div>';
2558         return $html;
2559     }
2561     /**
2562      * Returns HTML to display the 'Update this Modulename' button that appears on module pages.
2563      *
2564      * @deprecated since Moodle 3.2
2565      *
2566      * @param string $cmid the course_module id.
2567      * @param string $modulename the module name, eg. "forum", "quiz" or "workshop"
2568      * @return string the HTML for the button, if this user has permission to edit it, else an empty string.
2569      */
2570     public function update_module_button($cmid, $modulename) {
2571         global $CFG;
2573         debugging('core_renderer::update_module_button() has been deprecated and should not be used anymore. Activity modules ' .
2574             'should not add the edit module button, the link is already available in the Administration block. Themes can choose ' .
2575             'to display the link in the buttons row consistently for all module types.', DEBUG_DEVELOPER);
2577         if (has_capability('moodle/course:manageactivities', context_module::instance($cmid))) {
2578             $modulename = get_string('modulename', $modulename);
2579             $string = get_string('updatethis', '', $modulename);
2580             $url = new moodle_url("$CFG->wwwroot/course/mod.php", array('update' => $cmid, 'return' => true, 'sesskey' => sesskey()));
2581             return $this->single_button($url, $string);
2582         } else {
2583             return '';
2584         }
2585     }
2587     /**
2588      * Returns HTML to display a "Turn editing on/off" button in a form.
2589      *
2590      * @param moodle_url $url The URL + params to send through when clicking the button
2591      * @return string HTML the button
2592      */
2593     public function edit_button(moodle_url $url) {
2595         $url->param('sesskey', sesskey());
2596         if ($this->page->user_is_editing()) {
2597             $url->param('edit', 'off');
2598             $editstring = get_string('turneditingoff');
2599         } else {
2600             $url->param('edit', 'on');
2601             $editstring = get_string('turneditingon');
2602         }
2604         return $this->single_button($url, $editstring);
2605     }
2607     /**
2608      * Returns HTML to display a simple button to close a window
2609      *
2610      * @param string $text The lang string for the button's label (already output from get_string())
2611      * @return string html fragment
2612      */
2613     public function close_window_button($text='') {
2614         if (empty($text)) {
2615             $text = get_string('closewindow');
2616         }
2617         $button = new single_button(new moodle_url('#'), $text, 'get');
2618         $button->add_action(new component_action('click', 'close_window'));
2620         return $this->container($this->render($button), 'closewindow');
2621     }
2623     /**
2624      * Output an error message. By default wraps the error message in <span class="error">.
2625      * If the error message is blank, nothing is output.
2626      *
2627      * @param string $message the error message.
2628      * @return string the HTML to output.
2629      */
2630     public function error_text($message) {
2631         if (empty($message)) {
2632             return '';
2633         }
2634         $message = $this->pix_icon('i/warning', get_string('error'), '', array('class' => 'icon icon-pre', 'title'=>'')) . $message;
2635         return html_writer::tag('span', $message, array('class' => 'error'));
2636     }
2638     /**
2639      * Do not call this function directly.
2640      *
2641      * To terminate the current script with a fatal error, call the {@link print_error}
2642      * function, or throw an exception. Doing either of those things will then call this
2643      * function to display the error, before terminating the execution.
2644      *
2645      * @param string $message The message to output
2646      * @param string $moreinfourl URL where more info can be found about the error
2647      * @param string $link Link for the Continue button
2648      * @param array $backtrace The execution backtrace
2649      * @param string $debuginfo Debugging information
2650      * @return string the HTML to output.
2651      */
2652     public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null, $errorcode = "") {
2653         global $CFG;
2655         $output = '';
2656         $obbuffer = '';
2658         if ($this->has_started()) {
2659             // we can not always recover properly here, we have problems with output buffering,
2660             // html tables, etc.
2661             $output .= $this->opencontainers->pop_all_but_last();
2663         } else {
2664             // It is really bad if library code throws exception when output buffering is on,
2665             // because the buffered text would be printed before our start of page.
2666             // NOTE: this hack might be behave unexpectedly in case output buffering is enabled in PHP.ini
2667             error_reporting(0); // disable notices from gzip compression, etc.
2668             while (ob_get_level() > 0) {
2669                 $buff = ob_get_clean();
2670                 if ($buff === false) {
2671                     break;
2672                 }
2673                 $obbuffer .= $buff;
2674             }
2675             error_reporting($CFG->debug);
2677             // Output not yet started.
2678             $protocol = (isset($_SERVER['SERVER_PROTOCOL']) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0');
2679             if (empty($_SERVER['HTTP_RANGE'])) {
2680                 @header($protocol . ' 404 Not Found');
2681             } else if (core_useragent::check_safari_ios_version(602) && !empty($_SERVER['HTTP_X_PLAYBACK_SESSION_ID'])) {
2682                 // Coax iOS 10 into sending the session cookie.
2683                 @header($protocol . ' 403 Forbidden');
2684             } else {
2685                 // Must stop byteserving attempts somehow,
2686                 // this is weird but Chrome PDF viewer can be stopped only with 407!
2687                 @header($protocol . ' 407 Proxy Authentication Required');
2688             }
2690             $this->page->set_context(null); // ugly hack - make sure page context is set to something, we do not want bogus warnings here
2691             $this->page->set_url('/'); // no url
2692             //$this->page->set_pagelayout('base'); //TODO: MDL-20676 blocks on error pages are weird, unfortunately it somehow detect the pagelayout from URL :-(
2693             $this->page->set_title(get_string('error'));
2694             $this->page->set_heading($this->page->course->fullname);
2695             $output .= $this->header();
2696         }
2698         $message = '<p class="errormessage">' . $message . '</p>'.
2699                 '<p class="errorcode"><a href="' . $moreinfourl . '">' .
2700                 get_string('moreinformation') . '</a></p>';
2701         if (empty($CFG->rolesactive)) {
2702             $message .= '<p class="errormessage">' . get_string('installproblem', 'error') . '</p>';
2703             //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.
2704         }
2705         $output .= $this->box($message, 'errorbox', null, array('data-rel' => 'fatalerror'));
2707         if ($CFG->debugdeveloper) {
2708             if (!empty($debuginfo)) {
2709                 $debuginfo = s($debuginfo); // removes all nasty JS
2710                 $debuginfo = str_replace("\n", '<br />', $debuginfo); // keep newlines
2711                 $output .= $this->notification('<strong>Debug info:</strong> '.$debuginfo, 'notifytiny');
2712             }
2713             if (!empty($backtrace)) {
2714                 $output .= $this->notification('<strong>Stack trace:</strong> '.format_backtrace($backtrace), 'notifytiny');
2715             }
2716             if ($obbuffer !== '' ) {
2717                 $output .= $this->notification('<strong>Output buffer:</strong> '.s($obbuffer), 'notifytiny');
2718             }
2719         }
2721         if (empty($CFG->rolesactive)) {
2722             // continue does not make much sense if moodle is not installed yet because error is most probably not recoverable
2723         } else if (!empty($link)) {
2724             $output .= $this->continue_button($link);
2725         }
2727         $output .= $this->footer();
2729         // Padding to encourage IE to display our error page, rather than its own.
2730         $output .= str_repeat(' ', 512);
2732         return $output;
2733     }
2735     /**
2736      * Output a notification (that is, a status message about something that has just happened).
2737      *
2738      * Note: \core\notification::add() may be more suitable for your usage.
2739      *
2740      * @param string $message The message to print out.
2741      * @param string $type    The type of notification. See constants on \core\output\notification.
2742      * @return string the HTML to output.
2743      */
2744     public function notification($message, $type = null) {
2745         $typemappings = [
2746             // Valid types.
2747             'success'           => \core\output\notification::NOTIFY_SUCCESS,
2748             'info'              => \core\output\notification::NOTIFY_INFO,
2749             'warning'           => \core\output\notification::NOTIFY_WARNING,
2750             'error'             => \core\output\notification::NOTIFY_ERROR,
2752             // Legacy types mapped to current types.
2753             'notifyproblem'     => \core\output\notification::NOTIFY_ERROR,
2754             'notifytiny'        => \core\output\notification::NOTIFY_ERROR,
2755             'notifyerror'       => \core\output\notification::NOTIFY_ERROR,
2756             'notifysuccess'     => \core\output\notification::NOTIFY_SUCCESS,
2757             'notifymessage'     => \core\output\notification::NOTIFY_INFO,
2758             'notifyredirect'    => \core\output\notification::NOTIFY_INFO,
2759             'redirectmessage'   => \core\output\notification::NOTIFY_INFO,
2760         ];
2762         $extraclasses = [];
2764         if ($type) {
2765             if (strpos($type, ' ') === false) {
2766                 // No spaces in the list of classes, therefore no need to loop over and determine the class.
2767                 if (isset($typemappings[$type])) {
2768                     $type = $typemappings[$type];
2769                 } else {
2770                     // The value provided did not match a known type. It must be an extra class.
2771                     $extraclasses = [$type];
2772                 }
2773             } else {
2774                 // Identify what type of notification this is.
2775                 $classarray = explode(' ', self::prepare_classes($type));
2777                 // Separate out the type of notification from the extra classes.
2778                 foreach ($classarray as $class) {
2779                     if (isset($typemappings[$class])) {
2780                         $type = $typemappings[$class];
2781                     } else {
2782                         $extraclasses[] = $class;
2783                     }
2784                 }
2785             }
2786         }
2788         $notification = new \core\output\notification($message, $type);
2789         if (count($extraclasses)) {
2790             $notification->set_extra_classes($extraclasses);
2791         }
2793         // Return the rendered template.
2794         return $this->render_from_template($notification->get_template_name(), $notification->export_for_template($this));
2795     }
2797     /**
2798      * Output a notification at a particular level - in this case, NOTIFY_PROBLEM.
2799      *
2800      * @param string $message the message to print out
2801      * @return string HTML fragment.
2802      * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more.
2803      * @todo MDL-53113 This will be removed in Moodle 3.5.
2804      * @see \core\output\notification
2805      */
2806     public function notify_problem($message) {
2807         debugging(__FUNCTION__ . ' is deprecated.' .
2808             'Please use \core\notification::add, or \core\output\notification as required',
2809             DEBUG_DEVELOPER);
2810         $n = new \core\output\notification($message, \core\output\notification::NOTIFY_ERROR);
2811         return $this->render($n);
2812     }
2814     /**
2815      * Output a notification at a particular level - in this case, NOTIFY_SUCCESS.
2816      *
2817      * @param string $message the message to print out
2818      * @return string HTML fragment.
2819      * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more.
2820      * @todo MDL-53113 This will be removed in Moodle 3.5.
2821      * @see \core\output\notification
2822      */
2823     public function notify_success($message) {
2824         debugging(__FUNCTION__ . ' is deprecated.' .
2825             'Please use \core\notification::add, or \core\output\notification as required',
2826             DEBUG_DEVELOPER);
2827         $n = new \core\output\notification($message, \core\output\notification::NOTIFY_SUCCESS);
2828         return $this->render($n);
2829     }
2831     /**
2832      * Output a notification at a particular level - in this case, NOTIFY_MESSAGE.
2833      *
2834      * @param string $message the message to print out
2835      * @return string HTML fragment.
2836      * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more.
2837      * @todo MDL-53113 This will be removed in Moodle 3.5.
2838      * @see \core\output\notification
2839      */
2840     public function notify_message($message) {
2841         debugging(__FUNCTION__ . ' is deprecated.' .
2842             'Please use \core\notification::add, or \core\output\notification as required',
2843             DEBUG_DEVELOPER);
2844         $n = new \core\output\notification($message, \core\output\notification::NOTIFY_INFO);
2845         return $this->render($n);
2846     }
2848     /**
2849      * Output a notification at a particular level - in this case, NOTIFY_REDIRECT.
2850      *
2851      * @param string $message the message to print out
2852      * @return string HTML fragment.
2853      * @deprecated since Moodle 3.1 MDL-30811 - please do not use this function any more.
2854      * @todo MDL-53113 This will be removed in Moodle 3.5.
2855      * @see \core\output\notification
2856      */
2857     public function notify_redirect($message) {
2858         debugging(__FUNCTION__ . ' is deprecated.' .
2859             'Please use \core\notification::add, or \core\output\notification as required',
2860             DEBUG_DEVELOPER);
2861         $n = new \core\output\notification($message, \core\output\notification::NOTIFY_INFO);
2862         return $this->render($n);
2863     }
2865     /**
2866      * Render a notification (that is, a status message about something that has
2867      * just happened).
2868      *
2869      * @param \core\output\notification $notification the notification to print out
2870      * @return string the HTML to output.
2871      */
2872     protected function render_notification(\core\output\notification $notification) {
2873         return $this->render_from_template($notification->get_template_name(), $notification->export_for_template($this));
2874     }
2876     /**
2877      * Returns HTML to display a continue button that goes to a particular URL.
2878      *
2879      * @param string|moodle_url $url The url the button goes to.
2880      * @return string the HTML to output.
2881      */
2882     public function continue_button($url) {
2883         if (!($url instanceof moodle_url)) {
2884             $url = new moodle_url($url);
2885         }
2886         $button = new single_button($url, get_string('continue'), 'get', true);
2887         $button->class = 'continuebutton';
2889         return $this->render($button);
2890     }
2892     /**
2893      * Returns HTML to display a single paging bar to provide access to other pages  (usually in a search)
2894      *
2895      * Theme developers: DO NOT OVERRIDE! Please override function
2896      * {@link core_renderer::render_paging_bar()} instead.
2897      *
2898      * @param int $totalcount The total number of entries available to be paged through
2899      * @param int $page The page you are currently viewing
2900      * @param int $perpage The number of entries that should be shown per page
2901      * @param string|moodle_url $baseurl url of the current page, the $pagevar parameter is added
2902      * @param string $pagevar name of page parameter that holds the page number
2903      * @return string the HTML to output.
2904      */
2905     public function paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar = 'page') {
2906         $pb = new paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar);
2907         return $this->render($pb);
2908     }
2910     /**
2911      * Internal implementation of paging bar rendering.
2912      *
2913      * @param paging_bar $pagingbar
2914      * @return string
2915      */
2916     protected function render_paging_bar(paging_bar $pagingbar) {
2917         $output = '';
2918         $pagingbar = clone($pagingbar);
2919         $pagingbar->prepare($this, $this->page, $this->target);
2921         if ($pagingbar->totalcount > $pagingbar->perpage) {
2922             $output .= get_string('page') . ':';
2924             if (!empty($pagingbar->previouslink)) {
2925                 $output .= ' (' . $pagingbar->previouslink . ') ';
2926             }
2928             if (!empty($pagingbar->firstlink)) {
2929                 $output .= ' ' . $pagingbar->firstlink . ' ...';
2930             }
2932             foreach ($pagingbar->pagelinks as $link) {
2933                 $output .= "  $link";
2934             }
2936             if (!empty($pagingbar->lastlink)) {
2937                 $output .= ' ... ' . $pagingbar->lastlink . ' ';
2938             }
2940             if (!empty($pagingbar->nextlink)) {
2941                 $output .= '  (' . $pagingbar->nextlink . ')';
2942             }
2943         }
2945         return html_writer::tag('div', $output, array('class' => 'paging'));
2946     }
2948     /**
2949      * Returns HTML to display initials bar to provide access to other pages  (usually in a search)
2950      *
2951      * @param string $current the currently selected letter.
2952      * @param string $class class name to add to this initial bar.
2953      * @param string $title the name to put in front of this initial bar.
2954      * @param string $urlvar URL parameter name for this initial.
2955      * @param string $url URL object.
2956      * @param array $alpha of letters in the alphabet.
2957      * @return string the HTML to output.
2958      */
2959     public function initials_bar($current, $class, $title, $urlvar, $url, $alpha = null) {
2960         $ib = new initials_bar($current, $class, $title, $urlvar, $url, $alpha);
2961         return $this->render($ib);
2962     }
2964     /**
2965      * Internal implementation of initials bar rendering.
2966      *
2967      * @param initials_bar $initialsbar
2968      * @return string
2969      */
2970     protected function render_initials_bar(initials_bar $initialsbar) {
2971         return $this->render_from_template('core/initials_bar', $initialsbar->export_for_template($this));
2972     }
2974     /**
2975      * Output the place a skip link goes to.
2976      *
2977      * @param string $id The target name from the corresponding $PAGE->requires->skip_link_to($target) call.
2978      * @return string the HTML to output.
2979      */
2980     public function skip_link_target($id = null) {
2981         return html_writer::span('', '', array('id' => $id));
2982     }
2984     /**
2985      * Outputs a heading
2986      *
2987      * @param string $text The text of the heading
2988      * @param int $level The level of importance of the heading. Defaulting to 2
2989      * @param string $classes A space-separated list of CSS classes. Defaulting to null
2990      * @param string $id An optional ID
2991      * @return string the HTML to output.
2992      */
2993     public function heading($text, $level = 2, $classes = null, $id = null) {
2994         $level = (integer) $level;
2995         if ($level < 1 or $level > 6) {
2996             throw new coding_exception('Heading level must be an integer between 1 and 6.');
2997         }
2998         return html_writer::tag('h' . $level, $text, array('id' => $id, 'class' => renderer_base::prepare_classes($classes)));
2999     }
3001     /**
3002      * Outputs a box.
3003      *
3004      * @param string $contents The contents of the box
3005      * @param string $classes A space-separated list of CSS classes
3006      * @param string $id An optional ID
3007      * @param array $attributes An array of other attributes to give the box.
3008      * @return string the HTML to output.
3009      */
3010     public function box($contents, $classes = 'generalbox', $id = null, $attributes = array()) {
3011         return $this->box_start($classes, $id, $attributes) . $contents . $this->box_end();
3012     }
3014     /**
3015      * Outputs the opening section of a box.
3016      *
3017      * @param string $classes A space-separated list of CSS classes
3018      * @param string $id An optional ID
3019      * @param array $attributes An array of other attributes to give the box.
3020      * @return string the HTML to output.
3021      */
3022     public function box_start($classes = 'generalbox', $id = null, $attributes = array()) {
3023         $this->opencontainers->push('box', html_writer::end_tag('div'));
3024         $attributes['id'] = $id;
3025         $attributes['class'] = 'box ' . renderer_base::prepare_classes($classes);
3026         return html_writer::start_tag('div', $attributes);
3027     }
3029     /**
3030      * Outputs the closing section of a box.
3031      *
3032      * @return string the HTML to output.
3033      */
3034     public function box_end() {
3035         return $this->opencontainers->pop('box');
3036     }
3038     /**
3039      * Outputs a container.
3040      *
3041      * @param string $contents The contents of the box
3042      * @param string $classes A space-separated list of CSS classes
3043      * @param string $id An optional ID
3044      * @return string the HTML to output.
3045      */
3046     public function container($contents, $classes = null, $id = null) {
3047         return $this->container_start($classes, $id) . $contents . $this->container_end();
3048     }
3050     /**
3051      * Outputs the opening section of a container.
3052      *
3053      * @param string $classes A space-separated list of CSS classes
3054      * @param string $id An optional ID
3055      * @return string the HTML to output.
3056      */
3057     public function container_start($classes = null, $id = null) {
3058         $this->opencontainers->push('container', html_writer::end_tag('div'));
3059         return html_writer::start_tag('div', array('id' => $id,
3060                 'class' => renderer_base::prepare_classes($classes)));
3061     }
3063     /**
3064      * Outputs the closing section of a container.
3065      *
3066      * @return string the HTML to output.
3067      */
3068     public function container_end() {
3069         return $this->opencontainers->pop('container');
3070     }
3072     /**
3073      * Make nested HTML lists out of the items
3074      *
3075      * The resulting list will look something like this:
3076      *
3077      * <pre>
3078      * <<ul>>
3079      * <<li>><div class='tree_item parent'>(item contents)</div>
3080      *      <<ul>
3081      *      <<li>><div class='tree_item'>(item contents)</div><</li>>
3082      *      <</ul>>
3083      * <</li>>
3084      * <</ul>>
3085      * </pre>
3086      *
3087      * @param array $items
3088      * @param array $attrs html attributes passed to the top ofs the list
3089      * @return string HTML
3090      */
3091     public function tree_block_contents($items, $attrs = array()) {
3092         // exit if empty, we don't want an empty ul element
3093         if (empty($items)) {
3094             return '';
3095         }
3096         // array of nested li elements
3097         $lis = array();
3098         foreach ($items as $item) {
3099             // this applies to the li item which contains all child lists too
3100             $content = $item->content($this);
3101             $liclasses = array($item->get_css_type());
3102             if (!$item->forceopen || (!$item->forceopen && $item->collapse) || ($item->children->count()==0  && $item->nodetype==navigation_node::NODETYPE_BRANCH)) {
3103                 $liclasses[] = 'collapsed';
3104             }
3105             if ($item->isactive === true) {
3106                 $liclasses[] = 'current_branch';
3107             }
3108             $liattr = array('class'=>join(' ',$liclasses));
3109             // class attribute on the div item which only contains the item content
3110             $divclasses = array('tree_item');
3111             if ($item->children->count()>0  || $item->nodetype==navigation_node::NODETYPE_BRANCH) {
3112                 $divclasses[] = 'branch';
3113             } else {
3114                 $divclasses[] = 'leaf';
3115             }
3116             if (!empty($item->classes) && count($item->classes)>0) {
3117                 $divclasses[] = join(' ', $item->classes);
3118             }
3119             $divattr = array('class'=>join(' ', $divclasses));
3120             if (!empty($item->id)) {
3121                 $divattr['id'] = $item->id;
3122             }
3123             $content = html_writer::tag('p', $content, $divattr) . $this->tree_block_contents($item->children);
3124             if (!empty($item->preceedwithhr) && $item->preceedwithhr===true) {
3125                 $content = html_writer::empty_tag('hr') . $content;
3126             }
3127             $content = html_writer::tag('li', $content, $liattr);
3128             $lis[] = $content;
3129         }
3130         return html_writer::tag('ul', implode("\n", $lis), $attrs);
3131     }
3133     /**
3134      * Returns a search box.
3135      *
3136      * @param  string $id     The search box wrapper div id, defaults to an autogenerated one.
3137      * @return string         HTML with the search form hidden by default.
3138      */
3139     public function search_box($id = false) {
3140         global $CFG;
3142         // Accessing $CFG directly as using \core_search::is_global_search_enabled would
3143         // result in an extra included file for each site, even the ones where global search
3144         // is disabled.
3145         if (empty($CFG->enableglobalsearch) || !has_capability('moodle/search:query', context_system::instance())) {
3146             return '';
3147         }
3149         if ($id == false) {
3150             $id = uniqid();
3151         } else {
3152             // Needs to be cleaned, we use it for the input id.
3153             $id = clean_param($id, PARAM_ALPHANUMEXT);
3154         }
3156         // JS to animate the form.
3157         $this->page->requires->js_call_amd('core/search-input', 'init', array($id));
3159         $searchicon = html_writer::tag('div', $this->pix_icon('a/search', get_string('search', 'search'), 'moodle'),
3160             array('role' => 'button', 'tabindex' => 0));
3161         $formattrs = array('class' => 'search-input-form', 'action' => $CFG->wwwroot . '/search/index.php');
3162         $inputattrs = array('type' => 'text', 'name' => 'q', 'placeholder' => get_string('search', 'search'),
3163             'size' => 13, 'tabindex' => -1, 'id' => 'id_q_' . $id);
3165         $contents = html_writer::tag('label', get_string('enteryoursearchquery', 'search'),
3166             array('for' => 'id_q_' . $id, 'class' => 'accesshide')) . html_writer::tag('input', '', $inputattrs);
3167         $searchinput = html_writer::tag('form', $contents, $formattrs);
3169         return html_writer::tag('div', $searchicon . $searchinput, array('class' => 'search-input-wrapper nav-link', 'id' => $id));
3170     }
3172     /**
3173      * Allow plugins to provide some content to be rendered in the navbar.
3174      * The plugin must define a PLUGIN_render_navbar_output function that returns
3175      * the HTML they wish to add to the navbar.
3176      *
3177      * @return string HTML for the navbar
3178      */
3179     public function navbar_plugin_output() {
3180         $output = '';
3182         if ($pluginsfunction = get_plugins_with_function('render_navbar_output')) {
3183             foreach ($pluginsfunction as $plugintype => $plugins) {
3184                 foreach ($plugins as $pluginfunction) {
3185                     $output .= $pluginfunction($this);
3186                 }
3187             }
3188         }
3190         return $output;
3191     }
3193     /**
3194      * Construct a user menu, returning HTML that can be echoed out by a
3195      * layout file.
3196      *
3197      * @param stdClass $user A user object, usually $USER.
3198      * @param bool $withlinks true if a dropdown should be built.
3199      * @return string HTML fragment.
3200      */
3201     public function user_menu($user = null, $withlinks = null) {
3202         global $USER, $CFG;
3203         require_once($CFG->dirroot . '/user/lib.php');
3205         if (is_null($user)) {
3206             $user = $USER;
3207         }
3209         // Note: this behaviour is intended to match that of core_renderer::login_info,
3210         // but should not be considered to be good practice; layout options are
3211         // intended to be theme-specific. Please don't copy this snippet anywhere else.
3212         if (is_null($withlinks)) {
3213             $withlinks = empty($this->page->layout_options['nologinlinks']);
3214         }
3216         // Add a class for when $withlinks is false.
3217         $usermenuclasses = 'usermenu';
3218         if (!$withlinks) {
3219             $usermenuclasses .= ' withoutlinks';
3220         }
3222         $returnstr = "";
3224         // If during initial install, return the empty return string.
3225         if (during_initial_install()) {
3226             return $returnstr;
3227         }
3229         $loginpage = $this->is_login_page();
3230         $loginurl = get_login_url();
3231         // If not logged in, show the typical not-logged-in string.
3232         if (!isloggedin()) {
3233             $returnstr = get_string('loggedinnot', 'moodle');
3234             if (!$loginpage) {
3235                 $returnstr .= " (<a href=\"$loginurl\">" . get_string('login') . '</a>)';
3236             }
3237             return html_writer::div(
3238                 html_writer::span(
3239                     $returnstr,
3240                     'login'
3241                 ),
3242                 $usermenuclasses
3243             );
3245         }
3247         // If logged in as a guest user, show a string to that effect.
3248         if (isguestuser()) {
3249             $returnstr = get_string('loggedinasguest');
3250             if (!$loginpage && $withlinks) {
3251                 $returnstr .= " (<a href=\"$loginurl\">".get_string('login').'</a>)';
3252             }
3254             return html_writer::div(
3255                 html_writer::span(
3256                     $returnstr,
3257                     'login'
3258                 ),
3259                 $usermenuclasses
3260             );
3261         }
3263         // Get some navigation opts.
3264         $opts = user_get_user_navigation_info($user, $this->page);
3266         $avatarclasses = "avatars";
3267         $avatarcontents = html_writer::span($opts->metadata['useravatar'], 'avatar current');
3268         $usertextcontents = $opts->metadata['userfullname'];
3270         // Other user.
3271         if (!empty($opts->metadata['asotheruser'])) {
3272             $avatarcontents .= html_writer::span(
3273                 $opts->metadata['realuseravatar'],
3274                 'avatar realuser'
3275             );
3276             $usertextcontents = $opts->metadata['realuserfullname'];
3277             $usertextcontents .= html_writer::tag(
3278                 'span',
3279                 get_string(
3280                     'loggedinas',
3281                     'moodle',
3282                     html_writer::span(
3283                         $opts->metadata['userfullname'],
3284                         'value'
3285                     )
3286                 ),
3287                 array('class' => 'meta viewingas')
3288             );
3289         }
3291         // Role.
3292         if (!empty($opts->metadata['asotherrole'])) {
3293             $role = core_text::strtolower(preg_replace('#[ ]+#', '-', trim($opts->metadata['rolename'])));
3294             $usertextcontents .= html_writer::span(
3295                 $opts->metadata['rolename'],
3296                 'meta role role-' . $role
3297             );
3298         }
3300         // User login failures.
3301         if (!empty($opts->metadata['userloginfail'])) {
3302             $usertextcontents .= html_writer::span(
3303                 $opts->metadata['userloginfail'],
3304                 'meta loginfailures'
3305             );
3306         }
3308         // MNet.
3309         if (!empty($opts->metadata['asmnetuser'])) {
3310             $mnet = strtolower(preg_replace('#[ ]+#', '-', trim($opts->metadata['mnetidprovidername'])));
3311             $usertextcontents .= html_writer::span(
3312                 $opts->metadata['mnetidprovidername'],
3313                 'meta mnet mnet-' . $mnet
3314             );
3315         }
3317         $returnstr .= html_writer::span(
3318             html_writer::span($usertextcontents, 'usertext') .
3319             html_writer::span($avatarcontents, $avatarclasses),
3320             'userbutton'
3321         );
3323         // Create a divider (well, a filler).
3324         $divider = new action_menu_filler();
3325         $divider->primary = false;
3327         $am = new action_menu();
3328         $am->set_menu_trigger(
3329             $returnstr
3330         );
3331         $am->set_alignment(action_menu::TR, action_menu::BR);
3332         $am->set_nowrap_on_items();
3333         if ($withlinks) {
3334             $navitemcount = count($opts->navitems);
3335             $idx = 0;
3336             foreach ($opts->navitems as $key => $value) {
3338                 switch ($value->itemtype) {
3339                     case 'divider':
3340                         // If the nav item is a divider, add one and skip link processing.
3341                         $am->add($divider);
3342                         break;
3344                     case 'invalid':
3345                         // Silently skip invalid entries (should we post a notification?).
3346                         break;
3348                     case 'link':
3349                         // Process this as a link item.
3350                         $pix = null;
3351                         if (isset($value->pix) && !empty($value->pix)) {
3352                             $pix = new pix_icon($value->pix, $value->title, null, array('class' => 'iconsmall'));
3353                         } else if (isset($value->imgsrc) && !empty($value->imgsrc)) {
3354                             $value->title = html_writer::img(
3355                                 $value->imgsrc,
3356                                 $value->title,
3357                                 array('class' => 'iconsmall')
3358                             ) . $value->title;
3359                         }
3361                         $al = new action_menu_link_secondary(
3362                             $value->url,
3363                             $pix,
3364                             $value->title,
3365                             array('class' => 'icon')
3366                         );
3367                         if (!empty($value->titleidentifier)) {
3368                             $al->attributes['data-title'] = $value->titleidentifier;
3369                         }
3370                         $am->add($al);
3371                         break;
3372                 }
3374                 $idx++;
3376                 // Add dividers after the first item and before the last item.
3377                 if ($idx == 1 || $idx == $navitemcount - 1) {
3378                     $am->a