92346d9be8f0f5607b83a05d9a34260936c5389f
[moodle.git] / lib / outputrenderers.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Classes for rendering HTML output for Moodle.
20  *
21  * Please see http://docs.moodle.org/en/Developement:How_Moodle_outputs_HTML
22  * for an overview.
23  *
24  * @package    core
25  * @subpackage lib
26  * @copyright  2009 Tim Hunt
27  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
28  */
30 defined('MOODLE_INTERNAL') || die();
32 /**
33  * Simple base class for Moodle renderers.
34  *
35  * Tracks the xhtml_container_stack to use, which is passed in in the constructor.
36  *
37  * Also has methods to facilitate generating HTML output.
38  *
39  * @copyright 2009 Tim Hunt
40  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
41  * @since     Moodle 2.0
42  */
43 class renderer_base {
44     /** @var xhtml_container_stack the xhtml_container_stack to use. */
45     protected $opencontainers;
46     /** @var moodle_page the page we are rendering for. */
47     protected $page;
48     /** @var requested rendering target */
49     protected $target;
51     /**
52      * Constructor
53      * @param moodle_page $page the page we are doing output for.
54      * @param string $target one of rendering target constants
55      */
56     public function __construct(moodle_page $page, $target) {
57         $this->opencontainers = $page->opencontainers;
58         $this->page = $page;
59         $this->target = $target;
60     }
62     /**
63      * Returns rendered widget.
64      * @param renderable $widget instance with renderable interface
65      * @return string
66      */
67     public function render(renderable $widget) {
68         $rendermethod = 'render_'.get_class($widget);
69         if (method_exists($this, $rendermethod)) {
70             return $this->$rendermethod($widget);
71         }
72         throw new coding_exception('Can not render widget, renderer method ('.$rendermethod.') not found.');
73     }
75     /**
76      * Adds JS handlers needed for event execution for one html element id
77      * @param component_action $actions
78      * @param string $id
79      * @return string id of element, either original submitted or random new if not supplied
80      */
81     public function add_action_handler(component_action $action, $id=null) {
82         if (!$id) {
83             $id = html_writer::random_id($action->event);
84         }
85         $this->page->requires->event_handler("#$id", $action->event, $action->jsfunction, $action->jsfunctionargs);
86         return $id;
87     }
89     /**
90      * Have we started output yet?
91      * @return boolean true if the header has been printed.
92      */
93     public function has_started() {
94         return $this->page->state >= moodle_page::STATE_IN_BODY;
95     }
97     /**
98      * Given an array or space-separated list of classes, prepares and returns the HTML class attribute value
99      * @param mixed $classes Space-separated string or array of classes
100      * @return string HTML class attribute value
101      */
102     public static function prepare_classes($classes) {
103         if (is_array($classes)) {
104             return implode(' ', array_unique($classes));
105         }
106         return $classes;
107     }
109     /**
110      * Return the moodle_url for an image.
111      * The exact image location and extension is determined
112      * automatically by searching for gif|png|jpg|jpeg, please
113      * note there can not be diferent images with the different
114      * extension. The imagename is for historical reasons
115      * a relative path name, it may be changed later for core
116      * images. It is recommended to not use subdirectories
117      * in plugin and theme pix directories.
118      *
119      * There are three types of images:
120      * 1/ theme images  - stored in theme/mytheme/pix/,
121      *                    use component 'theme'
122      * 2/ core images   - stored in /pix/,
123      *                    overridden via theme/mytheme/pix_core/
124      * 3/ plugin images - stored in mod/mymodule/pix,
125      *                    overridden via theme/mytheme/pix_plugins/mod/mymodule/,
126      *                    example: pix_url('comment', 'mod_glossary')
127      *
128      * @param string $imagename the pathname of the image
129      * @param string $component full plugin name (aka component) or 'theme'
130      * @return moodle_url
131      */
132     public function pix_url($imagename, $component = 'moodle') {
133         return $this->page->theme->pix_url($imagename, $component);
134     }
138 /**
139  * Basis for all plugin renderers.
140  *
141  * @author    Petr Skoda (skodak)
142  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
143  * @since     Moodle 2.0
144  */
145 class plugin_renderer_base extends renderer_base {
146     /**
147      * A reference to the current general renderer probably {@see core_renderer}
148      * @var renderer_base
149      */
150     protected $output;
152     /**
153      * Constructor method, calls the parent constructor
154      * @param moodle_page $page
155      * @param string $target one of rendering target constants
156      */
157     public function __construct(moodle_page $page, $target) {
158         $this->output = $page->get_renderer('core', null, $target);
159         parent::__construct($page, $target);
160     }
162     /**
163      * Returns rendered widget.
164      * @param renderable $widget instance with renderable interface
165      * @return string
166      */
167     public function render(renderable $widget) {
168         $rendermethod = 'render_'.get_class($widget);
169         if (method_exists($this, $rendermethod)) {
170             return $this->$rendermethod($widget);
171         }
172         // pass to core renderer if method not found here
173         return $this->output->render($widget);
174     }
176     /**
177      * Magic method used to pass calls otherwise meant for the standard renderer
178      * to it to ensure we don't go causing unnecessary grief.
179      *
180      * @param string $method
181      * @param array $arguments
182      * @return mixed
183      */
184     public function __call($method, $arguments) {
185         if (method_exists('renderer_base', $method)) {
186             throw new coding_exception('Protected method called against '.__CLASS__.' :: '.$method);
187         }
188         if (method_exists($this->output, $method)) {
189             return call_user_func_array(array($this->output, $method), $arguments);
190         } else {
191             throw new coding_exception('Unknown method called against '.__CLASS__.' :: '.$method);
192         }
193     }
197 /**
198  * The standard implementation of the core_renderer interface.
199  *
200  * @copyright 2009 Tim Hunt
201  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
202  * @since     Moodle 2.0
203  */
204 class core_renderer extends renderer_base {
205     /** @var string used in {@link header()}. */
206     const PERFORMANCE_INFO_TOKEN = '%%PERFORMANCEINFO%%';
207     /** @var string used in {@link header()}. */
208     const END_HTML_TOKEN = '%%ENDHTML%%';
209     /** @var string used in {@link header()}. */
210     const MAIN_CONTENT_TOKEN = '[MAIN CONTENT GOES HERE]';
211     /** @var string used to pass information from {@link doctype()} to {@link standard_head_html()}. */
212     protected $contenttype;
213     /** @var string used by {@link redirect_message()} method to communicate with {@link header()}. */
214     protected $metarefreshtag = '';
215     /** @var set if the theme links function has been called **/
216     protected $switchlinkdisplayed;
218     /**
219      * Get the DOCTYPE declaration that should be used with this page. Designed to
220      * be called in theme layout.php files.
221      * @return string the DOCTYPE declaration (and any XML prologue) that should be used.
222      */
223     public function doctype() {
224         global $CFG;
226         $doctype = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">' . "\n";
227         $this->contenttype = 'text/html; charset=utf-8';
229         if (empty($CFG->xmlstrictheaders)) {
230             return $doctype;
231         }
233         // We want to serve the page with an XML content type, to force well-formedness errors to be reported.
234         $prolog = '<?xml version="1.0" encoding="utf-8"?>' . "\n";
235         if (isset($_SERVER['HTTP_ACCEPT']) && strpos($_SERVER['HTTP_ACCEPT'], 'application/xhtml+xml') !== false) {
236             // Firefox and other browsers that can cope natively with XHTML.
237             $this->contenttype = 'application/xhtml+xml; charset=utf-8';
239         } else if (preg_match('/MSIE.*Windows NT/', $_SERVER['HTTP_USER_AGENT'])) {
240             // IE can't cope with application/xhtml+xml, but it will cope if we send application/xml with an XSL stylesheet.
241             $this->contenttype = 'application/xml; charset=utf-8';
242             $prolog .= '<?xml-stylesheet type="text/xsl" href="' . $CFG->httpswwwroot . '/lib/xhtml.xsl"?>' . "\n";
244         } else {
245             $prolog = '';
246         }
248         return $prolog . $doctype;
249     }
251     /**
252      * The attributes that should be added to the <html> tag. Designed to
253      * be called in theme layout.php files.
254      * @return string HTML fragment.
255      */
256     public function htmlattributes() {
257         return get_html_lang(true) . ' xmlns="http://www.w3.org/1999/xhtml"';
258     }
260     /**
261      * The standard tags (meta tags, links to stylesheets and JavaScript, etc.)
262      * that should be included in the <head> tag. Designed to be called in theme
263      * layout.php files.
264      * @return string HTML fragment.
265      */
266     public function standard_head_html() {
267         global $CFG, $SESSION;
268         $output = '';
269         $output .= '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />' . "\n";
270         $output .= '<meta name="keywords" content="moodle, ' . $this->page->title . '" />' . "\n";
271         if (!$this->page->cacheable) {
272             $output .= '<meta http-equiv="pragma" content="no-cache" />' . "\n";
273             $output .= '<meta http-equiv="expires" content="0" />' . "\n";
274         }
275         // This is only set by the {@link redirect()} method
276         $output .= $this->metarefreshtag;
278         // Check if a periodic refresh delay has been set and make sure we arn't
279         // already meta refreshing
280         if ($this->metarefreshtag=='' && $this->page->periodicrefreshdelay!==null) {
281             $output .= '<meta http-equiv="refresh" content="'.$this->page->periodicrefreshdelay.';url='.$this->page->url->out().'" />';
282         }
284         // flow player embedding support
285         $this->page->requires->js_function_call('M.util.load_flowplayer');
287         $this->page->requires->js_function_call('setTimeout', array('fix_column_widths()', 20));
289         $focus = $this->page->focuscontrol;
290         if (!empty($focus)) {
291             if (preg_match("#forms\['([a-zA-Z0-9]+)'\].elements\['([a-zA-Z0-9]+)'\]#", $focus, $matches)) {
292                 // This is a horrifically bad way to handle focus but it is passed in
293                 // through messy formslib::moodleform
294                 $this->page->requires->js_function_call('old_onload_focus', array($matches[1], $matches[2]));
295             } else if (strpos($focus, '.')!==false) {
296                 // Old style of focus, bad way to do it
297                 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);
298                 $this->page->requires->js_function_call('old_onload_focus', explode('.', $focus, 2));
299             } else {
300                 // Focus element with given id
301                 $this->page->requires->js_function_call('focuscontrol', array($focus));
302             }
303         }
305         // Get the theme stylesheet - this has to be always first CSS, this loads also styles.css from all plugins;
306         // any other custom CSS can not be overridden via themes and is highly discouraged
307         $urls = $this->page->theme->css_urls($this->page);
308         foreach ($urls as $url) {
309             $this->page->requires->css_theme($url);
310         }
312         // Get the theme javascript head and footer
313         $jsurl = $this->page->theme->javascript_url(true);
314         $this->page->requires->js($jsurl, true);
315         $jsurl = $this->page->theme->javascript_url(false);
316         $this->page->requires->js($jsurl);
318         // Perform a browser environment check for the flash version.  Should only run once per login session.
319         if (!NO_MOODLE_COOKIES && isloggedin() && !empty($CFG->excludeoldflashclients) && empty($SESSION->flashversion)) {
320             $this->page->requires->js('/lib/swfobject/swfobject.js');
321             $this->page->requires->js_init_call('M.core_flashdetect.init');
322         }
324         // Get any HTML from the page_requirements_manager.
325         $output .= $this->page->requires->get_head_code($this->page, $this);
327         // List alternate versions.
328         foreach ($this->page->alternateversions as $type => $alt) {
329             $output .= html_writer::empty_tag('link', array('rel' => 'alternate',
330                     'type' => $type, 'title' => $alt->title, 'href' => $alt->url));
331         }
333         if (!empty($CFG->additionalhtmlhead)) {
334             $output .= "\n".$CFG->additionalhtmlhead;
335         }
337         return $output;
338     }
340     /**
341      * The standard tags (typically skip links) that should be output just inside
342      * the start of the <body> tag. Designed to be called in theme layout.php files.
343      * @return string HTML fragment.
344      */
345     public function standard_top_of_body_html() {
346         global $CFG;
347         $output = $this->page->requires->get_top_of_body_code();
348         if (!empty($CFG->additionalhtmltopofbody)) {
349             $output .= "\n".$CFG->additionalhtmltopofbody;
350         }
351         return $output;
352     }
354     /**
355      * The standard tags (typically performance information and validation links,
356      * if we are in developer debug mode) that should be output in the footer area
357      * of the page. Designed to be called in theme layout.php files.
358      * @return string HTML fragment.
359      */
360     public function standard_footer_html() {
361         global $CFG, $SCRIPT;
363         // This function is normally called from a layout.php file in {@link header()}
364         // but some of the content won't be known until later, so we return a placeholder
365         // for now. This will be replaced with the real content in {@link footer()}.
366         $output = self::PERFORMANCE_INFO_TOKEN;
367         if ($this->page->devicetypeinuse == 'legacy'){
368             // The legacy theme is in use print the notification
369             $output .= html_writer::tag('div', get_string('legacythemeinuse'), array('class'=>'legacythemeinuse'));
370         }
372         $output .= $this->theme_switch_links();
374         if (!empty($CFG->debugpageinfo)) {
375             $output .= '<div class="performanceinfo pageinfo">This page is: ' . $this->page->debug_summary() . '</div>';
376         }
377         if (debugging(null, DEBUG_DEVELOPER) and has_capability('moodle/site:config', get_context_instance(CONTEXT_SYSTEM))) {  // Only in developer mode
378             // Add link to profiling report if necessary
379             if (function_exists('profiling_is_running') && profiling_is_running()) {
380                 $txt = get_string('profiledscript', 'admin');
381                 $title = get_string('profiledscriptview', 'admin');
382                 $url = $CFG->wwwroot . '/admin/report/profiling/index.php?script=' . urlencode($SCRIPT);
383                 $link= '<a title="' . $title . '" href="' . $url . '">' . $txt . '</a>';
384                 $output .= '<div class="profilingfooter">' . $link . '</div>';
385             }
386             $output .= '<div class="purgecaches"><a href="'.$CFG->wwwroot.'/admin/purgecaches.php?confirm=1&amp;sesskey='.sesskey().'">'.get_string('purgecaches', 'admin').'</a></div>';
387         }
388         if (!empty($CFG->debugvalidators)) {
389             $output .= '<div class="validators"><ul>
390               <li><a href="http://validator.w3.org/check?verbose=1&amp;ss=1&amp;uri=' . urlencode(qualified_me()) . '">Validate HTML</a></li>
391               <li><a href="http://www.contentquality.com/mynewtester/cynthia.exe?rptmode=-1&amp;url1=' . urlencode(qualified_me()) . '">Section 508 Check</a></li>
392               <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>
393             </ul></div>';
394         }
395         if (!empty($CFG->additionalhtmlfooter)) {
396             $output .= "\n".$CFG->additionalhtmlfooter;
397         }
398         return $output;
399     }
401     /**
402      * The standard tags (typically script tags that are not needed earlier) that
403      * should be output after everything else, . Designed to be called in theme layout.php files.
404      * @return string HTML fragment.
405      */
406     public function standard_end_of_body_html() {
407         // This function is normally called from a layout.php file in {@link header()}
408         // but some of the content won't be known until later, so we return a placeholder
409         // for now. This will be replaced with the real content in {@link footer()}.
410         return self::END_HTML_TOKEN;
411     }
413     /**
414      * Return the standard string that says whether you are logged in (and switched
415      * roles/logged in as another user).
416      * @return string HTML fragment.
417      */
418     public function login_info() {
419         global $USER, $CFG, $DB, $SESSION;
421         if (during_initial_install()) {
422             return '';
423         }
425         $loginapge = ((string)$this->page->url === get_login_url());
426         $course = $this->page->course;
428         if (session_is_loggedinas()) {
429             $realuser = session_get_realuser();
430             $fullname = fullname($realuser, true);
431             $realuserinfo = " [<a href=\"$CFG->wwwroot/course/loginas.php?id=$course->id&amp;sesskey=".sesskey()."\">$fullname</a>] ";
432         } else {
433             $realuserinfo = '';
434         }
436         $loginurl = get_login_url();
438         if (empty($course->id)) {
439             // $course->id is not defined during installation
440             return '';
441         } else if (isloggedin()) {
442             $context = get_context_instance(CONTEXT_COURSE, $course->id);
444             $fullname = fullname($USER, true);
445             // Since Moodle 2.0 this link always goes to the public profile page (not the course profile page)
446             $username = "<a href=\"$CFG->wwwroot/user/profile.php?id=$USER->id\">$fullname</a>";
447             if (is_mnet_remote_user($USER) and $idprovider = $DB->get_record('mnet_host', array('id'=>$USER->mnethostid))) {
448                 $username .= " from <a href=\"{$idprovider->wwwroot}\">{$idprovider->name}</a>";
449             }
450             if (isguestuser()) {
451                 $loggedinas = $realuserinfo.get_string('loggedinasguest');
452                 if (!$loginapge) {
453                     $loggedinas .= " (<a href=\"$loginurl\">".get_string('login').'</a>)';
454                 }
455             } else if (is_role_switched($course->id)) { // Has switched roles
456                 $rolename = '';
457                 if ($role = $DB->get_record('role', array('id'=>$USER->access['rsw'][$context->path]))) {
458                     $rolename = ': '.format_string($role->name);
459                 }
460                 $loggedinas = get_string('loggedinas', 'moodle', $username).$rolename.
461                           " (<a href=\"$CFG->wwwroot/course/view.php?id=$course->id&amp;switchrole=0&amp;sesskey=".sesskey()."\">".get_string('switchrolereturn').'</a>)';
462             } else {
463                 $loggedinas = $realuserinfo.get_string('loggedinas', 'moodle', $username).' '.
464                           " (<a href=\"$CFG->wwwroot/login/logout.php?sesskey=".sesskey()."\">".get_string('logout').'</a>)';
465             }
466         } else {
467             $loggedinas = get_string('loggedinnot', 'moodle');
468             if (!$loginapge) {
469                 $loggedinas .= " (<a href=\"$loginurl\">".get_string('login').'</a>)';
470             }
471         }
473         $loggedinas = '<div class="logininfo">'.$loggedinas.'</div>';
475         if (isset($SESSION->justloggedin)) {
476             unset($SESSION->justloggedin);
477             if (!empty($CFG->displayloginfailures)) {
478                 if (!isguestuser()) {
479                     if ($count = count_login_failures($CFG->displayloginfailures, $USER->username, $USER->lastlogin)) {
480                         $loggedinas .= '&nbsp;<div class="loginfailures">';
481                         if (empty($count->accounts)) {
482                             $loggedinas .= get_string('failedloginattempts', '', $count);
483                         } else {
484                             $loggedinas .= get_string('failedloginattemptsall', '', $count);
485                         }
486                         if (has_capability('coursereport/log:view', get_context_instance(CONTEXT_SYSTEM))) {
487                             $loggedinas .= ' (<a href="'.$CFG->wwwroot.'/course/report/log/index.php'.
488                                                  '?chooselog=1&amp;id=1&amp;modid=site_errors">'.get_string('logs').'</a>)';
489                         }
490                         $loggedinas .= '</div>';
491                     }
492                 }
493             }
494         }
496         return $loggedinas;
497     }
499     /**
500      * Return the 'back' link that normally appears in the footer.
501      * @return string HTML fragment.
502      */
503     public function home_link() {
504         global $CFG, $SITE;
506         if ($this->page->pagetype == 'site-index') {
507             // Special case for site home page - please do not remove
508             return '<div class="sitelink">' .
509                    '<a title="Moodle" href="http://moodle.org/">' .
510                    '<img style="width:100px;height:30px" src="' . $this->pix_url('moodlelogo') . '" alt="moodlelogo" /></a></div>';
512         } else if (!empty($CFG->target_release) && $CFG->target_release != $CFG->release) {
513             // Special case for during install/upgrade.
514             return '<div class="sitelink">'.
515                    '<a title="Moodle" href="http://docs.moodle.org/en/Administrator_documentation" onclick="this.target=\'_blank\'">' .
516                    '<img style="width:100px;height:30px" src="' . $this->pix_url('moodlelogo') . '" alt="moodlelogo" /></a></div>';
518         } else if ($this->page->course->id == $SITE->id || strpos($this->page->pagetype, 'course-view') === 0) {
519             return '<div class="homelink"><a href="' . $CFG->wwwroot . '/">' .
520                     get_string('home') . '</a></div>';
522         } else {
523             return '<div class="homelink"><a href="' . $CFG->wwwroot . '/course/view.php?id=' . $this->page->course->id . '">' .
524                     format_string($this->page->course->shortname) . '</a></div>';
525         }
526     }
528     /**
529      * Redirects the user by any means possible given the current state
530      *
531      * This function should not be called directly, it should always be called using
532      * the redirect function in lib/weblib.php
533      *
534      * The redirect function should really only be called before page output has started
535      * however it will allow itself to be called during the state STATE_IN_BODY
536      *
537      * @param string $encodedurl The URL to send to encoded if required
538      * @param string $message The message to display to the user if any
539      * @param int $delay The delay before redirecting a user, if $message has been
540      *         set this is a requirement and defaults to 3, set to 0 no delay
541      * @param boolean $debugdisableredirect this redirect has been disabled for
542      *         debugging purposes. Display a message that explains, and don't
543      *         trigger the redirect.
544      * @return string The HTML to display to the user before dying, may contain
545      *         meta refresh, javascript refresh, and may have set header redirects
546      */
547     public function redirect_message($encodedurl, $message, $delay, $debugdisableredirect) {
548         global $CFG;
549         $url = str_replace('&amp;', '&', $encodedurl);
551         switch ($this->page->state) {
552             case moodle_page::STATE_BEFORE_HEADER :
553                 // No output yet it is safe to delivery the full arsenal of redirect methods
554                 if (!$debugdisableredirect) {
555                     // Don't use exactly the same time here, it can cause problems when both redirects fire at the same time.
556                     $this->metarefreshtag = '<meta http-equiv="refresh" content="'. $delay .'; url='. $encodedurl .'" />'."\n";
557                     $this->page->requires->js_function_call('document.location.replace', array($url), false, ($delay + 3));
558                 }
559                 $output = $this->header();
560                 break;
561             case moodle_page::STATE_PRINTING_HEADER :
562                 // We should hopefully never get here
563                 throw new coding_exception('You cannot redirect while printing the page header');
564                 break;
565             case moodle_page::STATE_IN_BODY :
566                 // We really shouldn't be here but we can deal with this
567                 debugging("You should really redirect before you start page output");
568                 if (!$debugdisableredirect) {
569                     $this->page->requires->js_function_call('document.location.replace', array($url), false, $delay);
570                 }
571                 $output = $this->opencontainers->pop_all_but_last();
572                 break;
573             case moodle_page::STATE_DONE :
574                 // Too late to be calling redirect now
575                 throw new coding_exception('You cannot redirect after the entire page has been generated');
576                 break;
577         }
578         $output .= $this->notification($message, 'redirectmessage');
579         $output .= '<div class="continuebutton">(<a href="'. $encodedurl .'">'. get_string('continue') .'</a>)</div>';
580         if ($debugdisableredirect) {
581             $output .= '<p><strong>Error output, so disabling automatic redirect.</strong></p>';
582         }
583         $output .= $this->footer();
584         return $output;
585     }
587     /**
588      * Start output by sending the HTTP headers, and printing the HTML <head>
589      * and the start of the <body>.
590      *
591      * To control what is printed, you should set properties on $PAGE. If you
592      * are familiar with the old {@link print_header()} function from Moodle 1.9
593      * you will find that there are properties on $PAGE that correspond to most
594      * of the old parameters to could be passed to print_header.
595      *
596      * Not that, in due course, the remaining $navigation, $menu parameters here
597      * will be replaced by more properties of $PAGE, but that is still to do.
598      *
599      * @return string HTML that you must output this, preferably immediately.
600      */
601     public function header() {
602         global $USER, $CFG;
604         if (session_is_loggedinas()) {
605             $this->page->add_body_class('userloggedinas');
606         }
608         $this->page->set_state(moodle_page::STATE_PRINTING_HEADER);
610         // Find the appropriate page layout file, based on $this->page->pagelayout.
611         $layoutfile = $this->page->theme->layout_file($this->page->pagelayout);
612         // Render the layout using the layout file.
613         $rendered = $this->render_page_layout($layoutfile);
615         // Slice the rendered output into header and footer.
616         $cutpos = strpos($rendered, self::MAIN_CONTENT_TOKEN);
617         if ($cutpos === false) {
618             throw new coding_exception('page layout file ' . $layoutfile .
619                     ' does not contain the string "' . self::MAIN_CONTENT_TOKEN . '".');
620         }
621         $header = substr($rendered, 0, $cutpos);
622         $footer = substr($rendered, $cutpos + strlen(self::MAIN_CONTENT_TOKEN));
624         if (empty($this->contenttype)) {
625             debugging('The page layout file did not call $OUTPUT->doctype()');
626             $header = $this->doctype() . $header;
627         }
629         send_headers($this->contenttype, $this->page->cacheable);
631         $this->opencontainers->push('header/footer', $footer);
632         $this->page->set_state(moodle_page::STATE_IN_BODY);
634         return $header . $this->skip_link_target('maincontent');
635     }
637     /**
638      * Renders and outputs the page layout file.
639      * @param string $layoutfile The name of the layout file
640      * @return string HTML code
641      */
642     protected function render_page_layout($layoutfile) {
643         global $CFG, $SITE, $USER;
644         // The next lines are a bit tricky. The point is, here we are in a method
645         // of a renderer class, and this object may, or may not, be the same as
646         // the global $OUTPUT object. When rendering the page layout file, we want to use
647         // this object. However, people writing Moodle code expect the current
648         // renderer to be called $OUTPUT, not $this, so define a variable called
649         // $OUTPUT pointing at $this. The same comment applies to $PAGE and $COURSE.
650         $OUTPUT = $this;
651         $PAGE = $this->page;
652         $COURSE = $this->page->course;
654         ob_start();
655         include($layoutfile);
656         $rendered = ob_get_contents();
657         ob_end_clean();
658         return $rendered;
659     }
661     /**
662      * Outputs the page's footer
663      * @return string HTML fragment
664      */
665     public function footer() {
666         global $CFG, $DB;
668         $output = $this->container_end_all(true);
670         $footer = $this->opencontainers->pop('header/footer');
672         if (debugging() and $DB and $DB->is_transaction_started()) {
673             // TODO: MDL-20625 print warning - transaction will be rolled back
674         }
676         // Provide some performance info if required
677         $performanceinfo = '';
678         if (defined('MDL_PERF') || (!empty($CFG->perfdebug) and $CFG->perfdebug > 7)) {
679             $perf = get_performance_info();
680             if (defined('MDL_PERFTOLOG') && !function_exists('register_shutdown_function')) {
681                 error_log("PERF: " . $perf['txt']);
682             }
683             if (defined('MDL_PERFTOFOOT') || debugging() || $CFG->perfdebug > 7) {
684                 $performanceinfo = $perf['html'];
685             }
686         }
687         $footer = str_replace(self::PERFORMANCE_INFO_TOKEN, $performanceinfo, $footer);
689         $footer = str_replace(self::END_HTML_TOKEN, $this->page->requires->get_end_code(), $footer);
691         $this->page->set_state(moodle_page::STATE_DONE);
693         return $output . $footer;
694     }
696     /**
697      * Close all but the last open container. This is useful in places like error
698      * handling, where you want to close all the open containers (apart from <body>)
699      * before outputting the error message.
700      * @param bool $shouldbenone assert that the stack should be empty now - causes a
701      *      developer debug warning if it isn't.
702      * @return string the HTML required to close any open containers inside <body>.
703      */
704     public function container_end_all($shouldbenone = false) {
705         return $this->opencontainers->pop_all_but_last($shouldbenone);
706     }
708     /**
709      * Returns lang menu or '', this method also checks forcing of languages in courses.
710      * @return string
711      */
712     public function lang_menu() {
713         global $CFG;
715         if (empty($CFG->langmenu)) {
716             return '';
717         }
719         if ($this->page->course != SITEID and !empty($this->page->course->lang)) {
720             // do not show lang menu if language forced
721             return '';
722         }
724         $currlang = current_language();
725         $langs = get_string_manager()->get_list_of_translations();
727         if (count($langs) < 2) {
728             return '';
729         }
731         $s = new single_select($this->page->url, 'lang', $langs, $currlang, null);
732         $s->label = get_accesshide(get_string('language'));
733         $s->class = 'langmenu';
734         return $this->render($s);
735     }
737     /**
738      * Output the row of editing icons for a block, as defined by the controls array.
739      * @param array $controls an array like {@link block_contents::$controls}.
740      * @return HTML fragment.
741      */
742     public function block_controls($controls) {
743         if (empty($controls)) {
744             return '';
745         }
746         $controlshtml = array();
747         foreach ($controls as $control) {
748             $controlshtml[] = html_writer::tag('a',
749                     html_writer::empty_tag('img',  array('src' => $this->pix_url($control['icon'])->out(false), 'alt' => $control['caption'])),
750                     array('class' => 'icon','title' => $control['caption'], 'href' => $control['url']));
751         }
752         return html_writer::tag('div', implode('', $controlshtml), array('class' => 'commands'));
753     }
755     /**
756      * Prints a nice side block with an optional header.
757      *
758      * The content is described
759      * by a {@link block_contents} object.
760      *
761      * <div id="inst{$instanceid}" class="block_{$blockname} block">
762      *      <div class="header"></div>
763      *      <div class="content">
764      *          ...CONTENT...
765      *          <div class="footer">
766      *          </div>
767      *      </div>
768      *      <div class="annotation">
769      *      </div>
770      * </div>
771      *
772      * @param block_contents $bc HTML for the content
773      * @param string $region the region the block is appearing in.
774      * @return string the HTML to be output.
775      */
776     function block(block_contents $bc, $region) {
777         $bc = clone($bc); // Avoid messing up the object passed in.
778         if (empty($bc->blockinstanceid) || !strip_tags($bc->title)) {
779             $bc->collapsible = block_contents::NOT_HIDEABLE;
780         }
781         if ($bc->collapsible == block_contents::HIDDEN) {
782             $bc->add_class('hidden');
783         }
784         if (!empty($bc->controls)) {
785             $bc->add_class('block_with_controls');
786         }
788         $skiptitle = strip_tags($bc->title);
789         if (empty($skiptitle)) {
790             $output = '';
791             $skipdest = '';
792         } else {
793             $output = html_writer::tag('a', get_string('skipa', 'access', $skiptitle), array('href' => '#sb-' . $bc->skipid, 'class' => 'skip-block'));
794             $skipdest = html_writer::tag('span', '', array('id' => 'sb-' . $bc->skipid, 'class' => 'skip-block-to'));
795         }
797         $output .= html_writer::start_tag('div', $bc->attributes);
799         $output .= $this->block_header($bc);
800         $output .= $this->block_content($bc);
802         $output .= html_writer::end_tag('div');
804         $output .= $this->block_annotation($bc);
806         $output .= $skipdest;
808         $this->init_block_hider_js($bc);
809         return $output;
810     }
812     /**
813      * Produces a header for a block
814      *
815      * @param block_contents $bc
816      * @return string
817      */
818     protected function block_header(block_contents $bc) {
820         $title = '';
821         if ($bc->title) {
822             $title = html_writer::tag('h2', $bc->title, null);
823         }
825         $controlshtml = $this->block_controls($bc->controls);
827         $output = '';
828         if ($title || $controlshtml) {
829             $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'));
830         }
831         return $output;
832     }
834     /**
835      * Produces the content area for a block
836      *
837      * @param block_contents $bc
838      * @return string
839      */
840     protected function block_content(block_contents $bc) {
841         $output = html_writer::start_tag('div', array('class' => 'content'));
842         if (!$bc->title && !$this->block_controls($bc->controls)) {
843             $output .= html_writer::tag('div', '', array('class'=>'block_action notitle'));
844         }
845         $output .= $bc->content;
846         $output .= $this->block_footer($bc);
847         $output .= html_writer::end_tag('div');
849         return $output;
850     }
852     /**
853      * Produces the footer for a block
854      *
855      * @param block_contents $bc
856      * @return string
857      */
858     protected function block_footer(block_contents $bc) {
859         $output = '';
860         if ($bc->footer) {
861             $output .= html_writer::tag('div', $bc->footer, array('class' => 'footer'));
862         }
863         return $output;
864     }
866     /**
867      * Produces the annotation for a block
868      *
869      * @param block_contents $bc
870      * @return string
871      */
872     protected function block_annotation(block_contents $bc) {
873         $output = '';
874         if ($bc->annotation) {
875             $output .= html_writer::tag('div', $bc->annotation, array('class' => 'blockannotation'));
876         }
877         return $output;
878     }
880     /**
881      * Calls the JS require function to hide a block.
882      * @param block_contents $bc A block_contents object
883      * @return void
884      */
885     protected function init_block_hider_js(block_contents $bc) {
886         if (!empty($bc->attributes['id']) and $bc->collapsible != block_contents::NOT_HIDEABLE) {
887             $config = new stdClass;
888             $config->id = $bc->attributes['id'];
889             $config->title = strip_tags($bc->title);
890             $config->preference = 'block' . $bc->blockinstanceid . 'hidden';
891             $config->tooltipVisible = get_string('hideblocka', 'access', $config->title);
892             $config->tooltipHidden = get_string('showblocka', 'access', $config->title);
894             $this->page->requires->js_init_call('M.util.init_block_hider', array($config));
895             user_preference_allow_ajax_update($config->preference, PARAM_BOOL);
896         }
897     }
899     /**
900      * Render the contents of a block_list.
901      * @param array $icons the icon for each item.
902      * @param array $items the content of each item.
903      * @return string HTML
904      */
905     public function list_block_contents($icons, $items) {
906         $row = 0;
907         $lis = array();
908         foreach ($items as $key => $string) {
909             $item = html_writer::start_tag('li', array('class' => 'r' . $row));
910             if (!empty($icons[$key])) { //test if the content has an assigned icon
911                 $item .= html_writer::tag('div', $icons[$key], array('class' => 'icon column c0'));
912             }
913             $item .= html_writer::tag('div', $string, array('class' => 'column c1'));
914             $item .= html_writer::end_tag('li');
915             $lis[] = $item;
916             $row = 1 - $row; // Flip even/odd.
917         }
918         return html_writer::tag('ul', implode("\n", $lis), array('class' => 'unlist'));
919     }
921     /**
922      * Output all the blocks in a particular region.
923      * @param string $region the name of a region on this page.
924      * @return string the HTML to be output.
925      */
926     public function blocks_for_region($region) {
927         $blockcontents = $this->page->blocks->get_content_for_region($region, $this);
929         $output = '';
930         foreach ($blockcontents as $bc) {
931             if ($bc instanceof block_contents) {
932                 $output .= $this->block($bc, $region);
933             } else if ($bc instanceof block_move_target) {
934                 $output .= $this->block_move_target($bc);
935             } else {
936                 throw new coding_exception('Unexpected type of thing (' . get_class($bc) . ') found in list of block contents.');
937             }
938         }
939         return $output;
940     }
942     /**
943      * Output a place where the block that is currently being moved can be dropped.
944      * @param block_move_target $target with the necessary details.
945      * @return string the HTML to be output.
946      */
947     public function block_move_target($target) {
948         return html_writer::tag('a', html_writer::tag('span', $target->text, array('class' => 'accesshide')), array('href' => $target->url, 'class' => 'blockmovetarget'));
949     }
951     /**
952      * Renders a special html link with attached action
953      *
954      * @param string|moodle_url $url
955      * @param string $text HTML fragment
956      * @param component_action $action
957      * @param array $attributes associative array of html link attributes + disabled
958      * @return HTML fragment
959      */
960     public function action_link($url, $text, component_action $action = null, array $attributes=null) {
961         if (!($url instanceof moodle_url)) {
962             $url = new moodle_url($url);
963         }
964         $link = new action_link($url, $text, $action, $attributes);
966         return $this->render($link);
967     }
969     /**
970      * Implementation of action_link rendering
971      * @param action_link $link
972      * @return string HTML fragment
973      */
974     protected function render_action_link(action_link $link) {
975         global $CFG;
977         // A disabled link is rendered as formatted text
978         if (!empty($link->attributes['disabled'])) {
979             // do not use div here due to nesting restriction in xhtml strict
980             return html_writer::tag('span', $link->text, array('class'=>'currentlink'));
981         }
983         $attributes = $link->attributes;
984         unset($link->attributes['disabled']);
985         $attributes['href'] = $link->url;
987         if ($link->actions) {
988             if (empty($attributes['id'])) {
989                 $id = html_writer::random_id('action_link');
990                 $attributes['id'] = $id;
991             } else {
992                 $id = $attributes['id'];
993             }
994             foreach ($link->actions as $action) {
995                 $this->add_action_handler($action, $id);
996             }
997         }
999         return html_writer::tag('a', $link->text, $attributes);
1000     }
1003     /**
1004      * Similar to action_link, image is used instead of the text
1005      *
1006      * @param string|moodle_url $url A string URL or moodel_url
1007      * @param pix_icon $pixicon
1008      * @param component_action $action
1009      * @param array $attributes associative array of html link attributes + disabled
1010      * @param bool $linktext show title next to image in link
1011      * @return string HTML fragment
1012      */
1013     public function action_icon($url, pix_icon $pixicon, component_action $action = null, array $attributes = null, $linktext=false) {
1014         if (!($url instanceof moodle_url)) {
1015             $url = new moodle_url($url);
1016         }
1017         $attributes = (array)$attributes;
1019         if (empty($attributes['class'])) {
1020             // let ppl override the class via $options
1021             $attributes['class'] = 'action-icon';
1022         }
1024         $icon = $this->render($pixicon);
1026         if ($linktext) {
1027             $text = $pixicon->attributes['alt'];
1028         } else {
1029             $text = '';
1030         }
1032         return $this->action_link($url, $text.$icon, $action, $attributes);
1033     }
1035    /**
1036     * Print a message along with button choices for Continue/Cancel
1037     *
1038     * If a string or moodle_url is given instead of a single_button, method defaults to post.
1039     *
1040     * @param string $message The question to ask the user
1041     * @param single_button|moodle_url|string $continue The single_button component representing the Continue answer. Can also be a moodle_url or string URL
1042     * @param single_button|moodle_url|string $cancel The single_button component representing the Cancel answer. Can also be a moodle_url or string URL
1043     * @return string HTML fragment
1044     */
1045     public function confirm($message, $continue, $cancel) {
1046         if ($continue instanceof single_button) {
1047             // ok
1048         } else if (is_string($continue)) {
1049             $continue = new single_button(new moodle_url($continue), get_string('continue'), 'post');
1050         } else if ($continue instanceof moodle_url) {
1051             $continue = new single_button($continue, get_string('continue'), 'post');
1052         } else {
1053             throw new coding_exception('The continue param to $OUTPUT->confirm() must be either a URL (string/moodle_url) or a single_button instance.');
1054         }
1056         if ($cancel instanceof single_button) {
1057             // ok
1058         } else if (is_string($cancel)) {
1059             $cancel = new single_button(new moodle_url($cancel), get_string('cancel'), 'get');
1060         } else if ($cancel instanceof moodle_url) {
1061             $cancel = new single_button($cancel, get_string('cancel'), 'get');
1062         } else {
1063             throw new coding_exception('The cancel param to $OUTPUT->confirm() must be either a URL (string/moodle_url) or a single_button instance.');
1064         }
1066         $output = $this->box_start('generalbox', 'notice');
1067         $output .= html_writer::tag('p', $message);
1068         $output .= html_writer::tag('div', $this->render($continue) . $this->render($cancel), array('class' => 'buttons'));
1069         $output .= $this->box_end();
1070         return $output;
1071     }
1073     /**
1074      * Returns a form with a single button.
1075      *
1076      * @param string|moodle_url $url
1077      * @param string $label button text
1078      * @param string $method get or post submit method
1079      * @param array $options associative array {disabled, title, etc.}
1080      * @return string HTML fragment
1081      */
1082     public function single_button($url, $label, $method='post', array $options=null) {
1083         if (!($url instanceof moodle_url)) {
1084             $url = new moodle_url($url);
1085         }
1086         $button = new single_button($url, $label, $method);
1088         foreach ((array)$options as $key=>$value) {
1089             if (array_key_exists($key, $button)) {
1090                 $button->$key = $value;
1091             }
1092         }
1094         return $this->render($button);
1095     }
1097     /**
1098      * Internal implementation of single_button rendering
1099      * @param single_button $button
1100      * @return string HTML fragment
1101      */
1102     protected function render_single_button(single_button $button) {
1103         $attributes = array('type'     => 'submit',
1104                             'value'    => $button->label,
1105                             'disabled' => $button->disabled ? 'disabled' : null,
1106                             'title'    => $button->tooltip);
1108         if ($button->actions) {
1109             $id = html_writer::random_id('single_button');
1110             $attributes['id'] = $id;
1111             foreach ($button->actions as $action) {
1112                 $this->add_action_handler($action, $id);
1113             }
1114         }
1116         // first the input element
1117         $output = html_writer::empty_tag('input', $attributes);
1119         // then hidden fields
1120         $params = $button->url->params();
1121         if ($button->method === 'post') {
1122             $params['sesskey'] = sesskey();
1123         }
1124         foreach ($params as $var => $val) {
1125             $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => $var, 'value' => $val));
1126         }
1128         // then div wrapper for xhtml strictness
1129         $output = html_writer::tag('div', $output);
1131         // now the form itself around it
1132         if ($button->method === 'get') {
1133             $url = $button->url->out_omit_querystring(true); // url without params, the anchor part allowed
1134         } else {
1135             $url = $button->url->out_omit_querystring();     // url without params, the anchor part not allowed
1136         }
1137         if ($url === '') {
1138             $url = '#'; // there has to be always some action
1139         }
1140         $attributes = array('method' => $button->method,
1141                             'action' => $url,
1142                             'id'     => $button->formid);
1143         $output = html_writer::tag('form', $output, $attributes);
1145         // and finally one more wrapper with class
1146         return html_writer::tag('div', $output, array('class' => $button->class));
1147     }
1149     /**
1150      * Returns a form with a single select widget.
1151      * @param moodle_url $url form action target, includes hidden fields
1152      * @param string $name name of selection field - the changing parameter in url
1153      * @param array $options list of options
1154      * @param string $selected selected element
1155      * @param array $nothing
1156      * @param string $formid
1157      * @return string HTML fragment
1158      */
1159     public function single_select($url, $name, array $options, $selected='', $nothing=array(''=>'choosedots'), $formid=null) {
1160         if (!($url instanceof moodle_url)) {
1161             $url = new moodle_url($url);
1162         }
1163         $select = new single_select($url, $name, $options, $selected, $nothing, $formid);
1165         return $this->render($select);
1166     }
1168     /**
1169      * Internal implementation of single_select rendering
1170      * @param single_select $select
1171      * @return string HTML fragment
1172      */
1173     protected function render_single_select(single_select $select) {
1174         $select = clone($select);
1175         if (empty($select->formid)) {
1176             $select->formid = html_writer::random_id('single_select_f');
1177         }
1179         $output = '';
1180         $params = $select->url->params();
1181         if ($select->method === 'post') {
1182             $params['sesskey'] = sesskey();
1183         }
1184         foreach ($params as $name=>$value) {
1185             $output .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>$name, 'value'=>$value));
1186         }
1188         if (empty($select->attributes['id'])) {
1189             $select->attributes['id'] = html_writer::random_id('single_select');
1190         }
1192         if ($select->disabled) {
1193             $select->attributes['disabled'] = 'disabled';
1194         }
1196         if ($select->tooltip) {
1197             $select->attributes['title'] = $select->tooltip;
1198         }
1200         if ($select->label) {
1201             $output .= html_writer::label($select->label, $select->attributes['id']);
1202         }
1204         if ($select->helpicon instanceof help_icon) {
1205             $output .= $this->render($select->helpicon);
1206         } else if ($select->helpicon instanceof old_help_icon) {
1207             $output .= $this->render($select->helpicon);
1208         }
1210         $output .= html_writer::select($select->options, $select->name, $select->selected, $select->nothing, $select->attributes);
1212         $go = html_writer::empty_tag('input', array('type'=>'submit', 'value'=>get_string('go')));
1213         $output .= html_writer::tag('noscript', html_writer::tag('div', $go), array('style'=>'inline'));
1215         $nothing = empty($select->nothing) ? false : key($select->nothing);
1216         $this->page->requires->js_init_call('M.util.init_select_autosubmit', array($select->formid, $select->attributes['id'], $nothing));
1218         // then div wrapper for xhtml strictness
1219         $output = html_writer::tag('div', $output);
1221         // now the form itself around it
1222         if ($select->method === 'get') {
1223             $url = $select->url->out_omit_querystring(true); // url without params, the anchor part allowed
1224         } else {
1225             $url = $select->url->out_omit_querystring();     // url without params, the anchor part not allowed
1226         }
1227         $formattributes = array('method' => $select->method,
1228                                 'action' => $url,
1229                                 'id'     => $select->formid);
1230         $output = html_writer::tag('form', $output, $formattributes);
1232         // and finally one more wrapper with class
1233         return html_writer::tag('div', $output, array('class' => $select->class));
1234     }
1236     /**
1237      * Returns a form with a url select widget.
1238      * @param array $urls list of urls - array('/course/view.php?id=1'=>'Frontpage', ....)
1239      * @param string $selected selected element
1240      * @param array $nothing
1241      * @param string $formid
1242      * @return string HTML fragment
1243      */
1244     public function url_select(array $urls, $selected, $nothing=array(''=>'choosedots'), $formid=null) {
1245         $select = new url_select($urls, $selected, $nothing, $formid);
1246         return $this->render($select);
1247     }
1249     /**
1250      * Internal implementation of url_select rendering
1251      * @param single_select $select
1252      * @return string HTML fragment
1253      */
1254     protected function render_url_select(url_select $select) {
1255         global $CFG;
1257         $select = clone($select);
1258         if (empty($select->formid)) {
1259             $select->formid = html_writer::random_id('url_select_f');
1260         }
1262         if (empty($select->attributes['id'])) {
1263             $select->attributes['id'] = html_writer::random_id('url_select');
1264         }
1266         if ($select->disabled) {
1267             $select->attributes['disabled'] = 'disabled';
1268         }
1270         if ($select->tooltip) {
1271             $select->attributes['title'] = $select->tooltip;
1272         }
1274         $output = '';
1276         if ($select->label) {
1277             $output .= html_writer::label($select->label, $select->attributes['id']);
1278         }
1280         if ($select->helpicon instanceof help_icon) {
1281             $output .= $this->render($select->helpicon);
1282         } else if ($select->helpicon instanceof old_help_icon) {
1283             $output .= $this->render($select->helpicon);
1284         }
1286         // For security reasons, the script course/jumpto.php requires URL starting with '/'. To keep
1287         // backward compatibility, we are removing heading $CFG->wwwroot from URLs here.
1288         $urls = array();
1289         foreach ($select->urls as $k=>$v) {
1290             if (is_array($v)) {
1291                 // optgroup structure
1292                 foreach ($v as $optgrouptitle => $optgroupoptions) {
1293                     foreach ($optgroupoptions as $optionurl => $optiontitle) {
1294                         if (empty($optionurl)) {
1295                             $safeoptionurl = '';
1296                         } else if (strpos($optionurl, $CFG->wwwroot.'/') === 0) {
1297                             // debugging('URLs passed to url_select should be in local relative form - please fix the code.', DEBUG_DEVELOPER);
1298                             $safeoptionurl = str_replace($CFG->wwwroot, '', $optionurl);
1299                         } else if (strpos($optionurl, '/') !== 0) {
1300                             debugging("Invalid url_select urls parameter inside optgroup: url '$optionurl' is not local relative url!");
1301                             continue;
1302                         } else {
1303                             $safeoptionurl = $optionurl;
1304                         }
1305                         $urls[$k][$optgrouptitle][$safeoptionurl] = $optiontitle;
1306                     }
1307                 }
1308             } else {
1309                 // plain list structure
1310                 if (empty($k)) {
1311                     // nothing selected option
1312                 } else if (strpos($k, $CFG->wwwroot.'/') === 0) {
1313                     $k = str_replace($CFG->wwwroot, '', $k);
1314                 } else if (strpos($k, '/') !== 0) {
1315                     debugging("Invalid url_select urls parameter: url '$k' is not local relative url!");
1316                     continue;
1317                 }
1318                 $urls[$k] = $v;
1319             }
1320         }
1321         $selected = $select->selected;
1322         if (!empty($selected)) {
1323             if (strpos($select->selected, $CFG->wwwroot.'/') === 0) {
1324                 $selected = str_replace($CFG->wwwroot, '', $selected);
1325             } else if (strpos($selected, '/') !== 0) {
1326                 debugging("Invalid value of parameter 'selected': url '$selected' is not local relative url!");
1327             }
1328         }
1330         $output .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'sesskey', 'value'=>sesskey()));
1331         $output .= html_writer::select($urls, 'jump', $selected, $select->nothing, $select->attributes);
1333         if (!$select->showbutton) {
1334             $go = html_writer::empty_tag('input', array('type'=>'submit', 'value'=>get_string('go')));
1335             $output .= html_writer::tag('noscript', html_writer::tag('div', $go), array('style'=>'inline'));
1336             $nothing = empty($select->nothing) ? false : key($select->nothing);
1337             $output .= $this->page->requires->js_init_call('M.util.init_url_select', array($select->formid, $select->attributes['id'], $nothing));
1338         } else {
1339             $output .= html_writer::empty_tag('input', array('type'=>'submit', 'value'=>$select->showbutton));
1340         }
1342         // then div wrapper for xhtml strictness
1343         $output = html_writer::tag('div', $output);
1345         // now the form itself around it
1346         $formattributes = array('method' => 'post',
1347                                 'action' => new moodle_url('/course/jumpto.php'),
1348                                 'id'     => $select->formid);
1349         $output = html_writer::tag('form', $output, $formattributes);
1351         // and finally one more wrapper with class
1352         return html_writer::tag('div', $output, array('class' => $select->class));
1353     }
1355     /**
1356      * Returns a string containing a link to the user documentation.
1357      * Also contains an icon by default. Shown to teachers and admin only.
1358      * @param string $path The page link after doc root and language, no leading slash.
1359      * @param string $text The text to be displayed for the link
1360      * @return string
1361      */
1362     public function doc_link($path, $text = '') {
1363         global $CFG;
1365         $icon = $this->pix_icon('docs', $text, 'moodle', array('class'=>'iconhelp'));
1367         $url = new moodle_url(get_docs_url($path));
1369         $attributes = array('href'=>$url);
1370         if (!empty($CFG->doctonewwindow)) {
1371             $attributes['id'] = $this->add_action_handler(new popup_action('click', $url));
1372         }
1374         return html_writer::tag('a', $icon.$text, $attributes);
1375     }
1377     /**
1378      * Render icon
1379      * @param string $pix short pix name
1380      * @param string $alt mandatory alt attribute
1381      * @param string $component standard compoennt name like 'moodle', 'mod_forum', etc.
1382      * @param array $attributes htm lattributes
1383      * @return string HTML fragment
1384      */
1385     public function pix_icon($pix, $alt, $component='moodle', array $attributes = null) {
1386         $icon = new pix_icon($pix, $alt, $component, $attributes);
1387         return $this->render($icon);
1388     }
1390     /**
1391      * Render icon
1392      * @param pix_icon $icon
1393      * @return string HTML fragment
1394      */
1395     protected function render_pix_icon(pix_icon $icon) {
1396         $attributes = $icon->attributes;
1397         $attributes['src'] = $this->pix_url($icon->pix, $icon->component);
1398         return html_writer::empty_tag('img', $attributes);
1399     }
1401     /**
1402      * Render emoticon
1403      * @param pix_emoticon $emoticon
1404      * @return string HTML fragment
1405      */
1406     protected function render_pix_emoticon(pix_emoticon $emoticon) {
1407         $attributes = $emoticon->attributes;
1408         $attributes['src'] = $this->pix_url($emoticon->pix, $emoticon->component);
1409         return html_writer::empty_tag('img', $attributes);
1410     }
1412     /**
1413     * Produces the html that represents this rating in the UI
1414     * @param $page the page object on which this rating will appear
1415     */
1416     function render_rating(rating $rating) {
1417         global $CFG, $USER;
1419         if ($rating->settings->aggregationmethod == RATING_AGGREGATE_NONE) {
1420             return null;//ratings are turned off
1421         }
1423         $ratingmanager = new rating_manager();
1424         // Initialise the JavaScript so ratings can be done by AJAX.
1425         $ratingmanager->initialise_rating_javascript($this->page);
1427         $strrate = get_string("rate", "rating");
1428         $ratinghtml = ''; //the string we'll return
1430         // permissions check - can they view the aggregate?
1431         if ($rating->user_can_view_aggregate()) {
1433             $aggregatelabel = $ratingmanager->get_aggregate_label($rating->settings->aggregationmethod);
1434             $aggregatestr   = $rating->get_aggregate_string();
1436             $aggregatehtml  = html_writer::tag('span', $aggregatestr, array('id' => 'ratingaggregate'.$rating->itemid)).' ';
1437             $aggregatehtml .= html_writer::start_tag('span', array('id'=>"ratingcount{$rating->itemid}"));
1438             if ($rating->count > 0) {
1439                 $aggregatehtml .= "({$rating->count})";
1440             } else {
1441                 $aggregatehtml .= '-';
1442             }
1443             $aggregatehtml .= html_writer::end_tag('span').' ';
1445             $ratinghtml .= html_writer::tag('span', $aggregatelabel, array('class'=>'rating-aggregate-label'));
1446             if ($rating->settings->permissions->viewall && $rating->settings->pluginpermissions->viewall) {
1448                 $nonpopuplink = $rating->get_view_ratings_url();
1449                 $popuplink = $rating->get_view_ratings_url(true);
1451                 $action = new popup_action('click', $popuplink, 'ratings', array('height' => 400, 'width' => 600));
1452                 $ratinghtml .= $this->action_link($nonpopuplink, $aggregatehtml, $action);
1453             } else {
1454                 $ratinghtml .= $aggregatehtml;
1455             }
1456         }
1458         $formstart = null;
1459         // if the item doesn't belong to the current user, the user has permission to rate
1460         // and we're within the assessable period
1461         if ($rating->user_can_rate()) {
1463             $rateurl = $rating->get_rate_url();
1464             $inputs = $rateurl->params();
1466             //start the rating form
1467             $formattrs = array(
1468                 'id'     => "postrating{$rating->itemid}",
1469                 'class'  => 'postratingform',
1470                 'method' => 'post',
1471                 'action' => $rateurl->out_omit_querystring()
1472             );
1473             $formstart  = html_writer::start_tag('form', $formattrs);
1474             $formstart .= html_writer::start_tag('div', array('class' => 'ratingform'));
1476             // add the hidden inputs
1477             foreach ($inputs as $name => $value) {
1478                 $attributes = array('type' => 'hidden', 'class' => 'ratinginput', 'name' => $name, 'value' => $value);
1479                 $formstart .= html_writer::empty_tag('input', $attributes);
1480             }
1482             if (empty($ratinghtml)) {
1483                 $ratinghtml .= $strrate.': ';
1484             }
1485             $ratinghtml = $formstart.$ratinghtml;
1487             $scalearray = array(RATING_UNSET_RATING => $strrate.'...') + $rating->settings->scale->scaleitems;
1488             $scaleattrs = array('class'=>'postratingmenu ratinginput','id'=>'menurating'.$rating->itemid);
1489             $ratinghtml .= html_writer::select($scalearray, 'rating', $rating->rating, false, $scaleattrs);
1491             //output submit button
1492             $ratinghtml .= html_writer::start_tag('span', array('class'=>"ratingsubmit"));
1494             $attributes = array('type' => 'submit', 'class' => 'postratingmenusubmit', 'id' => 'postratingsubmit'.$rating->itemid, 'value' => s(get_string('rate', 'rating')));
1495             $ratinghtml .= html_writer::empty_tag('input', $attributes);
1497             if (!$rating->settings->scale->isnumeric) {
1498                 $ratinghtml .= $this->help_icon_scale($rating->settings->scale->courseid, $rating->settings->scale);
1499             }
1500             $ratinghtml .= html_writer::end_tag('span');
1501             $ratinghtml .= html_writer::end_tag('div');
1502             $ratinghtml .= html_writer::end_tag('form');
1503         }
1505         return $ratinghtml;
1506     }
1508     /*
1509      * Centered heading with attached help button (same title text)
1510      * and optional icon attached
1511      * @param string $text A heading text
1512      * @param string $helpidentifier The keyword that defines a help page
1513      * @param string $component component name
1514      * @param string|moodle_url $icon
1515      * @param string $iconalt icon alt text
1516      * @return string HTML fragment
1517      */
1518     public function heading_with_help($text, $helpidentifier, $component='moodle', $icon='', $iconalt='') {
1519         $image = '';
1520         if ($icon) {
1521             $image = $this->pix_icon($icon, $iconalt, $component, array('class'=>'icon'));
1522         }
1524         $help = '';
1525         if ($helpidentifier) {
1526             $help = $this->help_icon($helpidentifier, $component);
1527         }
1529         return $this->heading($image.$text.$help, 2, 'main help');
1530     }
1532     /**
1533      * Print a help icon.
1534      *
1535      * @deprecated since Moodle 2.0
1536      * @param string $page The keyword that defines a help page
1537      * @param string $title A descriptive text for accessibility only
1538      * @param string $component component name
1539      * @param string|bool $linktext true means use $title as link text, string means link text value
1540      * @return string HTML fragment
1541      */
1542     public function old_help_icon($helpidentifier, $title, $component = 'moodle', $linktext = '') {
1543         debugging('The method old_help_icon() is deprecated, please fix the code and use help_icon() method instead', DEBUG_DEVELOPER);
1544         $icon = new old_help_icon($helpidentifier, $title, $component);
1545         if ($linktext === true) {
1546             $icon->linktext = $title;
1547         } else if (!empty($linktext)) {
1548             $icon->linktext = $linktext;
1549         }
1550         return $this->render($icon);
1551     }
1553     /**
1554      * Implementation of user image rendering.
1555      * @param help_icon $helpicon
1556      * @return string HTML fragment
1557      */
1558     protected function render_old_help_icon(old_help_icon $helpicon) {
1559         global $CFG;
1561         // first get the help image icon
1562         $src = $this->pix_url('help');
1564         if (empty($helpicon->linktext)) {
1565             $alt = $helpicon->title;
1566         } else {
1567             $alt = get_string('helpwiththis');
1568         }
1570         $attributes = array('src'=>$src, 'alt'=>$alt, 'class'=>'iconhelp');
1571         $output = html_writer::empty_tag('img', $attributes);
1573         // add the link text if given
1574         if (!empty($helpicon->linktext)) {
1575             // the spacing has to be done through CSS
1576             $output .= $helpicon->linktext;
1577         }
1579         // now create the link around it - we need https on loginhttps pages
1580         $url = new moodle_url($CFG->httpswwwroot.'/help.php', array('component' => $helpicon->component, 'identifier' => $helpicon->helpidentifier, 'lang'=>current_language()));
1582         // note: this title is displayed only if JS is disabled, otherwise the link will have the new ajax tooltip
1583         $title = get_string('helpprefix2', '', trim($helpicon->title, ". \t"));
1585         $attributes = array('href'=>$url, 'title'=>$title);
1586         $id = html_writer::random_id('helpicon');
1587         $attributes['id'] = $id;
1588         $output = html_writer::tag('a', $output, $attributes);
1590         $this->page->requires->js_init_call('M.util.help_icon.add', array(array('id'=>$id, 'url'=>$url->out(false))));
1592         // and finally span
1593         return html_writer::tag('span', $output, array('class' => 'helplink'));
1594     }
1596     /**
1597      * Print a help icon.
1598      *
1599      * @param string $identifier The keyword that defines a help page
1600      * @param string $component component name
1601      * @param string|bool $linktext true means use $title as link text, string means link text value
1602      * @return string HTML fragment
1603      */
1604     public function help_icon($identifier, $component = 'moodle', $linktext = '') {
1605         $icon = new help_icon($identifier, $component);
1606         $icon->diag_strings();
1607         if ($linktext === true) {
1608             $icon->linktext = get_string($icon->identifier, $icon->component);
1609         } else if (!empty($linktext)) {
1610             $icon->linktext = $linktext;
1611         }
1612         return $this->render($icon);
1613     }
1615     /**
1616      * Implementation of user image rendering.
1617      * @param help_icon $helpicon
1618      * @return string HTML fragment
1619      */
1620     protected function render_help_icon(help_icon $helpicon) {
1621         global $CFG;
1623         // first get the help image icon
1624         $src = $this->pix_url('help');
1626         $title = get_string($helpicon->identifier, $helpicon->component);
1628         if (empty($helpicon->linktext)) {
1629             $alt = $title;
1630         } else {
1631             $alt = get_string('helpwiththis');
1632         }
1634         $attributes = array('src'=>$src, 'alt'=>$alt, 'class'=>'iconhelp');
1635         $output = html_writer::empty_tag('img', $attributes);
1637         // add the link text if given
1638         if (!empty($helpicon->linktext)) {
1639             // the spacing has to be done through CSS
1640             $output .= $helpicon->linktext;
1641         }
1643         // now create the link around it - we need https on loginhttps pages
1644         $url = new moodle_url($CFG->httpswwwroot.'/help.php', array('component' => $helpicon->component, 'identifier' => $helpicon->identifier, 'lang'=>current_language()));
1646         // note: this title is displayed only if JS is disabled, otherwise the link will have the new ajax tooltip
1647         $title = get_string('helpprefix2', '', trim($title, ". \t"));
1649         $attributes = array('href'=>$url, 'title'=>$title);
1650         $id = html_writer::random_id('helpicon');
1651         $attributes['id'] = $id;
1652         $output = html_writer::tag('a', $output, $attributes);
1654         $this->page->requires->js_init_call('M.util.help_icon.add', array(array('id'=>$id, 'url'=>$url->out(false))));
1656         // and finally span
1657         return html_writer::tag('span', $output, array('class' => 'helplink'));
1658     }
1660     /**
1661      * Print scale help icon.
1662      *
1663      * @param int $courseid
1664      * @param object $scale instance
1665      * @return string  HTML fragment
1666      */
1667     public function help_icon_scale($courseid, stdClass $scale) {
1668         global $CFG;
1670         $title = get_string('helpprefix2', '', $scale->name) .' ('.get_string('newwindow').')';
1672         $icon = $this->pix_icon('help', get_string('scales'), 'moodle', array('class'=>'iconhelp'));
1674         $scaleid = abs($scale->id);
1676         $link = new moodle_url('/course/scales.php', array('id' => $courseid, 'list' => true, 'scaleid' => $scaleid));
1677         $action = new popup_action('click', $link, 'ratingscale');
1679         return html_writer::tag('span', $this->action_link($link, $icon, $action), array('class' => 'helplink'));
1680     }
1682     /**
1683      * Creates and returns a spacer image with optional line break.
1684      *
1685      * @param array $attributes
1686      * @param boo spacer
1687      * @return string HTML fragment
1688      */
1689     public function spacer(array $attributes = null, $br = false) {
1690         $attributes = (array)$attributes;
1691         if (empty($attributes['width'])) {
1692             $attributes['width'] = 1;
1693         }
1694         if (empty($attributes['height'])) {
1695             $attributes['height'] = 1;
1696         }
1697         $attributes['class'] = 'spacer';
1699         $output = $this->pix_icon('spacer', '', 'moodle', $attributes);
1701         if (!empty($br)) {
1702             $output .= '<br />';
1703         }
1705         return $output;
1706     }
1708     /**
1709      * Print the specified user's avatar.
1710      *
1711      * User avatar may be obtained in two ways:
1712      * <pre>
1713      * // Option 1: (shortcut for simple cases, preferred way)
1714      * // $user has come from the DB and has fields id, picture, imagealt, firstname and lastname
1715      * $OUTPUT->user_picture($user, array('popup'=>true));
1716      *
1717      * // Option 2:
1718      * $userpic = new user_picture($user);
1719      * // Set properties of $userpic
1720      * $userpic->popup = true;
1721      * $OUTPUT->render($userpic);
1722      * </pre>
1723      *
1724      * @param object Object with at least fields id, picture, imagealt, firstname, lastname
1725      *     If any of these are missing, the database is queried. Avoid this
1726      *     if at all possible, particularly for reports. It is very bad for performance.
1727      * @param array $options associative array with user picture options, used only if not a user_picture object,
1728      *     options are:
1729      *     - courseid=$this->page->course->id (course id of user profile in link)
1730      *     - size=35 (size of image)
1731      *     - link=true (make image clickable - the link leads to user profile)
1732      *     - popup=false (open in popup)
1733      *     - alttext=true (add image alt attribute)
1734      *     - class = image class attribute (default 'userpicture')
1735      * @return string HTML fragment
1736      */
1737     public function user_picture(stdClass $user, array $options = null) {
1738         $userpicture = new user_picture($user);
1739         foreach ((array)$options as $key=>$value) {
1740             if (array_key_exists($key, $userpicture)) {
1741                 $userpicture->$key = $value;
1742             }
1743         }
1744         return $this->render($userpicture);
1745     }
1747     /**
1748      * Internal implementation of user image rendering.
1749      * @param user_picture $userpicture
1750      * @return string
1751      */
1752     protected function render_user_picture(user_picture $userpicture) {
1753         global $CFG, $DB;
1755         $user = $userpicture->user;
1757         if ($userpicture->alttext) {
1758             if (!empty($user->imagealt)) {
1759                 $alt = $user->imagealt;
1760             } else {
1761                 $alt = get_string('pictureof', '', fullname($user));
1762             }
1763         } else {
1764             $alt = '';
1765         }
1767         if (empty($userpicture->size)) {
1768             $file = 'f2';
1769             $size = 35;
1770         } else if ($userpicture->size === true or $userpicture->size == 1) {
1771             $file = 'f1';
1772             $size = 100;
1773         } else if ($userpicture->size >= 50) {
1774             $file = 'f1';
1775             $size = $userpicture->size;
1776         } else {
1777             $file = 'f2';
1778             $size = $userpicture->size;
1779         }
1781         $class = $userpicture->class;
1783         if ($user->picture == 1) {
1784             $usercontext = get_context_instance(CONTEXT_USER, $user->id);
1785             $src = moodle_url::make_pluginfile_url($usercontext->id, 'user', 'icon', NULL, '/', $file);
1787         } else if ($user->picture == 2) {
1788             //TODO: gravatar user icon support
1790         } else { // Print default user pictures (use theme version if available)
1791             $class .= ' defaultuserpic';
1792             $src = $this->pix_url('u/' . $file);
1793         }
1795         $attributes = array('src'=>$src, 'alt'=>$alt, 'title'=>$alt, 'class'=>$class, 'width'=>$size, 'height'=>$size);
1797         // get the image html output fisrt
1798         $output = html_writer::empty_tag('img', $attributes);;
1800         // then wrap it in link if needed
1801         if (!$userpicture->link) {
1802             return $output;
1803         }
1805         if (empty($userpicture->courseid)) {
1806             $courseid = $this->page->course->id;
1807         } else {
1808             $courseid = $userpicture->courseid;
1809         }
1811         if ($courseid == SITEID) {
1812             $url = new moodle_url('/user/profile.php', array('id' => $user->id));
1813         } else {
1814             $url = new moodle_url('/user/view.php', array('id' => $user->id, 'course' => $courseid));
1815         }
1817         $attributes = array('href'=>$url);
1819         if ($userpicture->popup) {
1820             $id = html_writer::random_id('userpicture');
1821             $attributes['id'] = $id;
1822             $this->add_action_handler(new popup_action('click', $url), $id);
1823         }
1825         return html_writer::tag('a', $output, $attributes);
1826     }
1828     /**
1829      * Internal implementation of file tree viewer items rendering.
1830      * @param array $dir
1831      * @return string
1832      */
1833     public function htmllize_file_tree($dir) {
1834         if (empty($dir['subdirs']) and empty($dir['files'])) {
1835             return '';
1836         }
1837         $result = '<ul>';
1838         foreach ($dir['subdirs'] as $subdir) {
1839             $result .= '<li>'.s($subdir['dirname']).' '.$this->htmllize_file_tree($subdir).'</li>';
1840         }
1841         foreach ($dir['files'] as $file) {
1842             $filename = $file->get_filename();
1843             $result .= '<li><span>'.html_writer::link($file->fileurl, $filename).'</span></li>';
1844         }
1845         $result .= '</ul>';
1847         return $result;
1848     }
1849     /**
1850      * Print the file picker
1851      *
1852      * <pre>
1853      * $OUTPUT->file_picker($options);
1854      * </pre>
1855      *
1856      * @param array $options associative array with file manager options
1857      *   options are:
1858      *       maxbytes=>-1,
1859      *       itemid=>0,
1860      *       client_id=>uniqid(),
1861      *       acepted_types=>'*',
1862      *       return_types=>FILE_INTERNAL,
1863      *       context=>$PAGE->context
1864      * @return string HTML fragment
1865      */
1866     public function file_picker($options) {
1867         $fp = new file_picker($options);
1868         return $this->render($fp);
1869     }
1870     /**
1871      * Internal implementation of file picker rendering.
1872      * @param file_picker $fp
1873      * @return string
1874      */
1875     public function render_file_picker(file_picker $fp) {
1876         global $CFG, $OUTPUT, $USER;
1877         $options = $fp->options;
1878         $client_id = $options->client_id;
1879         $strsaved = get_string('filesaved', 'repository');
1880         $straddfile = get_string('openpicker', 'repository');
1881         $strloading  = get_string('loading', 'repository');
1882         $icon_progress = $OUTPUT->pix_icon('i/loading_small', $strloading).'';
1884         $currentfile = $options->currentfile;
1885         if (empty($currentfile)) {
1886             $currentfile = get_string('nofilesattached', 'repository');
1887         }
1888         if ($options->maxbytes) {
1889             $size = $options->maxbytes;
1890         } else {
1891             $size = get_max_upload_file_size();
1892         }
1893         if ($size == -1) {
1894             $maxsize = '';
1895         } else {
1896             $maxsize = get_string('maxfilesize', 'moodle', display_size($size));
1897         }
1898         if ($options->buttonname) {
1899             $buttonname = ' name="' . $options->buttonname . '"';
1900         } else {
1901             $buttonname = '';
1902         }
1903         $html = <<<EOD
1904 <div class="filemanager-loading mdl-align" id='filepicker-loading-{$client_id}'>
1905 $icon_progress
1906 </div>
1907 <div id="filepicker-wrapper-{$client_id}" class="mdl-left" style="display:none">
1908     <div>
1909         <input type="button" id="filepicker-button-{$client_id}" value="{$straddfile}"{$buttonname}/>
1910         <span> $maxsize </span>
1911     </div>
1912 EOD;
1913         if ($options->env != 'url') {
1914             $html .= <<<EOD
1915     <div id="file_info_{$client_id}" class="mdl-left filepicker-filelist">$currentfile</div>
1916 EOD;
1917         }
1918         $html .= '</div>';
1919         return $html;
1920     }
1922     /**
1923      * Prints the 'Update this Modulename' button that appears on module pages.
1924      *
1925      * @param string $cmid the course_module id.
1926      * @param string $modulename the module name, eg. "forum", "quiz" or "workshop"
1927      * @return string the HTML for the button, if this user has permission to edit it, else an empty string.
1928      */
1929     public function update_module_button($cmid, $modulename) {
1930         global $CFG;
1931         if (has_capability('moodle/course:manageactivities', get_context_instance(CONTEXT_MODULE, $cmid))) {
1932             $modulename = get_string('modulename', $modulename);
1933             $string = get_string('updatethis', '', $modulename);
1934             $url = new moodle_url("$CFG->wwwroot/course/mod.php", array('update' => $cmid, 'return' => true, 'sesskey' => sesskey()));
1935             return $this->single_button($url, $string);
1936         } else {
1937             return '';
1938         }
1939     }
1941     /**
1942      * Prints a "Turn editing on/off" button in a form.
1943      * @param moodle_url $url The URL + params to send through when clicking the button
1944      * @return string HTML the button
1945      */
1946     public function edit_button(moodle_url $url) {
1948         $url->param('sesskey', sesskey());
1949         if ($this->page->user_is_editing()) {
1950             $url->param('edit', 'off');
1951             $editstring = get_string('turneditingoff');
1952         } else {
1953             $url->param('edit', 'on');
1954             $editstring = get_string('turneditingon');
1955         }
1957         return $this->single_button($url, $editstring);
1958     }
1960     /**
1961      * Prints a simple button to close a window
1962      *
1963      * @param string $text The lang string for the button's label (already output from get_string())
1964      * @return string html fragment
1965      */
1966     public function close_window_button($text='') {
1967         if (empty($text)) {
1968             $text = get_string('closewindow');
1969         }
1970         $button = new single_button(new moodle_url('#'), $text, 'get');
1971         $button->add_action(new component_action('click', 'close_window'));
1973         return $this->container($this->render($button), 'closewindow');
1974     }
1976     /**
1977      * Output an error message. By default wraps the error message in <span class="error">.
1978      * If the error message is blank, nothing is output.
1979      * @param string $message the error message.
1980      * @return string the HTML to output.
1981      */
1982     public function error_text($message) {
1983         if (empty($message)) {
1984             return '';
1985         }
1986         return html_writer::tag('span', $message, array('class' => 'error'));
1987     }
1989     /**
1990      * Do not call this function directly.
1991      *
1992      * To terminate the current script with a fatal error, call the {@link print_error}
1993      * function, or throw an exception. Doing either of those things will then call this
1994      * function to display the error, before terminating the execution.
1995      *
1996      * @param string $message The message to output
1997      * @param string $moreinfourl URL where more info can be found about the error
1998      * @param string $link Link for the Continue button
1999      * @param array $backtrace The execution backtrace
2000      * @param string $debuginfo Debugging information
2001      * @return string the HTML to output.
2002      */
2003     public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
2004         global $CFG;
2006         $output = '';
2007         $obbuffer = '';
2009         if ($this->has_started()) {
2010             // we can not always recover properly here, we have problems with output buffering,
2011             // html tables, etc.
2012             $output .= $this->opencontainers->pop_all_but_last();
2014         } else {
2015             // It is really bad if library code throws exception when output buffering is on,
2016             // because the buffered text would be printed before our start of page.
2017             // NOTE: this hack might be behave unexpectedly in case output buffering is enabled in PHP.ini
2018             error_reporting(0); // disable notices from gzip compression, etc.
2019             while (ob_get_level() > 0) {
2020                 $buff = ob_get_clean();
2021                 if ($buff === false) {
2022                     break;
2023                 }
2024                 $obbuffer .= $buff;
2025             }
2026             error_reporting($CFG->debug);
2028             // Header not yet printed
2029             if (isset($_SERVER['SERVER_PROTOCOL'])) {
2030                 // server protocol should be always present, because this render
2031                 // can not be used from command line or when outputting custom XML
2032                 @header($_SERVER['SERVER_PROTOCOL'] . ' 404 Not Found');
2033             }
2034             $this->page->set_context(null); // ugly hack - make sure page context is set to something, we do not want bogus warnings here
2035             $this->page->set_url('/'); // no url
2036             //$this->page->set_pagelayout('base'); //TODO: MDL-20676 blocks on error pages are weird, unfortunately it somehow detect the pagelayout from URL :-(
2037             $this->page->set_title(get_string('error'));
2038             $this->page->set_heading($this->page->course->fullname);
2039             $output .= $this->header();
2040         }
2042         $message = '<p class="errormessage">' . $message . '</p>'.
2043                 '<p class="errorcode"><a href="' . $moreinfourl . '">' .
2044                 get_string('moreinformation') . '</a></p>';
2045         $output .= $this->box($message, 'errorbox');
2047         if (debugging('', DEBUG_DEVELOPER)) {
2048             if (!empty($debuginfo)) {
2049                 $debuginfo = s($debuginfo); // removes all nasty JS
2050                 $debuginfo = str_replace("\n", '<br />', $debuginfo); // keep newlines
2051                 $output .= $this->notification('<strong>Debug info:</strong> '.$debuginfo, 'notifytiny');
2052             }
2053             if (!empty($backtrace)) {
2054                 $output .= $this->notification('<strong>Stack trace:</strong> '.format_backtrace($backtrace), 'notifytiny');
2055             }
2056             if ($obbuffer !== '' ) {
2057                 $output .= $this->notification('<strong>Output buffer:</strong> '.s($obbuffer), 'notifytiny');
2058             }
2059         }
2061         if (!empty($link)) {
2062             $output .= $this->continue_button($link);
2063         }
2065         $output .= $this->footer();
2067         // Padding to encourage IE to display our error page, rather than its own.
2068         $output .= str_repeat(' ', 512);
2070         return $output;
2071     }
2073     /**
2074      * Output a notification (that is, a status message about something that has
2075      * just happened).
2076      *
2077      * @param string $message the message to print out
2078      * @param string $classes normally 'notifyproblem' or 'notifysuccess'.
2079      * @return string the HTML to output.
2080      */
2081     public function notification($message, $classes = 'notifyproblem') {
2082         return html_writer::tag('div', clean_text($message), array('class' => renderer_base::prepare_classes($classes)));
2083     }
2085     /**
2086      * Print a continue button that goes to a particular URL.
2087      *
2088      * @param string|moodle_url $url The url the button goes to.
2089      * @return string the HTML to output.
2090      */
2091     public function continue_button($url) {
2092         if (!($url instanceof moodle_url)) {
2093             $url = new moodle_url($url);
2094         }
2095         $button = new single_button($url, get_string('continue'), 'get');
2096         $button->class = 'continuebutton';
2098         return $this->render($button);
2099     }
2101     /**
2102      * Prints a single paging bar to provide access to other pages  (usually in a search)
2103      *
2104      * @param int $totalcount The total number of entries available to be paged through
2105      * @param int $page The page you are currently viewing
2106      * @param int $perpage The number of entries that should be shown per page
2107      * @param string|moodle_url $baseurl url of the current page, the $pagevar parameter is added
2108      * @param string $pagevar name of page parameter that holds the page number
2109      * @return string the HTML to output.
2110      */
2111     public function paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar = 'page') {
2112         $pb = new paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar);
2113         return $this->render($pb);
2114     }
2116     /**
2117      * Internal implementation of paging bar rendering.
2118      * @param paging_bar $pagingbar
2119      * @return string
2120      */
2121     protected function render_paging_bar(paging_bar $pagingbar) {
2122         $output = '';
2123         $pagingbar = clone($pagingbar);
2124         $pagingbar->prepare($this, $this->page, $this->target);
2126         if ($pagingbar->totalcount > $pagingbar->perpage) {
2127             $output .= get_string('page') . ':';
2129             if (!empty($pagingbar->previouslink)) {
2130                 $output .= '&#160;(' . $pagingbar->previouslink . ')&#160;';
2131             }
2133             if (!empty($pagingbar->firstlink)) {
2134                 $output .= '&#160;' . $pagingbar->firstlink . '&#160;...';
2135             }
2137             foreach ($pagingbar->pagelinks as $link) {
2138                 $output .= "&#160;&#160;$link";
2139             }
2141             if (!empty($pagingbar->lastlink)) {
2142                 $output .= '&#160;...' . $pagingbar->lastlink . '&#160;';
2143             }
2145             if (!empty($pagingbar->nextlink)) {
2146                 $output .= '&#160;&#160;(' . $pagingbar->nextlink . ')';
2147             }
2148         }
2150         return html_writer::tag('div', $output, array('class' => 'paging'));
2151     }
2153     /**
2154      * Output the place a skip link goes to.
2155      * @param string $id The target name from the corresponding $PAGE->requires->skip_link_to($target) call.
2156      * @return string the HTML to output.
2157      */
2158     public function skip_link_target($id = null) {
2159         return html_writer::tag('span', '', array('id' => $id));
2160     }
2162     /**
2163      * Outputs a heading
2164      * @param string $text The text of the heading
2165      * @param int $level The level of importance of the heading. Defaulting to 2
2166      * @param string $classes A space-separated list of CSS classes
2167      * @param string $id An optional ID
2168      * @return string the HTML to output.
2169      */
2170     public function heading($text, $level = 2, $classes = 'main', $id = null) {
2171         $level = (integer) $level;
2172         if ($level < 1 or $level > 6) {
2173             throw new coding_exception('Heading level must be an integer between 1 and 6.');
2174         }
2175         return html_writer::tag('h' . $level, $text, array('id' => $id, 'class' => renderer_base::prepare_classes($classes)));
2176     }
2178     /**
2179      * Outputs a box.
2180      * @param string $contents The contents of the box
2181      * @param string $classes A space-separated list of CSS classes
2182      * @param string $id An optional ID
2183      * @return string the HTML to output.
2184      */
2185     public function box($contents, $classes = 'generalbox', $id = null) {
2186         return $this->box_start($classes, $id) . $contents . $this->box_end();
2187     }
2189     /**
2190      * Outputs the opening section of a box.
2191      * @param string $classes A space-separated list of CSS classes
2192      * @param string $id An optional ID
2193      * @return string the HTML to output.
2194      */
2195     public function box_start($classes = 'generalbox', $id = null) {
2196         $this->opencontainers->push('box', html_writer::end_tag('div'));
2197         return html_writer::start_tag('div', array('id' => $id,
2198                 'class' => 'box ' . renderer_base::prepare_classes($classes)));
2199     }
2201     /**
2202      * Outputs the closing section of a box.
2203      * @return string the HTML to output.
2204      */
2205     public function box_end() {
2206         return $this->opencontainers->pop('box');
2207     }
2209     /**
2210      * Outputs a container.
2211      * @param string $contents The contents of the box
2212      * @param string $classes A space-separated list of CSS classes
2213      * @param string $id An optional ID
2214      * @return string the HTML to output.
2215      */
2216     public function container($contents, $classes = null, $id = null) {
2217         return $this->container_start($classes, $id) . $contents . $this->container_end();
2218     }
2220     /**
2221      * Outputs the opening section of a container.
2222      * @param string $classes A space-separated list of CSS classes
2223      * @param string $id An optional ID
2224      * @return string the HTML to output.
2225      */
2226     public function container_start($classes = null, $id = null) {
2227         $this->opencontainers->push('container', html_writer::end_tag('div'));
2228         return html_writer::start_tag('div', array('id' => $id,
2229                 'class' => renderer_base::prepare_classes($classes)));
2230     }
2232     /**
2233      * Outputs the closing section of a container.
2234      * @return string the HTML to output.
2235      */
2236     public function container_end() {
2237         return $this->opencontainers->pop('container');
2238     }
2240     /**
2241      * Make nested HTML lists out of the items
2242      *
2243      * The resulting list will look something like this:
2244      *
2245      * <pre>
2246      * <<ul>>
2247      * <<li>><div class='tree_item parent'>(item contents)</div>
2248      *      <<ul>
2249      *      <<li>><div class='tree_item'>(item contents)</div><</li>>
2250      *      <</ul>>
2251      * <</li>>
2252      * <</ul>>
2253      * </pre>
2254      *
2255      * @param array[]tree_item $items
2256      * @param array[string]string $attrs html attributes passed to the top of
2257      * the list
2258      * @return string HTML
2259      */
2260     function tree_block_contents($items, $attrs=array()) {
2261         // exit if empty, we don't want an empty ul element
2262         if (empty($items)) {
2263             return '';
2264         }
2265         // array of nested li elements
2266         $lis = array();
2267         foreach ($items as $item) {
2268             // this applies to the li item which contains all child lists too
2269             $content = $item->content($this);
2270             $liclasses = array($item->get_css_type());
2271             if (!$item->forceopen || (!$item->forceopen && $item->collapse) || ($item->children->count()==0  && $item->nodetype==navigation_node::NODETYPE_BRANCH)) {
2272                 $liclasses[] = 'collapsed';
2273             }
2274             if ($item->isactive === true) {
2275                 $liclasses[] = 'current_branch';
2276             }
2277             $liattr = array('class'=>join(' ',$liclasses));
2278             // class attribute on the div item which only contains the item content
2279             $divclasses = array('tree_item');
2280             if ($item->children->count()>0  || $item->nodetype==navigation_node::NODETYPE_BRANCH) {
2281                 $divclasses[] = 'branch';
2282             } else {
2283                 $divclasses[] = 'leaf';
2284             }
2285             if (!empty($item->classes) && count($item->classes)>0) {
2286                 $divclasses[] = join(' ', $item->classes);
2287             }
2288             $divattr = array('class'=>join(' ', $divclasses));
2289             if (!empty($item->id)) {
2290                 $divattr['id'] = $item->id;
2291             }
2292             $content = html_writer::tag('p', $content, $divattr) . $this->tree_block_contents($item->children);
2293             if (!empty($item->preceedwithhr) && $item->preceedwithhr===true) {
2294                 $content = html_writer::empty_tag('hr') . $content;
2295             }
2296             $content = html_writer::tag('li', $content, $liattr);
2297             $lis[] = $content;
2298         }
2299         return html_writer::tag('ul', implode("\n", $lis), $attrs);
2300     }
2302     /**
2303      * Return the navbar content so that it can be echoed out by the layout
2304      * @return string XHTML navbar
2305      */
2306     public function navbar() {
2307         $items = $this->page->navbar->get_items();
2309         $htmlblocks = array();
2310         // Iterate the navarray and display each node
2311         $itemcount = count($items);
2312         $separator = get_separator();
2313         for ($i=0;$i < $itemcount;$i++) {
2314             $item = $items[$i];
2315             $item->hideicon = true;
2316             if ($i===0) {
2317                 $content = html_writer::tag('li', $this->render($item));
2318             } else {
2319                 $content = html_writer::tag('li', $separator.$this->render($item));
2320             }
2321             $htmlblocks[] = $content;
2322         }
2324         //accessibility: heading for navbar list  (MDL-20446)
2325         $navbarcontent = html_writer::tag('span', get_string('pagepath'), array('class'=>'accesshide'));
2326         $navbarcontent .= html_writer::tag('ul', join('', $htmlblocks));
2327         // XHTML
2328         return $navbarcontent;
2329     }
2331     protected function render_navigation_node(navigation_node $item) {
2332         $content = $item->get_content();
2333         $title = $item->get_title();
2334         if ($item->icon instanceof renderable && !$item->hideicon) {
2335             $icon = $this->render($item->icon);
2336             $content = $icon.$content; // use CSS for spacing of icons
2337         }
2338         if ($item->helpbutton !== null) {
2339             $content = trim($item->helpbutton).html_writer::tag('span', $content, array('class'=>'clearhelpbutton', 'tabindex'=>'0'));
2340         }
2341         if ($content === '') {
2342             return '';
2343         }
2344         if ($item->action instanceof action_link) {
2345             $link = $item->action;
2346             if ($item->hidden) {
2347                 $link->add_class('dimmed');
2348             }
2349             $link->text = $content.$link->text; // add help icon
2350             $content = $this->render($link);
2351         } else if ($item->action instanceof moodle_url) {
2352             $attributes = array();
2353             if ($title !== '') {
2354                 $attributes['title'] = $title;
2355             }
2356             if ($item->hidden) {
2357                 $attributes['class'] = 'dimmed_text';
2358             }
2359             $content = html_writer::link($item->action, $content, $attributes);
2361         } else if (is_string($item->action) || empty($item->action)) {
2362             $attributes = array('tabindex'=>'0'); //add tab support to span but still maintain character stream sequence.
2363             if ($title !== '') {
2364                 $attributes['title'] = $title;
2365             }
2366             if ($item->hidden) {
2367                 $attributes['class'] = 'dimmed_text';
2368             }
2369             $content = html_writer::tag('span', $content, $attributes);
2370         }
2371         return $content;
2372     }
2374     /**
2375      * Accessibility: Right arrow-like character is
2376      * used in the breadcrumb trail, course navigation menu
2377      * (previous/next activity), calendar, and search forum block.
2378      * If the theme does not set characters, appropriate defaults
2379      * are set automatically. Please DO NOT
2380      * use &lt; &gt; &raquo; - these are confusing for blind users.
2381      * @return string
2382      */
2383     public function rarrow() {
2384         return $this->page->theme->rarrow;
2385     }
2387     /**
2388      * Accessibility: Right arrow-like character is
2389      * used in the breadcrumb trail, course navigation menu
2390      * (previous/next activity), calendar, and search forum block.
2391      * If the theme does not set characters, appropriate defaults
2392      * are set automatically. Please DO NOT
2393      * use &lt; &gt; &raquo; - these are confusing for blind users.
2394      * @return string
2395      */
2396     public function larrow() {
2397         return $this->page->theme->larrow;
2398     }
2400     /**
2401      * Returns the custom menu if one has been set
2402      *
2403      * A custom menu can be configured by browsing to
2404      *    Settings: Administration > Appearance > Themes > Theme settings
2405      * and then configuring the custommenu config setting as described.
2406      *
2407      * @return string
2408      */
2409     public function custom_menu() {
2410         global $CFG;
2411         if (empty($CFG->custommenuitems)) {
2412             return '';
2413         }
2414         $custommenu = new custom_menu();
2415         return $this->render_custom_menu($custommenu);
2416     }
2418     /**
2419      * Renders a custom menu object (located in outputcomponents.php)
2420      *
2421      * The custom menu this method produces makes use of the YUI3 menunav widget
2422      * and requires very specific html elements and classes.
2423      *
2424      * @staticvar int $menucount
2425      * @param custom_menu $menu
2426      * @return string
2427      */
2428     protected function render_custom_menu(custom_menu $menu) {
2429         static $menucount = 0;
2430         // If the menu has no children return an empty string
2431         if (!$menu->has_children()) {
2432             return '';
2433         }
2434         // Increment the menu count. This is used for ID's that get worked with
2435         // in JavaScript as is essential
2436         $menucount++;
2437         // Initialise this custom menu
2438         $this->page->requires->js_init_call('M.core_custom_menu.init', array('custom_menu_'.$menucount));
2439         // Build the root nodes as required by YUI
2440         $content = html_writer::start_tag('div', array('id'=>'custom_menu_'.$menucount, 'class'=>'yui3-menu yui3-menu-horizontal javascript-disabled'));
2441         $content .= html_writer::start_tag('div', array('class'=>'yui3-menu-content'));
2442         $content .= html_writer::start_tag('ul');
2443         // Render each child
2444         foreach ($menu->get_children() as $item) {
2445             $content .= $this->render_custom_menu_item($item);
2446         }
2447         // Close the open tags
2448         $content .= html_writer::end_tag('ul');
2449         $content .= html_writer::end_tag('div');
2450         $content .= html_writer::end_tag('div');
2451         // Return the custom menu
2452         return $content;
2453     }
2455     /**
2456      * Renders a custom menu node as part of a submenu
2457      *
2458      * The custom menu this method produces makes use of the YUI3 menunav widget
2459      * and requires very specific html elements and classes.
2460      *
2461      * @see render_custom_menu()
2462      *
2463      * @staticvar int $submenucount
2464      * @param custom_menu_item $menunode
2465      * @return string
2466      */
2467     protected function render_custom_menu_item(custom_menu_item $menunode) {
2468         // Required to ensure we get unique trackable id's
2469         static $submenucount = 0;
2470         if ($menunode->has_children()) {
2471             // If the child has menus render it as a sub menu
2472             $submenucount++;
2473             $content = html_writer::start_tag('li');
2474             if ($menunode->get_url() !== null) {
2475                 $url = $menunode->get_url();
2476             } else {
2477                 $url = '#cm_submenu_'.$submenucount;
2478             }
2479             $content .= html_writer::link($url, $menunode->get_text(), array('class'=>'yui3-menu-label', 'title'=>$menunode->get_title()));
2480             $content .= html_writer::start_tag('div', array('id'=>'cm_submenu_'.$submenucount, 'class'=>'yui3-menu custom_menu_submenu'));
2481             $content .= html_writer::start_tag('div', array('class'=>'yui3-menu-content'));
2482             $content .= html_writer::start_tag('ul');
2483             foreach ($menunode->get_children() as $menunode) {
2484                 $content .= $this->render_custom_menu_item($menunode);
2485             }
2486             $content .= html_writer::end_tag('ul');
2487             $content .= html_writer::end_tag('div');
2488             $content .= html_writer::end_tag('div');
2489             $content .= html_writer::end_tag('li');
2490         } else {
2491             // The node doesn't have children so produce a final menuitem
2492             $content = html_writer::start_tag('li', array('class'=>'yui3-menuitem'));
2493             if ($menunode->get_url() !== null) {
2494                 $url = $menunode->get_url();
2495             } else {
2496                 $url = '#';
2497             }
2498             $content .= html_writer::link($url, $menunode->get_text(), array('class'=>'yui3-menuitem-content', 'title'=>$menunode->get_title()));
2499             $content .= html_writer::end_tag('li');
2500         }
2501         // Return the sub menu
2502         return $content;
2503     }
2506     /*
2507      * Renders theme links for switching between default and other themes.
2508      */
2509     protected function theme_switch_links() {
2510         if ($this->switchlinkdisplayed) {
2511             return '';
2512         }
2514         global $USER;
2516         $type = get_device_type();
2518         $this->switchlinkdisplayed = true;
2520         if ($type == 'default') {
2521             return '';
2522         }
2524         $switched = get_user_switched_device();
2526         if ($switched) {
2527             $linktext = get_string('switchdevicerecommended');
2528         } else {
2529             $linktext = get_string('switchdevicedefault');
2530         }
2532         $content = html_writer::start_tag('div', array('id'=>'theme_switch_link'));
2533         $linkurl = new moodle_url('/theme/switch.php', array('url' => $this->page->url));
2535         $content .= html_writer::link($linkurl, $linktext);
2536         $content .= html_writer::end_tag('div');
2538         return $content;
2539     }
2543 /// RENDERERS
2545 /**
2546  * A renderer that generates output for command-line scripts.
2547  *
2548  * The implementation of this renderer is probably incomplete.
2549  *
2550  * @copyright 2009 Tim Hunt
2551  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2552  * @since     Moodle 2.0
2553  */
2554 class core_renderer_cli extends core_renderer {
2555     /**
2556      * Returns the page header.
2557      * @return string HTML fragment
2558      */
2559     public function header() {
2560         return $this->page->heading . "\n";
2561     }
2563     /**
2564      * Returns a template fragment representing a Heading.
2565      * @param string $text The text of the heading
2566      * @param int $level The level of importance of the heading
2567      * @param string $classes A space-separated list of CSS classes
2568      * @param string $id An optional ID
2569      * @return string A template fragment for a heading
2570      */
2571     public function heading($text, $level = 2, $classes = 'main', $id = null) {
2572         $text .= "\n";
2573         switch ($level) {
2574             case 1:
2575                 return '=>' . $text;
2576             case 2:
2577                 return '-->' . $text;
2578             default:
2579                 return $text;
2580         }
2581     }
2583     /**
2584      * Returns a template fragment representing a fatal error.
2585      * @param string $message The message to output
2586      * @param string $moreinfourl URL where more info can be found about the error
2587      * @param string $link Link for the Continue button
2588      * @param array $backtrace The execution backtrace
2589      * @param string $debuginfo Debugging information
2590      * @return string A template fragment for a fatal error
2591      */
2592     public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
2593         $output = "!!! $message !!!\n";
2595         if (debugging('', DEBUG_DEVELOPER)) {
2596             if (!empty($debuginfo)) {
2597                 $output .= $this->notification($debuginfo, 'notifytiny');
2598             }
2599             if (!empty($backtrace)) {
2600                 $output .= $this->notification('Stack trace: ' . format_backtrace($backtrace, true), 'notifytiny');
2601             }
2602         }
2604         return $output;
2605     }
2607     /**
2608      * Returns a template fragment representing a notification.
2609      * @param string $message The message to include
2610      * @param string $classes A space-separated list of CSS classes
2611      * @return string A template fragment for a notification
2612      */
2613     public function notification($message, $classes = 'notifyproblem') {
2614         $message = clean_text($message);
2615         if ($classes === 'notifysuccess') {
2616             return "++ $message ++\n";
2617         }
2618         return "!! $message !!\n";
2619     }
2623 /**
2624  * A renderer that generates output for ajax scripts.
2625  *
2626  * This renderer prevents accidental sends back only json
2627  * encoded error messages, all other output is ignored.
2628  *
2629  * @copyright 2010 Petr Skoda
2630  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2631  * @since     Moodle 2.0
2632  */
2633 class core_renderer_ajax extends core_renderer {
2634     /**
2635      * Returns a template fragment representing a fatal error.
2636      * @param string $message The message to output
2637      * @param string $moreinfourl URL where more info can be found about the error
2638      * @param string $link Link for the Continue button
2639      * @param array $backtrace The execution backtrace
2640      * @param string $debuginfo Debugging information
2641      * @return string A template fragment for a fatal error
2642      */
2643     public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
2644         global $CFG;
2646         $this->page->set_context(null); // ugly hack - make sure page context is set to something, we do not want bogus warnings here
2648         $e = new stdClass();
2649         $e->error      = $message;
2650         $e->stacktrace = NULL;
2651         $e->debuginfo  = NULL;
2652         $e->reproductionlink = NULL;
2653         if (!empty($CFG->debug) and $CFG->debug >= DEBUG_DEVELOPER) {
2654             $e->reproductionlink = $link;
2655             if (!empty($debuginfo)) {
2656                 $e->debuginfo = $debuginfo;
2657             }
2658             if (!empty($backtrace)) {
2659                 $e->stacktrace = format_backtrace($backtrace, true);
2660             }
2661         }
2662         $this->header();
2663         return json_encode($e);
2664     }
2666     public function notification($message, $classes = 'notifyproblem') {
2667     }
2669     public function redirect_message($encodedurl, $message, $delay, $debugdisableredirect) {
2670     }
2672     public function header() {
2673         // unfortunately YUI iframe upload does not support application/json
2674         if (!empty($_FILES)) {
2675             @header('Content-type: text/plain; charset=utf-8');
2676         } else {
2677             @header('Content-type: application/json; charset=utf-8');
2678         }
2680         /// Headers to make it not cacheable and json
2681         @header('Cache-Control: no-store, no-cache, must-revalidate');
2682         @header('Cache-Control: post-check=0, pre-check=0', false);
2683         @header('Pragma: no-cache');
2684         @header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
2685         @header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
2686         @header('Accept-Ranges: none');
2687     }
2689     public function footer() {
2690     }
2692     public function heading($text, $level = 2, $classes = 'main', $id = null) {
2693     }