1ca922ad352f0d14c1e62b58993d2e66b054732b
[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_PERFTOLOG') && !function_exists('register_shutdown_function')) {
887                 error_log("PERF: " . $perf['txt']);
888             }
889             if (defined('MDL_PERFTOFOOT') || debugging() || $CFG->perfdebug > 7) {
890                 $performanceinfo = $perf['html'];
891             }
892         }
893         $footer = str_replace($this->unique_performance_info_token, $performanceinfo, $footer);
895         $footer = str_replace($this->unique_end_html_token, $this->page->requires->get_end_code(), $footer);
897         $this->page->set_state(moodle_page::STATE_DONE);
899         return $output . $footer;
900     }
902     /**
903      * Close all but the last open container. This is useful in places like error
904      * handling, where you want to close all the open containers (apart from <body>)
905      * before outputting the error message.
906      *
907      * @param bool $shouldbenone assert that the stack should be empty now - causes a
908      *      developer debug warning if it isn't.
909      * @return string the HTML required to close any open containers inside <body>.
910      */
911     public function container_end_all($shouldbenone = false) {
912         return $this->opencontainers->pop_all_but_last($shouldbenone);
913     }
915     /**
916      * Returns course-specific information to be output immediately above content on any course page
917      * (for the current course)
918      *
919      * @param bool $onlyifnotcalledbefore output content only if it has not been output before
920      * @return string
921      */
922     public function course_content_header($onlyifnotcalledbefore = false) {
923         global $CFG;
924         if ($this->page->course->id == SITEID) {
925             // return immediately and do not include /course/lib.php if not necessary
926             return '';
927         }
928         static $functioncalled = false;
929         if ($functioncalled && $onlyifnotcalledbefore) {
930             // we have already output the content header
931             return '';
932         }
933         require_once($CFG->dirroot.'/course/lib.php');
934         $functioncalled = true;
935         $courseformat = course_get_format($this->page->course);
936         if (($obj = $courseformat->course_content_header()) !== null) {
937             return html_writer::div($courseformat->get_renderer($this->page)->render($obj), 'course-content-header');
938         }
939         return '';
940     }
942     /**
943      * Returns course-specific information to be output immediately below content on any course page
944      * (for the current course)
945      *
946      * @param bool $onlyifnotcalledbefore output content only if it has not been output before
947      * @return string
948      */
949     public function course_content_footer($onlyifnotcalledbefore = false) {
950         global $CFG;
951         if ($this->page->course->id == SITEID) {
952             // return immediately and do not include /course/lib.php if not necessary
953             return '';
954         }
955         static $functioncalled = false;
956         if ($functioncalled && $onlyifnotcalledbefore) {
957             // we have already output the content footer
958             return '';
959         }
960         $functioncalled = true;
961         require_once($CFG->dirroot.'/course/lib.php');
962         $courseformat = course_get_format($this->page->course);
963         if (($obj = $courseformat->course_content_footer()) !== null) {
964             return html_writer::div($courseformat->get_renderer($this->page)->render($obj), 'course-content-footer');
965         }
966         return '';
967     }
969     /**
970      * Returns course-specific information to be output on any course page in the header area
971      * (for the current course)
972      *
973      * @return string
974      */
975     public function course_header() {
976         global $CFG;
977         if ($this->page->course->id == SITEID) {
978             // return immediately and do not include /course/lib.php if not necessary
979             return '';
980         }
981         require_once($CFG->dirroot.'/course/lib.php');
982         $courseformat = course_get_format($this->page->course);
983         if (($obj = $courseformat->course_header()) !== null) {
984             return $courseformat->get_renderer($this->page)->render($obj);
985         }
986         return '';
987     }
989     /**
990      * Returns course-specific information to be output on any course page in the footer area
991      * (for the current course)
992      *
993      * @return string
994      */
995     public function course_footer() {
996         global $CFG;
997         if ($this->page->course->id == SITEID) {
998             // return immediately and do not include /course/lib.php if not necessary
999             return '';
1000         }
1001         require_once($CFG->dirroot.'/course/lib.php');
1002         $courseformat = course_get_format($this->page->course);
1003         if (($obj = $courseformat->course_footer()) !== null) {
1004             return $courseformat->get_renderer($this->page)->render($obj);
1005         }
1006         return '';
1007     }
1009     /**
1010      * Returns lang menu or '', this method also checks forcing of languages in courses.
1011      *
1012      * This function calls {@link core_renderer::render_single_select()} to actually display the language menu.
1013      *
1014      * @return string The lang menu HTML or empty string
1015      */
1016     public function lang_menu() {
1017         global $CFG;
1019         if (empty($CFG->langmenu)) {
1020             return '';
1021         }
1023         if ($this->page->course != SITEID and !empty($this->page->course->lang)) {
1024             // do not show lang menu if language forced
1025             return '';
1026         }
1028         $currlang = current_language();
1029         $langs = get_string_manager()->get_list_of_translations();
1031         if (count($langs) < 2) {
1032             return '';
1033         }
1035         $s = new single_select($this->page->url, 'lang', $langs, $currlang, null);
1036         $s->label = get_accesshide(get_string('language'));
1037         $s->class = 'langmenu';
1038         return $this->render($s);
1039     }
1041     /**
1042      * Output the row of editing icons for a block, as defined by the controls array.
1043      *
1044      * @param array $controls an array like {@link block_contents::$controls}.
1045      * @param string $blockid The ID given to the block.
1046      * @return string HTML fragment.
1047      */
1048     public function block_controls($actions, $blockid = null) {
1049         global $CFG;
1050         if (empty($actions)) {
1051             return '';
1052         }
1053         $menu = new action_menu($actions);
1054         if ($blockid !== null) {
1055             $menu->set_owner_selector('#'.$blockid);
1056         }
1057         $menu->attributes['class'] .= ' block-control-actions commands';
1058         if (isset($CFG->blockeditingmenu) && !$CFG->blockeditingmenu) {
1059             $menu->do_not_enhance();
1060         }
1061         return $this->render($menu);
1062     }
1064     /**
1065      * Renders an action menu component.
1066      *
1067      * ARIA references:
1068      *   - http://www.w3.org/WAI/GL/wiki/Using_ARIA_menus
1069      *   - http://stackoverflow.com/questions/12279113/recommended-wai-aria-implementation-for-navigation-bar-menu
1070      *
1071      * @param action_menu $menu
1072      * @return string HTML
1073      */
1074     public function render_action_menu(action_menu $menu) {
1075         $menu->initialise_js($this->page);
1077         $output = html_writer::start_tag('div', $menu->attributes);
1078         $output .= html_writer::start_tag('ul', $menu->attributesprimary);
1079         foreach ($menu->get_primary_actions($this) as $action) {
1080             if ($action instanceof renderable) {
1081                 $content = $this->render($action);
1082                 $role = 'presentation';
1083             } else {
1084                 $content = $action;
1085                 $role = 'menuitem';
1086             }
1087             $output .= html_writer::tag('li', $content, array('role' => $role));
1088         }
1089         $output .= html_writer::end_tag('ul');
1090         $output .= html_writer::start_tag('ul', $menu->attributessecondary);
1091         foreach ($menu->get_secondary_actions() as $action) {
1092             if ($action instanceof renderable) {
1093                 $content = $this->render($action);
1094                 $role = 'presentation';
1095             } else {
1096                 $content = $action;
1097                 $role = 'menuitem';
1098             }
1099             $output .= html_writer::tag('li', $content, array('role' => $role));
1100         }
1101         $output .= html_writer::end_tag('ul');
1102         $output .= html_writer::end_tag('div');
1103         return $output;
1104     }
1106     /**
1107      * Renders an action_menu_link item.
1108      *
1109      * @param action_menu_link $action
1110      * @return string HTML fragment
1111      */
1112     protected function render_action_menu_link(action_menu_link $action) {
1114         $comparetoalt = '';
1115         $text = '';
1116         if (!$action->icon || $action->primary === false) {
1117             $text .= html_writer::start_tag('span', array('class'=>'menu-action-text'));
1118             if ($action->text instanceof renderable) {
1119                 $text .= $this->render($action->text);
1120             } else {
1121                 $text .= $action->text;
1122                 $comparetoalt = $action->text;
1123             }
1124             $text .= html_writer::end_tag('span');
1125         }
1127         $icon = '';
1128         if ($action->icon) {
1129             $icon = $action->icon;
1130             if ($action->primary || !$action->actionmenu->will_be_enhanced()) {
1131                 $action->attributes['title'] = $action->text;
1132             }
1133             if ($icon->attributes['alt'] === $comparetoalt && $action->actionmenu->will_be_enhanced()) {
1134                 $icon->attributes['alt'] = ' ';
1135             }
1136             $icon = $this->render($icon);
1137         }
1139         // A disabled link is rendered as formatted text.
1140         if (!empty($action->attributes['disabled'])) {
1141             // Do not use div here due to nesting restriction in xhtml strict.
1142             return html_writer::tag('span', $icon.$text, array('class'=>'currentlink', 'role' => 'menuitem'));
1143         }
1145         $attributes = $action->attributes;
1146         unset($action->attributes['disabled']);
1147         $attributes['href'] = $action->url;
1149         return html_writer::tag('a', $icon.$text, $attributes);
1150     }
1152     /**
1153      * Renders a primary action_menu_link item.
1154      *
1155      * @param action_menu_link_primary $action
1156      * @return string HTML fragment
1157      */
1158     protected function render_action_menu_link_primary(action_menu_link_primary $action) {
1159         return $this->render_action_menu_link($action);
1160     }
1162     /**
1163      * Renders a secondary action_menu_link item.
1164      *
1165      * @param action_menu_link_secondary $action
1166      * @return string HTML fragment
1167      */
1168     protected function render_action_menu_link_secondary(action_menu_link_secondary $action) {
1169         return $this->render_action_menu_link($action);
1170     }
1172     /**
1173      * Prints a nice side block with an optional header.
1174      *
1175      * The content is described
1176      * by a {@link core_renderer::block_contents} object.
1177      *
1178      * <div id="inst{$instanceid}" class="block_{$blockname} block">
1179      *      <div class="header"></div>
1180      *      <div class="content">
1181      *          ...CONTENT...
1182      *          <div class="footer">
1183      *          </div>
1184      *      </div>
1185      *      <div class="annotation">
1186      *      </div>
1187      * </div>
1188      *
1189      * @param block_contents $bc HTML for the content
1190      * @param string $region the region the block is appearing in.
1191      * @return string the HTML to be output.
1192      */
1193     public function block(block_contents $bc, $region) {
1194         $bc = clone($bc); // Avoid messing up the object passed in.
1195         if (empty($bc->blockinstanceid) || !strip_tags($bc->title)) {
1196             $bc->collapsible = block_contents::NOT_HIDEABLE;
1197         }
1198         if (!empty($bc->blockinstanceid)) {
1199             $bc->attributes['data-instanceid'] = $bc->blockinstanceid;
1200         }
1201         $skiptitle = strip_tags($bc->title);
1202         if ($bc->blockinstanceid && !empty($skiptitle)) {
1203             $bc->attributes['aria-labelledby'] = 'instance-'.$bc->blockinstanceid.'-header';
1204         } else if (!empty($bc->arialabel)) {
1205             $bc->attributes['aria-label'] = $bc->arialabel;
1206         }
1207         if ($bc->dockable) {
1208             $bc->attributes['data-dockable'] = 1;
1209         }
1210         if ($bc->collapsible == block_contents::HIDDEN) {
1211             $bc->add_class('hidden');
1212         }
1213         if (!empty($bc->controls)) {
1214             $bc->add_class('block_with_controls');
1215         }
1218         if (empty($skiptitle)) {
1219             $output = '';
1220             $skipdest = '';
1221         } else {
1222             $output = html_writer::tag('a', get_string('skipa', 'access', $skiptitle), array('href' => '#sb-' . $bc->skipid, 'class' => 'skip-block'));
1223             $skipdest = html_writer::tag('span', '', array('id' => 'sb-' . $bc->skipid, 'class' => 'skip-block-to'));
1224         }
1226         $output .= html_writer::start_tag('div', $bc->attributes);
1228         $output .= $this->block_header($bc);
1229         $output .= $this->block_content($bc);
1231         $output .= html_writer::end_tag('div');
1233         $output .= $this->block_annotation($bc);
1235         $output .= $skipdest;
1237         $this->init_block_hider_js($bc);
1238         return $output;
1239     }
1241     /**
1242      * Produces a header for a block
1243      *
1244      * @param block_contents $bc
1245      * @return string
1246      */
1247     protected function block_header(block_contents $bc) {
1249         $title = '';
1250         if ($bc->title) {
1251             $attributes = array();
1252             if ($bc->blockinstanceid) {
1253                 $attributes['id'] = 'instance-'.$bc->blockinstanceid.'-header';
1254             }
1255             $title = html_writer::tag('h2', $bc->title, $attributes);
1256         }
1258         $blockid = null;
1259         if (isset($bc->attributes['id'])) {
1260             $blockid = $bc->attributes['id'];
1261         }
1262         $controlshtml = $this->block_controls($bc->controls, $blockid);
1264         $output = '';
1265         if ($title || $controlshtml) {
1266             $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'));
1267         }
1268         return $output;
1269     }
1271     /**
1272      * Produces the content area for a block
1273      *
1274      * @param block_contents $bc
1275      * @return string
1276      */
1277     protected function block_content(block_contents $bc) {
1278         $output = html_writer::start_tag('div', array('class' => 'content'));
1279         if (!$bc->title && !$this->block_controls($bc->controls)) {
1280             $output .= html_writer::tag('div', '', array('class'=>'block_action notitle'));
1281         }
1282         $output .= $bc->content;
1283         $output .= $this->block_footer($bc);
1284         $output .= html_writer::end_tag('div');
1286         return $output;
1287     }
1289     /**
1290      * Produces the footer for a block
1291      *
1292      * @param block_contents $bc
1293      * @return string
1294      */
1295     protected function block_footer(block_contents $bc) {
1296         $output = '';
1297         if ($bc->footer) {
1298             $output .= html_writer::tag('div', $bc->footer, array('class' => 'footer'));
1299         }
1300         return $output;
1301     }
1303     /**
1304      * Produces the annotation for a block
1305      *
1306      * @param block_contents $bc
1307      * @return string
1308      */
1309     protected function block_annotation(block_contents $bc) {
1310         $output = '';
1311         if ($bc->annotation) {
1312             $output .= html_writer::tag('div', $bc->annotation, array('class' => 'blockannotation'));
1313         }
1314         return $output;
1315     }
1317     /**
1318      * Calls the JS require function to hide a block.
1319      *
1320      * @param block_contents $bc A block_contents object
1321      */
1322     protected function init_block_hider_js(block_contents $bc) {
1323         if (!empty($bc->attributes['id']) and $bc->collapsible != block_contents::NOT_HIDEABLE) {
1324             $config = new stdClass;
1325             $config->id = $bc->attributes['id'];
1326             $config->title = strip_tags($bc->title);
1327             $config->preference = 'block' . $bc->blockinstanceid . 'hidden';
1328             $config->tooltipVisible = get_string('hideblocka', 'access', $config->title);
1329             $config->tooltipHidden = get_string('showblocka', 'access', $config->title);
1331             $this->page->requires->js_init_call('M.util.init_block_hider', array($config));
1332             user_preference_allow_ajax_update($config->preference, PARAM_BOOL);
1333         }
1334     }
1336     /**
1337      * Render the contents of a block_list.
1338      *
1339      * @param array $icons the icon for each item.
1340      * @param array $items the content of each item.
1341      * @return string HTML
1342      */
1343     public function list_block_contents($icons, $items) {
1344         $row = 0;
1345         $lis = array();
1346         foreach ($items as $key => $string) {
1347             $item = html_writer::start_tag('li', array('class' => 'r' . $row));
1348             if (!empty($icons[$key])) { //test if the content has an assigned icon
1349                 $item .= html_writer::tag('div', $icons[$key], array('class' => 'icon column c0'));
1350             }
1351             $item .= html_writer::tag('div', $string, array('class' => 'column c1'));
1352             $item .= html_writer::end_tag('li');
1353             $lis[] = $item;
1354             $row = 1 - $row; // Flip even/odd.
1355         }
1356         return html_writer::tag('ul', implode("\n", $lis), array('class' => 'unlist'));
1357     }
1359     /**
1360      * Output all the blocks in a particular region.
1361      *
1362      * @param string $region the name of a region on this page.
1363      * @return string the HTML to be output.
1364      */
1365     public function blocks_for_region($region) {
1366         $region = $this->page->apply_theme_region_manipulations($region);
1367         $blockcontents = $this->page->blocks->get_content_for_region($region, $this);
1368         $blocks = $this->page->blocks->get_blocks_for_region($region);
1369         $lastblock = null;
1370         $zones = array();
1371         foreach ($blocks as $block) {
1372             $zones[] = $block->title;
1373         }
1374         $output = '';
1376         foreach ($blockcontents as $bc) {
1377             if ($bc instanceof block_contents) {
1378                 $output .= $this->block($bc, $region);
1379                 $lastblock = $bc->title;
1380             } else if ($bc instanceof block_move_target) {
1381                 $output .= $this->block_move_target($bc, $zones, $lastblock);
1382             } else {
1383                 throw new coding_exception('Unexpected type of thing (' . get_class($bc) . ') found in list of block contents.');
1384             }
1385         }
1386         return $output;
1387     }
1389     /**
1390      * Output a place where the block that is currently being moved can be dropped.
1391      *
1392      * @param block_move_target $target with the necessary details.
1393      * @param array $zones array of areas where the block can be moved to
1394      * @param string $previous the block located before the area currently being rendered.
1395      * @return string the HTML to be output.
1396      */
1397     public function block_move_target($target, $zones, $previous) {
1398         if ($previous == null) {
1399             $position = get_string('moveblockbefore', 'block', $zones[0]);
1400         } else {
1401             $position = get_string('moveblockafter', 'block', $previous);
1402         }
1403         return html_writer::tag('a', html_writer::tag('span', $position, array('class' => 'accesshide')), array('href' => $target->url, 'class' => 'blockmovetarget'));
1404     }
1406     /**
1407      * Renders a special html link with attached action
1408      *
1409      * Theme developers: DO NOT OVERRIDE! Please override function
1410      * {@link core_renderer::render_action_link()} instead.
1411      *
1412      * @param string|moodle_url $url
1413      * @param string $text HTML fragment
1414      * @param component_action $action
1415      * @param array $attributes associative array of html link attributes + disabled
1416      * @param pix_icon optional pix icon to render with the link
1417      * @return string HTML fragment
1418      */
1419     public function action_link($url, $text, component_action $action = null, array $attributes = null, $icon = null) {
1420         if (!($url instanceof moodle_url)) {
1421             $url = new moodle_url($url);
1422         }
1423         $link = new action_link($url, $text, $action, $attributes, $icon);
1425         return $this->render($link);
1426     }
1428     /**
1429      * Renders an action_link object.
1430      *
1431      * The provided link is renderer and the HTML returned. At the same time the
1432      * associated actions are setup in JS by {@link core_renderer::add_action_handler()}
1433      *
1434      * @param action_link $link
1435      * @return string HTML fragment
1436      */
1437     protected function render_action_link(action_link $link) {
1438         global $CFG;
1440         $text = '';
1441         if ($link->icon) {
1442             $text .= $this->render($link->icon);
1443         }
1445         if ($link->text instanceof renderable) {
1446             $text .= $this->render($link->text);
1447         } else {
1448             $text .= $link->text;
1449         }
1451         // A disabled link is rendered as formatted text
1452         if (!empty($link->attributes['disabled'])) {
1453             // do not use div here due to nesting restriction in xhtml strict
1454             return html_writer::tag('span', $text, array('class'=>'currentlink'));
1455         }
1457         $attributes = $link->attributes;
1458         unset($link->attributes['disabled']);
1459         $attributes['href'] = $link->url;
1461         if ($link->actions) {
1462             if (empty($attributes['id'])) {
1463                 $id = html_writer::random_id('action_link');
1464                 $attributes['id'] = $id;
1465             } else {
1466                 $id = $attributes['id'];
1467             }
1468             foreach ($link->actions as $action) {
1469                 $this->add_action_handler($action, $id);
1470             }
1471         }
1473         return html_writer::tag('a', $text, $attributes);
1474     }
1477     /**
1478      * Renders an action_icon.
1479      *
1480      * This function uses the {@link core_renderer::action_link()} method for the
1481      * most part. What it does different is prepare the icon as HTML and use it
1482      * as the link text.
1483      *
1484      * Theme developers: If you want to change how action links and/or icons are rendered,
1485      * consider overriding function {@link core_renderer::render_action_link()} and
1486      * {@link core_renderer::render_pix_icon()}.
1487      *
1488      * @param string|moodle_url $url A string URL or moodel_url
1489      * @param pix_icon $pixicon
1490      * @param component_action $action
1491      * @param array $attributes associative array of html link attributes + disabled
1492      * @param bool $linktext show title next to image in link
1493      * @return string HTML fragment
1494      */
1495     public function action_icon($url, pix_icon $pixicon, component_action $action = null, array $attributes = null, $linktext=false) {
1496         if (!($url instanceof moodle_url)) {
1497             $url = new moodle_url($url);
1498         }
1499         $attributes = (array)$attributes;
1501         if (empty($attributes['class'])) {
1502             // let ppl override the class via $options
1503             $attributes['class'] = 'action-icon';
1504         }
1506         $icon = $this->render($pixicon);
1508         if ($linktext) {
1509             $text = $pixicon->attributes['alt'];
1510         } else {
1511             $text = '';
1512         }
1514         return $this->action_link($url, $text.$icon, $action, $attributes);
1515     }
1517    /**
1518     * Print a message along with button choices for Continue/Cancel
1519     *
1520     * If a string or moodle_url is given instead of a single_button, method defaults to post.
1521     *
1522     * @param string $message The question to ask the user
1523     * @param single_button|moodle_url|string $continue The single_button component representing the Continue answer. Can also be a moodle_url or string URL
1524     * @param single_button|moodle_url|string $cancel The single_button component representing the Cancel answer. Can also be a moodle_url or string URL
1525     * @return string HTML fragment
1526     */
1527     public function confirm($message, $continue, $cancel) {
1528         if ($continue instanceof single_button) {
1529             // ok
1530         } else if (is_string($continue)) {
1531             $continue = new single_button(new moodle_url($continue), get_string('continue'), 'post');
1532         } else if ($continue instanceof moodle_url) {
1533             $continue = new single_button($continue, get_string('continue'), 'post');
1534         } else {
1535             throw new coding_exception('The continue param to $OUTPUT->confirm() must be either a URL (string/moodle_url) or a single_button instance.');
1536         }
1538         if ($cancel instanceof single_button) {
1539             // ok
1540         } else if (is_string($cancel)) {
1541             $cancel = new single_button(new moodle_url($cancel), get_string('cancel'), 'get');
1542         } else if ($cancel instanceof moodle_url) {
1543             $cancel = new single_button($cancel, get_string('cancel'), 'get');
1544         } else {
1545             throw new coding_exception('The cancel param to $OUTPUT->confirm() must be either a URL (string/moodle_url) or a single_button instance.');
1546         }
1548         $output = $this->box_start('generalbox', 'notice');
1549         $output .= html_writer::tag('p', $message);
1550         $output .= html_writer::tag('div', $this->render($continue) . $this->render($cancel), array('class' => 'buttons'));
1551         $output .= $this->box_end();
1552         return $output;
1553     }
1555     /**
1556      * Returns a form with a single button.
1557      *
1558      * Theme developers: DO NOT OVERRIDE! Please override function
1559      * {@link core_renderer::render_single_button()} instead.
1560      *
1561      * @param string|moodle_url $url
1562      * @param string $label button text
1563      * @param string $method get or post submit method
1564      * @param array $options associative array {disabled, title, etc.}
1565      * @return string HTML fragment
1566      */
1567     public function single_button($url, $label, $method='post', array $options=null) {
1568         if (!($url instanceof moodle_url)) {
1569             $url = new moodle_url($url);
1570         }
1571         $button = new single_button($url, $label, $method);
1573         foreach ((array)$options as $key=>$value) {
1574             if (array_key_exists($key, $button)) {
1575                 $button->$key = $value;
1576             }
1577         }
1579         return $this->render($button);
1580     }
1582     /**
1583      * Renders a single button widget.
1584      *
1585      * This will return HTML to display a form containing a single button.
1586      *
1587      * @param single_button $button
1588      * @return string HTML fragment
1589      */
1590     protected function render_single_button(single_button $button) {
1591         $attributes = array('type'     => 'submit',
1592                             'value'    => $button->label,
1593                             'disabled' => $button->disabled ? 'disabled' : null,
1594                             'title'    => $button->tooltip);
1596         if ($button->actions) {
1597             $id = html_writer::random_id('single_button');
1598             $attributes['id'] = $id;
1599             foreach ($button->actions as $action) {
1600                 $this->add_action_handler($action, $id);
1601             }
1602         }
1604         // first the input element
1605         $output = html_writer::empty_tag('input', $attributes);
1607         // then hidden fields
1608         $params = $button->url->params();
1609         if ($button->method === 'post') {
1610             $params['sesskey'] = sesskey();
1611         }
1612         foreach ($params as $var => $val) {
1613             $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => $var, 'value' => $val));
1614         }
1616         // then div wrapper for xhtml strictness
1617         $output = html_writer::tag('div', $output);
1619         // now the form itself around it
1620         if ($button->method === 'get') {
1621             $url = $button->url->out_omit_querystring(true); // url without params, the anchor part allowed
1622         } else {
1623             $url = $button->url->out_omit_querystring();     // url without params, the anchor part not allowed
1624         }
1625         if ($url === '') {
1626             $url = '#'; // there has to be always some action
1627         }
1628         $attributes = array('method' => $button->method,
1629                             'action' => $url,
1630                             'id'     => $button->formid);
1631         $output = html_writer::tag('form', $output, $attributes);
1633         // and finally one more wrapper with class
1634         return html_writer::tag('div', $output, array('class' => $button->class));
1635     }
1637     /**
1638      * Returns a form with a single select widget.
1639      *
1640      * Theme developers: DO NOT OVERRIDE! Please override function
1641      * {@link core_renderer::render_single_select()} instead.
1642      *
1643      * @param moodle_url $url form action target, includes hidden fields
1644      * @param string $name name of selection field - the changing parameter in url
1645      * @param array $options list of options
1646      * @param string $selected selected element
1647      * @param array $nothing
1648      * @param string $formid
1649      * @return string HTML fragment
1650      */
1651     public function single_select($url, $name, array $options, $selected = '', $nothing = array('' => 'choosedots'), $formid = null) {
1652         if (!($url instanceof moodle_url)) {
1653             $url = new moodle_url($url);
1654         }
1655         $select = new single_select($url, $name, $options, $selected, $nothing, $formid);
1657         return $this->render($select);
1658     }
1660     /**
1661      * Internal implementation of single_select rendering
1662      *
1663      * @param single_select $select
1664      * @return string HTML fragment
1665      */
1666     protected function render_single_select(single_select $select) {
1667         $select = clone($select);
1668         if (empty($select->formid)) {
1669             $select->formid = html_writer::random_id('single_select_f');
1670         }
1672         $output = '';
1673         $params = $select->url->params();
1674         if ($select->method === 'post') {
1675             $params['sesskey'] = sesskey();
1676         }
1677         foreach ($params as $name=>$value) {
1678             $output .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>$name, 'value'=>$value));
1679         }
1681         if (empty($select->attributes['id'])) {
1682             $select->attributes['id'] = html_writer::random_id('single_select');
1683         }
1685         if ($select->disabled) {
1686             $select->attributes['disabled'] = 'disabled';
1687         }
1689         if ($select->tooltip) {
1690             $select->attributes['title'] = $select->tooltip;
1691         }
1693         $select->attributes['class'] = 'autosubmit';
1694         if ($select->class) {
1695             $select->attributes['class'] .= ' ' . $select->class;
1696         }
1698         if ($select->label) {
1699             $output .= html_writer::label($select->label, $select->attributes['id'], false, $select->labelattributes);
1700         }
1702         if ($select->helpicon instanceof help_icon) {
1703             $output .= $this->render($select->helpicon);
1704         }
1705         $output .= html_writer::select($select->options, $select->name, $select->selected, $select->nothing, $select->attributes);
1707         $go = html_writer::empty_tag('input', array('type'=>'submit', 'value'=>get_string('go')));
1708         $output .= html_writer::tag('noscript', html_writer::tag('div', $go), array('class' => 'inline'));
1710         $nothing = empty($select->nothing) ? false : key($select->nothing);
1711         $this->page->requires->yui_module('moodle-core-formautosubmit',
1712             'M.core.init_formautosubmit',
1713             array(array('selectid' => $select->attributes['id'], 'nothing' => $nothing))
1714         );
1716         // then div wrapper for xhtml strictness
1717         $output = html_writer::tag('div', $output);
1719         // now the form itself around it
1720         if ($select->method === 'get') {
1721             $url = $select->url->out_omit_querystring(true); // url without params, the anchor part allowed
1722         } else {
1723             $url = $select->url->out_omit_querystring();     // url without params, the anchor part not allowed
1724         }
1725         $formattributes = array('method' => $select->method,
1726                                 'action' => $url,
1727                                 'id'     => $select->formid);
1728         $output = html_writer::tag('form', $output, $formattributes);
1730         // and finally one more wrapper with class
1731         return html_writer::tag('div', $output, array('class' => $select->class));
1732     }
1734     /**
1735      * Returns a form with a url select widget.
1736      *
1737      * Theme developers: DO NOT OVERRIDE! Please override function
1738      * {@link core_renderer::render_url_select()} instead.
1739      *
1740      * @param array $urls list of urls - array('/course/view.php?id=1'=>'Frontpage', ....)
1741      * @param string $selected selected element
1742      * @param array $nothing
1743      * @param string $formid
1744      * @return string HTML fragment
1745      */
1746     public function url_select(array $urls, $selected, $nothing = array('' => 'choosedots'), $formid = null) {
1747         $select = new url_select($urls, $selected, $nothing, $formid);
1748         return $this->render($select);
1749     }
1751     /**
1752      * Internal implementation of url_select rendering
1753      *
1754      * @param url_select $select
1755      * @return string HTML fragment
1756      */
1757     protected function render_url_select(url_select $select) {
1758         global $CFG;
1760         $select = clone($select);
1761         if (empty($select->formid)) {
1762             $select->formid = html_writer::random_id('url_select_f');
1763         }
1765         if (empty($select->attributes['id'])) {
1766             $select->attributes['id'] = html_writer::random_id('url_select');
1767         }
1769         if ($select->disabled) {
1770             $select->attributes['disabled'] = 'disabled';
1771         }
1773         if ($select->tooltip) {
1774             $select->attributes['title'] = $select->tooltip;
1775         }
1777         $output = '';
1779         if ($select->label) {
1780             $output .= html_writer::label($select->label, $select->attributes['id'], false, $select->labelattributes);
1781         }
1783         $classes = array();
1784         if (!$select->showbutton) {
1785             $classes[] = 'autosubmit';
1786         }
1787         if ($select->class) {
1788             $classes[] = $select->class;
1789         }
1790         if (count($classes)) {
1791             $select->attributes['class'] = implode(' ', $classes);
1792         }
1794         if ($select->helpicon instanceof help_icon) {
1795             $output .= $this->render($select->helpicon);
1796         }
1798         // For security reasons, the script course/jumpto.php requires URL starting with '/'. To keep
1799         // backward compatibility, we are removing heading $CFG->wwwroot from URLs here.
1800         $urls = array();
1801         foreach ($select->urls as $k=>$v) {
1802             if (is_array($v)) {
1803                 // optgroup structure
1804                 foreach ($v as $optgrouptitle => $optgroupoptions) {
1805                     foreach ($optgroupoptions as $optionurl => $optiontitle) {
1806                         if (empty($optionurl)) {
1807                             $safeoptionurl = '';
1808                         } else if (strpos($optionurl, $CFG->wwwroot.'/') === 0) {
1809                             // debugging('URLs passed to url_select should be in local relative form - please fix the code.', DEBUG_DEVELOPER);
1810                             $safeoptionurl = str_replace($CFG->wwwroot, '', $optionurl);
1811                         } else if (strpos($optionurl, '/') !== 0) {
1812                             debugging("Invalid url_select urls parameter inside optgroup: url '$optionurl' is not local relative url!");
1813                             continue;
1814                         } else {
1815                             $safeoptionurl = $optionurl;
1816                         }
1817                         $urls[$k][$optgrouptitle][$safeoptionurl] = $optiontitle;
1818                     }
1819                 }
1820             } else {
1821                 // plain list structure
1822                 if (empty($k)) {
1823                     // nothing selected option
1824                 } else if (strpos($k, $CFG->wwwroot.'/') === 0) {
1825                     $k = str_replace($CFG->wwwroot, '', $k);
1826                 } else if (strpos($k, '/') !== 0) {
1827                     debugging("Invalid url_select urls parameter: url '$k' is not local relative url!");
1828                     continue;
1829                 }
1830                 $urls[$k] = $v;
1831             }
1832         }
1833         $selected = $select->selected;
1834         if (!empty($selected)) {
1835             if (strpos($select->selected, $CFG->wwwroot.'/') === 0) {
1836                 $selected = str_replace($CFG->wwwroot, '', $selected);
1837             } else if (strpos($selected, '/') !== 0) {
1838                 debugging("Invalid value of parameter 'selected': url '$selected' is not local relative url!");
1839             }
1840         }
1842         $output .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'sesskey', 'value'=>sesskey()));
1843         $output .= html_writer::select($urls, 'jump', $selected, $select->nothing, $select->attributes);
1845         if (!$select->showbutton) {
1846             $go = html_writer::empty_tag('input', array('type'=>'submit', 'value'=>get_string('go')));
1847             $output .= html_writer::tag('noscript', html_writer::tag('div', $go), array('class' => 'inline'));
1848             $nothing = empty($select->nothing) ? false : key($select->nothing);
1849             $this->page->requires->yui_module('moodle-core-formautosubmit',
1850                 'M.core.init_formautosubmit',
1851                 array(array('selectid' => $select->attributes['id'], 'nothing' => $nothing))
1852             );
1853         } else {
1854             $output .= html_writer::empty_tag('input', array('type'=>'submit', 'value'=>$select->showbutton));
1855         }
1857         // then div wrapper for xhtml strictness
1858         $output = html_writer::tag('div', $output);
1860         // now the form itself around it
1861         $formattributes = array('method' => 'post',
1862                                 'action' => new moodle_url('/course/jumpto.php'),
1863                                 'id'     => $select->formid);
1864         $output = html_writer::tag('form', $output, $formattributes);
1866         // and finally one more wrapper with class
1867         return html_writer::tag('div', $output, array('class' => $select->class));
1868     }
1870     /**
1871      * Returns a string containing a link to the user documentation.
1872      * Also contains an icon by default. Shown to teachers and admin only.
1873      *
1874      * @param string $path The page link after doc root and language, no leading slash.
1875      * @param string $text The text to be displayed for the link
1876      * @param boolean $forcepopup Whether to force a popup regardless of the value of $CFG->doctonewwindow
1877      * @return string
1878      */
1879     public function doc_link($path, $text = '', $forcepopup = false) {
1880         global $CFG;
1882         $icon = $this->pix_icon('docs', $text, 'moodle', array('class'=>'iconhelp icon-pre'));
1884         $url = new moodle_url(get_docs_url($path));
1886         $attributes = array('href'=>$url);
1887         if (!empty($CFG->doctonewwindow) || $forcepopup) {
1888             $attributes['class'] = 'helplinkpopup';
1889         }
1891         return html_writer::tag('a', $icon.$text, $attributes);
1892     }
1894     /**
1895      * Return HTML for a pix_icon.
1896      *
1897      * Theme developers: DO NOT OVERRIDE! Please override function
1898      * {@link core_renderer::render_pix_icon()} instead.
1899      *
1900      * @param string $pix short pix name
1901      * @param string $alt mandatory alt attribute
1902      * @param string $component standard compoennt name like 'moodle', 'mod_forum', etc.
1903      * @param array $attributes htm lattributes
1904      * @return string HTML fragment
1905      */
1906     public function pix_icon($pix, $alt, $component='moodle', array $attributes = null) {
1907         $icon = new pix_icon($pix, $alt, $component, $attributes);
1908         return $this->render($icon);
1909     }
1911     /**
1912      * Renders a pix_icon widget and returns the HTML to display it.
1913      *
1914      * @param pix_icon $icon
1915      * @return string HTML fragment
1916      */
1917     protected function render_pix_icon(pix_icon $icon) {
1918         $attributes = $icon->attributes;
1919         $attributes['src'] = $this->pix_url($icon->pix, $icon->component);
1920         return html_writer::empty_tag('img', $attributes);
1921     }
1923     /**
1924      * Return HTML to display an emoticon icon.
1925      *
1926      * @param pix_emoticon $emoticon
1927      * @return string HTML fragment
1928      */
1929     protected function render_pix_emoticon(pix_emoticon $emoticon) {
1930         $attributes = $emoticon->attributes;
1931         $attributes['src'] = $this->pix_url($emoticon->pix, $emoticon->component);
1932         return html_writer::empty_tag('img', $attributes);
1933     }
1935     /**
1936      * Produces the html that represents this rating in the UI
1937      *
1938      * @param rating $rating the page object on which this rating will appear
1939      * @return string
1940      */
1941     function render_rating(rating $rating) {
1942         global $CFG, $USER;
1944         if ($rating->settings->aggregationmethod == RATING_AGGREGATE_NONE) {
1945             return null;//ratings are turned off
1946         }
1948         $ratingmanager = new rating_manager();
1949         // Initialise the JavaScript so ratings can be done by AJAX.
1950         $ratingmanager->initialise_rating_javascript($this->page);
1952         $strrate = get_string("rate", "rating");
1953         $ratinghtml = ''; //the string we'll return
1955         // permissions check - can they view the aggregate?
1956         if ($rating->user_can_view_aggregate()) {
1958             $aggregatelabel = $ratingmanager->get_aggregate_label($rating->settings->aggregationmethod);
1959             $aggregatestr   = $rating->get_aggregate_string();
1961             $aggregatehtml  = html_writer::tag('span', $aggregatestr, array('id' => 'ratingaggregate'.$rating->itemid, 'class' => 'ratingaggregate')).' ';
1962             if ($rating->count > 0) {
1963                 $countstr = "({$rating->count})";
1964             } else {
1965                 $countstr = '-';
1966             }
1967             $aggregatehtml .= html_writer::tag('span', $countstr, array('id'=>"ratingcount{$rating->itemid}", 'class' => 'ratingcount')).' ';
1969             $ratinghtml .= html_writer::tag('span', $aggregatelabel, array('class'=>'rating-aggregate-label'));
1970             if ($rating->settings->permissions->viewall && $rating->settings->pluginpermissions->viewall) {
1972                 $nonpopuplink = $rating->get_view_ratings_url();
1973                 $popuplink = $rating->get_view_ratings_url(true);
1975                 $action = new popup_action('click', $popuplink, 'ratings', array('height' => 400, 'width' => 600));
1976                 $ratinghtml .= $this->action_link($nonpopuplink, $aggregatehtml, $action);
1977             } else {
1978                 $ratinghtml .= $aggregatehtml;
1979             }
1980         }
1982         $formstart = null;
1983         // if the item doesn't belong to the current user, the user has permission to rate
1984         // and we're within the assessable period
1985         if ($rating->user_can_rate()) {
1987             $rateurl = $rating->get_rate_url();
1988             $inputs = $rateurl->params();
1990             //start the rating form
1991             $formattrs = array(
1992                 'id'     => "postrating{$rating->itemid}",
1993                 'class'  => 'postratingform',
1994                 'method' => 'post',
1995                 'action' => $rateurl->out_omit_querystring()
1996             );
1997             $formstart  = html_writer::start_tag('form', $formattrs);
1998             $formstart .= html_writer::start_tag('div', array('class' => 'ratingform'));
2000             // add the hidden inputs
2001             foreach ($inputs as $name => $value) {
2002                 $attributes = array('type' => 'hidden', 'class' => 'ratinginput', 'name' => $name, 'value' => $value);
2003                 $formstart .= html_writer::empty_tag('input', $attributes);
2004             }
2006             if (empty($ratinghtml)) {
2007                 $ratinghtml .= $strrate.': ';
2008             }
2009             $ratinghtml = $formstart.$ratinghtml;
2011             $scalearray = array(RATING_UNSET_RATING => $strrate.'...') + $rating->settings->scale->scaleitems;
2012             $scaleattrs = array('class'=>'postratingmenu ratinginput','id'=>'menurating'.$rating->itemid);
2013             $ratinghtml .= html_writer::label($rating->rating, 'menurating'.$rating->itemid, false, array('class' => 'accesshide'));
2014             $ratinghtml .= html_writer::select($scalearray, 'rating', $rating->rating, false, $scaleattrs);
2016             //output submit button
2017             $ratinghtml .= html_writer::start_tag('span', array('class'=>"ratingsubmit"));
2019             $attributes = array('type' => 'submit', 'class' => 'postratingmenusubmit', 'id' => 'postratingsubmit'.$rating->itemid, 'value' => s(get_string('rate', 'rating')));
2020             $ratinghtml .= html_writer::empty_tag('input', $attributes);
2022             if (!$rating->settings->scale->isnumeric) {
2023                 // If a global scale, try to find current course ID from the context
2024                 if (empty($rating->settings->scale->courseid) and $coursecontext = $rating->context->get_course_context(false)) {
2025                     $courseid = $coursecontext->instanceid;
2026                 } else {
2027                     $courseid = $rating->settings->scale->courseid;
2028                 }
2029                 $ratinghtml .= $this->help_icon_scale($courseid, $rating->settings->scale);
2030             }
2031             $ratinghtml .= html_writer::end_tag('span');
2032             $ratinghtml .= html_writer::end_tag('div');
2033             $ratinghtml .= html_writer::end_tag('form');
2034         }
2036         return $ratinghtml;
2037     }
2039     /**
2040      * Centered heading with attached help button (same title text)
2041      * and optional icon attached.
2042      *
2043      * @param string $text A heading text
2044      * @param string $helpidentifier The keyword that defines a help page
2045      * @param string $component component name
2046      * @param string|moodle_url $icon
2047      * @param string $iconalt icon alt text
2048      * @param int $level The level of importance of the heading. Defaulting to 2
2049      * @param string $classnames A space-separated list of CSS classes. Defaulting to null
2050      * @return string HTML fragment
2051      */
2052     public function heading_with_help($text, $helpidentifier, $component = 'moodle', $icon = '', $iconalt = '', $level = 2, $classnames = null) {
2053         $image = '';
2054         if ($icon) {
2055             $image = $this->pix_icon($icon, $iconalt, $component, array('class'=>'icon'));
2056         }
2058         $help = '';
2059         if ($helpidentifier) {
2060             $help = $this->help_icon($helpidentifier, $component);
2061         }
2063         return $this->heading($image.$text.$help, $level, $classnames);
2064     }
2066     /**
2067      * Returns HTML to display a help icon.
2068      *
2069      * @deprecated since Moodle 2.0
2070      */
2071     public function old_help_icon($helpidentifier, $title, $component = 'moodle', $linktext = '') {
2072         throw new coding_exception('old_help_icon() can not be used any more, please see help_icon().');
2073     }
2075     /**
2076      * Returns HTML to display a help icon.
2077      *
2078      * Theme developers: DO NOT OVERRIDE! Please override function
2079      * {@link core_renderer::render_help_icon()} instead.
2080      *
2081      * @param string $identifier The keyword that defines a help page
2082      * @param string $component component name
2083      * @param string|bool $linktext true means use $title as link text, string means link text value
2084      * @return string HTML fragment
2085      */
2086     public function help_icon($identifier, $component = 'moodle', $linktext = '') {
2087         $icon = new help_icon($identifier, $component);
2088         $icon->diag_strings();
2089         if ($linktext === true) {
2090             $icon->linktext = get_string($icon->identifier, $icon->component);
2091         } else if (!empty($linktext)) {
2092             $icon->linktext = $linktext;
2093         }
2094         return $this->render($icon);
2095     }
2097     /**
2098      * Implementation of user image rendering.
2099      *
2100      * @param help_icon $helpicon A help icon instance
2101      * @return string HTML fragment
2102      */
2103     protected function render_help_icon(help_icon $helpicon) {
2104         global $CFG;
2106         // first get the help image icon
2107         $src = $this->pix_url('help');
2109         $title = get_string($helpicon->identifier, $helpicon->component);
2111         if (empty($helpicon->linktext)) {
2112             $alt = get_string('helpprefix2', '', trim($title, ". \t"));
2113         } else {
2114             $alt = get_string('helpwiththis');
2115         }
2117         $attributes = array('src'=>$src, 'alt'=>$alt, 'class'=>'iconhelp');
2118         $output = html_writer::empty_tag('img', $attributes);
2120         // add the link text if given
2121         if (!empty($helpicon->linktext)) {
2122             // the spacing has to be done through CSS
2123             $output .= $helpicon->linktext;
2124         }
2126         // now create the link around it - we need https on loginhttps pages
2127         $url = new moodle_url($CFG->httpswwwroot.'/help.php', array('component' => $helpicon->component, 'identifier' => $helpicon->identifier, 'lang'=>current_language()));
2129         // note: this title is displayed only if JS is disabled, otherwise the link will have the new ajax tooltip
2130         $title = get_string('helpprefix2', '', trim($title, ". \t"));
2132         $attributes = array('href' => $url, 'title' => $title, 'aria-haspopup' => 'true', 'target'=>'_blank');
2133         $output = html_writer::tag('a', $output, $attributes);
2135         // and finally span
2136         return html_writer::tag('span', $output, array('class' => 'helptooltip'));
2137     }
2139     /**
2140      * Returns HTML to display a scale help icon.
2141      *
2142      * @param int $courseid
2143      * @param stdClass $scale instance
2144      * @return string HTML fragment
2145      */
2146     public function help_icon_scale($courseid, stdClass $scale) {
2147         global $CFG;
2149         $title = get_string('helpprefix2', '', $scale->name) .' ('.get_string('newwindow').')';
2151         $icon = $this->pix_icon('help', get_string('scales'), 'moodle', array('class'=>'iconhelp'));
2153         $scaleid = abs($scale->id);
2155         $link = new moodle_url('/course/scales.php', array('id' => $courseid, 'list' => true, 'scaleid' => $scaleid));
2156         $action = new popup_action('click', $link, 'ratingscale');
2158         return html_writer::tag('span', $this->action_link($link, $icon, $action), array('class' => 'helplink'));
2159     }
2161     /**
2162      * Creates and returns a spacer image with optional line break.
2163      *
2164      * @param array $attributes Any HTML attributes to add to the spaced.
2165      * @param bool $br Include a BR after the spacer.... DON'T USE THIS. Don't be
2166      *     laxy do it with CSS which is a much better solution.
2167      * @return string HTML fragment
2168      */
2169     public function spacer(array $attributes = null, $br = false) {
2170         $attributes = (array)$attributes;
2171         if (empty($attributes['width'])) {
2172             $attributes['width'] = 1;
2173         }
2174         if (empty($attributes['height'])) {
2175             $attributes['height'] = 1;
2176         }
2177         $attributes['class'] = 'spacer';
2179         $output = $this->pix_icon('spacer', '', 'moodle', $attributes);
2181         if (!empty($br)) {
2182             $output .= '<br />';
2183         }
2185         return $output;
2186     }
2188     /**
2189      * Returns HTML to display the specified user's avatar.
2190      *
2191      * User avatar may be obtained in two ways:
2192      * <pre>
2193      * // Option 1: (shortcut for simple cases, preferred way)
2194      * // $user has come from the DB and has fields id, picture, imagealt, firstname and lastname
2195      * $OUTPUT->user_picture($user, array('popup'=>true));
2196      *
2197      * // Option 2:
2198      * $userpic = new user_picture($user);
2199      * // Set properties of $userpic
2200      * $userpic->popup = true;
2201      * $OUTPUT->render($userpic);
2202      * </pre>
2203      *
2204      * Theme developers: DO NOT OVERRIDE! Please override function
2205      * {@link core_renderer::render_user_picture()} instead.
2206      *
2207      * @param stdClass $user Object with at least fields id, picture, imagealt, firstname, lastname
2208      *     If any of these are missing, the database is queried. Avoid this
2209      *     if at all possible, particularly for reports. It is very bad for performance.
2210      * @param array $options associative array with user picture options, used only if not a user_picture object,
2211      *     options are:
2212      *     - courseid=$this->page->course->id (course id of user profile in link)
2213      *     - size=35 (size of image)
2214      *     - link=true (make image clickable - the link leads to user profile)
2215      *     - popup=false (open in popup)
2216      *     - alttext=true (add image alt attribute)
2217      *     - class = image class attribute (default 'userpicture')
2218      * @return string HTML fragment
2219      */
2220     public function user_picture(stdClass $user, array $options = null) {
2221         $userpicture = new user_picture($user);
2222         foreach ((array)$options as $key=>$value) {
2223             if (array_key_exists($key, $userpicture)) {
2224                 $userpicture->$key = $value;
2225             }
2226         }
2227         return $this->render($userpicture);
2228     }
2230     /**
2231      * Internal implementation of user image rendering.
2232      *
2233      * @param user_picture $userpicture
2234      * @return string
2235      */
2236     protected function render_user_picture(user_picture $userpicture) {
2237         global $CFG, $DB;
2239         $user = $userpicture->user;
2241         if ($userpicture->alttext) {
2242             if (!empty($user->imagealt)) {
2243                 $alt = $user->imagealt;
2244             } else {
2245                 $alt = get_string('pictureof', '', fullname($user));
2246             }
2247         } else {
2248             $alt = '';
2249         }
2251         if (empty($userpicture->size)) {
2252             $size = 35;
2253         } else if ($userpicture->size === true or $userpicture->size == 1) {
2254             $size = 100;
2255         } else {
2256             $size = $userpicture->size;
2257         }
2259         $class = $userpicture->class;
2261         if ($user->picture == 0) {
2262             $class .= ' defaultuserpic';
2263         }
2265         $src = $userpicture->get_url($this->page, $this);
2267         $attributes = array('src'=>$src, 'alt'=>$alt, 'title'=>$alt, 'class'=>$class, 'width'=>$size, 'height'=>$size);
2269         // get the image html output fisrt
2270         $output = html_writer::empty_tag('img', $attributes);
2272         // then wrap it in link if needed
2273         if (!$userpicture->link) {
2274             return $output;
2275         }
2277         if (empty($userpicture->courseid)) {
2278             $courseid = $this->page->course->id;
2279         } else {
2280             $courseid = $userpicture->courseid;
2281         }
2283         if ($courseid == SITEID) {
2284             $url = new moodle_url('/user/profile.php', array('id' => $user->id));
2285         } else {
2286             $url = new moodle_url('/user/view.php', array('id' => $user->id, 'course' => $courseid));
2287         }
2289         $attributes = array('href'=>$url);
2291         if ($userpicture->popup) {
2292             $id = html_writer::random_id('userpicture');
2293             $attributes['id'] = $id;
2294             $this->add_action_handler(new popup_action('click', $url), $id);
2295         }
2297         return html_writer::tag('a', $output, $attributes);
2298     }
2300     /**
2301      * Internal implementation of file tree viewer items rendering.
2302      *
2303      * @param array $dir
2304      * @return string
2305      */
2306     public function htmllize_file_tree($dir) {
2307         if (empty($dir['subdirs']) and empty($dir['files'])) {
2308             return '';
2309         }
2310         $result = '<ul>';
2311         foreach ($dir['subdirs'] as $subdir) {
2312             $result .= '<li>'.s($subdir['dirname']).' '.$this->htmllize_file_tree($subdir).'</li>';
2313         }
2314         foreach ($dir['files'] as $file) {
2315             $filename = $file->get_filename();
2316             $result .= '<li><span>'.html_writer::link($file->fileurl, $filename).'</span></li>';
2317         }
2318         $result .= '</ul>';
2320         return $result;
2321     }
2323     /**
2324      * Returns HTML to display the file picker
2325      *
2326      * <pre>
2327      * $OUTPUT->file_picker($options);
2328      * </pre>
2329      *
2330      * Theme developers: DO NOT OVERRIDE! Please override function
2331      * {@link core_renderer::render_file_picker()} instead.
2332      *
2333      * @param array $options associative array with file manager options
2334      *   options are:
2335      *       maxbytes=>-1,
2336      *       itemid=>0,
2337      *       client_id=>uniqid(),
2338      *       acepted_types=>'*',
2339      *       return_types=>FILE_INTERNAL,
2340      *       context=>$PAGE->context
2341      * @return string HTML fragment
2342      */
2343     public function file_picker($options) {
2344         $fp = new file_picker($options);
2345         return $this->render($fp);
2346     }
2348     /**
2349      * Internal implementation of file picker rendering.
2350      *
2351      * @param file_picker $fp
2352      * @return string
2353      */
2354     public function render_file_picker(file_picker $fp) {
2355         global $CFG, $OUTPUT, $USER;
2356         $options = $fp->options;
2357         $client_id = $options->client_id;
2358         $strsaved = get_string('filesaved', 'repository');
2359         $straddfile = get_string('openpicker', 'repository');
2360         $strloading  = get_string('loading', 'repository');
2361         $strdndenabled = get_string('dndenabled_inbox', 'moodle');
2362         $strdroptoupload = get_string('droptoupload', 'moodle');
2363         $icon_progress = $OUTPUT->pix_icon('i/loading_small', $strloading).'';
2365         $currentfile = $options->currentfile;
2366         if (empty($currentfile)) {
2367             $currentfile = '';
2368         } else {
2369             $currentfile .= ' - ';
2370         }
2371         if ($options->maxbytes) {
2372             $size = $options->maxbytes;
2373         } else {
2374             $size = get_max_upload_file_size();
2375         }
2376         if ($size == -1) {
2377             $maxsize = '';
2378         } else {
2379             $maxsize = get_string('maxfilesize', 'moodle', display_size($size));
2380         }
2381         if ($options->buttonname) {
2382             $buttonname = ' name="' . $options->buttonname . '"';
2383         } else {
2384             $buttonname = '';
2385         }
2386         $html = <<<EOD
2387 <div class="filemanager-loading mdl-align" id='filepicker-loading-{$client_id}'>
2388 $icon_progress
2389 </div>
2390 <div id="filepicker-wrapper-{$client_id}" class="mdl-left" style="display:none">
2391     <div>
2392         <input type="button" class="fp-btn-choose" id="filepicker-button-{$client_id}" value="{$straddfile}"{$buttonname}/>
2393         <span> $maxsize </span>
2394     </div>
2395 EOD;
2396         if ($options->env != 'url') {
2397             $html .= <<<EOD
2398     <div id="file_info_{$client_id}" class="mdl-left filepicker-filelist" style="position: relative">
2399     <div class="filepicker-filename">
2400         <div class="filepicker-container">$currentfile<div class="dndupload-message">$strdndenabled <br/><div class="dndupload-arrow"></div></div></div>
2401         <div class="dndupload-progressbars"></div>
2402     </div>
2403     <div><div class="dndupload-target">{$strdroptoupload}<br/><div class="dndupload-arrow"></div></div></div>
2404     </div>
2405 EOD;
2406         }
2407         $html .= '</div>';
2408         return $html;
2409     }
2411     /**
2412      * Returns HTML to display the 'Update this Modulename' button that appears on module pages.
2413      *
2414      * @param string $cmid the course_module id.
2415      * @param string $modulename the module name, eg. "forum", "quiz" or "workshop"
2416      * @return string the HTML for the button, if this user has permission to edit it, else an empty string.
2417      */
2418     public function update_module_button($cmid, $modulename) {
2419         global $CFG;
2420         if (has_capability('moodle/course:manageactivities', context_module::instance($cmid))) {
2421             $modulename = get_string('modulename', $modulename);
2422             $string = get_string('updatethis', '', $modulename);
2423             $url = new moodle_url("$CFG->wwwroot/course/mod.php", array('update' => $cmid, 'return' => true, 'sesskey' => sesskey()));
2424             return $this->single_button($url, $string);
2425         } else {
2426             return '';
2427         }
2428     }
2430     /**
2431      * Returns HTML to display a "Turn editing on/off" button in a form.
2432      *
2433      * @param moodle_url $url The URL + params to send through when clicking the button
2434      * @return string HTML the button
2435      */
2436     public function edit_button(moodle_url $url) {
2438         $url->param('sesskey', sesskey());
2439         if ($this->page->user_is_editing()) {
2440             $url->param('edit', 'off');
2441             $editstring = get_string('turneditingoff');
2442         } else {
2443             $url->param('edit', 'on');
2444             $editstring = get_string('turneditingon');
2445         }
2447         return $this->single_button($url, $editstring);
2448     }
2450     /**
2451      * Returns HTML to display a simple button to close a window
2452      *
2453      * @param string $text The lang string for the button's label (already output from get_string())
2454      * @return string html fragment
2455      */
2456     public function close_window_button($text='') {
2457         if (empty($text)) {
2458             $text = get_string('closewindow');
2459         }
2460         $button = new single_button(new moodle_url('#'), $text, 'get');
2461         $button->add_action(new component_action('click', 'close_window'));
2463         return $this->container($this->render($button), 'closewindow');
2464     }
2466     /**
2467      * Output an error message. By default wraps the error message in <span class="error">.
2468      * If the error message is blank, nothing is output.
2469      *
2470      * @param string $message the error message.
2471      * @return string the HTML to output.
2472      */
2473     public function error_text($message) {
2474         if (empty($message)) {
2475             return '';
2476         }
2477         $message = $this->pix_icon('i/warning', get_string('error'), '', array('class' => 'icon icon-pre', 'title'=>'')) . $message;
2478         return html_writer::tag('span', $message, array('class' => 'error'));
2479     }
2481     /**
2482      * Do not call this function directly.
2483      *
2484      * To terminate the current script with a fatal error, call the {@link print_error}
2485      * function, or throw an exception. Doing either of those things will then call this
2486      * function to display the error, before terminating the execution.
2487      *
2488      * @param string $message The message to output
2489      * @param string $moreinfourl URL where more info can be found about the error
2490      * @param string $link Link for the Continue button
2491      * @param array $backtrace The execution backtrace
2492      * @param string $debuginfo Debugging information
2493      * @return string the HTML to output.
2494      */
2495     public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
2496         global $CFG;
2498         $output = '';
2499         $obbuffer = '';
2501         if ($this->has_started()) {
2502             // we can not always recover properly here, we have problems with output buffering,
2503             // html tables, etc.
2504             $output .= $this->opencontainers->pop_all_but_last();
2506         } else {
2507             // It is really bad if library code throws exception when output buffering is on,
2508             // because the buffered text would be printed before our start of page.
2509             // NOTE: this hack might be behave unexpectedly in case output buffering is enabled in PHP.ini
2510             error_reporting(0); // disable notices from gzip compression, etc.
2511             while (ob_get_level() > 0) {
2512                 $buff = ob_get_clean();
2513                 if ($buff === false) {
2514                     break;
2515                 }
2516                 $obbuffer .= $buff;
2517             }
2518             error_reporting($CFG->debug);
2520             // Output not yet started.
2521             $protocol = (isset($_SERVER['SERVER_PROTOCOL']) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0');
2522             if (empty($_SERVER['HTTP_RANGE'])) {
2523                 @header($protocol . ' 404 Not Found');
2524             } else {
2525                 // Must stop byteserving attempts somehow,
2526                 // this is weird but Chrome PDF viewer can be stopped only with 407!
2527                 @header($protocol . ' 407 Proxy Authentication Required');
2528             }
2530             $this->page->set_context(null); // ugly hack - make sure page context is set to something, we do not want bogus warnings here
2531             $this->page->set_url('/'); // no url
2532             //$this->page->set_pagelayout('base'); //TODO: MDL-20676 blocks on error pages are weird, unfortunately it somehow detect the pagelayout from URL :-(
2533             $this->page->set_title(get_string('error'));
2534             $this->page->set_heading($this->page->course->fullname);
2535             $output .= $this->header();
2536         }
2538         $message = '<p class="errormessage">' . $message . '</p>'.
2539                 '<p class="errorcode"><a href="' . $moreinfourl . '">' .
2540                 get_string('moreinformation') . '</a></p>';
2541         if (empty($CFG->rolesactive)) {
2542             $message .= '<p class="errormessage">' . get_string('installproblem', 'error') . '</p>';
2543             //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.
2544         }
2545         $output .= $this->box($message, 'errorbox', null, array('data-rel' => 'fatalerror'));
2547         if ($CFG->debugdeveloper) {
2548             if (!empty($debuginfo)) {
2549                 $debuginfo = s($debuginfo); // removes all nasty JS
2550                 $debuginfo = str_replace("\n", '<br />', $debuginfo); // keep newlines
2551                 $output .= $this->notification('<strong>Debug info:</strong> '.$debuginfo, 'notifytiny');
2552             }
2553             if (!empty($backtrace)) {
2554                 $output .= $this->notification('<strong>Stack trace:</strong> '.format_backtrace($backtrace), 'notifytiny');
2555             }
2556             if ($obbuffer !== '' ) {
2557                 $output .= $this->notification('<strong>Output buffer:</strong> '.s($obbuffer), 'notifytiny');
2558             }
2559         }
2561         if (empty($CFG->rolesactive)) {
2562             // continue does not make much sense if moodle is not installed yet because error is most probably not recoverable
2563         } else if (!empty($link)) {
2564             $output .= $this->continue_button($link);
2565         }
2567         $output .= $this->footer();
2569         // Padding to encourage IE to display our error page, rather than its own.
2570         $output .= str_repeat(' ', 512);
2572         return $output;
2573     }
2575     /**
2576      * Output a notification (that is, a status message about something that has
2577      * just happened).
2578      *
2579      * @param string $message the message to print out
2580      * @param string $classes normally 'notifyproblem' or 'notifysuccess'.
2581      * @return string the HTML to output.
2582      */
2583     public function notification($message, $classes = 'notifyproblem') {
2584         return html_writer::tag('div', clean_text($message), array('class' => renderer_base::prepare_classes($classes)));
2585     }
2587     /**
2588      * Returns HTML to display a continue button that goes to a particular URL.
2589      *
2590      * @param string|moodle_url $url The url the button goes to.
2591      * @return string the HTML to output.
2592      */
2593     public function continue_button($url) {
2594         if (!($url instanceof moodle_url)) {
2595             $url = new moodle_url($url);
2596         }
2597         $button = new single_button($url, get_string('continue'), 'get');
2598         $button->class = 'continuebutton';
2600         return $this->render($button);
2601     }
2603     /**
2604      * Returns HTML to display a single paging bar to provide access to other pages  (usually in a search)
2605      *
2606      * Theme developers: DO NOT OVERRIDE! Please override function
2607      * {@link core_renderer::render_paging_bar()} instead.
2608      *
2609      * @param int $totalcount The total number of entries available to be paged through
2610      * @param int $page The page you are currently viewing
2611      * @param int $perpage The number of entries that should be shown per page
2612      * @param string|moodle_url $baseurl url of the current page, the $pagevar parameter is added
2613      * @param string $pagevar name of page parameter that holds the page number
2614      * @return string the HTML to output.
2615      */
2616     public function paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar = 'page') {
2617         $pb = new paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar);
2618         return $this->render($pb);
2619     }
2621     /**
2622      * Internal implementation of paging bar rendering.
2623      *
2624      * @param paging_bar $pagingbar
2625      * @return string
2626      */
2627     protected function render_paging_bar(paging_bar $pagingbar) {
2628         $output = '';
2629         $pagingbar = clone($pagingbar);
2630         $pagingbar->prepare($this, $this->page, $this->target);
2632         if ($pagingbar->totalcount > $pagingbar->perpage) {
2633             $output .= get_string('page') . ':';
2635             if (!empty($pagingbar->previouslink)) {
2636                 $output .= '&#160;(' . $pagingbar->previouslink . ')&#160;';
2637             }
2639             if (!empty($pagingbar->firstlink)) {
2640                 $output .= '&#160;' . $pagingbar->firstlink . '&#160;...';
2641             }
2643             foreach ($pagingbar->pagelinks as $link) {
2644                 $output .= "&#160;&#160;$link";
2645             }
2647             if (!empty($pagingbar->lastlink)) {
2648                 $output .= '&#160;...' . $pagingbar->lastlink . '&#160;';
2649             }
2651             if (!empty($pagingbar->nextlink)) {
2652                 $output .= '&#160;&#160;(' . $pagingbar->nextlink . ')';
2653             }
2654         }
2656         return html_writer::tag('div', $output, array('class' => 'paging'));
2657     }
2659     /**
2660      * Output the place a skip link goes to.
2661      *
2662      * @param string $id The target name from the corresponding $PAGE->requires->skip_link_to($target) call.
2663      * @return string the HTML to output.
2664      */
2665     public function skip_link_target($id = null) {
2666         return html_writer::tag('span', '', array('id' => $id));
2667     }
2669     /**
2670      * Outputs a heading
2671      *
2672      * @param string $text The text of the heading
2673      * @param int $level The level of importance of the heading. Defaulting to 2
2674      * @param string $classes A space-separated list of CSS classes. Defaulting to null
2675      * @param string $id An optional ID
2676      * @return string the HTML to output.
2677      */
2678     public function heading($text, $level = 2, $classes = null, $id = null) {
2679         $level = (integer) $level;
2680         if ($level < 1 or $level > 6) {
2681             throw new coding_exception('Heading level must be an integer between 1 and 6.');
2682         }
2683         return html_writer::tag('h' . $level, $text, array('id' => $id, 'class' => renderer_base::prepare_classes($classes)));
2684     }
2686     /**
2687      * Outputs a box.
2688      *
2689      * @param string $contents The contents of the box
2690      * @param string $classes A space-separated list of CSS classes
2691      * @param string $id An optional ID
2692      * @param array $attributes An array of other attributes to give the box.
2693      * @return string the HTML to output.
2694      */
2695     public function box($contents, $classes = 'generalbox', $id = null, $attributes = array()) {
2696         return $this->box_start($classes, $id, $attributes) . $contents . $this->box_end();
2697     }
2699     /**
2700      * Outputs the opening section of a box.
2701      *
2702      * @param string $classes A space-separated list of CSS classes
2703      * @param string $id An optional ID
2704      * @param array $attributes An array of other attributes to give the box.
2705      * @return string the HTML to output.
2706      */
2707     public function box_start($classes = 'generalbox', $id = null, $attributes = array()) {
2708         $this->opencontainers->push('box', html_writer::end_tag('div'));
2709         $attributes['id'] = $id;
2710         $attributes['class'] = 'box ' . renderer_base::prepare_classes($classes);
2711         return html_writer::start_tag('div', $attributes);
2712     }
2714     /**
2715      * Outputs the closing section of a box.
2716      *
2717      * @return string the HTML to output.
2718      */
2719     public function box_end() {
2720         return $this->opencontainers->pop('box');
2721     }
2723     /**
2724      * Outputs a container.
2725      *
2726      * @param string $contents The contents of the box
2727      * @param string $classes A space-separated list of CSS classes
2728      * @param string $id An optional ID
2729      * @return string the HTML to output.
2730      */
2731     public function container($contents, $classes = null, $id = null) {
2732         return $this->container_start($classes, $id) . $contents . $this->container_end();
2733     }
2735     /**
2736      * Outputs the opening section of a container.
2737      *
2738      * @param string $classes A space-separated list of CSS classes
2739      * @param string $id An optional ID
2740      * @return string the HTML to output.
2741      */
2742     public function container_start($classes = null, $id = null) {
2743         $this->opencontainers->push('container', html_writer::end_tag('div'));
2744         return html_writer::start_tag('div', array('id' => $id,
2745                 'class' => renderer_base::prepare_classes($classes)));
2746     }
2748     /**
2749      * Outputs the closing section of a container.
2750      *
2751      * @return string the HTML to output.
2752      */
2753     public function container_end() {
2754         return $this->opencontainers->pop('container');
2755     }
2757     /**
2758      * Make nested HTML lists out of the items
2759      *
2760      * The resulting list will look something like this:
2761      *
2762      * <pre>
2763      * <<ul>>
2764      * <<li>><div class='tree_item parent'>(item contents)</div>
2765      *      <<ul>
2766      *      <<li>><div class='tree_item'>(item contents)</div><</li>>
2767      *      <</ul>>
2768      * <</li>>
2769      * <</ul>>
2770      * </pre>
2771      *
2772      * @param array $items
2773      * @param array $attrs html attributes passed to the top ofs the list
2774      * @return string HTML
2775      */
2776     public function tree_block_contents($items, $attrs = array()) {
2777         // exit if empty, we don't want an empty ul element
2778         if (empty($items)) {
2779             return '';
2780         }
2781         // array of nested li elements
2782         $lis = array();
2783         foreach ($items as $item) {
2784             // this applies to the li item which contains all child lists too
2785             $content = $item->content($this);
2786             $liclasses = array($item->get_css_type());
2787             if (!$item->forceopen || (!$item->forceopen && $item->collapse) || ($item->children->count()==0  && $item->nodetype==navigation_node::NODETYPE_BRANCH)) {
2788                 $liclasses[] = 'collapsed';
2789             }
2790             if ($item->isactive === true) {
2791                 $liclasses[] = 'current_branch';
2792             }
2793             $liattr = array('class'=>join(' ',$liclasses));
2794             // class attribute on the div item which only contains the item content
2795             $divclasses = array('tree_item');
2796             if ($item->children->count()>0  || $item->nodetype==navigation_node::NODETYPE_BRANCH) {
2797                 $divclasses[] = 'branch';
2798             } else {
2799                 $divclasses[] = 'leaf';
2800             }
2801             if (!empty($item->classes) && count($item->classes)>0) {
2802                 $divclasses[] = join(' ', $item->classes);
2803             }
2804             $divattr = array('class'=>join(' ', $divclasses));
2805             if (!empty($item->id)) {
2806                 $divattr['id'] = $item->id;
2807             }
2808             $content = html_writer::tag('p', $content, $divattr) . $this->tree_block_contents($item->children);
2809             if (!empty($item->preceedwithhr) && $item->preceedwithhr===true) {
2810                 $content = html_writer::empty_tag('hr') . $content;
2811             }
2812             $content = html_writer::tag('li', $content, $liattr);
2813             $lis[] = $content;
2814         }
2815         return html_writer::tag('ul', implode("\n", $lis), $attrs);
2816     }
2818     /**
2819      * Return the navbar content so that it can be echoed out by the layout
2820      *
2821      * @return string XHTML navbar
2822      */
2823     public function navbar() {
2824         $items = $this->page->navbar->get_items();
2825         $itemcount = count($items);
2826         if ($itemcount === 0) {
2827             return '';
2828         }
2830         $htmlblocks = array();
2831         // Iterate the navarray and display each node
2832         $separator = get_separator();
2833         for ($i=0;$i < $itemcount;$i++) {
2834             $item = $items[$i];
2835             $item->hideicon = true;
2836             if ($i===0) {
2837                 $content = html_writer::tag('li', $this->render($item));
2838             } else {
2839                 $content = html_writer::tag('li', $separator.$this->render($item));
2840             }
2841             $htmlblocks[] = $content;
2842         }
2844         //accessibility: heading for navbar list  (MDL-20446)
2845         $navbarcontent = html_writer::tag('span', get_string('pagepath'), array('class'=>'accesshide'));
2846         $navbarcontent .= html_writer::tag('ul', join('', $htmlblocks), array('role'=>'navigation'));
2847         // XHTML
2848         return $navbarcontent;
2849     }
2851     /**
2852      * Renders a navigation node object.
2853      *
2854      * @param navigation_node $item The navigation node to render.
2855      * @return string HTML fragment
2856      */
2857     protected function render_navigation_node(navigation_node $item) {
2858         $content = $item->get_content();
2859         $title = $item->get_title();
2860         if ($item->icon instanceof renderable && !$item->hideicon) {
2861             $icon = $this->render($item->icon);
2862             $content = $icon.$content; // use CSS for spacing of icons
2863         }
2864         if ($item->helpbutton !== null) {
2865             $content = trim($item->helpbutton).html_writer::tag('span', $content, array('class'=>'clearhelpbutton', 'tabindex'=>'0'));
2866         }
2867         if ($content === '') {
2868             return '';
2869         }
2870         if ($item->action instanceof action_link) {
2871             $link = $item->action;
2872             if ($item->hidden) {
2873                 $link->add_class('dimmed');
2874             }
2875             if (!empty($content)) {
2876                 // Providing there is content we will use that for the link content.
2877                 $link->text = $content;
2878             }
2879             $content = $this->render($link);
2880         } else if ($item->action instanceof moodle_url) {
2881             $attributes = array();
2882             if ($title !== '') {
2883                 $attributes['title'] = $title;
2884             }
2885             if ($item->hidden) {
2886                 $attributes['class'] = 'dimmed_text';
2887             }
2888             $content = html_writer::link($item->action, $content, $attributes);
2890         } else if (is_string($item->action) || empty($item->action)) {
2891             $attributes = array('tabindex'=>'0'); //add tab support to span but still maintain character stream sequence.
2892             if ($title !== '') {
2893                 $attributes['title'] = $title;
2894             }
2895             if ($item->hidden) {
2896                 $attributes['class'] = 'dimmed_text';
2897             }
2898             $content = html_writer::tag('span', $content, $attributes);
2899         }
2900         return $content;
2901     }
2903     /**
2904      * Accessibility: Right arrow-like character is
2905      * used in the breadcrumb trail, course navigation menu
2906      * (previous/next activity), calendar, and search forum block.
2907      * If the theme does not set characters, appropriate defaults
2908      * are set automatically. Please DO NOT
2909      * use &lt; &gt; &raquo; - these are confusing for blind users.
2910      *
2911      * @return string
2912      */
2913     public function rarrow() {
2914         return $this->page->theme->rarrow;
2915     }
2917     /**
2918      * Accessibility: Right arrow-like character is
2919      * used in the breadcrumb trail, course navigation menu
2920      * (previous/next activity), calendar, and search forum block.
2921      * If the theme does not set characters, appropriate defaults
2922      * are set automatically. Please DO NOT
2923      * use &lt; &gt; &raquo; - these are confusing for blind users.
2924      *
2925      * @return string
2926      */
2927     public function larrow() {
2928         return $this->page->theme->larrow;
2929     }
2931     /**
2932      * Returns the custom menu if one has been set
2933      *
2934      * A custom menu can be configured by browsing to
2935      *    Settings: Administration > Appearance > Themes > Theme settings
2936      * and then configuring the custommenu config setting as described.
2937      *
2938      * Theme developers: DO NOT OVERRIDE! Please override function
2939      * {@link core_renderer::render_custom_menu()} instead.
2940      *
2941      * @param string $custommenuitems - custom menuitems set by theme instead of global theme settings
2942      * @return string
2943      */
2944     public function custom_menu($custommenuitems = '') {
2945         global $CFG;
2946         if (empty($custommenuitems) && !empty($CFG->custommenuitems)) {
2947             $custommenuitems = $CFG->custommenuitems;
2948         }
2949         if (empty($custommenuitems)) {
2950             return '';
2951         }
2952         $custommenu = new custom_menu($custommenuitems, current_language());
2953         return $this->render($custommenu);
2954     }
2956     /**
2957      * Renders a custom menu object (located in outputcomponents.php)
2958      *
2959      * The custom menu this method produces makes use of the YUI3 menunav widget
2960      * and requires very specific html elements and classes.
2961      *
2962      * @staticvar int $menucount
2963      * @param custom_menu $menu
2964      * @return string
2965      */
2966     protected function render_custom_menu(custom_menu $menu) {
2967         static $menucount = 0;
2968         // If the menu has no children return an empty string
2969         if (!$menu->has_children()) {
2970             return '';
2971         }
2972         // Increment the menu count. This is used for ID's that get worked with
2973         // in JavaScript as is essential
2974         $menucount++;
2975         // Initialise this custom menu (the custom menu object is contained in javascript-static
2976         $jscode = js_writer::function_call_with_Y('M.core_custom_menu.init', array('custom_menu_'.$menucount));
2977         $jscode = "(function(){{$jscode}})";
2978         $this->page->requires->yui_module('node-menunav', $jscode);
2979         // Build the root nodes as required by YUI
2980         $content = html_writer::start_tag('div', array('id'=>'custom_menu_'.$menucount, 'class'=>'yui3-menu yui3-menu-horizontal javascript-disabled custom-menu'));
2981         $content .= html_writer::start_tag('div', array('class'=>'yui3-menu-content'));
2982         $content .= html_writer::start_tag('ul');
2983         // Render each child
2984         foreach ($menu->get_children() as $item) {
2985             $content .= $this->render_custom_menu_item($item);
2986         }
2987         // Close the open tags
2988         $content .= html_writer::end_tag('ul');
2989         $content .= html_writer::end_tag('div');
2990         $content .= html_writer::end_tag('div');
2991         // Return the custom menu
2992         return $content;
2993     }
2995     /**
2996      * Renders a custom menu node as part of a submenu
2997      *
2998      * The custom menu this method produces makes use of the YUI3 menunav widget
2999      * and requires very specific html elements and classes.
3000      *
3001      * @see core:renderer::render_custom_menu()
3002      *
3003      * @staticvar int $submenucount
3004      * @param custom_menu_item $menunode
3005      * @return string
3006      */
3007     protected function render_custom_menu_item(custom_menu_item $menunode) {
3008         // Required to ensure we get unique trackable id's
3009         static $submenucount = 0;
3010         if ($menunode->has_children()) {
3011             // If the child has menus render it as a sub menu
3012             $submenucount++;
3013             $content = html_writer::start_tag('li');
3014             if ($menunode->get_url() !== null) {
3015                 $url = $menunode->get_url();
3016             } else {
3017                 $url = '#cm_submenu_'.$submenucount;
3018             }
3019             $content .= html_writer::link($url, $menunode->get_text(), array('class'=>'yui3-menu-label', 'title'=>$menunode->get_title()));
3020             $content .= html_writer::start_tag('div', array('id'=>'cm_submenu_'.$submenucount, 'class'=>'yui3-menu custom_menu_submenu'));
3021             $content .= html_writer::start_tag('div', array('class'=>'yui3-menu-content'));
3022             $content .= html_writer::start_tag('ul');
3023             foreach ($menunode->get_children() as $menunode) {
3024                 $content .= $this->render_custom_menu_item($menunode);
3025             }
3026             $content .= html_writer::end_tag('ul');
3027             $content .= html_writer::end_tag('div');
3028             $content .= html_writer::end_tag('div');
3029             $content .= html_writer::end_tag('li');
3030         } else {
3031             // The node doesn't have children so produce a final menuitem
3032             $content = html_writer::start_tag('li', array('class'=>'yui3-menuitem'));
3033             if ($menunode->get_url() !== null) {
3034                 $url = $menunode->get_url();
3035             } else {
3036                 $url = '#';
3037             }
3038             $content .= html_writer::link($url, $menunode->get_text(), array('class'=>'yui3-menuitem-content', 'title'=>$menunode->get_title()));
3039             $content .= html_writer::end_tag('li');
3040         }
3041         // Return the sub menu
3042         return $content;
3043     }
3045     /**
3046      * Renders theme links for switching between default and other themes.
3047      *
3048      * @return string
3049      */
3050     protected function theme_switch_links() {
3052         $actualdevice = core_useragent::get_device_type();
3053         $currentdevice = $this->page->devicetypeinuse;
3054         $switched = ($actualdevice != $currentdevice);
3056         if (!$switched && $currentdevice == 'default' && $actualdevice == 'default') {
3057             // The user is using the a default device and hasn't switched so don't shown the switch
3058             // device links.
3059             return '';
3060         }
3062         if ($switched) {
3063             $linktext = get_string('switchdevicerecommended');
3064             $devicetype = $actualdevice;
3065         } else {
3066             $linktext = get_string('switchdevicedefault');
3067             $devicetype = 'default';
3068         }
3069         $linkurl = new moodle_url('/theme/switchdevice.php', array('url' => $this->page->url, 'device' => $devicetype, 'sesskey' => sesskey()));
3071         $content  = html_writer::start_tag('div', array('id' => 'theme_switch_link'));
3072         $content .= html_writer::link($linkurl, $linktext);
3073         $content .= html_writer::end_tag('div');
3075         return $content;
3076     }
3078     /**
3079      * Renders tabs
3080      *
3081      * This function replaces print_tabs() used before Moodle 2.5 but with slightly different arguments
3082      *
3083      * Theme developers: In order to change how tabs are displayed please override functions
3084      * {@link core_renderer::render_tabtree()} and/or {@link core_renderer::render_tabobject()}
3085      *
3086      * @param array $tabs array of tabs, each of them may have it's own ->subtree
3087      * @param string|null $selected which tab to mark as selected, all parent tabs will
3088      *     automatically be marked as activated
3089      * @param array|string|null $inactive list of ids of inactive tabs, regardless of
3090      *     their level. Note that you can as weel specify tabobject::$inactive for separate instances
3091      * @return string
3092      */
3093     public final function tabtree($tabs, $selected = null, $inactive = null) {
3094         return $this->render(new tabtree($tabs, $selected, $inactive));
3095     }
3097     /**
3098      * Renders tabtree
3099      *
3100      * @param tabtree $tabtree
3101      * @return string
3102      */
3103     protected function render_tabtree(tabtree $tabtree) {
3104         if (empty($tabtree->subtree)) {
3105             return '';
3106         }
3107         $str = '';
3108         $str .= html_writer::start_tag('div', array('class' => 'tabtree'));
3109         $str .= $this->render_tabobject($tabtree);
3110         $str .= html_writer::end_tag('div').
3111                 html_writer::tag('div', ' ', array('class' => 'clearer'));
3112         return $str;
3113     }
3115     /**
3116      * Renders tabobject (part of tabtree)
3117      *
3118      * This function is called from {@link core_renderer::render_tabtree()}
3119      * and also it calls itself when printing the $tabobject subtree recursively.
3120      *
3121      * Property $tabobject->level indicates the number of row of tabs.
3122      *
3123      * @param tabobject $tabobject
3124      * @return string HTML fragment
3125      */
3126     protected function render_tabobject(tabobject $tabobject) {
3127         $str = '';
3129         // Print name of the current tab.
3130         if ($tabobject instanceof tabtree) {
3131             // No name for tabtree root.
3132         } else if ($tabobject->inactive || $tabobject->activated || ($tabobject->selected && !$tabobject->linkedwhenselected)) {
3133             // Tab name without a link. The <a> tag is used for styling.
3134             $str .= html_writer::tag('a', html_writer::span($tabobject->text), array('class' => 'nolink'));
3135         } else {
3136             // Tab name with a link.
3137             if (!($tabobject->link instanceof moodle_url)) {
3138                 // backward compartibility when link was passed as quoted string
3139                 $str .= "<a href=\"$tabobject->link\" title=\"$tabobject->title\"><span>$tabobject->text</span></a>";
3140             } else {
3141                 $str .= html_writer::link($tabobject->link, html_writer::span($tabobject->text), array('title' => $tabobject->title));
3142             }
3143         }
3145         if (empty($tabobject->subtree)) {
3146             if ($tabobject->selected) {
3147                 $str .= html_writer::tag('div', '&nbsp;', array('class' => 'tabrow'. ($tabobject->level + 1). ' empty'));
3148             }
3149             return $str;
3150         }
3152         // Print subtree
3153         $str .= html_writer::start_tag('ul', array('class' => 'tabrow'. $tabobject->level));
3154         $cnt = 0;
3155         foreach ($tabobject->subtree as $tab) {
3156             $liclass = '';
3157             if (!$cnt) {
3158                 $liclass .= ' first';
3159             }
3160             if ($cnt == count($tabobject->subtree) - 1) {
3161                 $liclass .= ' last';
3162             }
3163             if ((empty($tab->subtree)) && (!empty($tab->selected))) {
3164                 $liclass .= ' onerow';
3165             }
3167             if ($tab->selected) {
3168                 $liclass .= ' here selected';
3169             } else if ($tab->activated) {
3170                 $liclass .= ' here active';
3171             }
3173             // This will recursively call function render_tabobject() for each item in subtree
3174             $str .= html_writer::tag('li', $this->render($tab), array('class' => trim($liclass)));
3175             $cnt++;
3176         }
3177         $str .= html_writer::end_tag('ul');
3179         return $str;
3180     }
3182     /**
3183      * Get the HTML for blocks in the given region.
3184      *
3185      * @since 2.5.1 2.6
3186      * @param string $region The region to get HTML for.
3187      * @return string HTML.
3188      */
3189     public function blocks($region, $classes = array(), $tag = 'aside') {
3190         $displayregion = $this->page->apply_theme_region_manipulations($region);
3191         $classes = (array)$classes;
3192         $classes[] = 'block-region';
3193         $attributes = array(
3194             'id' => 'block-region-'.preg_replace('#[^a-zA-Z0-9_\-]+#', '-', $displayregion),
3195             'class' => join(' ', $classes),
3196             'data-blockregion' => $displayregion,
3197             'data-droptarget' => '1'
3198         );
3199         return html_writer::tag($tag, $this->blocks_for_region($region), $attributes);
3200     }
3202     /**
3203      * Returns the CSS classes to apply to the body tag.
3204      *
3205      * @since 2.5.1 2.6
3206      * @param array $additionalclasses Any additional classes to apply.
3207      * @return string
3208      */
3209     public function body_css_classes(array $additionalclasses = array()) {
3210         // Add a class for each block region on the page.
3211         // We use the block manager here because the theme object makes get_string calls.
3212         foreach ($this->page->blocks->get_regions() as $region) {
3213             $additionalclasses[] = 'has-region-'.$region;
3214             if ($this->page->blocks->region_has_content($region, $this)) {
3215                 $additionalclasses[] = 'used-region-'.$region;
3216             } else {
3217                 $additionalclasses[] = 'empty-region-'.$region;
3218             }
3219         }
3220         foreach ($this->page->layout_options as $option => $value) {
3221             if ($value) {
3222                 $additionalclasses[] = 'layout-option-'.$option;
3223             }
3224         }
3225         $css = $this->page->bodyclasses .' '. join(' ', $additionalclasses);
3226         return $css;
3227     }
3229     /**
3230      * The ID attribute to apply to the body tag.
3231      *
3232      * @since 2.5.1 2.6
3233      * @return string
3234      */
3235     public function body_id() {
3236         return $this->page->bodyid;
3237     }
3239     /**
3240      * Returns HTML attributes to use within the body tag. This includes an ID and classes.
3241      *
3242      * @since 2.5.1 2.6
3243      * @param string|array $additionalclasses Any additional classes to give the body tag,
3244      * @return string
3245      */
3246     public function body_attributes($additionalclasses = array()) {
3247         if (!is_array($additionalclasses)) {
3248             $additionalclasses = explode(' ', $additionalclasses);
3249         }
3250         return ' id="'. $this->body_id().'" class="'.$this->body_css_classes($additionalclasses).'"';
3251     }
3253     /**
3254      * Gets HTML for the page heading.
3255      *
3256      * @since 2.5.1 2.6
3257      * @param string $tag The tag to encase the heading in. h1 by default.
3258      * @return string HTML.
3259      */
3260     public function page_heading($tag = 'h1') {
3261         return html_writer::tag($tag, $this->page->heading);
3262     }
3264     /**
3265      * Gets the HTML for the page heading button.
3266      *
3267      * @since 2.5.1 2.6
3268      * @return string HTML.
3269      */
3270     public function page_heading_button() {
3271         return $this->page->button;
3272     }
3274     /**
3275      * Returns the Moodle docs link to use for this page.
3276      *
3277      * @since 2.5.1 2.6
3278      * @param string $text
3279      * @return string
3280      */
3281     public function page_doc_link($text = null) {
3282         if ($text === null) {
3283             $text = get_string('moodledocslink');
3284         }
3285         $path = page_get_doc_link_path($this->page);
3286         if (!$path) {
3287             return '';
3288         }
3289         return $this->doc_link($path, $text);
3290     }
3292     /**
3293      * Returns the page heading menu.
3294      *
3295      * @since 2.5.1 2.6
3296      * @return string HTML.
3297      */
3298     public function page_heading_menu() {
3299         return $this->page->headingmenu;
3300     }
3302     /**
3303      * Returns the title to use on the page.
3304      *
3305      * @since 2.5.1 2.6
3306      * @return string
3307      */
3308     public function page_title() {
3309         return $this->page->title;
3310     }
3312     /**
3313      * Returns the URL for the favicon.
3314      *
3315      * @since 2.5.1 2.6
3316      * @return string The favicon URL
3317      */
3318     public function favicon() {
3319         return $this->pix_url('favicon', 'theme');
3320     }
3323 /**
3324  * A renderer that generates output for command-line scripts.
3325  *
3326  * The implementation of this renderer is probably incomplete.
3327  *
3328  * @copyright 2009 Tim Hunt
3329  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3330  * @since Moodle 2.0
3331  * @package core
3332  * @category output
3333  */
3334 class core_renderer_cli extends core_renderer {
3336     /**
3337      * Returns the page header.
3338      *
3339      * @return string HTML fragment
3340      */
3341     public function header() {
3342         return $this->page->heading . "\n";
3343     }
3345     /**
3346      * Returns a template fragment representing a Heading.
3347      *
3348      * @param string $text The text of the heading
3349      * @param int $level The level of importance of the heading
3350      * @param string $classes A space-separated list of CSS classes
3351      * @param string $id An optional ID
3352      * @return string A template fragment for a heading
3353      */
3354     public function heading($text, $level = 2, $classes = 'main', $id = null) {
3355         $text .= "\n";
3356         switch ($level) {
3357             case 1:
3358                 return '=>' . $text;
3359             case 2:
3360                 return '-->' . $text;
3361             default:
3362                 return $text;
3363         }
3364     }
3366     /**
3367      * Returns a template fragment representing a fatal error.
3368      *
3369      * @param string $message The message to output
3370      * @param string $moreinfourl URL where more info can be found about the error
3371      * @param string $link Link for the Continue button
3372      * @param array $backtrace The execution backtrace
3373      * @param string $debuginfo Debugging information
3374      * @return string A template fragment for a fatal error
3375      */
3376     public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
3377         global $CFG;
3379         $output = "!!! $message !!!\n";
3381         if ($CFG->debugdeveloper) {
3382             if (!empty($debuginfo)) {
3383                 $output .= $this->notification($debuginfo, 'notifytiny');
3384             }
3385             if (!empty($backtrace)) {
3386                 $output .= $this->notification('Stack trace: ' . format_backtrace($backtrace, true), 'notifytiny');
3387             }
3388         }
3390         return $output;
3391     }
3393     /**
3394      * Returns a template fragment representing a notification.
3395      *
3396      * @param string $message The message to include
3397      * @param string $classes A space-separated list of CSS classes
3398      * @return string A template fragment for a notification
3399      */
3400     public function notification($message, $classes = 'notifyproblem') {
3401         $message = clean_text($message);
3402         if ($classes === 'notifysuccess') {
3403             return "++ $message ++\n";
3404         }
3405         return "!! $message !!\n";
3406     }
3410 /**
3411  * A renderer that generates output for ajax scripts.
3412  *
3413  * This renderer prevents accidental sends back only json
3414  * encoded error messages, all other output is ignored.
3415  *
3416  * @copyright 2010 Petr Skoda
3417  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3418  * @since Moodle 2.0
3419  * @package core
3420  * @category output
3421  */
3422 class core_renderer_ajax extends core_renderer {
3424     /**
3425      * Returns a template fragment representing a fatal error.
3426      *
3427      * @param string $message The message to output
3428      * @param string $moreinfourl URL where more info can be found about the error
3429      * @param string $link Link for the Continue button
3430      * @param array $backtrace The execution backtrace
3431      * @param string $debuginfo Debugging information
3432      * @return string A template fragment for a fatal error
3433      */
3434     public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
3435         global $CFG;
3437         $this->page->set_context(null); // ugly hack - make sure page context is set to something, we do not want bogus warnings here
3439         $e = new stdClass();
3440         $e->error      = $message;
3441         $e->stacktrace = NULL;
3442         $e->debuginfo  = NULL;
3443         $e->reproductionlink = NULL;
3444         if (!empty($CFG->debug) and $CFG->debug >= DEBUG_DEVELOPER) {
3445             $e->reproductionlink = $link;
3446             if (!empty($debuginfo)) {
3447                 $e->debuginfo = $debuginfo;
3448             }
3449             if (!empty($backtrace)) {
3450                 $e->stacktrace = format_backtrace($backtrace, true);
3451             }
3452         }
3453         $this->header();
3454         return json_encode($e);
3455     }
3457     /**
3458      * Used to display a notification.
3459      * For the AJAX notifications are discarded.
3460      *
3461      * @param string $message
3462      * @param string $classes
3463      */
3464     public function notification($message, $classes = 'notifyproblem') {}
3466     /**
3467      * Used to display a redirection message.
3468      * AJAX redirections should not occur and as such redirection messages
3469      * are discarded.
3470      *
3471      * @param moodle_url|string $encodedurl
3472      * @param string $message
3473      * @param int $delay
3474      * @param bool $debugdisableredirect
3475      */
3476     public function redirect_message($encodedurl, $message, $delay, $debugdisableredirect) {}
3478     /**
3479      * Prepares the start of an AJAX output.
3480      */
3481     public function header() {
3482         // unfortunately YUI iframe upload does not support application/json
3483         if (!empty($_FILES)) {
3484             @header('Content-type: text/plain; charset=utf-8');
3485         } else {
3486             @header('Content-type: application/json; charset=utf-8');
3487         }
3489         // Headers to make it not cacheable and json
3490         @header('Cache-Control: no-store, no-cache, must-revalidate');
3491         @header('Cache-Control: post-check=0, pre-check=0', false);
3492         @header('Pragma: no-cache');
3493         @header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
3494         @header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
3495         @header('Accept-Ranges: none');
3496     }
3498     /**
3499      * There is no footer for an AJAX request, however we must override the
3500      * footer method to prevent the default footer.
3501      */
3502     public function footer() {}
3504     /**
3505      * No need for headers in an AJAX request... this should never happen.
3506      * @param string $text
3507      * @param int $level
3508      * @param string $classes
3509      * @param string $id
3510      */
3511     public function heading($text, $level = 2, $classes = 'main', $id = null) {}
3515 /**
3516  * Renderer for media files.
3517  *
3518  * Used in file resources, media filter, and any other places that need to
3519  * output embedded media.
3520  *
3521  * @copyright 2011 The Open University
3522  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3523  */
3524 class core_media_renderer extends plugin_renderer_base {
3525     /** @var array Array of available 'player' objects */
3526     private $players;
3527     /** @var string Regex pattern for links which may contain embeddable content */
3528     private $embeddablemarkers;
3530     /**
3531      * Constructor requires medialib.php.
3532      *
3533      * This is needed in the constructor (not later) so that you can use the
3534      * constants and static functions that are defined in core_media class
3535      * before you call renderer functions.
3536      */
3537     public function __construct() {
3538         global $CFG;
3539         require_once($CFG->libdir . '/medialib.php');
3540     }
3542     /**
3543      * Obtains the list of core_media_player objects currently in use to render
3544      * items.
3545      *
3546      * The list is in rank order (highest first) and does not include players
3547      * which are disabled.
3548      *
3549      * @return array Array of core_media_player objects in rank order
3550      */
3551     protected function get_players() {
3552         global $CFG;
3554         // Save time by only building the list once.
3555         if (!$this->players) {
3556             // Get raw list of players.
3557             $players = $this->get_players_raw();
3559             // Chuck all the ones that are disabled.
3560             foreach ($players as $key => $player) {
3561                 if (!$player->is_enabled()) {
3562                     unset($players[$key]);
3563                 }
3564             }
3566             // Sort in rank order (highest first).
3567             usort($players, array('core_media_player', 'compare_by_rank'));
3568             $this->players = $players;
3569         }
3570         return $this->players;
3571     }
3573     /**
3574      * Obtains a raw list of player objects that includes objects regardless
3575      * of whether they are disabled or not, and without sorting.
3576      *
3577      * You can override this in a subclass if you need to add additional
3578      * players.
3579      *
3580      * The return array is be indexed by player name to make it easier to
3581      * remove players in a subclass.
3582      *
3583      * @return array $players Array of core_media_player objects in any order
3584      */
3585     protected function get_players_raw() {
3586         return array(
3587             'vimeo' => new core_media_player_vimeo(),
3588             'youtube' => new core_media_player_youtube(),
3589             'youtube_playlist' => new core_media_player_youtube_playlist(),
3590             'html5video' => new core_media_player_html5video(),
3591             'html5audio' => new core_media_player_html5audio(),
3592             'mp3' => new core_media_player_mp3(),
3593             'flv' => new core_media_player_flv(),
3594             'wmp' => new core_media_player_wmp(),
3595             'qt' => new core_media_player_qt(),
3596             'rm' => new core_media_player_rm(),
3597             'swf' => new core_media_player_swf(),
3598             'link' => new core_media_player_link(),
3599         );
3600     }
3602     /**
3603      * Renders a media file (audio or video) using suitable embedded player.
3604      *
3605      * See embed_alternatives function for full description of parameters.
3606      * This function calls through to that one.
3607      *
3608      * When using this function you can also specify width and height in the
3609      * URL by including ?d=100x100 at the end. If specified in the URL, this
3610      * will override the $width and $height parameters.
3611      *
3612      * @param moodle_url $url Full URL of media file
3613      * @param string $name Optional user-readable name to display in download link
3614      * @param int $width Width in pixels (optional)
3615      * @param int $height Height in pixels (optional)
3616      * @param array $options Array of key/value pairs
3617      * @return string HTML content of embed
3618      */
3619     public function embed_url(moodle_url $url, $name = '', $width = 0, $height = 0,
3620             $options = array()) {
3622         // Get width and height from URL if specified (overrides parameters in
3623         // function call).
3624         $rawurl = $url->out(false);
3625         if (preg_match('/[?#]d=([\d]{1,4}%?)x([\d]{1,4}%?)/', $rawurl, $matches)) {
3626             $width = $matches[1];
3627             $height = $matches[2];
3628             $url = new moodle_url(str_replace($matches[0], '', $rawurl));
3629         }
3631         // Defer to array version of function.
3632         return $this->embed_alternatives(array($url), $name, $width, $height, $options);
3633     }
3635     /**
3636      * Renders media files (audio or video) using suitable embedded player.
3637      * The list of URLs should be alternative versions of the same content in
3638      * multiple formats. If there is only one format it should have a single
3639      * entry.
3640      *
3641      * If the media files are not in a supported format, this will give students
3642      * a download link to each format. The download link uses the filename
3643      * unless you supply the optional name parameter.
3644      *
3645      * Width and height are optional. If specified, these are suggested sizes
3646      * and should be the exact values supplied by the user, if they come from
3647      * user input. These will be treated as relating to the size of the video
3648      * content, not including any player control bar.
3649      *
3650      * For audio files, height will be ignored. For video files, a few formats
3651      * work if you specify only width, but in general if you specify width
3652      * you must specify height as well.
3653      *
3654      * The $options array is passed through to the core_media_player classes
3655      * that render the object tag. The keys can contain values from
3656      * core_media::OPTION_xx.
3657      *
3658      * @param array $alternatives Array of moodle_url to media files
3659      * @param string $name Optional user-readable name to display in download link
3660      * @param int $width Width in pixels (optional)
3661      * @param int $height Height in pixels (optional)
3662      * @param array $options Array of key/value pairs
3663      * @return string HTML content of embed
3664      */
3665     public function embed_alternatives($alternatives, $name = '', $width = 0, $height = 0,
3666             $options = array()) {
3668         // Get list of player plugins (will also require the library).
3669         $players = $this->get_players();
3671         // Set up initial text which will be replaced by first player that
3672         // supports any of the formats.
3673         $out = core_media_player::PLACEHOLDER;
3675         // Loop through all players that support any of these URLs.
3676         foreach ($players as $player) {
3677             // Option: When no other player matched, don't do the default link player.
3678             if (!empty($options[core_media::OPTION_FALLBACK_TO_BLANK]) &&
3679                     $player->get_rank() === 0 && $out === core_media_player::PLACEHOLDER) {
3680                 continue;
3681             }
3683             $supported = $player->list_supported_urls($alternatives, $options);
3684             if ($supported) {
3685                 // Embed.
3686                 $text = $player->embed($supported, $name, $width, $height, $options);
3688                 // Put this in place of the 'fallback' slot in the previous text.
3689                 $out = str_replace(core_media_player::PLACEHOLDER, $text, $out);
3690             }
3691         }
3693         // Remove 'fallback' slot from final version and return it.
3694         $out = str_replace(core_media_player::PLACEHOLDER, '', $out);
3695         if (!empty($options[core_media::OPTION_BLOCK]) && $out !== '') {
3696             $out = html_writer::tag('div', $out, array('class' => 'resourcecontent'));
3697         }
3698         return $out;
3699     }
3701     /**
3702      * Checks whether a file can be embedded. If this returns true you will get
3703      * an embedded player; if this returns false, you will just get a download
3704      * link.
3705      *
3706      * This is a wrapper for can_embed_urls.
3707      *
3708      * @param moodle_url $url URL of media file
3709      * @param array $options Options (same as when embedding)
3710      * @return bool True if file can be embedded
3711      */
3712     public function can_embed_url(moodle_url $url, $options = array()) {
3713         return $this->can_embed_urls(array($url), $options);
3714     }
3716     /**
3717      * Checks whether a file can be embedded. If this returns true you will get
3718      * an embedded player; if this returns false, you will just get a download
3719      * link.
3720      *
3721      * @param array $urls URL of media file and any alternatives (moodle_url)
3722      * @param array $options Options (same as when embedding)
3723      * @return bool True if file can be embedded
3724      */
3725     public function can_embed_urls(array $urls, $options = array()) {
3726         // Check all players to see if any of them support it.
3727         foreach ($this->get_players() as $player) {
3728             // Link player (always last on list) doesn't count!
3729             if ($player->get_rank() <= 0) {
3730                 break;
3731             }
3732             // First player that supports it, return true.
3733             if ($player->list_supported_urls($urls, $options)) {
3734                 return true;
3735             }
3736         }
3737         return false;
3738     }
3740     /**
3741      * Obtains a list of markers that can be used in a regular expression when
3742      * searching for URLs that can be embedded by any player type.
3743      *
3744      * This string is used to improve peformance of regex matching by ensuring
3745      * that the (presumably C) regex code can do a quick keyword check on the
3746      * URL part of a link to see if it matches one of these, rather than having
3747      * to go into PHP code for every single link to see if it can be embedded.
3748      *
3749      * @return string String suitable for use in regex such as '(\.mp4|\.flv)'
3750      */
3751     public function get_embeddable_markers() {
3752         if (empty($this->embeddablemarkers)) {
3753             $markers = '';
3754             foreach ($this->get_players() as $player) {
3755                 foreach ($player->get_embeddable_markers() as $marker) {
3756                     if ($markers !== '') {
3757                         $markers .= '|';
3758                     }
3759                     $markers .= preg_quote($marker);
3760                 }
3761             }
3762             $this->embeddablemarkers = $markers;
3763         }
3764         return $this->embeddablemarkers;
3765     }