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