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