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