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