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