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