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