11eb9d62f1bc8efda5db4346fd7d1d5611042842
[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 = '';
216     /**
217      * Get the DOCTYPE declaration that should be used with this page. Designed to
218      * be called in theme layout.php files.
219      * @return string the DOCTYPE declaration (and any XML prologue) that should be used.
220      */
221     public function doctype() {
222         global $CFG;
224         $doctype = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">' . "\n";
225         $this->contenttype = 'text/html; charset=utf-8';
227         if (empty($CFG->xmlstrictheaders)) {
228             return $doctype;
229         }
231         // We want to serve the page with an XML content type, to force well-formedness errors to be reported.
232         $prolog = '<?xml version="1.0" encoding="utf-8"?>' . "\n";
233         if (isset($_SERVER['HTTP_ACCEPT']) && strpos($_SERVER['HTTP_ACCEPT'], 'application/xhtml+xml') !== false) {
234             // Firefox and other browsers that can cope natively with XHTML.
235             $this->contenttype = 'application/xhtml+xml; charset=utf-8';
237         } else if (preg_match('/MSIE.*Windows NT/', $_SERVER['HTTP_USER_AGENT'])) {
238             // IE can't cope with application/xhtml+xml, but it will cope if we send application/xml with an XSL stylesheet.
239             $this->contenttype = 'application/xml; charset=utf-8';
240             $prolog .= '<?xml-stylesheet type="text/xsl" href="' . $CFG->httpswwwroot . '/lib/xhtml.xsl"?>' . "\n";
242         } else {
243             $prolog = '';
244         }
246         return $prolog . $doctype;
247     }
249     /**
250      * The attributes that should be added to the <html> tag. Designed to
251      * be called in theme layout.php files.
252      * @return string HTML fragment.
253      */
254     public function htmlattributes() {
255         return get_html_lang(true) . ' xmlns="http://www.w3.org/1999/xhtml"';
256     }
258     /**
259      * The standard tags (meta tags, links to stylesheets and JavaScript, etc.)
260      * that should be included in the <head> tag. Designed to be called in theme
261      * layout.php files.
262      * @return string HTML fragment.
263      */
264     public function standard_head_html() {
265         global $CFG, $SESSION;
266         $output = '';
267         $output .= '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />' . "\n";
268         $output .= '<meta name="keywords" content="moodle, ' . $this->page->title . '" />' . "\n";
269         if (!$this->page->cacheable) {
270             $output .= '<meta http-equiv="pragma" content="no-cache" />' . "\n";
271             $output .= '<meta http-equiv="expires" content="0" />' . "\n";
272         }
273         // This is only set by the {@link redirect()} method
274         $output .= $this->metarefreshtag;
276         // Check if a periodic refresh delay has been set and make sure we arn't
277         // already meta refreshing
278         if ($this->metarefreshtag=='' && $this->page->periodicrefreshdelay!==null) {
279             $output .= '<meta http-equiv="refresh" content="'.$this->page->periodicrefreshdelay.';url='.$this->page->url->out().'" />';
280         }
282         $this->page->requires->js_function_call('setTimeout', array('fix_column_widths()', 20));
284         $focus = $this->page->focuscontrol;
285         if (!empty($focus)) {
286             if (preg_match("#forms\['([a-zA-Z0-9]+)'\].elements\['([a-zA-Z0-9]+)'\]#", $focus, $matches)) {
287                 // This is a horrifically bad way to handle focus but it is passed in
288                 // through messy formslib::moodleform
289                 $this->page->requires->js_function_call('old_onload_focus', array($matches[1], $matches[2]));
290             } else if (strpos($focus, '.')!==false) {
291                 // Old style of focus, bad way to do it
292                 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);
293                 $this->page->requires->js_function_call('old_onload_focus', explode('.', $focus, 2));
294             } else {
295                 // Focus element with given id
296                 $this->page->requires->js_function_call('focuscontrol', array($focus));
297             }
298         }
300         // Get the theme stylesheet - this has to be always first CSS, this loads also styles.css from all plugins;
301         // any other custom CSS can not be overridden via themes and is highly discouraged
302         $urls = $this->page->theme->css_urls($this->page);
303         foreach ($urls as $url) {
304             $this->page->requires->css_theme($url);
305         }
307         // Get the theme javascript head and footer
308         $jsurl = $this->page->theme->javascript_url(true);
309         $this->page->requires->js($jsurl, true);
310         $jsurl = $this->page->theme->javascript_url(false);
311         $this->page->requires->js($jsurl);
313         // Perform a browser environment check for the flash version.  Should only run once per login session.
314         if (!NO_MOODLE_COOKIES && isloggedin() && !empty($CFG->excludeoldflashclients) && empty($SESSION->flashversion)) {
315             $this->page->requires->js('/lib/swfobject/swfobject.js');
316             $this->page->requires->js_init_call('M.core_flashdetect.init');
317         }
319         // Get any HTML from the page_requirements_manager.
320         $output .= $this->page->requires->get_head_code($this->page, $this);
322         // List alternate versions.
323         foreach ($this->page->alternateversions as $type => $alt) {
324             $output .= html_writer::empty_tag('link', array('rel' => 'alternate',
325                     'type' => $type, 'title' => $alt->title, 'href' => $alt->url));
326         }
328         return $output;
329     }
331     /**
332      * The standard tags (typically skip links) that should be output just inside
333      * the start of the <body> tag. Designed to be called in theme layout.php files.
334      * @return string HTML fragment.
335      */
336     public function standard_top_of_body_html() {
337         return  $this->page->requires->get_top_of_body_code();
338     }
340     /**
341      * The standard tags (typically performance information and validation links,
342      * if we are in developer debug mode) that should be output in the footer area
343      * of the page. Designed to be called in theme layout.php files.
344      * @return string HTML fragment.
345      */
346     public function standard_footer_html() {
347         global $CFG;
349         // This function is normally called from a layout.php file in {@link header()}
350         // but some of the content won't be known until later, so we return a placeholder
351         // for now. This will be replaced with the real content in {@link footer()}.
352         $output = self::PERFORMANCE_INFO_TOKEN;
353         if ($this->page->legacythemeinuse) {
354             // The legacy theme is in use print the notification
355             $output .= html_writer::tag('div', get_string('legacythemeinuse'), array('class'=>'legacythemeinuse'));
356         }
357         if (!empty($CFG->debugpageinfo)) {
358             $output .= '<div class="performanceinfo">This page is: ' . $this->page->debug_summary() . '</div>';
359         }
360         if (debugging(null, DEBUG_DEVELOPER) and has_capability('moodle/site:config', get_context_instance(CONTEXT_SYSTEM))) {  // Only in developer mode
361             $output .= '<div class="purgecaches"><a href="'.$CFG->wwwroot.'/admin/purgecaches.php?confirm=1&amp;sesskey='.sesskey().'">'.get_string('purgecaches', 'admin').'</a></div>';
362         }
363         if (!empty($CFG->debugvalidators)) {
364             $output .= '<div class="validators"><ul>
365               <li><a href="http://validator.w3.org/check?verbose=1&amp;ss=1&amp;uri=' . urlencode(qualified_me()) . '">Validate HTML</a></li>
366               <li><a href="http://www.contentquality.com/mynewtester/cynthia.exe?rptmode=-1&amp;url1=' . urlencode(qualified_me()) . '">Section 508 Check</a></li>
367               <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>
368             </ul></div>';
369         }
370         return $output;
371     }
373     /**
374      * The standard tags (typically script tags that are not needed earlier) that
375      * should be output after everything else, . Designed to be called in theme layout.php files.
376      * @return string HTML fragment.
377      */
378     public function standard_end_of_body_html() {
379         // This function is normally called from a layout.php file in {@link header()}
380         // but some of the content won't be known until later, so we return a placeholder
381         // for now. This will be replaced with the real content in {@link footer()}.
382         echo self::END_HTML_TOKEN;
383     }
385     /**
386      * Return the standard string that says whether you are logged in (and switched
387      * roles/logged in as another user).
388      * @return string HTML fragment.
389      */
390     public function login_info() {
391         global $USER, $CFG, $DB;
393         if (during_initial_install()) {
394             return '';
395         }
397         $course = $this->page->course;
399         if (session_is_loggedinas()) {
400             $realuser = session_get_realuser();
401             $fullname = fullname($realuser, true);
402             $realuserinfo = " [<a href=\"$CFG->wwwroot/course/loginas.php?id=$course->id&amp;return=1&amp;sesskey=".sesskey()."\">$fullname</a>] ";
403         } else {
404             $realuserinfo = '';
405         }
407         $loginurl = get_login_url();
409         if (empty($course->id)) {
410             // $course->id is not defined during installation
411             return '';
412         } else if (isloggedin()) {
413             $context = get_context_instance(CONTEXT_COURSE, $course->id);
415             $fullname = fullname($USER, true);
416             // Since Moodle 2.0 this link always goes to the public profile page (not the course profile page)
417             $username = "<a href=\"$CFG->wwwroot/user/profile.php?id=$USER->id\">$fullname</a>";
418             if (is_mnet_remote_user($USER) and $idprovider = $DB->get_record('mnet_host', array('id'=>$USER->mnethostid))) {
419                 $username .= " from <a href=\"{$idprovider->wwwroot}\">{$idprovider->name}</a>";
420             }
421             if (isset($USER->username) && $USER->username == 'guest') {
422                 $loggedinas = $realuserinfo.get_string('loggedinasguest').
423                           " (<a href=\"$loginurl\">".get_string('login').'</a>)';
424             } else if (!empty($USER->access['rsw'][$context->path])) {
425                 $rolename = '';
426                 if ($role = $DB->get_record('role', array('id'=>$USER->access['rsw'][$context->path]))) {
427                     $rolename = ': '.format_string($role->name);
428                 }
429                 $loggedinas = get_string('loggedinas', 'moodle', $username).$rolename.
430                           " (<a href=\"$CFG->wwwroot/course/view.php?id=$course->id&amp;switchrole=0&amp;sesskey=".sesskey()."\">".get_string('switchrolereturn').'</a>)';
431             } else {
432                 $loggedinas = $realuserinfo.get_string('loggedinas', 'moodle', $username).' '.
433                           " (<a href=\"$CFG->wwwroot/login/logout.php?sesskey=".sesskey()."\">".get_string('logout').'</a>)';
434             }
435         } else {
436             $loggedinas = get_string('loggedinnot', 'moodle').
437                           " (<a href=\"$loginurl\">".get_string('login').'</a>)';
438         }
440         $loggedinas = '<div class="logininfo">'.$loggedinas.'</div>';
442         if (isset($SESSION->justloggedin)) {
443             unset($SESSION->justloggedin);
444             if (!empty($CFG->displayloginfailures)) {
445                 if (!empty($USER->username) and $USER->username != 'guest') {
446                     if ($count = count_login_failures($CFG->displayloginfailures, $USER->username, $USER->lastlogin)) {
447                         $loggedinas .= '&nbsp;<div class="loginfailures">';
448                         if (empty($count->accounts)) {
449                             $loggedinas .= get_string('failedloginattempts', '', $count);
450                         } else {
451                             $loggedinas .= get_string('failedloginattemptsall', '', $count);
452                         }
453                         if (has_capability('coursereport/log:view', get_context_instance(CONTEXT_SYSTEM))) {
454                             $loggedinas .= ' (<a href="'.$CFG->wwwroot.'/course/report/log/index.php'.
455                                                  '?chooselog=1&amp;id=1&amp;modid=site_errors">'.get_string('logs').'</a>)';
456                         }
457                         $loggedinas .= '</div>';
458                     }
459                 }
460             }
461         }
463         return $loggedinas;
464     }
466     /**
467      * Return the 'back' link that normally appears in the footer.
468      * @return string HTML fragment.
469      */
470     public function home_link() {
471         global $CFG, $SITE;
473         if ($this->page->pagetype == 'site-index') {
474             // Special case for site home page - please do not remove
475             return '<div class="sitelink">' .
476                    '<a title="Moodle" href="http://moodle.org/">' .
477                    '<img style="width:100px;height:30px" src="' . $this->pix_url('moodlelogo') . '" alt="moodlelogo" /></a></div>';
479         } else if (!empty($CFG->target_release) && $CFG->target_release != $CFG->release) {
480             // Special case for during install/upgrade.
481             return '<div class="sitelink">'.
482                    '<a title="Moodle" href="http://docs.moodle.org/en/Administrator_documentation" onclick="this.target=\'_blank\'">' .
483                    '<img style="width:100px;height:30px" src="' . $this->pix_url('moodlelogo') . '" alt="moodlelogo" /></a></div>';
485         } else if ($this->page->course->id == $SITE->id || strpos($this->page->pagetype, 'course-view') === 0) {
486             return '<div class="homelink"><a href="' . $CFG->wwwroot . '/">' .
487                     get_string('home') . '</a></div>';
489         } else {
490             return '<div class="homelink"><a href="' . $CFG->wwwroot . '/course/view.php?id=' . $this->page->course->id . '">' .
491                     format_string($this->page->course->shortname) . '</a></div>';
492         }
493     }
495     /**
496      * Redirects the user by any means possible given the current state
497      *
498      * This function should not be called directly, it should always be called using
499      * the redirect function in lib/weblib.php
500      *
501      * The redirect function should really only be called before page output has started
502      * however it will allow itself to be called during the state STATE_IN_BODY
503      *
504      * @param string $encodedurl The URL to send to encoded if required
505      * @param string $message The message to display to the user if any
506      * @param int $delay The delay before redirecting a user, if $message has been
507      *         set this is a requirement and defaults to 3, set to 0 no delay
508      * @param boolean $debugdisableredirect this redirect has been disabled for
509      *         debugging purposes. Display a message that explains, and don't
510      *         trigger the redirect.
511      * @return string The HTML to display to the user before dying, may contain
512      *         meta refresh, javascript refresh, and may have set header redirects
513      */
514     public function redirect_message($encodedurl, $message, $delay, $debugdisableredirect) {
515         global $CFG;
516         $url = str_replace('&amp;', '&', $encodedurl);
518         switch ($this->page->state) {
519             case moodle_page::STATE_BEFORE_HEADER :
520                 // No output yet it is safe to delivery the full arsenal of redirect methods
521                 if (!$debugdisableredirect) {
522                     // Don't use exactly the same time here, it can cause problems when both redirects fire at the same time.
523                     $this->metarefreshtag = '<meta http-equiv="refresh" content="'. $delay .'; url='. $encodedurl .'" />'."\n";
524                     $this->page->requires->js_function_call('document.location.replace', array($url), false, ($delay + 3));
525                 }
526                 $output = $this->header();
527                 break;
528             case moodle_page::STATE_PRINTING_HEADER :
529                 // We should hopefully never get here
530                 throw new coding_exception('You cannot redirect while printing the page header');
531                 break;
532             case moodle_page::STATE_IN_BODY :
533                 // We really shouldn't be here but we can deal with this
534                 debugging("You should really redirect before you start page output");
535                 if (!$debugdisableredirect) {
536                     $this->page->requires->js_function_call('document.location.replace', array($url), false, $delay);
537                 }
538                 $output = $this->opencontainers->pop_all_but_last();
539                 break;
540             case moodle_page::STATE_DONE :
541                 // Too late to be calling redirect now
542                 throw new coding_exception('You cannot redirect after the entire page has been generated');
543                 break;
544         }
545         $output .= $this->notification($message, 'redirectmessage');
546         $output .= '<div class="continuebutton">(<a href="'. $encodedurl .'">'. get_string('continue') .'</a>)</div>';
547         if ($debugdisableredirect) {
548             $output .= '<p><strong>Error output, so disabling automatic redirect.</strong></p>';
549         }
550         $output .= $this->footer();
551         return $output;
552     }
554     /**
555      * Start output by sending the HTTP headers, and printing the HTML <head>
556      * and the start of the <body>.
557      *
558      * To control what is printed, you should set properties on $PAGE. If you
559      * are familiar with the old {@link print_header()} function from Moodle 1.9
560      * you will find that there are properties on $PAGE that correspond to most
561      * of the old parameters to could be passed to print_header.
562      *
563      * Not that, in due course, the remaining $navigation, $menu parameters here
564      * will be replaced by more properties of $PAGE, but that is still to do.
565      *
566      * @return string HTML that you must output this, preferably immediately.
567      */
568     public function header() {
569         global $USER, $CFG;
571         $this->page->set_state(moodle_page::STATE_PRINTING_HEADER);
573         // Find the appropriate page layout file, based on $this->page->pagelayout.
574         $layoutfile = $this->page->theme->layout_file($this->page->pagelayout);
575         // Render the layout using the layout file.
576         $rendered = $this->render_page_layout($layoutfile);
578         // Slice the rendered output into header and footer.
579         $cutpos = strpos($rendered, self::MAIN_CONTENT_TOKEN);
580         if ($cutpos === false) {
581             throw new coding_exception('page layout file ' . $layoutfile .
582                     ' does not contain the string "' . self::MAIN_CONTENT_TOKEN . '".');
583         }
584         $header = substr($rendered, 0, $cutpos);
585         $footer = substr($rendered, $cutpos + strlen(self::MAIN_CONTENT_TOKEN));
587         if (empty($this->contenttype)) {
588             debugging('The page layout file did not call $OUTPUT->doctype()');
589             $header = $this->doctype() . $header;
590         }
592         send_headers($this->contenttype, $this->page->cacheable);
594         $this->opencontainers->push('header/footer', $footer);
595         $this->page->set_state(moodle_page::STATE_IN_BODY);
597         return $header . $this->skip_link_target('maincontent');
598     }
600     /**
601      * Renders and outputs the page layout file.
602      * @param string $layoutfile The name of the layout file
603      * @return string HTML code
604      */
605     protected function render_page_layout($layoutfile) {
606         global $CFG, $SITE, $USER;
607         // The next lines are a bit tricky. The point is, here we are in a method
608         // of a renderer class, and this object may, or may not, be the same as
609         // the global $OUTPUT object. When rendering the page layout file, we want to use
610         // this object. However, people writing Moodle code expect the current
611         // renderer to be called $OUTPUT, not $this, so define a variable called
612         // $OUTPUT pointing at $this. The same comment applies to $PAGE and $COURSE.
613         $OUTPUT = $this;
614         $PAGE = $this->page;
615         $COURSE = $this->page->course;
617         ob_start();
618         include($layoutfile);
619         $rendered = ob_get_contents();
620         ob_end_clean();
621         return $rendered;
622     }
624     /**
625      * Outputs the page's footer
626      * @return string HTML fragment
627      */
628     public function footer() {
629         global $CFG, $DB;
631         $output = $this->container_end_all(true);
633         $footer = $this->opencontainers->pop('header/footer');
635         if (debugging() and $DB and $DB->is_transaction_started()) {
636             // TODO: MDL-20625 print warning - transaction will be rolled back
637         }
639         // Provide some performance info if required
640         $performanceinfo = '';
641         if (defined('MDL_PERF') || (!empty($CFG->perfdebug) and $CFG->perfdebug > 7)) {
642             $perf = get_performance_info();
643             if (defined('MDL_PERFTOLOG') && !function_exists('register_shutdown_function')) {
644                 error_log("PERF: " . $perf['txt']);
645             }
646             if (defined('MDL_PERFTOFOOT') || debugging() || $CFG->perfdebug > 7) {
647                 $performanceinfo = $perf['html'];
648             }
649         }
650         $footer = str_replace(self::PERFORMANCE_INFO_TOKEN, $performanceinfo, $footer);
652         $footer = str_replace(self::END_HTML_TOKEN, $this->page->requires->get_end_code(), $footer);
654         $this->page->set_state(moodle_page::STATE_DONE);
656         return $output . $footer;
657     }
659     /**
660      * Close all but the last open container. This is useful in places like error
661      * handling, where you want to close all the open containers (apart from <body>)
662      * before outputting the error message.
663      * @param bool $shouldbenone assert that the stack should be empty now - causes a
664      *      developer debug warning if it isn't.
665      * @return string the HTML required to close any open containers inside <body>.
666      */
667     public function container_end_all($shouldbenone = false) {
668         return $this->opencontainers->pop_all_but_last($shouldbenone);
669     }
671     /**
672      * Returns lang menu or '', this method also checks forcing of languages in courses.
673      * @return string
674      */
675     public function lang_menu() {
676         global $CFG;
678         if (empty($CFG->langmenu)) {
679             return '';
680         }
682         if ($this->page->course != SITEID and !empty($this->page->course->lang)) {
683             // do not show lang menu if language forced
684             return '';
685         }
687         $currlang = current_language();
688         $langs = get_string_manager()->get_list_of_translations();
690         if (count($langs) < 2) {
691             return '';
692         }
694         $s = new single_select($this->page->url, 'lang', $langs, $currlang, null);
695         $s->label = get_accesshide(get_string('language'));
696         $s->class = 'langmenu';
697         return $this->render($s);
698     }
700     /**
701      * Output the row of editing icons for a block, as defined by the controls array.
702      * @param array $controls an array like {@link block_contents::$controls}.
703      * @return HTML fragment.
704      */
705     public function block_controls($controls) {
706         if (empty($controls)) {
707             return '';
708         }
709         $controlshtml = array();
710         foreach ($controls as $control) {
711             $controlshtml[] = html_writer::tag('a',
712                     html_writer::empty_tag('img',  array('src' => $this->pix_url($control['icon'])->out(false), 'alt' => $control['caption'])),
713                     array('class' => 'icon','title' => $control['caption'], 'href' => $control['url']));
714         }
715         return html_writer::tag('div', implode('', $controlshtml), array('class' => 'commands'));
716     }
718     /**
719      * Prints a nice side block with an optional header.
720      *
721      * The content is described
722      * by a {@link block_contents} object.
723      *
724      * @param block_contents $bc HTML for the content
725      * @param string $region the region the block is appearing in.
726      * @return string the HTML to be output.
727      */
728     function block(block_contents $bc, $region) {
729         $bc = clone($bc); // Avoid messing up the object passed in.
730         if (empty($bc->blockinstanceid) || !strip_tags($bc->title)) {
731             $bc->collapsible = block_contents::NOT_HIDEABLE;
732         }
733         if ($bc->collapsible == block_contents::HIDDEN) {
734             $bc->add_class('hidden');
735         }
736         if (!empty($bc->controls)) {
737             $bc->add_class('block_with_controls');
738         }
740         $skiptitle = strip_tags($bc->title);
741         if (empty($skiptitle)) {
742             $output = '';
743             $skipdest = '';
744         } else {
745             $output = html_writer::tag('a', get_string('skipa', 'access', $skiptitle), array('href' => '#sb-' . $bc->skipid, 'class' => 'skip-block'));
746             $skipdest = html_writer::tag('span', '', array('id' => 'sb-' . $bc->skipid, 'class' => 'skip-block-to'));
747         }
749         $output .= html_writer::start_tag('div', $bc->attributes);
751         $controlshtml = $this->block_controls($bc->controls);
753         $title = '';
754         if ($bc->title) {
755             $title = html_writer::tag('h2', $bc->title, null);
756         }
758         if ($title || $controlshtml) {
759             $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'));
760         }
762         $output .= html_writer::start_tag('div', array('class' => 'content'));
763         if (!$title && !$controlshtml) {
764             $output .= html_writer::tag('div', '', array('class'=>'block_action notitle'));
765         }
766         $output .= $bc->content;
768         if ($bc->footer) {
769             $output .= html_writer::tag('div', $bc->footer, array('class' => 'footer'));
770         }
772         $output .= html_writer::end_tag('div');
773         $output .= html_writer::end_tag('div');
775         if ($bc->annotation) {
776             $output .= html_writer::tag('div', $bc->annotation, array('class' => 'blockannotation'));
777         }
778         $output .= $skipdest;
780         $this->init_block_hider_js($bc);
781         return $output;
782     }
784     /**
785      * Calls the JS require function to hide a block.
786      * @param block_contents $bc A block_contents object
787      * @return void
788      */
789     protected function init_block_hider_js(block_contents $bc) {
790         if (!empty($bc->attributes['id']) and $bc->collapsible != block_contents::NOT_HIDEABLE) {
791             $userpref = 'block' . $bc->blockinstanceid . 'hidden';
792             user_preference_allow_ajax_update($userpref, PARAM_BOOL);
793             $this->page->requires->yui2_lib('dom');
794             $this->page->requires->yui2_lib('event');
795             $plaintitle = strip_tags($bc->title);
796             $this->page->requires->js_function_call('new block_hider', array($bc->attributes['id'], $userpref,
797                     get_string('hideblocka', 'access', $plaintitle), get_string('showblocka', 'access', $plaintitle),
798                     $this->pix_url('t/switch_minus')->out(false), $this->pix_url('t/switch_plus')->out(false)));
799         }
800     }
802     /**
803      * Render the contents of a block_list.
804      * @param array $icons the icon for each item.
805      * @param array $items the content of each item.
806      * @return string HTML
807      */
808     public function list_block_contents($icons, $items) {
809         $row = 0;
810         $lis = array();
811         foreach ($items as $key => $string) {
812             $item = html_writer::start_tag('li', array('class' => 'r' . $row));
813             if (!empty($icons[$key])) { //test if the content has an assigned icon
814                 $item .= html_writer::tag('div', $icons[$key], array('class' => 'icon column c0'));
815             }
816             $item .= html_writer::tag('div', $string, array('class' => 'column c1'));
817             $item .= html_writer::end_tag('li');
818             $lis[] = $item;
819             $row = 1 - $row; // Flip even/odd.
820         }
821         return html_writer::tag('ul', implode("\n", $lis), array('class' => 'list'));
822     }
824     /**
825      * Output all the blocks in a particular region.
826      * @param string $region the name of a region on this page.
827      * @return string the HTML to be output.
828      */
829     public function blocks_for_region($region) {
830         $blockcontents = $this->page->blocks->get_content_for_region($region, $this);
832         $output = '';
833         foreach ($blockcontents as $bc) {
834             if ($bc instanceof block_contents) {
835                 $output .= $this->block($bc, $region);
836             } else if ($bc instanceof block_move_target) {
837                 $output .= $this->block_move_target($bc);
838             } else {
839                 throw new coding_exception('Unexpected type of thing (' . get_class($bc) . ') found in list of block contents.');
840             }
841         }
842         return $output;
843     }
845     /**
846      * Output a place where the block that is currently being moved can be dropped.
847      * @param block_move_target $target with the necessary details.
848      * @return string the HTML to be output.
849      */
850     public function block_move_target($target) {
851         return html_writer::tag('a', html_writer::tag('span', $target->text, array('class' => 'accesshide')), array('href' => $target->url, 'class' => 'blockmovetarget'));
852     }
854     /**
855      * Renders a special html link with attached action
856      *
857      * @param string|moodle_url $url
858      * @param string $text HTML fragment
859      * @param component_action $action
860      * @param array $attributes associative array of html link attributes + disabled
861      * @return HTML fragment
862      */
863     public function action_link($url, $text, component_action $action = null, array $attributes=null) {
864         if (!($url instanceof moodle_url)) {
865             $url = new moodle_url($url);
866         }
867         $link = new action_link($url, $text, $action, $attributes);
869         return $this->render($link);
870     }
872     /**
873      * Implementation of action_link rendering
874      * @param action_link $link
875      * @return string HTML fragment
876      */
877     protected function render_action_link(action_link $link) {
878         global $CFG;
880         // A disabled link is rendered as formatted text
881         if (!empty($link->attributes['disabled'])) {
882             // do not use div here due to nesting restriction in xhtml strict
883             return html_writer::tag('span', $link->text, array('class'=>'currentlink'));
884         }
886         $attributes = $link->attributes;
887         unset($link->attributes['disabled']);
888         $attributes['href'] = $link->url;
890         if ($link->actions) {
891             if (empty($attributes['id'])) {
892                 $id = html_writer::random_id('action_link');
893                 $attributes['id'] = $id;
894             } else {
895                 $id = $attributes['id'];
896             }
897             foreach ($link->actions as $action) {
898                 $this->add_action_handler($action, $id);
899             }
900         }
902         return html_writer::tag('a', $link->text, $attributes);
903     }
906     /**
907      * Similar to action_link, image is used instead of the text
908      *
909      * @param string|moodle_url $url A string URL or moodel_url
910      * @param pix_icon $pixicon
911      * @param component_action $action
912      * @param array $attributes associative array of html link attributes + disabled
913      * @param bool $linktext show title next to image in link
914      * @return string HTML fragment
915      */
916     public function action_icon($url, pix_icon $pixicon, component_action $action = null, array $attributes = null, $linktext=false) {
917         if (!($url instanceof moodle_url)) {
918             $url = new moodle_url($url);
919         }
920         $attributes = (array)$attributes;
922         if (empty($attributes['class'])) {
923             // let ppl override the class via $options
924             $attributes['class'] = 'action-icon';
925         }
927         $icon = $this->render($pixicon);
929         if ($linktext) {
930             $text = $pixicon->attributes['alt'];
931         } else {
932             $text = '';
933         }
935         return $this->action_link($url, $text.$icon, $action, $attributes);
936     }
938    /**
939     * Print a message along with button choices for Continue/Cancel
940     *
941     * If a string or moodle_url is given instead of a single_button, method defaults to post.
942     *
943     * @param string $message The question to ask the user
944     * @param single_button|moodle_url|string $continue The single_button component representing the Continue answer. Can also be a moodle_url or string URL
945     * @param single_button|moodle_url|string $cancel The single_button component representing the Cancel answer. Can also be a moodle_url or string URL
946     * @return string HTML fragment
947     */
948     public function confirm($message, $continue, $cancel) {
949         if ($continue instanceof single_button) {
950             // ok
951         } else if (is_string($continue)) {
952             $continue = new single_button(new moodle_url($continue), get_string('continue'), 'post');
953         } else if ($continue instanceof moodle_url) {
954             $continue = new single_button($continue, get_string('continue'), 'post');
955         } else {
956             throw new coding_exception('The continue param to $OUTPUT->confirm() must be either a URL (string/moodle_url) or a single_button instance.');
957         }
959         if ($cancel instanceof single_button) {
960             // ok
961         } else if (is_string($cancel)) {
962             $cancel = new single_button(new moodle_url($cancel), get_string('cancel'), 'get');
963         } else if ($cancel instanceof moodle_url) {
964             $cancel = new single_button($cancel, get_string('cancel'), 'get');
965         } else {
966             throw new coding_exception('The cancel param to $OUTPUT->confirm() must be either a URL (string/moodle_url) or a single_button instance.');
967         }
969         $output = $this->box_start('generalbox', 'notice');
970         $output .= html_writer::tag('p', $message);
971         $output .= html_writer::tag('div', $this->render($continue) . $this->render($cancel), array('class' => 'buttons'));
972         $output .= $this->box_end();
973         return $output;
974     }
976     /**
977      * Returns a form with a single button.
978      *
979      * @param string|moodle_url $url
980      * @param string $label button text
981      * @param string $method get or post submit method
982      * @param array $options associative array {disabled, title, etc.}
983      * @return string HTML fragment
984      */
985     public function single_button($url, $label, $method='post', array $options=null) {
986         if (!($url instanceof moodle_url)) {
987             $url = new moodle_url($url);
988         }
989         $button = new single_button($url, $label, $method);
991         foreach ((array)$options as $key=>$value) {
992             if (array_key_exists($key, $button)) {
993                 $button->$key = $value;
994             }
995         }
997         return $this->render($button);
998     }
1000     /**
1001      * Internal implementation of single_button rendering
1002      * @param single_button $button
1003      * @return string HTML fragment
1004      */
1005     protected function render_single_button(single_button $button) {
1006         $attributes = array('type'     => 'submit',
1007                             'value'    => $button->label,
1008                             'disabled' => $button->disabled ? 'disabled' : null,
1009                             'title'    => $button->tooltip);
1011         if ($button->actions) {
1012             $id = html_writer::random_id('single_button');
1013             $attributes['id'] = $id;
1014             foreach ($button->actions as $action) {
1015                 $this->add_action_handler($action, $id);
1016             }
1017         }
1019         // first the input element
1020         $output = html_writer::empty_tag('input', $attributes);
1022         // then hidden fields
1023         $params = $button->url->params();
1024         if ($button->method === 'post') {
1025             $params['sesskey'] = sesskey();
1026         }
1027         foreach ($params as $var => $val) {
1028             $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => $var, 'value' => $val));
1029         }
1031         // then div wrapper for xhtml strictness
1032         $output = html_writer::tag('div', $output);
1034         // now the form itself around it
1035         $url = $button->url->out_omit_querystring(); // url without params
1036         if ($url === '') {
1037             $url = '#'; // there has to be always some action
1038         }
1039         $attributes = array('method' => $button->method,
1040                             'action' => $url,
1041                             'id'     => $button->formid);
1042         $output = html_writer::tag('form', $output, $attributes);
1044         // and finally one more wrapper with class
1045         return html_writer::tag('div', $output, array('class' => $button->class));
1046     }
1048     /**
1049      * Returns a form with a single select widget.
1050      * @param moodle_url $url form action target, includes hidden fields
1051      * @param string $name name of selection field - the changing parameter in url
1052      * @param array $options list of options
1053      * @param string $selected selected element
1054      * @param array $nothing
1055      * @param string $formid
1056      * @return string HTML fragment
1057      */
1058     public function single_select($url, $name, array $options, $selected='', $nothing=array(''=>'choosedots'), $formid=null) {
1059         if (!($url instanceof moodle_url)) {
1060             $url = new moodle_url($url);
1061         }
1062         $select = new single_select($url, $name, $options, $selected, $nothing, $formid);
1064         return $this->render($select);
1065     }
1067     /**
1068      * Internal implementation of single_select rendering
1069      * @param single_select $select
1070      * @return string HTML fragment
1071      */
1072     protected function render_single_select(single_select $select) {
1073         $select = clone($select);
1074         if (empty($select->formid)) {
1075             $select->formid = html_writer::random_id('single_select_f');
1076         }
1078         $output = '';
1079         $params = $select->url->params();
1080         if ($select->method === 'post') {
1081             $params['sesskey'] = sesskey();
1082         }
1083         foreach ($params as $name=>$value) {
1084             $output .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>$name, 'value'=>$value));
1085         }
1087         if (empty($select->attributes['id'])) {
1088             $select->attributes['id'] = html_writer::random_id('single_select');
1089         }
1091         if ($select->disabled) {
1092             $select->attributes['disabled'] = 'disabled';
1093         }
1095         if ($select->tooltip) {
1096             $select->attributes['title'] = $select->tooltip;
1097         }
1099         if ($select->label) {
1100             $output .= html_writer::label($select->label, $select->attributes['id']);
1101         }
1103         if ($select->helpicon instanceof help_icon) {
1104             $output .= $this->render($select->helpicon);
1105         } else if ($select->helpicon instanceof old_help_icon) {
1106             $output .= $this->render($select->helpicon);
1107         }
1109         $output .= html_writer::select($select->options, $select->name, $select->selected, $select->nothing, $select->attributes);
1111         $go = html_writer::empty_tag('input', array('type'=>'submit', 'value'=>get_string('go')));
1112         $output .= html_writer::tag('noscript', $go, array('style'=>'inline'));
1114         $nothing = empty($select->nothing) ? false : key($select->nothing);
1115         $this->page->requires->js_init_call('M.util.init_select_autosubmit', array($select->formid, $select->attributes['id'], $nothing));
1117         // then div wrapper for xhtml strictness
1118         $output = html_writer::tag('div', $output);
1120         // now the form itself around it
1121         $formattributes = array('method' => $select->method,
1122                                 'action' => $select->url->out_omit_querystring(),
1123                                 'id'     => $select->formid);
1124         $output = html_writer::tag('form', $output, $formattributes);
1126         // and finally one more wrapper with class
1127         return html_writer::tag('div', $output, array('class' => $select->class));
1128     }
1130     /**
1131      * Returns a form with a url select widget.
1132      * @param array $urls list of urls - array('/course/view.php?id=1'=>'Frontpage', ....)
1133      * @param string $selected selected element
1134      * @param array $nothing
1135      * @param string $formid
1136      * @return string HTML fragment
1137      */
1138     public function url_select(array $urls, $selected, $nothing=array(''=>'choosedots'), $formid=null) {
1139         $select = new url_select($urls, $selected, $nothing, $formid);
1140         return $this->render($select);
1141     }
1143     /**
1144      * Internal implementation of url_select rendering
1145      * @param single_select $select
1146      * @return string HTML fragment
1147      */
1148     protected function render_url_select(url_select $select) {
1149         global $CFG;
1151         $select = clone($select);
1152         if (empty($select->formid)) {
1153             $select->formid = html_writer::random_id('url_select_f');
1154         }
1156         if (empty($select->attributes['id'])) {
1157             $select->attributes['id'] = html_writer::random_id('url_select');
1158         }
1160         if ($select->disabled) {
1161             $select->attributes['disabled'] = 'disabled';
1162         }
1164         if ($select->tooltip) {
1165             $select->attributes['title'] = $select->tooltip;
1166         }
1168         $output = '';
1170         if ($select->label) {
1171             $output .= html_writer::label($select->label, $select->attributes['id']);
1172         }
1174         if ($select->helpicon instanceof help_icon) {
1175             $output .= $this->render($select->helpicon);
1176         } else if ($select->helpicon instanceof old_help_icon) {
1177             $output .= $this->render($select->helpicon);
1178         }
1180         // For security reasons, the script course/jumpto.php requires URL starting with '/'. To keep
1181         // backward compatibility, we are removing heading $CFG->wwwroot from URLs here.
1182         $urls = array();
1183         foreach ($select->urls as $k=>$v) {
1184             if (is_array($v)) {
1185                 // optgroup structure
1186                 foreach ($v as $optgrouptitle => $optgroupoptions) {
1187                     foreach ($optgroupoptions as $optionurl => $optiontitle) {
1188                         if (empty($optionurl)) {
1189                             $safeoptionurl = '';
1190                         } else if (strpos($optionurl, $CFG->wwwroot.'/') === 0) {
1191                             // debugging('URLs passed to url_select should be in local relative form - please fix the code.', DEBUG_DEVELOPER);
1192                             $safeoptionurl = str_replace($CFG->wwwroot, '', $optionurl);
1193                         } else if (strpos($optionurl, '/') !== 0) {
1194                             debugging("Invalid url_select urls parameter inside optgroup: url '$optionurl' is not local relative url!");
1195                             continue;
1196                         } else {
1197                             $safeoptionurl = $optionurl;
1198                         }
1199                         $urls[$k][$optgrouptitle][$safeoptionurl] = $optiontitle;
1200                     }
1201                 }
1202             } else {
1203                 // plain list structure
1204                 if (empty($k)) {
1205                     // nothing selected option
1206                 } else if (strpos($k, $CFG->wwwroot.'/') === 0) {
1207                     $k = str_replace($CFG->wwwroot, '', $k);
1208                 } else if (strpos($k, '/') !== 0) {
1209                     debugging("Invalid url_select urls parameter: url '$k' is not local relative url!");
1210                     continue;
1211                 }
1212                 $urls[$k] = $v;
1213             }
1214         }
1215         $selected = $select->selected;
1216         if (!empty($selected)) {
1217             if (strpos($select->selected, $CFG->wwwroot.'/') === 0) {
1218                 $selected = str_replace($CFG->wwwroot, '', $selected);
1219             } else if (strpos($selected, '/') !== 0) {
1220                 debugging("Invalid value of parameter 'selected': url '$selected' is not local relative url!");
1221             }
1222         }
1224         $output .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'sesskey', 'value'=>sesskey()));
1225         $output .= html_writer::select($urls, 'jump', $selected, $select->nothing, $select->attributes);
1227         $go = html_writer::empty_tag('input', array('type'=>'submit', 'value'=>get_string('go')));
1228         $output .= html_writer::tag('noscript', $go, array('style'=>'inline'));
1230         $nothing = empty($select->nothing) ? false : key($select->nothing);
1231         $output .= $this->page->requires->js_init_call('M.util.init_url_select', array($select->formid, $select->attributes['id'], $nothing));
1233         // then div wrapper for xhtml strictness
1234         $output = html_writer::tag('div', $output);
1236         // now the form itself around it
1237         $formattributes = array('method' => 'post',
1238                                 'action' => new moodle_url('/course/jumpto.php'),
1239                                 'id'     => $select->formid);
1240         $output = html_writer::tag('form', $output, $formattributes);
1242         // and finally one more wrapper with class
1243         return html_writer::tag('div', $output, array('class' => $select->class));
1244     }
1246     /**
1247      * Returns a string containing a link to the user documentation.
1248      * Also contains an icon by default. Shown to teachers and admin only.
1249      * @param string $path The page link after doc root and language, no leading slash.
1250      * @param string $text The text to be displayed for the link
1251      * @return string
1252      */
1253     public function doc_link($path, $text) {
1254         global $CFG;
1256         $icon = $this->pix_icon('docs', $text, 'moodle', array('class'=>'iconhelp'));
1258         $url = new moodle_url(get_docs_url($path));
1260         $attributes = array('href'=>$url);
1261         if (!empty($CFG->doctonewwindow)) {
1262             $attributes['id'] = $this->add_action_handler(new popup_action('click', $url));
1263         }
1265         return html_writer::tag('a', $icon.$text, $attributes);
1266     }
1268     /**
1269      * Render icon
1270      * @param string $pix short pix name
1271      * @param string $alt mandatory alt attribute
1272      * @param strin $component standard compoennt name like 'moodle', 'mod_form', etc.
1273      * @param array $attributes htm lattributes
1274      * @return string HTML fragment
1275      */
1276     public function pix_icon($pix, $alt, $component='moodle', array $attributes = null) {
1277         $icon = new pix_icon($pix, $alt, $component, $attributes);
1278         return $this->render($icon);
1279     }
1281     /**
1282      * Render icon
1283      * @param pix_icon $icon
1284      * @return string HTML fragment
1285      */
1286     protected function render_pix_icon(pix_icon $icon) {
1287         $attributes = $icon->attributes;
1288         $attributes['src'] = $this->pix_url($icon->pix, $icon->component);
1289         return html_writer::empty_tag('img', $attributes);
1290     }
1292     /**
1293     * Produces the html that represents this rating in the UI
1294     * @param $page the page object on which this rating will appear
1295     */
1296     function render_rating(rating $rating) {
1297         global $CFG, $USER;
1298         static $havesetupjavascript = false;
1300         if( $rating->settings->aggregationmethod == RATING_AGGREGATE_NONE ){
1301             return null;//ratings are turned off
1302         }
1304         $useajax = !empty($CFG->enableajax);
1306         //include required Javascript
1307         if( !$havesetupjavascript && $useajax ) {
1308             $this->page->requires->js_init_call('M.core_rating.init');
1309             $havesetupjavascript = true;
1310         }
1312         //check the item we're rating was created in the assessable time window
1313         $inassessablewindow = true;
1314         if ( $rating->settings->assesstimestart && $rating->settings->assesstimefinish ) {
1315             if ($rating->itemtimecreated < $rating->settings->assesstimestart || $rating->itemtimecreated > $rating->settings->assesstimefinish) {
1316                 $inassessablewindow = false;
1317             }
1318         }
1320         $strrate = get_string("rate", "rating");
1321         $ratinghtml = ''; //the string we'll return
1323         //permissions check - can they view the aggregate?
1324         if ( ($rating->itemuserid==$USER->id
1325                 && $rating->settings->permissions->view && $rating->settings->pluginpermissions->view)
1326             || ($rating->itemuserid!=$USER->id
1327                 && $rating->settings->permissions->viewany && $rating->settings->pluginpermissions->viewany) ) {
1329             $aggregatelabel = '';
1330             switch ($rating->settings->aggregationmethod) {
1331                 case RATING_AGGREGATE_AVERAGE :
1332                     $aggregatelabel .= get_string("aggregateavg", "forum");
1333                     break;
1334                 case RATING_AGGREGATE_COUNT :
1335                     $aggregatelabel .= get_string("aggregatecount", "forum");
1336                     break;
1337                 case RATING_AGGREGATE_MAXIMUM :
1338                     $aggregatelabel .= get_string("aggregatemax", "forum");
1339                     break;
1340                 case RATING_AGGREGATE_MINIMUM :
1341                     $aggregatelabel .= get_string("aggregatemin", "forum");
1342                     break;
1343                 case RATING_AGGREGATE_SUM :
1344                     $aggregatelabel .= get_string("aggregatesum", "forum");
1345                     break;
1346             }
1348             //$scalemax = 0;//no longer displaying scale max
1349             $aggregatestr = '';
1351             //only display aggregate if aggregation method isn't COUNT
1352             if ($rating->aggregate && $rating->settings->aggregationmethod!= RATING_AGGREGATE_COUNT) {
1353                 if ($rating->settings->aggregationmethod!= RATING_AGGREGATE_SUM && is_array($rating->settings->scale->scaleitems)) {
1354                     $aggregatestr .= $rating->settings->scale->scaleitems[round($rating->aggregate)];//round aggregate as we're using it as an index
1355                 }
1356                 else { //aggregation is SUM or the scale is numeric
1357                     $aggregatestr .= round($rating->aggregate,1);
1358                 }
1359             } else {
1360                 $aggregatestr = ' - ';
1361             }
1363             $countstr = html_writer::start_tag('span', array('id'=>"ratingcount{$rating->itemid}"));
1364             if ($rating->count>0) {
1365                 $countstr .= "({$rating->count})";
1366             }
1367             $countstr .= html_writer::end_tag('span');
1369             //$aggregatehtml = "{$ratingstr} / $scalemax ({$rating->count}) ";
1370             $aggregatehtml = "<span id='ratingaggregate{$rating->itemid}'>{$aggregatestr}</span> $countstr ";
1372             if ($rating->settings->permissions->viewall && $rating->settings->pluginpermissions->viewall) {
1373                 $url = "/rating/index.php?contextid={$rating->context->id}&itemid={$rating->itemid}&scaleid={$rating->settings->scale->id}";
1374                 $nonpopuplink = new moodle_url($url);
1375                 $popuplink = new moodle_url("$url&popup=1");
1377                 $action = new popup_action('click', $popuplink, 'ratings', array('height' => 400, 'width' => 600));
1378                 $ratinghtml .= $aggregatelabel.get_string('labelsep', 'langconfig').$this->action_link($nonpopuplink, $aggregatehtml, $action);
1379             } else {
1380                 $ratinghtml .= $aggregatelabel.get_string('labelsep', 'langconfig').$aggregatehtml;
1381             }
1382         }
1384         $formstart = null;
1385         //if the item doesn't belong to the current user, the user has permission to rate
1386         //and we're within the assessable period
1387         if ($rating->itemuserid!=$USER->id
1388             && $rating->settings->permissions->rate
1389             && $rating->settings->pluginpermissions->rate
1390             && $inassessablewindow) {
1392             //start the rating form
1393             $formstart = html_writer::start_tag('form',
1394                 array('id'=>"postrating{$rating->itemid}", 'class'=>'postratingform', 'method'=>'post', 'action'=>"{$CFG->wwwroot}/rating/rate.php"));
1396             $formstart .= html_writer::start_tag('div', array('class'=>'ratingform'));
1398             //add the hidden inputs
1400             $attributes = array('type'=>'hidden', 'class'=>'ratinginput', 'name'=>'contextid', 'value'=>$rating->context->id);
1401             $formstart .= html_writer::empty_tag('input', $attributes);
1403             $attributes['name'] = 'itemid';
1404             $attributes['value'] = $rating->itemid;
1405             $formstart .= html_writer::empty_tag('input', $attributes);
1407             $attributes['name'] = 'scaleid';
1408             $attributes['value'] = $rating->settings->scale->id;
1409             $formstart .= html_writer::empty_tag('input', $attributes);
1411             $attributes['name'] = 'returnurl';
1412             $attributes['value'] = $rating->settings->returnurl;
1413             $formstart .= html_writer::empty_tag('input', $attributes);
1415             $attributes['name'] = 'rateduserid';
1416             $attributes['value'] = $rating->itemuserid;
1417             $formstart .= html_writer::empty_tag('input', $attributes);
1419             $attributes['name'] = 'aggregation';
1420             $attributes['value'] = $rating->settings->aggregationmethod;
1421             $formstart .= html_writer::empty_tag('input', $attributes);
1423             $attributes['name'] = 'sesskey';
1424             $attributes['value'] = sesskey();;
1425             $formstart .= html_writer::empty_tag('input', $attributes);
1427             if (empty($ratinghtml)) {
1428                 $ratinghtml .= $strrate.': ';
1429             }
1431             $ratinghtml = $formstart.$ratinghtml;
1433             //generate an array of values for numeric scales
1434             $scalearray = $rating->settings->scale->scaleitems;
1435             if (!is_array($scalearray)) { //almost certainly a numerical scale
1436                 $intscalearray = intval($scalearray);//just in case they've passed "5" instead of 5
1437                 if( is_int($intscalearray) && $intscalearray>0 ){
1438                     $scalearray = array();
1439                     for($i=0; $i<=$rating->settings->scale->scaleitems; $i++) {
1440                         $scalearray[$i] = $i;
1441                     }
1442                 }
1443             }
1445             $scalearray = array(RATING_UNSET_RATING => $strrate.'...') + $scalearray;
1446             $ratinghtml .= html_writer::select($scalearray, 'rating', $rating->rating, false, array('class'=>'postratingmenu ratinginput','id'=>'menurating'.$rating->itemid));
1448             //output submit button
1450             $ratinghtml .= html_writer::start_tag('span', array('class'=>"ratingsubmit"));
1452             $attributes = array('type'=>'submit', 'class'=>'postratingmenusubmit', 'id'=>'postratingsubmit'.$rating->itemid, 'value'=>s(get_string('rate', 'rating')));
1453             $ratinghtml .= html_writer::empty_tag('input', $attributes);
1455             if (is_array($rating->settings->scale->scaleitems)) {
1456                 $ratinghtml .= $this->help_icon_scale($rating->settings->scale->courseid, $rating->settings->scale);
1457             }
1458             $ratinghtml .= html_writer::end_tag('span');
1459             $ratinghtml .= html_writer::end_tag('div');
1460             $ratinghtml .= html_writer::end_tag('form');
1461         }
1463         return $ratinghtml;
1464     }
1466     /*
1467      * Centered heading with attached help button (same title text)
1468      * and optional icon attached
1469      * @param string $text A heading text
1470      * @param string $helpidentifier The keyword that defines a help page
1471      * @param string $component component name
1472      * @param string|moodle_url $icon
1473      * @param string $iconalt icon alt text
1474      * @return string HTML fragment
1475      */
1476     public function heading_with_help($text, $helpidentifier, $component='moodle', $icon='', $iconalt='') {
1477         $image = '';
1478         if ($icon) {
1479             $image = $this->pix_icon($icon, $iconalt, $component, array('class'=>'icon'));
1480         }
1482         $help = '';
1483         if ($helpidentifier) {
1484             $help = $this->help_icon($helpidentifier, $component);
1485         }
1487         return $this->heading($image.$text.$help, 2, 'main help');
1488     }
1490     /**
1491      * Print a help icon.
1492      *
1493      * @param string $page The keyword that defines a help page
1494      * @param string $title A descriptive text for accessibility only
1495      * @param string $component component name
1496      * @param string|bool $linktext true means use $title as link text, string means link text value
1497      * @return string HTML fragment
1498      */
1499     public function old_help_icon($helpidentifier, $title, $component = 'moodle', $linktext = '') {
1500         $icon = new old_help_icon($helpidentifier, $title, $component);
1501         if ($linktext === true) {
1502             $icon->linktext = $title;
1503         } else if (!empty($linktext)) {
1504             $icon->linktext = $linktext;
1505         }
1506         return $this->render($icon);
1507     }
1509     /**
1510      * Implementation of user image rendering.
1511      * @param help_icon $helpicon
1512      * @return string HTML fragment
1513      */
1514     protected function render_old_help_icon(old_help_icon $helpicon) {
1515         global $CFG;
1517         // first get the help image icon
1518         $src = $this->pix_url('help');
1520         if (empty($helpicon->linktext)) {
1521             $alt = $helpicon->title;
1522         } else {
1523             $alt = get_string('helpwiththis');
1524         }
1526         $attributes = array('src'=>$src, 'alt'=>$alt, 'class'=>'iconhelp');
1527         $output = html_writer::empty_tag('img', $attributes);
1529         // add the link text if given
1530         if (!empty($helpicon->linktext)) {
1531             // the spacing has to be done through CSS
1532             $output .= $helpicon->linktext;
1533         }
1535         // now create the link around it
1536         $url = new moodle_url('/help.php', array('component' => $helpicon->component, 'identifier' => $helpicon->helpidentifier, 'lang'=>current_language()));
1538         // note: this title is displayed only if JS is disabled, otherwise the link will have the new ajax tooltip
1539         $title = get_string('helpprefix2', '', trim($helpicon->title, ". \t"));
1541         $attributes = array('href'=>$url, 'title'=>$title);
1542         $id = html_writer::random_id('helpicon');
1543         $attributes['id'] = $id;
1544         $output = html_writer::tag('a', $output, $attributes);
1546         $this->page->requires->js_init_call('M.util.help_icon.add', array(array('id'=>$id, 'url'=>$url->out(false))));
1548         // and finally span
1549         return html_writer::tag('span', $output, array('class' => 'helplink'));
1550     }
1552     /**
1553      * Print a help icon.
1554      *
1555      * @param string $identifier The keyword that defines a help page
1556      * @param string $component component name
1557      * @param string|bool $linktext true means use $title as link text, string means link text value
1558      * @return string HTML fragment
1559      */
1560     public function help_icon($identifier, $component = 'moodle', $linktext = '') {
1561         $icon = new help_icon($identifier, $component);
1562         $icon->diag_strings();
1563         if ($linktext === true) {
1564             $icon->linktext = get_string($icon->identifier, $icon->component);
1565         } else if (!empty($linktext)) {
1566             $icon->linktext = $linktext;
1567         }
1568         return $this->render($icon);
1569     }
1571     /**
1572      * Implementation of user image rendering.
1573      * @param help_icon $helpicon
1574      * @return string HTML fragment
1575      */
1576     protected function render_help_icon(help_icon $helpicon) {
1577         global $CFG;
1579         // first get the help image icon
1580         $src = $this->pix_url('help');
1582         $title = get_string($helpicon->identifier, $helpicon->component);
1584         if (empty($helpicon->linktext)) {
1585             $alt = $title;
1586         } else {
1587             $alt = get_string('helpwiththis');
1588         }
1590         $attributes = array('src'=>$src, 'alt'=>$alt, 'class'=>'iconhelp');
1591         $output = html_writer::empty_tag('img', $attributes);
1593         // add the link text if given
1594         if (!empty($helpicon->linktext)) {
1595             // the spacing has to be done through CSS
1596             $output .= $helpicon->linktext;
1597         }
1599         // now create the link around it
1600         $url = new moodle_url('/help.php', array('component' => $helpicon->component, 'identifier' => $helpicon->identifier, 'lang'=>current_language()));
1602         // note: this title is displayed only if JS is disabled, otherwise the link will have the new ajax tooltip
1603         $title = get_string('helpprefix2', '', trim($title, ". \t"));
1605         $attributes = array('href'=>$url, 'title'=>$title);
1606         $id = html_writer::random_id('helpicon');
1607         $attributes['id'] = $id;
1608         $output = html_writer::tag('a', $output, $attributes);
1610         $this->page->requires->js_init_call('M.util.help_icon.add', array(array('id'=>$id, 'url'=>$url->out(false))));
1612         // and finally span
1613         return html_writer::tag('span', $output, array('class' => 'helplink'));
1614     }
1616     /**
1617      * Print scale help icon.
1618      *
1619      * @param int $courseid
1620      * @param object $scale instance
1621      * @return string  HTML fragment
1622      */
1623     public function help_icon_scale($courseid, stdClass $scale) {
1624         global $CFG;
1626         $title = get_string('helpprefix2', '', $scale->name) .' ('.get_string('newwindow').')';
1628         $icon = $this->pix_icon('help', get_string('scales'), 'moodle', array('class'=>'iconhelp'));
1630         $link = new moodle_url('/course/scales.php', array('id' => $courseid, 'list' => true, 'scaleid' => $scale->id));
1631         $action = new popup_action('click', $link, 'ratingscale');
1633         return html_writer::tag('span', $this->action_link($link, $icon, $action), array('class' => 'helplink'));
1634     }
1636     /**
1637      * Creates and returns a spacer image with optional line break.
1638      *
1639      * @param array $attributes
1640      * @param boo spacer
1641      * @return string HTML fragment
1642      */
1643     public function spacer(array $attributes = null, $br = false) {
1644         $attributes = (array)$attributes;
1645         if (empty($attributes['width'])) {
1646             $attributes['width'] = 1;
1647         }
1648         if (empty($options['height'])) {
1649             $attributes['height'] = 1;
1650         }
1651         $attributes['class'] = 'spacer';
1653         $output = $this->pix_icon('spacer', '', 'moodle', $attributes);
1655         if (!empty($br)) {
1656             $output .= '<br />';
1657         }
1659         return $output;
1660     }
1662     /**
1663      * Print the specified user's avatar.
1664      *
1665      * User avatar may be obtained in two ways:
1666      * <pre>
1667      * // Option 1: (shortcut for simple cases, preferred way)
1668      * // $user has come from the DB and has fields id, picture, imagealt, firstname and lastname
1669      * $OUTPUT->user_picture($user, array('popup'=>true));
1670      *
1671      * // Option 2:
1672      * $userpic = new user_picture($user);
1673      * // Set properties of $userpic
1674      * $userpic->popup = true;
1675      * $OUTPUT->render($userpic);
1676      * </pre>
1677      *
1678      * @param object Object with at least fields id, picture, imagealt, firstname, lastname
1679      *     If any of these are missing, the database is queried. Avoid this
1680      *     if at all possible, particularly for reports. It is very bad for performance.
1681      * @param array $options associative array with user picture options, used only if not a user_picture object,
1682      *     options are:
1683      *     - courseid=$this->page->course->id (course id of user profile in link)
1684      *     - size=35 (size of image)
1685      *     - link=true (make image clickable - the link leads to user profile)
1686      *     - popup=false (open in popup)
1687      *     - alttext=true (add image alt attribute)
1688      *     - class = image class attribute (default 'userpicture')
1689      * @return string HTML fragment
1690      */
1691     public function user_picture(stdClass $user, array $options = null) {
1692         $userpicture = new user_picture($user);
1693         foreach ((array)$options as $key=>$value) {
1694             if (array_key_exists($key, $userpicture)) {
1695                 $userpicture->$key = $value;
1696             }
1697         }
1698         return $this->render($userpicture);
1699     }
1701     /**
1702      * Internal implementation of user image rendering.
1703      * @param user_picture $userpicture
1704      * @return string
1705      */
1706     protected function render_user_picture(user_picture $userpicture) {
1707         global $CFG, $DB;
1709         $user = $userpicture->user;
1711         if ($userpicture->alttext) {
1712             if (!empty($user->imagealt)) {
1713                 $alt = $user->imagealt;
1714             } else {
1715                 $alt = get_string('pictureof', '', fullname($user));
1716             }
1717         } else {
1718             $alt = '';
1719         }
1721         if (empty($userpicture->size)) {
1722             $file = 'f2';
1723             $size = 35;
1724         } else if ($userpicture->size === true or $userpicture->size == 1) {
1725             $file = 'f1';
1726             $size = 100;
1727         } else if ($userpicture->size >= 50) {
1728             $file = 'f1';
1729             $size = $userpicture->size;
1730         } else {
1731             $file = 'f2';
1732             $size = $userpicture->size;
1733         }
1735         $class = $userpicture->class;
1737         if ($user->picture == 1) {
1738             $usercontext = get_context_instance(CONTEXT_USER, $user->id);
1739             $src = moodle_url::make_pluginfile_url($usercontext->id, 'user', 'icon', NULL, '/', $file);
1741         } else if ($user->picture == 2) {
1742             //TODO: gravatar user icon support
1744         } else { // Print default user pictures (use theme version if available)
1745             $class .= ' defaultuserpic';
1746             $src = $this->pix_url('u/' . $file);
1747         }
1749         $attributes = array('src'=>$src, 'alt'=>$alt, 'class'=>$class, 'width'=>$size, 'height'=>$size);
1751         // get the image html output fisrt
1752         $output = html_writer::empty_tag('img', $attributes);;
1754         // then wrap it in link if needed
1755         if (!$userpicture->link) {
1756             return $output;
1757         }
1759         if (empty($userpicture->courseid)) {
1760             $courseid = $this->page->course->id;
1761         } else {
1762             $courseid = $userpicture->courseid;
1763         }
1765         if ($courseid == SITEID) {
1766             $url = new moodle_url('/user/profile.php', array('id' => $user->id));
1767         } else {
1768             $url = new moodle_url('/user/view.php', array('id' => $user->id, 'course' => $courseid));
1769         }
1771         $attributes = array('href'=>$url);
1773         if ($userpicture->popup) {
1774             $id = html_writer::random_id('userpicture');
1775             $attributes['id'] = $id;
1776             $this->add_action_handler(new popup_action('click', $url), $id);
1777         }
1779         return html_writer::tag('a', $output, $attributes);
1780     }
1782     /**
1783      * Internal implementation of file tree viewer items rendering.
1784      * @param array $dir
1785      * @return string
1786      */
1787     public function htmllize_file_tree($dir) {
1788         if (empty($dir['subdirs']) and empty($dir['files'])) {
1789             return '';
1790         }
1791         $result = '<ul>';
1792         foreach ($dir['subdirs'] as $subdir) {
1793             $result .= '<li>'.s($subdir['dirname']).' '.$this->htmllize_file_tree($subdir).'</li>';
1794         }
1795         foreach ($dir['files'] as $file) {
1796             $filename = $file->get_filename();
1797             $result .= '<li><span>'.html_writer::link($file->fileurl, $filename).'</span></li>';
1798         }
1799         $result .= '</ul>';
1801         return $result;
1802     }
1803     /**
1804      * Print the file picker
1805      *
1806      * <pre>
1807      * $OUTPUT->file_picker($options);
1808      * </pre>
1809      *
1810      * @param array $options associative array with file manager options
1811      *   options are:
1812      *       maxbytes=>-1,
1813      *       itemid=>0,
1814      *       client_id=>uniqid(),
1815      *       acepted_types=>'*',
1816      *       return_types=>FILE_INTERNAL,
1817      *       context=>$PAGE->context
1818      * @return string HTML fragment
1819      */
1820     public function file_picker($options) {
1821         $fp = new file_picker($options);
1822         return $this->render($fp);
1823     }
1824     /**
1825      * Internal implementation of file picker rendering.
1826      * @param file_picker $fp
1827      * @return string
1828      */
1829     public function render_file_picker(file_picker $fp) {
1830         global $CFG, $OUTPUT, $USER;
1831         $options = $fp->options;
1832         $client_id = $options->client_id;
1833         $strsaved = get_string('filesaved', 'repository');
1834         $straddfile = get_string('openpicker', 'repository');
1835         $strloading  = get_string('loading', 'repository');
1836         $icon_progress = $OUTPUT->pix_icon('i/loading_small', $strloading).'';
1838         $currentfile = $options->currentfile;
1839         if (empty($currentfile)) {
1840             $currentfile = get_string('nofilesattached', 'repository');
1841         }
1842         $html = <<<EOD
1843 <div class="filemanager-loading mdl-align" id='filepicker-loading-{$client_id}'>
1844 $icon_progress
1845 </div>
1846 <div id="filepicker-wrapper-{$client_id}" class="mdl-left" style="display:none">
1847     <div>
1848         <button id="filepicker-button-{$client_id}">$straddfile</button>
1849     </div>
1850 EOD;
1851         if ($options->env != 'url') {
1852             $html .= <<<EOD
1853     <div id="file_info_{$client_id}" class="mdl-left filepicker-filelist">$currentfile</div>
1854 EOD;
1855         }
1856         $html .= '</div>';
1857         return $html;
1858     }
1860     /**
1861      * Prints the 'Update this Modulename' button that appears on module pages.
1862      *
1863      * @param string $cmid the course_module id.
1864      * @param string $modulename the module name, eg. "forum", "quiz" or "workshop"
1865      * @return string the HTML for the button, if this user has permission to edit it, else an empty string.
1866      */
1867     public function update_module_button($cmid, $modulename) {
1868         global $CFG;
1869         if (has_capability('moodle/course:manageactivities', get_context_instance(CONTEXT_MODULE, $cmid))) {
1870             $modulename = get_string('modulename', $modulename);
1871             $string = get_string('updatethis', '', $modulename);
1872             $url = new moodle_url("$CFG->wwwroot/course/mod.php", array('update' => $cmid, 'return' => true, 'sesskey' => sesskey()));
1873             return $this->single_button($url, $string);
1874         } else {
1875             return '';
1876         }
1877     }
1879     /**
1880      * Prints a "Turn editing on/off" button in a form.
1881      * @param moodle_url $url The URL + params to send through when clicking the button
1882      * @return string HTML the button
1883      */
1884     public function edit_button(moodle_url $url) {
1886         $url->param('sesskey', sesskey());
1887         if ($this->page->user_is_editing()) {
1888             $url->param('edit', 'off');
1889             $editstring = get_string('turneditingoff');
1890         } else {
1891             $url->param('edit', 'on');
1892             $editstring = get_string('turneditingon');
1893         }
1895         return $this->single_button($url, $editstring);
1896     }
1898     /**
1899      * Prints a simple button to close a window
1900      *
1901      * @param string $text The lang string for the button's label (already output from get_string())
1902      * @return string html fragment
1903      */
1904     public function close_window_button($text='') {
1905         if (empty($text)) {
1906             $text = get_string('closewindow');
1907         }
1908         $button = new single_button(new moodle_url('#'), $text, 'get');
1909         $button->add_action(new component_action('click', 'close_window'));
1911         return $this->container($this->render($button), 'closewindow');
1912     }
1914     /**
1915      * Output an error message. By default wraps the error message in <span class="error">.
1916      * If the error message is blank, nothing is output.
1917      * @param string $message the error message.
1918      * @return string the HTML to output.
1919      */
1920     public function error_text($message) {
1921         if (empty($message)) {
1922             return '';
1923         }
1924         return html_writer::tag('span', $message, array('class' => 'error'));
1925     }
1927     /**
1928      * Do not call this function directly.
1929      *
1930      * To terminate the current script with a fatal error, call the {@link print_error}
1931      * function, or throw an exception. Doing either of those things will then call this
1932      * function to display the error, before terminating the execution.
1933      *
1934      * @param string $message The message to output
1935      * @param string $moreinfourl URL where more info can be found about the error
1936      * @param string $link Link for the Continue button
1937      * @param array $backtrace The execution backtrace
1938      * @param string $debuginfo Debugging information
1939      * @return string the HTML to output.
1940      */
1941     public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
1943         $output = '';
1944         $obbuffer = '';
1946         if ($this->has_started()) {
1947             // we can not always recover properly here, we have problems with output buffering,
1948             // html tables, etc.
1949             $output .= $this->opencontainers->pop_all_but_last();
1951         } else {
1952             // It is really bad if library code throws exception when output buffering is on,
1953             // because the buffered text would be printed before our start of page.
1954             // NOTE: this hack might be behave unexpectedly in case output buffering is enabled in PHP.ini
1955             while (ob_get_level() > 0) {
1956                 $obbuffer .= ob_get_clean();
1957             }
1959             // Header not yet printed
1960             if (isset($_SERVER['SERVER_PROTOCOL'])) {
1961                 // server protocol should be always present, because this render
1962                 // can not be used from command line or when outputting custom XML
1963                 @header($_SERVER['SERVER_PROTOCOL'] . ' 404 Not Found');
1964             }
1965             $this->page->set_url('/'); // no url
1966             //$this->page->set_pagelayout('base'); //TODO: MDL-20676 blocks on error pages are weird, unfortunately it somehow detect the pagelayout from URL :-(
1967             $this->page->set_title(get_string('error'));
1968             $this->page->set_heading($this->page->course->fullname);
1969             $output .= $this->header();
1970         }
1972         $message = '<p class="errormessage">' . $message . '</p>'.
1973                 '<p class="errorcode"><a href="' . $moreinfourl . '">' .
1974                 get_string('moreinformation') . '</a></p>';
1975         $output .= $this->box($message, 'errorbox');
1977         if (debugging('', DEBUG_DEVELOPER)) {
1978             if (!empty($debuginfo)) {
1979                 $debuginfo = s($debuginfo); // removes all nasty JS
1980                 $debuginfo = str_replace("\n", '<br />', $debuginfo); // keep newlines
1981                 $output .= $this->notification('<strong>Debug info:</strong> '.$debuginfo, 'notifytiny');
1982             }
1983             if (!empty($backtrace)) {
1984                 $output .= $this->notification('<strong>Stack trace:</strong> '.format_backtrace($backtrace), 'notifytiny');
1985             }
1986             if ($obbuffer !== '' ) {
1987                 $output .= $this->notification('<strong>Output buffer:</strong> '.s($obbuffer), 'notifytiny');
1988             }
1989         }
1991         if (!empty($link)) {
1992             $output .= $this->continue_button($link);
1993         }
1995         $output .= $this->footer();
1997         // Padding to encourage IE to display our error page, rather than its own.
1998         $output .= str_repeat(' ', 512);
2000         return $output;
2001     }
2003     /**
2004      * Output a notification (that is, a status message about something that has
2005      * just happened).
2006      *
2007      * @param string $message the message to print out
2008      * @param string $classes normally 'notifyproblem' or 'notifysuccess'.
2009      * @return string the HTML to output.
2010      */
2011     public function notification($message, $classes = 'notifyproblem') {
2012         return html_writer::tag('div', clean_text($message), array('class' => renderer_base::prepare_classes($classes)));
2013     }
2015     /**
2016      * Print a continue button that goes to a particular URL.
2017      *
2018      * @param string|moodle_url $url The url the button goes to.
2019      * @return string the HTML to output.
2020      */
2021     public function continue_button($url) {
2022         if (!($url instanceof moodle_url)) {
2023             $url = new moodle_url($url);
2024         }
2025         $button = new single_button($url, get_string('continue'), 'get');
2026         $button->class = 'continuebutton';
2028         return $this->render($button);
2029     }
2031     /**
2032      * Prints a single paging bar to provide access to other pages  (usually in a search)
2033      *
2034      * @param int $totalcount The total number of entries available to be paged through
2035      * @param int $page The page you are currently viewing
2036      * @param int $perpage The number of entries that should be shown per page
2037      * @param string|moodle_url $baseurl url of the current page, the $pagevar parameter is added
2038      * @param string $pagevar name of page parameter that holds the page number
2039      * @return string the HTML to output.
2040      */
2041     public function paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar = 'page') {
2042         $pb = new paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar);
2043         return $this->render($pb);
2044     }
2046     /**
2047      * Internal implementation of paging bar rendering.
2048      * @param paging_bar $pagingbar
2049      * @return string
2050      */
2051     protected function render_paging_bar(paging_bar $pagingbar) {
2052         $output = '';
2053         $pagingbar = clone($pagingbar);
2054         $pagingbar->prepare($this, $this->page, $this->target);
2056         if ($pagingbar->totalcount > $pagingbar->perpage) {
2057             $output .= get_string('page') . ':';
2059             if (!empty($pagingbar->previouslink)) {
2060                 $output .= '&#160;(' . $pagingbar->previouslink . ')&#160;';
2061             }
2063             if (!empty($pagingbar->firstlink)) {
2064                 $output .= '&#160;' . $pagingbar->firstlink . '&#160;...';
2065             }
2067             foreach ($pagingbar->pagelinks as $link) {
2068                 $output .= "&#160;&#160;$link";
2069             }
2071             if (!empty($pagingbar->lastlink)) {
2072                 $output .= '&#160;...' . $pagingbar->lastlink . '&#160;';
2073             }
2075             if (!empty($pagingbar->nextlink)) {
2076                 $output .= '&#160;&#160;(' . $pagingbar->nextlink . ')';
2077             }
2078         }
2080         return html_writer::tag('div', $output, array('class' => 'paging'));
2081     }
2083     /**
2084      * Output the place a skip link goes to.
2085      * @param string $id The target name from the corresponding $PAGE->requires->skip_link_to($target) call.
2086      * @return string the HTML to output.
2087      */
2088     public function skip_link_target($id = null) {
2089         return html_writer::tag('span', '', array('id' => $id));
2090     }
2092     /**
2093      * Outputs a heading
2094      * @param string $text The text of the heading
2095      * @param int $level The level of importance of the heading. Defaulting to 2
2096      * @param string $classes A space-separated list of CSS classes
2097      * @param string $id An optional ID
2098      * @return string the HTML to output.
2099      */
2100     public function heading($text, $level = 2, $classes = 'main', $id = null) {
2101         $level = (integer) $level;
2102         if ($level < 1 or $level > 6) {
2103             throw new coding_exception('Heading level must be an integer between 1 and 6.');
2104         }
2105         return html_writer::tag('h' . $level, $text, array('id' => $id, 'class' => renderer_base::prepare_classes($classes)));
2106     }
2108     /**
2109      * Outputs a box.
2110      * @param string $contents The contents of the box
2111      * @param string $classes A space-separated list of CSS classes
2112      * @param string $id An optional ID
2113      * @return string the HTML to output.
2114      */
2115     public function box($contents, $classes = 'generalbox', $id = null) {
2116         return $this->box_start($classes, $id) . $contents . $this->box_end();
2117     }
2119     /**
2120      * Outputs the opening section of a box.
2121      * @param string $classes A space-separated list of CSS classes
2122      * @param string $id An optional ID
2123      * @return string the HTML to output.
2124      */
2125     public function box_start($classes = 'generalbox', $id = null) {
2126         $this->opencontainers->push('box', html_writer::end_tag('div'));
2127         return html_writer::start_tag('div', array('id' => $id,
2128                 'class' => 'box ' . renderer_base::prepare_classes($classes)));
2129     }
2131     /**
2132      * Outputs the closing section of a box.
2133      * @return string the HTML to output.
2134      */
2135     public function box_end() {
2136         return $this->opencontainers->pop('box');
2137     }
2139     /**
2140      * Outputs a container.
2141      * @param string $contents The contents of the box
2142      * @param string $classes A space-separated list of CSS classes
2143      * @param string $id An optional ID
2144      * @return string the HTML to output.
2145      */
2146     public function container($contents, $classes = null, $id = null) {
2147         return $this->container_start($classes, $id) . $contents . $this->container_end();
2148     }
2150     /**
2151      * Outputs the opening section of a container.
2152      * @param string $classes A space-separated list of CSS classes
2153      * @param string $id An optional ID
2154      * @return string the HTML to output.
2155      */
2156     public function container_start($classes = null, $id = null) {
2157         $this->opencontainers->push('container', html_writer::end_tag('div'));
2158         return html_writer::start_tag('div', array('id' => $id,
2159                 'class' => renderer_base::prepare_classes($classes)));
2160     }
2162     /**
2163      * Outputs the closing section of a container.
2164      * @return string the HTML to output.
2165      */
2166     public function container_end() {
2167         return $this->opencontainers->pop('container');
2168     }
2170     /**
2171      * Make nested HTML lists out of the items
2172      *
2173      * The resulting list will look something like this:
2174      *
2175      * <pre>
2176      * <<ul>>
2177      * <<li>><div class='tree_item parent'>(item contents)</div>
2178      *      <<ul>
2179      *      <<li>><div class='tree_item'>(item contents)</div><</li>>
2180      *      <</ul>>
2181      * <</li>>
2182      * <</ul>>
2183      * </pre>
2184      *
2185      * @param array[]tree_item $items
2186      * @param array[string]string $attrs html attributes passed to the top of
2187      * the list
2188      * @return string HTML
2189      */
2190     function tree_block_contents($items, $attrs=array()) {
2191         // exit if empty, we don't want an empty ul element
2192         if (empty($items)) {
2193             return '';
2194         }
2195         // array of nested li elements
2196         $lis = array();
2197         foreach ($items as $item) {
2198             // this applies to the li item which contains all child lists too
2199             $content = $item->content($this);
2200             $liclasses = array($item->get_css_type());
2201             if (!$item->forceopen || (!$item->forceopen && $item->collapse) || ($item->children->count()==0  && $item->nodetype==navigation_node::NODETYPE_BRANCH)) {
2202                 $liclasses[] = 'collapsed';
2203             }
2204             if ($item->isactive === true) {
2205                 $liclasses[] = 'current_branch';
2206             }
2207             $liattr = array('class'=>join(' ',$liclasses));
2208             // class attribute on the div item which only contains the item content
2209             $divclasses = array('tree_item');
2210             if ($item->children->count()>0  || $item->nodetype==navigation_node::NODETYPE_BRANCH) {
2211                 $divclasses[] = 'branch';
2212             } else {
2213                 $divclasses[] = 'leaf';
2214             }
2215             if (!empty($item->classes) && count($item->classes)>0) {
2216                 $divclasses[] = join(' ', $item->classes);
2217             }
2218             $divattr = array('class'=>join(' ', $divclasses));
2219             if (!empty($item->id)) {
2220                 $divattr['id'] = $item->id;
2221             }
2222             $content = html_writer::tag('p', $content, $divattr) . $this->tree_block_contents($item->children);
2223             if (!empty($item->preceedwithhr) && $item->preceedwithhr===true) {
2224                 $content = html_writer::empty_tag('hr') . $content;
2225             }
2226             $content = html_writer::tag('li', $content, $liattr);
2227             $lis[] = $content;
2228         }
2229         return html_writer::tag('ul', implode("\n", $lis), $attrs);
2230     }
2232     /**
2233      * Return the navbar content so that it can be echoed out by the layout
2234      * @return string XHTML navbar
2235      */
2236     public function navbar() {
2237         //return $this->page->navbar->content();
2239         $items = $this->page->navbar->get_items();
2241         $count = 0;
2243         $htmlblocks = array();
2244         // Iterate the navarray and display each node
2245         $itemcount = count($items);
2246         $separator = get_separator();
2247         for ($i=0;$i < $itemcount;$i++) {
2248             $item = $items[$i];
2249             $item->hideicon = true;
2250             if ($i===0) {
2251                 $content = html_writer::tag('li', $this->render($item));
2252             } else {
2253                 $content = html_writer::tag('li', $separator.$this->render($item));
2254             }
2255             $htmlblocks[] = $content;
2256         }
2258         //accessibility: heading for navbar list  (MDL-20446)
2259         $navbarcontent = html_writer::tag('span', get_string('pagepath'), array('class'=>'accesshide'));
2260         $navbarcontent .= html_writer::tag('ul', join('', $htmlblocks));
2261         // XHTML
2262         return $navbarcontent;
2263     }
2265     protected function render_navigation_node(navigation_node $item) {
2266         $content = $item->get_content();
2267         $title = $item->get_title();
2268         if ($item->icon instanceof renderable && !$item->hideicon) {
2269             $icon = $this->render($item->icon);
2270             $content = $icon.$content; // use CSS for spacing of icons
2271         }
2272         if ($item->helpbutton !== null) {
2273             $content = trim($item->helpbutton).html_writer::tag('span', $content, array('class'=>'clearhelpbutton'));
2274         }
2275         if ($content === '') {
2276             return '';
2277         }
2278         if ($item->action instanceof action_link) {
2279             //TODO: to be replaced with something else
2280             $link = $item->action;
2281             if ($item->hidden) {
2282                 $link->add_class('dimmed');
2283             }
2284             $content = $this->output->render($link);
2285         } else if ($item->action instanceof moodle_url) {
2286             $attributes = array();
2287             if ($title !== '') {
2288                 $attributes['title'] = $title;
2289             }
2290             if ($item->hidden) {
2291                 $attributes['class'] = 'dimmed_text';
2292             }
2293             $content = html_writer::link($item->action, $content, $attributes);
2295         } else if (is_string($item->action) || empty($item->action)) {
2296             $attributes = array();
2297             if ($title !== '') {
2298                 $attributes['title'] = $title;
2299             }
2300             if ($item->hidden) {
2301                 $attributes['class'] = 'dimmed_text';
2302             }
2303             $content = html_writer::tag('span', $content, $attributes);
2304         }
2305         return $content;
2306     }
2308     /**
2309      * Accessibility: Right arrow-like character is
2310      * used in the breadcrumb trail, course navigation menu
2311      * (previous/next activity), calendar, and search forum block.
2312      * If the theme does not set characters, appropriate defaults
2313      * are set automatically. Please DO NOT
2314      * use &lt; &gt; &raquo; - these are confusing for blind users.
2315      * @return string
2316      */
2317     public function rarrow() {
2318         return $this->page->theme->rarrow;
2319     }
2321     /**
2322      * Accessibility: Right arrow-like character is
2323      * used in the breadcrumb trail, course navigation menu
2324      * (previous/next activity), calendar, and search forum block.
2325      * If the theme does not set characters, appropriate defaults
2326      * are set automatically. Please DO NOT
2327      * use &lt; &gt; &raquo; - these are confusing for blind users.
2328      * @return string
2329      */
2330     public function larrow() {
2331         return $this->page->theme->larrow;
2332     }
2334     /**
2335      * Returns the colours of the small MP3 player
2336      * @return string
2337      */
2338     public function filter_mediaplugin_colors() {
2339         return $this->page->theme->filter_mediaplugin_colors;
2340     }
2342     /**
2343      * Returns the colours of the big MP3 player
2344      * @return string
2345      */
2346     public function resource_mp3player_colors() {
2347         return $this->page->theme->resource_mp3player_colors;
2348     }
2350     /**
2351      * Returns the custom menu if one has been set
2352      *
2353      * A custom menu can be configured by browsing to
2354      *    Settings: Administration > Appearance > Themes > Theme settings
2355      * and then configuring the custommenu config setting as described.
2356      *
2357      * @return string
2358      */
2359     public function custom_menu() {
2360         global $CFG;
2361         if (empty($CFG->custommenuitems)) {
2362             return '';
2363         }
2364         $custommenu = new custom_menu();
2365         return $this->render_custom_menu($custommenu);
2366     }
2368     /**
2369      * Renders a custom menu object (located in outputcomponents.php)
2370      *
2371      * The custom menu this method produces makes use of the YUI3 menunav widget
2372      * and requires very specific html elements and classes.
2373      *
2374      * @staticvar int $menucount
2375      * @param custom_menu $menu
2376      * @return string
2377      */
2378     protected function render_custom_menu(custom_menu $menu) {
2379         static $menucount = 0;
2380         // If the menu has no children return an empty string
2381         if (!$menu->has_children()) {
2382             return '';
2383         }
2384         // Increment the menu count. This is used for ID's that get worked with
2385         // in JavaScript as is essential
2386         $menucount++;
2387         // Initialise this custom menu
2388         $this->page->requires->js_init_call('M.core_custom_menu.init', array('custom_menu_'.$menucount));
2389         // Build the root nodes as required by YUI
2390         $content = html_writer::start_tag('div', array('id'=>'custom_menu_'.$menucount, 'class'=>'yui3-menu yui3-menu-horizontal javascript-disabled'));
2391         $content .= html_writer::start_tag('div', array('class'=>'yui3-menu-content'));
2392         $content .= html_writer::start_tag('ul');
2393         // Render each child
2394         foreach ($menu->get_children() as $item) {
2395             $content .= $this->render_custom_menu_item($item);
2396         }
2397         // Close the open tags
2398         $content .= html_writer::end_tag('ul');
2399         $content .= html_writer::end_tag('div');
2400         $content .= html_writer::end_tag('div');
2401         // Return the custom menu
2402         return $content;
2403     }
2405     /**
2406      * Renders a custom menu node as part of a submenu
2407      *
2408      * The custom menu this method produces makes use of the YUI3 menunav widget
2409      * and requires very specific html elements and classes.
2410      *
2411      * @see render_custom_menu()
2412      *
2413      * @staticvar int $submenucount
2414      * @param custom_menu_item $menunode
2415      * @return string
2416      */
2417     protected function render_custom_menu_item(custom_menu_item $menunode) {
2418         // Required to ensure we get unique trackable id's
2419         static $submenucount = 0;
2420         if ($menunode->has_children()) {
2421             // If the child has menus render it as a sub menu
2422             $submenucount++;
2423             $content = html_writer::start_tag('li');
2424             if ($menunode->get_url() !== null) {
2425                 $url = $menunode->get_url();
2426             } else {
2427                 $url = '#cm_submenu_'.$submenucount;
2428             }
2429             $content .= html_writer::link($url, $menunode->get_text(), array('class'=>'yui3-menu-label', 'title'=>$menunode->get_title()));
2430             $content .= html_writer::start_tag('div', array('id'=>'cm_submenu_'.$submenucount, 'class'=>'yui3-menu custom_menu_submenu'));
2431             $content .= html_writer::start_tag('div', array('class'=>'yui3-menu-content'));
2432             $content .= html_writer::start_tag('ul');
2433             foreach ($menunode->get_children() as $menunode) {
2434                 $content .= $this->render_custom_menu_item($menunode);
2435             }
2436             $content .= html_writer::end_tag('ul');
2437             $content .= html_writer::end_tag('div');
2438             $content .= html_writer::end_tag('div');
2439             $content .= html_writer::end_tag('li');
2440         } else {
2441             // The node doesn't have children so produce a final menuitem
2442             $content = html_writer::start_tag('li', array('class'=>'yui3-menuitem'));
2443             if ($menunode->get_url() !== null) {
2444                 $url = $menunode->get_url();
2445             } else {
2446                 $url = '#';
2447             }
2448             $content .= html_writer::link($url, $menunode->get_text(), array('class'=>'yui3-menuitem-content', 'title'=>$menunode->get_title()));
2449             $content .= html_writer::end_tag('li');
2450         }
2451         // Return the sub menu
2452         return $content;
2453     }
2455     /**
2456      * Renders the image_gallery component and initialises its JavaScript
2457      *
2458      * @param image_gallery $imagegallery
2459      * @return string
2460      */
2461     protected function render_image_gallery(image_gallery $imagegallery) {
2462         $this->page->requires->yui_module(array('gallery-lightbox','gallery-lightbox-skin'),
2463                  'Y.Lightbox.init', null, '2010.04.08-12-35');
2464         if (count($imagegallery->images) == 0) {
2465             return '';
2466         }
2467         $classes = array('image_gallery');
2468         if ($imagegallery->displayfirstimageonly) {
2469             $classes[] = 'oneimageonly';
2470         }
2471         $content = html_writer::start_tag('div', array('class'=>join(' ', $classes)));
2472         foreach ($imagegallery->images as $image) {
2473             $content .= html_writer::tag('a', html_writer::empty_tag('img', $image->thumb), $image->link);
2474         }
2475         $content .= html_writer::end_tag('div');
2476         return $content;
2477     }
2481 /// RENDERERS
2483 /**
2484  * A renderer that generates output for command-line scripts.
2485  *
2486  * The implementation of this renderer is probably incomplete.
2487  *
2488  * @copyright 2009 Tim Hunt
2489  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2490  * @since     Moodle 2.0
2491  */
2492 class core_renderer_cli extends core_renderer {
2493     /**
2494      * Returns the page header.
2495      * @return string HTML fragment
2496      */
2497     public function header() {
2498         output_starting_hook();
2499         return $this->page->heading . "\n";
2500     }
2502     /**
2503      * Returns a template fragment representing a Heading.
2504      * @param string $text The text of the heading
2505      * @param int $level The level of importance of the heading
2506      * @param string $classes A space-separated list of CSS classes
2507      * @param string $id An optional ID
2508      * @return string A template fragment for a heading
2509      */
2510     public function heading($text, $level = 2, $classes = 'main', $id = null) {
2511         $text .= "\n";
2512         switch ($level) {
2513             case 1:
2514                 return '=>' . $text;
2515             case 2:
2516                 return '-->' . $text;
2517             default:
2518                 return $text;
2519         }
2520     }
2522     /**
2523      * Returns a template fragment representing a fatal error.
2524      * @param string $message The message to output
2525      * @param string $moreinfourl URL where more info can be found about the error
2526      * @param string $link Link for the Continue button
2527      * @param array $backtrace The execution backtrace
2528      * @param string $debuginfo Debugging information
2529      * @return string A template fragment for a fatal error
2530      */
2531     public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
2532         $output = "!!! $message !!!\n";
2534         if (debugging('', DEBUG_DEVELOPER)) {
2535             if (!empty($debuginfo)) {
2536                 $this->notification($debuginfo, 'notifytiny');
2537             }
2538             if (!empty($backtrace)) {
2539                 $this->notification('Stack trace: ' . format_backtrace($backtrace, true), 'notifytiny');
2540             }
2541         }
2542     }
2544     /**
2545      * Returns a template fragment representing a notification.
2546      * @param string $message The message to include
2547      * @param string $classes A space-separated list of CSS classes
2548      * @return string A template fragment for a notification
2549      */
2550     public function notification($message, $classes = 'notifyproblem') {
2551         $message = clean_text($message);
2552         if ($classes === 'notifysuccess') {
2553             return "++ $message ++\n";
2554         }
2555         return "!! $message !!\n";
2556     }
2560 /**
2561  * A renderer that generates output for ajax scripts.
2562  *
2563  * This renderer prevents accidental sends back only json
2564  * encoded error messages, all other output is ignored.
2565  *
2566  * @copyright 2010 Petr Skoda
2567  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2568  * @since     Moodle 2.0
2569  */
2570 class core_renderer_ajax extends core_renderer {
2571     /**
2572      * Returns a template fragment representing a fatal error.
2573      * @param string $message The message to output
2574      * @param string $moreinfourl URL where more info can be found about the error
2575      * @param string $link Link for the Continue button
2576      * @param array $backtrace The execution backtrace
2577      * @param string $debuginfo Debugging information
2578      * @return string A template fragment for a fatal error
2579      */
2580     public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
2581         global $FULLME, $USER;
2582         $e = new stdClass();
2583         $e->error      = $message;
2584         $e->stacktrace = NULL;
2585         $e->debuginfo  = NULL;
2586         $e->reproductionlink = NULL;
2587         if (!empty($CFG->debug) and $CFG->debug >= DEBUG_DEVELOPER) {
2588             $e->reproductionlink = $link;
2589             if (!empty($debuginfo)) {
2590                 $e->debuginfo = $debuginfo;
2591             }
2592             if (!empty($backtrace)) {
2593                 $e->stacktrace = format_backtrace($backtrace, true);
2594             }
2595         }
2596         @header('Content-type: application/json');
2597         return json_encode($e);
2598     }
2600     public function notification($message, $classes = 'notifyproblem') {
2601     }
2602     public function redirect_message($encodedurl, $message, $delay, $debugdisableredirect) {
2603     }
2604     public function header() {
2605     }
2606     public function footer() {
2607     }
2608     public function heading($text, $level = 2, $classes = 'main', $id = null) {
2609     }