MDL-20034: add title attribute to user profile (image tag).
[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 pageinfo">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, $SESSION;
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;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 (isguestuser()) {
422                 $loggedinas = $realuserinfo.get_string('loggedinasguest').
423                           " (<a href=\"$loginurl\">".get_string('login').'</a>)';
424             } else if (is_role_switched($course->id)) { // Has switched roles
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 (!isguestuser()) {
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         if (session_is_loggedinas()) {
572             $this->page->add_body_class('userloggedinas');
573         }
575         $this->page->set_state(moodle_page::STATE_PRINTING_HEADER);
577         // Find the appropriate page layout file, based on $this->page->pagelayout.
578         $layoutfile = $this->page->theme->layout_file($this->page->pagelayout);
579         // Render the layout using the layout file.
580         $rendered = $this->render_page_layout($layoutfile);
582         // Slice the rendered output into header and footer.
583         $cutpos = strpos($rendered, self::MAIN_CONTENT_TOKEN);
584         if ($cutpos === false) {
585             throw new coding_exception('page layout file ' . $layoutfile .
586                     ' does not contain the string "' . self::MAIN_CONTENT_TOKEN . '".');
587         }
588         $header = substr($rendered, 0, $cutpos);
589         $footer = substr($rendered, $cutpos + strlen(self::MAIN_CONTENT_TOKEN));
591         if (empty($this->contenttype)) {
592             debugging('The page layout file did not call $OUTPUT->doctype()');
593             $header = $this->doctype() . $header;
594         }
596         send_headers($this->contenttype, $this->page->cacheable);
598         $this->opencontainers->push('header/footer', $footer);
599         $this->page->set_state(moodle_page::STATE_IN_BODY);
601         return $header . $this->skip_link_target('maincontent');
602     }
604     /**
605      * Renders and outputs the page layout file.
606      * @param string $layoutfile The name of the layout file
607      * @return string HTML code
608      */
609     protected function render_page_layout($layoutfile) {
610         global $CFG, $SITE, $USER;
611         // The next lines are a bit tricky. The point is, here we are in a method
612         // of a renderer class, and this object may, or may not, be the same as
613         // the global $OUTPUT object. When rendering the page layout file, we want to use
614         // this object. However, people writing Moodle code expect the current
615         // renderer to be called $OUTPUT, not $this, so define a variable called
616         // $OUTPUT pointing at $this. The same comment applies to $PAGE and $COURSE.
617         $OUTPUT = $this;
618         $PAGE = $this->page;
619         $COURSE = $this->page->course;
621         ob_start();
622         include($layoutfile);
623         $rendered = ob_get_contents();
624         ob_end_clean();
625         return $rendered;
626     }
628     /**
629      * Outputs the page's footer
630      * @return string HTML fragment
631      */
632     public function footer() {
633         global $CFG, $DB;
635         $output = $this->container_end_all(true);
637         $footer = $this->opencontainers->pop('header/footer');
639         if (debugging() and $DB and $DB->is_transaction_started()) {
640             // TODO: MDL-20625 print warning - transaction will be rolled back
641         }
643         // Provide some performance info if required
644         $performanceinfo = '';
645         if (defined('MDL_PERF') || (!empty($CFG->perfdebug) and $CFG->perfdebug > 7)) {
646             $perf = get_performance_info();
647             if (defined('MDL_PERFTOLOG') && !function_exists('register_shutdown_function')) {
648                 error_log("PERF: " . $perf['txt']);
649             }
650             if (defined('MDL_PERFTOFOOT') || debugging() || $CFG->perfdebug > 7) {
651                 $performanceinfo = $perf['html'];
652             }
653         }
654         $footer = str_replace(self::PERFORMANCE_INFO_TOKEN, $performanceinfo, $footer);
656         $footer = str_replace(self::END_HTML_TOKEN, $this->page->requires->get_end_code(), $footer);
658         $this->page->set_state(moodle_page::STATE_DONE);
660         return $output . $footer;
661     }
663     /**
664      * Close all but the last open container. This is useful in places like error
665      * handling, where you want to close all the open containers (apart from <body>)
666      * before outputting the error message.
667      * @param bool $shouldbenone assert that the stack should be empty now - causes a
668      *      developer debug warning if it isn't.
669      * @return string the HTML required to close any open containers inside <body>.
670      */
671     public function container_end_all($shouldbenone = false) {
672         return $this->opencontainers->pop_all_but_last($shouldbenone);
673     }
675     /**
676      * Returns lang menu or '', this method also checks forcing of languages in courses.
677      * @return string
678      */
679     public function lang_menu() {
680         global $CFG;
682         if (empty($CFG->langmenu)) {
683             return '';
684         }
686         if ($this->page->course != SITEID and !empty($this->page->course->lang)) {
687             // do not show lang menu if language forced
688             return '';
689         }
691         $currlang = current_language();
692         $langs = get_string_manager()->get_list_of_translations();
694         if (count($langs) < 2) {
695             return '';
696         }
698         $s = new single_select($this->page->url, 'lang', $langs, $currlang, null);
699         $s->label = get_accesshide(get_string('language'));
700         $s->class = 'langmenu';
701         return $this->render($s);
702     }
704     /**
705      * Output the row of editing icons for a block, as defined by the controls array.
706      * @param array $controls an array like {@link block_contents::$controls}.
707      * @return HTML fragment.
708      */
709     public function block_controls($controls) {
710         if (empty($controls)) {
711             return '';
712         }
713         $controlshtml = array();
714         foreach ($controls as $control) {
715             $controlshtml[] = html_writer::tag('a',
716                     html_writer::empty_tag('img',  array('src' => $this->pix_url($control['icon'])->out(false), 'alt' => $control['caption'])),
717                     array('class' => 'icon','title' => $control['caption'], 'href' => $control['url']));
718         }
719         return html_writer::tag('div', implode('', $controlshtml), array('class' => 'commands'));
720     }
722     /**
723      * Prints a nice side block with an optional header.
724      *
725      * The content is described
726      * by a {@link block_contents} object.
727      *
728      * <div id="inst{$instanceid}" class="block_{$blockname} block">
729      *      <div class="header"></div>
730      *      <div class="content">
731      *          ...CONTENT...
732      *          <div class="footer">
733      *          </div>
734      *      </div>
735      *      <div class="annotation">
736      *      </div>
737      * </div>
738      *
739      * @param block_contents $bc HTML for the content
740      * @param string $region the region the block is appearing in.
741      * @return string the HTML to be output.
742      */
743     function block(block_contents $bc, $region) {
744         $bc = clone($bc); // Avoid messing up the object passed in.
745         if (empty($bc->blockinstanceid) || !strip_tags($bc->title)) {
746             $bc->collapsible = block_contents::NOT_HIDEABLE;
747         }
748         if ($bc->collapsible == block_contents::HIDDEN) {
749             $bc->add_class('hidden');
750         }
751         if (!empty($bc->controls)) {
752             $bc->add_class('block_with_controls');
753         }
755         $skiptitle = strip_tags($bc->title);
756         if (empty($skiptitle)) {
757             $output = '';
758             $skipdest = '';
759         } else {
760             $output = html_writer::tag('a', get_string('skipa', 'access', $skiptitle), array('href' => '#sb-' . $bc->skipid, 'class' => 'skip-block'));
761             $skipdest = html_writer::tag('span', '', array('id' => 'sb-' . $bc->skipid, 'class' => 'skip-block-to'));
762         }
764         $output .= html_writer::start_tag('div', $bc->attributes);
766         $output .= $this->block_header($bc);
767         $output .= $this->block_content($bc);
769         $output .= html_writer::end_tag('div');
771         $output .= $this->block_annotation($bc);
773         $output .= $skipdest;
775         $this->init_block_hider_js($bc);
776         return $output;
777     }
779     /**
780      * Produces a header for a block
781      *
782      * @param block_contents $bc
783      * @return string
784      */
785     protected function block_header(block_contents $bc) {
787         $title = '';
788         if ($bc->title) {
789             $title = html_writer::tag('h2', $bc->title, null);
790         }
792         $controlshtml = $this->block_controls($bc->controls);
794         $output = '';
795         if ($title || $controlshtml) {
796             $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'));
797         }
798         return $output;
799     }
801     /**
802      * Produces the content area for a block
803      *
804      * @param block_contents $bc
805      * @return string
806      */
807     protected function block_content(block_contents $bc) {
808         $output = html_writer::start_tag('div', array('class' => 'content'));
809         if (!$bc->title && !$this->block_controls($bc->controls)) {
810             $output .= html_writer::tag('div', '', array('class'=>'block_action notitle'));
811         }
812         $output .= $bc->content;
813         $output .= $this->block_footer($bc);
814         $output .= html_writer::end_tag('div');
816         return $output;
817     }
819     /**
820      * Produces the footer for a block
821      *
822      * @param block_contents $bc
823      * @return string
824      */
825     protected function block_footer(block_contents $bc) {
826         $output = '';
827         if ($bc->footer) {
828             $output .= html_writer::tag('div', $bc->footer, array('class' => 'footer'));
829         }
830         return $output;
831     }
833     /**
834      * Produces the annotation for a block
835      *
836      * @param block_contents $bc
837      * @return string
838      */
839     protected function block_annotation(block_contents $bc) {
840         $output = '';
841         if ($bc->annotation) {
842             $output .= html_writer::tag('div', $bc->annotation, array('class' => 'blockannotation'));
843         }
844         return $output;
845     }
847     /**
848      * Calls the JS require function to hide a block.
849      * @param block_contents $bc A block_contents object
850      * @return void
851      */
852     protected function init_block_hider_js(block_contents $bc) {
853         if (!empty($bc->attributes['id']) and $bc->collapsible != block_contents::NOT_HIDEABLE) {
854             $config = new stdClass;
855             $config->id = $bc->attributes['id'];
856             $config->title = strip_tags($bc->title);
857             $config->preference = 'block' . $bc->blockinstanceid . 'hidden';
858             $config->tooltipVisible = get_string('hideblocka', 'access', $config->title);
859             $config->tooltipHidden = get_string('showblocka', 'access', $config->title);
861             $this->page->requires->js_init_call('M.util.init_block_hider', array($config));
862             user_preference_allow_ajax_update($config->preference, PARAM_BOOL);
863         }
864     }
866     /**
867      * Render the contents of a block_list.
868      * @param array $icons the icon for each item.
869      * @param array $items the content of each item.
870      * @return string HTML
871      */
872     public function list_block_contents($icons, $items) {
873         $row = 0;
874         $lis = array();
875         foreach ($items as $key => $string) {
876             $item = html_writer::start_tag('li', array('class' => 'r' . $row));
877             if (!empty($icons[$key])) { //test if the content has an assigned icon
878                 $item .= html_writer::tag('div', $icons[$key], array('class' => 'icon column c0'));
879             }
880             $item .= html_writer::tag('div', $string, array('class' => 'column c1'));
881             $item .= html_writer::end_tag('li');
882             $lis[] = $item;
883             $row = 1 - $row; // Flip even/odd.
884         }
885         return html_writer::tag('ul', implode("\n", $lis), array('class' => 'list'));
886     }
888     /**
889      * Output all the blocks in a particular region.
890      * @param string $region the name of a region on this page.
891      * @return string the HTML to be output.
892      */
893     public function blocks_for_region($region) {
894         $blockcontents = $this->page->blocks->get_content_for_region($region, $this);
896         $output = '';
897         foreach ($blockcontents as $bc) {
898             if ($bc instanceof block_contents) {
899                 $output .= $this->block($bc, $region);
900             } else if ($bc instanceof block_move_target) {
901                 $output .= $this->block_move_target($bc);
902             } else {
903                 throw new coding_exception('Unexpected type of thing (' . get_class($bc) . ') found in list of block contents.');
904             }
905         }
906         return $output;
907     }
909     /**
910      * Output a place where the block that is currently being moved can be dropped.
911      * @param block_move_target $target with the necessary details.
912      * @return string the HTML to be output.
913      */
914     public function block_move_target($target) {
915         return html_writer::tag('a', html_writer::tag('span', $target->text, array('class' => 'accesshide')), array('href' => $target->url, 'class' => 'blockmovetarget'));
916     }
918     /**
919      * Renders a special html link with attached action
920      *
921      * @param string|moodle_url $url
922      * @param string $text HTML fragment
923      * @param component_action $action
924      * @param array $attributes associative array of html link attributes + disabled
925      * @return HTML fragment
926      */
927     public function action_link($url, $text, component_action $action = null, array $attributes=null) {
928         if (!($url instanceof moodle_url)) {
929             $url = new moodle_url($url);
930         }
931         $link = new action_link($url, $text, $action, $attributes);
933         return $this->render($link);
934     }
936     /**
937      * Implementation of action_link rendering
938      * @param action_link $link
939      * @return string HTML fragment
940      */
941     protected function render_action_link(action_link $link) {
942         global $CFG;
944         // A disabled link is rendered as formatted text
945         if (!empty($link->attributes['disabled'])) {
946             // do not use div here due to nesting restriction in xhtml strict
947             return html_writer::tag('span', $link->text, array('class'=>'currentlink'));
948         }
950         $attributes = $link->attributes;
951         unset($link->attributes['disabled']);
952         $attributes['href'] = $link->url;
954         if ($link->actions) {
955             if (empty($attributes['id'])) {
956                 $id = html_writer::random_id('action_link');
957                 $attributes['id'] = $id;
958             } else {
959                 $id = $attributes['id'];
960             }
961             foreach ($link->actions as $action) {
962                 $this->add_action_handler($action, $id);
963             }
964         }
966         return html_writer::tag('a', $link->text, $attributes);
967     }
970     /**
971      * Similar to action_link, image is used instead of the text
972      *
973      * @param string|moodle_url $url A string URL or moodel_url
974      * @param pix_icon $pixicon
975      * @param component_action $action
976      * @param array $attributes associative array of html link attributes + disabled
977      * @param bool $linktext show title next to image in link
978      * @return string HTML fragment
979      */
980     public function action_icon($url, pix_icon $pixicon, component_action $action = null, array $attributes = null, $linktext=false) {
981         if (!($url instanceof moodle_url)) {
982             $url = new moodle_url($url);
983         }
984         $attributes = (array)$attributes;
986         if (empty($attributes['class'])) {
987             // let ppl override the class via $options
988             $attributes['class'] = 'action-icon';
989         }
991         $icon = $this->render($pixicon);
993         if ($linktext) {
994             $text = $pixicon->attributes['alt'];
995         } else {
996             $text = '';
997         }
999         return $this->action_link($url, $text.$icon, $action, $attributes);
1000     }
1002    /**
1003     * Print a message along with button choices for Continue/Cancel
1004     *
1005     * If a string or moodle_url is given instead of a single_button, method defaults to post.
1006     *
1007     * @param string $message The question to ask the user
1008     * @param single_button|moodle_url|string $continue The single_button component representing the Continue answer. Can also be a moodle_url or string URL
1009     * @param single_button|moodle_url|string $cancel The single_button component representing the Cancel answer. Can also be a moodle_url or string URL
1010     * @return string HTML fragment
1011     */
1012     public function confirm($message, $continue, $cancel) {
1013         if ($continue instanceof single_button) {
1014             // ok
1015         } else if (is_string($continue)) {
1016             $continue = new single_button(new moodle_url($continue), get_string('continue'), 'post');
1017         } else if ($continue instanceof moodle_url) {
1018             $continue = new single_button($continue, get_string('continue'), 'post');
1019         } else {
1020             throw new coding_exception('The continue param to $OUTPUT->confirm() must be either a URL (string/moodle_url) or a single_button instance.');
1021         }
1023         if ($cancel instanceof single_button) {
1024             // ok
1025         } else if (is_string($cancel)) {
1026             $cancel = new single_button(new moodle_url($cancel), get_string('cancel'), 'get');
1027         } else if ($cancel instanceof moodle_url) {
1028             $cancel = new single_button($cancel, get_string('cancel'), 'get');
1029         } else {
1030             throw new coding_exception('The cancel param to $OUTPUT->confirm() must be either a URL (string/moodle_url) or a single_button instance.');
1031         }
1033         $output = $this->box_start('generalbox', 'notice');
1034         $output .= html_writer::tag('p', $message);
1035         $output .= html_writer::tag('div', $this->render($continue) . $this->render($cancel), array('class' => 'buttons'));
1036         $output .= $this->box_end();
1037         return $output;
1038     }
1040     /**
1041      * Returns a form with a single button.
1042      *
1043      * @param string|moodle_url $url
1044      * @param string $label button text
1045      * @param string $method get or post submit method
1046      * @param array $options associative array {disabled, title, etc.}
1047      * @return string HTML fragment
1048      */
1049     public function single_button($url, $label, $method='post', array $options=null) {
1050         if (!($url instanceof moodle_url)) {
1051             $url = new moodle_url($url);
1052         }
1053         $button = new single_button($url, $label, $method);
1055         foreach ((array)$options as $key=>$value) {
1056             if (array_key_exists($key, $button)) {
1057                 $button->$key = $value;
1058             }
1059         }
1061         return $this->render($button);
1062     }
1064     /**
1065      * Internal implementation of single_button rendering
1066      * @param single_button $button
1067      * @return string HTML fragment
1068      */
1069     protected function render_single_button(single_button $button) {
1070         $attributes = array('type'     => 'submit',
1071                             'value'    => $button->label,
1072                             'disabled' => $button->disabled ? 'disabled' : null,
1073                             'title'    => $button->tooltip);
1075         if ($button->actions) {
1076             $id = html_writer::random_id('single_button');
1077             $attributes['id'] = $id;
1078             foreach ($button->actions as $action) {
1079                 $this->add_action_handler($action, $id);
1080             }
1081         }
1083         // first the input element
1084         $output = html_writer::empty_tag('input', $attributes);
1086         // then hidden fields
1087         $params = $button->url->params();
1088         if ($button->method === 'post') {
1089             $params['sesskey'] = sesskey();
1090         }
1091         foreach ($params as $var => $val) {
1092             $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => $var, 'value' => $val));
1093         }
1095         // then div wrapper for xhtml strictness
1096         $output = html_writer::tag('div', $output);
1098         // now the form itself around it
1099         $url = $button->url->out_omit_querystring(); // url without params
1100         if ($url === '') {
1101             $url = '#'; // there has to be always some action
1102         }
1103         $attributes = array('method' => $button->method,
1104                             'action' => $url,
1105                             'id'     => $button->formid);
1106         $output = html_writer::tag('form', $output, $attributes);
1108         // and finally one more wrapper with class
1109         return html_writer::tag('div', $output, array('class' => $button->class));
1110     }
1112     /**
1113      * Returns a form with a single select widget.
1114      * @param moodle_url $url form action target, includes hidden fields
1115      * @param string $name name of selection field - the changing parameter in url
1116      * @param array $options list of options
1117      * @param string $selected selected element
1118      * @param array $nothing
1119      * @param string $formid
1120      * @return string HTML fragment
1121      */
1122     public function single_select($url, $name, array $options, $selected='', $nothing=array(''=>'choosedots'), $formid=null) {
1123         if (!($url instanceof moodle_url)) {
1124             $url = new moodle_url($url);
1125         }
1126         $select = new single_select($url, $name, $options, $selected, $nothing, $formid);
1128         return $this->render($select);
1129     }
1131     /**
1132      * Internal implementation of single_select rendering
1133      * @param single_select $select
1134      * @return string HTML fragment
1135      */
1136     protected function render_single_select(single_select $select) {
1137         $select = clone($select);
1138         if (empty($select->formid)) {
1139             $select->formid = html_writer::random_id('single_select_f');
1140         }
1142         $output = '';
1143         $params = $select->url->params();
1144         if ($select->method === 'post') {
1145             $params['sesskey'] = sesskey();
1146         }
1147         foreach ($params as $name=>$value) {
1148             $output .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>$name, 'value'=>$value));
1149         }
1151         if (empty($select->attributes['id'])) {
1152             $select->attributes['id'] = html_writer::random_id('single_select');
1153         }
1155         if ($select->disabled) {
1156             $select->attributes['disabled'] = 'disabled';
1157         }
1159         if ($select->tooltip) {
1160             $select->attributes['title'] = $select->tooltip;
1161         }
1163         if ($select->label) {
1164             $output .= html_writer::label($select->label, $select->attributes['id']);
1165         }
1167         if ($select->helpicon instanceof help_icon) {
1168             $output .= $this->render($select->helpicon);
1169         } else if ($select->helpicon instanceof old_help_icon) {
1170             $output .= $this->render($select->helpicon);
1171         }
1173         $output .= html_writer::select($select->options, $select->name, $select->selected, $select->nothing, $select->attributes);
1175         $go = html_writer::empty_tag('input', array('type'=>'submit', 'value'=>get_string('go')));
1176         $output .= html_writer::tag('noscript', $go, array('style'=>'inline'));
1178         $nothing = empty($select->nothing) ? false : key($select->nothing);
1179         $this->page->requires->js_init_call('M.util.init_select_autosubmit', array($select->formid, $select->attributes['id'], $nothing));
1181         // then div wrapper for xhtml strictness
1182         $output = html_writer::tag('div', $output);
1184         // now the form itself around it
1185         $formattributes = array('method' => $select->method,
1186                                 'action' => $select->url->out_omit_querystring(),
1187                                 'id'     => $select->formid);
1188         $output = html_writer::tag('form', $output, $formattributes);
1190         // and finally one more wrapper with class
1191         return html_writer::tag('div', $output, array('class' => $select->class));
1192     }
1194     /**
1195      * Returns a form with a url select widget.
1196      * @param array $urls list of urls - array('/course/view.php?id=1'=>'Frontpage', ....)
1197      * @param string $selected selected element
1198      * @param array $nothing
1199      * @param string $formid
1200      * @return string HTML fragment
1201      */
1202     public function url_select(array $urls, $selected, $nothing=array(''=>'choosedots'), $formid=null) {
1203         $select = new url_select($urls, $selected, $nothing, $formid);
1204         return $this->render($select);
1205     }
1207     /**
1208      * Internal implementation of url_select rendering
1209      * @param single_select $select
1210      * @return string HTML fragment
1211      */
1212     protected function render_url_select(url_select $select) {
1213         global $CFG;
1215         $select = clone($select);
1216         if (empty($select->formid)) {
1217             $select->formid = html_writer::random_id('url_select_f');
1218         }
1220         if (empty($select->attributes['id'])) {
1221             $select->attributes['id'] = html_writer::random_id('url_select');
1222         }
1224         if ($select->disabled) {
1225             $select->attributes['disabled'] = 'disabled';
1226         }
1228         if ($select->tooltip) {
1229             $select->attributes['title'] = $select->tooltip;
1230         }
1232         $output = '';
1234         if ($select->label) {
1235             $output .= html_writer::label($select->label, $select->attributes['id']);
1236         }
1238         if ($select->helpicon instanceof help_icon) {
1239             $output .= $this->render($select->helpicon);
1240         } else if ($select->helpicon instanceof old_help_icon) {
1241             $output .= $this->render($select->helpicon);
1242         }
1244         // For security reasons, the script course/jumpto.php requires URL starting with '/'. To keep
1245         // backward compatibility, we are removing heading $CFG->wwwroot from URLs here.
1246         $urls = array();
1247         foreach ($select->urls as $k=>$v) {
1248             if (is_array($v)) {
1249                 // optgroup structure
1250                 foreach ($v as $optgrouptitle => $optgroupoptions) {
1251                     foreach ($optgroupoptions as $optionurl => $optiontitle) {
1252                         if (empty($optionurl)) {
1253                             $safeoptionurl = '';
1254                         } else if (strpos($optionurl, $CFG->wwwroot.'/') === 0) {
1255                             // debugging('URLs passed to url_select should be in local relative form - please fix the code.', DEBUG_DEVELOPER);
1256                             $safeoptionurl = str_replace($CFG->wwwroot, '', $optionurl);
1257                         } else if (strpos($optionurl, '/') !== 0) {
1258                             debugging("Invalid url_select urls parameter inside optgroup: url '$optionurl' is not local relative url!");
1259                             continue;
1260                         } else {
1261                             $safeoptionurl = $optionurl;
1262                         }
1263                         $urls[$k][$optgrouptitle][$safeoptionurl] = $optiontitle;
1264                     }
1265                 }
1266             } else {
1267                 // plain list structure
1268                 if (empty($k)) {
1269                     // nothing selected option
1270                 } else if (strpos($k, $CFG->wwwroot.'/') === 0) {
1271                     $k = str_replace($CFG->wwwroot, '', $k);
1272                 } else if (strpos($k, '/') !== 0) {
1273                     debugging("Invalid url_select urls parameter: url '$k' is not local relative url!");
1274                     continue;
1275                 }
1276                 $urls[$k] = $v;
1277             }
1278         }
1279         $selected = $select->selected;
1280         if (!empty($selected)) {
1281             if (strpos($select->selected, $CFG->wwwroot.'/') === 0) {
1282                 $selected = str_replace($CFG->wwwroot, '', $selected);
1283             } else if (strpos($selected, '/') !== 0) {
1284                 debugging("Invalid value of parameter 'selected': url '$selected' is not local relative url!");
1285             }
1286         }
1288         $output .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'sesskey', 'value'=>sesskey()));
1289         $output .= html_writer::select($urls, 'jump', $selected, $select->nothing, $select->attributes);
1291         $go = html_writer::empty_tag('input', array('type'=>'submit', 'value'=>get_string('go')));
1292         $output .= html_writer::tag('noscript', $go, array('style'=>'inline'));
1294         $nothing = empty($select->nothing) ? false : key($select->nothing);
1295         $output .= $this->page->requires->js_init_call('M.util.init_url_select', array($select->formid, $select->attributes['id'], $nothing));
1297         // then div wrapper for xhtml strictness
1298         $output = html_writer::tag('div', $output);
1300         // now the form itself around it
1301         $formattributes = array('method' => 'post',
1302                                 'action' => new moodle_url('/course/jumpto.php'),
1303                                 'id'     => $select->formid);
1304         $output = html_writer::tag('form', $output, $formattributes);
1306         // and finally one more wrapper with class
1307         return html_writer::tag('div', $output, array('class' => $select->class));
1308     }
1310     /**
1311      * Returns a string containing a link to the user documentation.
1312      * Also contains an icon by default. Shown to teachers and admin only.
1313      * @param string $path The page link after doc root and language, no leading slash.
1314      * @param string $text The text to be displayed for the link
1315      * @return string
1316      */
1317     public function doc_link($path, $text = '') {
1318         global $CFG;
1320         $icon = $this->pix_icon('docs', $text, 'moodle', array('class'=>'iconhelp'));
1322         $url = new moodle_url(get_docs_url($path));
1324         $attributes = array('href'=>$url);
1325         if (!empty($CFG->doctonewwindow)) {
1326             $attributes['id'] = $this->add_action_handler(new popup_action('click', $url));
1327         }
1329         return html_writer::tag('a', $icon.$text, $attributes);
1330     }
1332     /**
1333      * Render icon
1334      * @param string $pix short pix name
1335      * @param string $alt mandatory alt attribute
1336      * @param string $component standard compoennt name like 'moodle', 'mod_forum', etc.
1337      * @param array $attributes htm lattributes
1338      * @return string HTML fragment
1339      */
1340     public function pix_icon($pix, $alt, $component='moodle', array $attributes = null) {
1341         $icon = new pix_icon($pix, $alt, $component, $attributes);
1342         return $this->render($icon);
1343     }
1345     /**
1346      * Render icon
1347      * @param pix_icon $icon
1348      * @return string HTML fragment
1349      */
1350     protected function render_pix_icon(pix_icon $icon) {
1351         $attributes = $icon->attributes;
1352         $attributes['src'] = $this->pix_url($icon->pix, $icon->component);
1353         return html_writer::empty_tag('img', $attributes);
1354     }
1356     /**
1357     * Produces the html that represents this rating in the UI
1358     * @param $page the page object on which this rating will appear
1359     */
1360     function render_rating(rating $rating) {
1361         global $CFG, $USER;
1362         static $havesetupjavascript = false;
1364         if( $rating->settings->aggregationmethod == RATING_AGGREGATE_NONE ){
1365             return null;//ratings are turned off
1366         }
1368         $useajax = !empty($CFG->enableajax);
1370         //include required Javascript
1371         if( !$havesetupjavascript && $useajax ) {
1372             $this->page->requires->js_init_call('M.core_rating.init');
1373             $havesetupjavascript = true;
1374         }
1376         //check the item we're rating was created in the assessable time window
1377         $inassessablewindow = true;
1378         if ( $rating->settings->assesstimestart && $rating->settings->assesstimefinish ) {
1379             if ($rating->itemtimecreated < $rating->settings->assesstimestart || $rating->itemtimecreated > $rating->settings->assesstimefinish) {
1380                 $inassessablewindow = false;
1381             }
1382         }
1384         $strrate = get_string("rate", "rating");
1385         $ratinghtml = ''; //the string we'll return
1387         //permissions check - can they view the aggregate?
1388         $canviewaggregate = false;
1390         //if its the current user's item and they have permission to view the aggregate on their own items
1391         if ( $rating->itemuserid==$USER->id && $rating->settings->permissions->view && $rating->settings->pluginpermissions->view) {
1392             $canviewaggregate = true;
1393         }
1395         //if the item doesnt belong to anyone or its another user's items and they can see the aggregate on items they don't own
1396         //Note that viewany doesnt mean you can see the aggregate or ratings of your own items
1397         if ( (empty($rating->itemuserid) or $rating->itemuserid!=$USER->id) && $rating->settings->permissions->viewany && $rating->settings->pluginpermissions->viewany ) {
1398             $canviewaggregate = true;
1399         }
1401         if ($canviewaggregate==true) {
1402             $aggregatelabel = '';
1403             switch ($rating->settings->aggregationmethod) {
1404                 case RATING_AGGREGATE_AVERAGE :
1405                     $aggregatelabel .= get_string("aggregateavg", "rating");
1406                     break;
1407                 case RATING_AGGREGATE_COUNT :
1408                     $aggregatelabel .= get_string("aggregatecount", "rating");
1409                     break;
1410                 case RATING_AGGREGATE_MAXIMUM :
1411                     $aggregatelabel .= get_string("aggregatemax", "rating");
1412                     break;
1413                 case RATING_AGGREGATE_MINIMUM :
1414                     $aggregatelabel .= get_string("aggregatemin", "rating");
1415                     break;
1416                 case RATING_AGGREGATE_SUM :
1417                     $aggregatelabel .= get_string("aggregatesum", "rating");
1418                     break;
1419             }
1420             $aggregatelabel .= get_string('labelsep', 'langconfig');
1422             //$scalemax = 0;//no longer displaying scale max
1423             $aggregatestr = '';
1425             //only display aggregate if aggregation method isn't COUNT
1426             if ($rating->aggregate && $rating->settings->aggregationmethod!= RATING_AGGREGATE_COUNT) {
1427                 if ($rating->settings->aggregationmethod!= RATING_AGGREGATE_SUM && is_array($rating->settings->scale->scaleitems)) {
1428                     $aggregatestr .= $rating->settings->scale->scaleitems[round($rating->aggregate)];//round aggregate as we're using it as an index
1429                 }
1430                 else { //aggregation is SUM or the scale is numeric
1431                     $aggregatestr .= round($rating->aggregate,1);
1432                 }
1433             } else {
1434                 $aggregatestr = ' - ';
1435             }
1437             $countstr = html_writer::start_tag('span', array('id'=>"ratingcount{$rating->itemid}"));
1438             if ($rating->count>0) {
1439                 $countstr .= "({$rating->count})";
1440             }
1441             $countstr .= html_writer::end_tag('span');
1443             //$aggregatehtml = "{$ratingstr} / $scalemax ({$rating->count}) ";
1444             $aggregatehtml = "<span id='ratingaggregate{$rating->itemid}'>{$aggregatestr}</span> $countstr ";
1446             $ratinghtml .= html_writer::tag('span', $aggregatelabel, array('class'=>'rating-aggregate-label'));
1447             if ($rating->settings->permissions->viewall && $rating->settings->pluginpermissions->viewall) {
1448                 $url = "/rating/index.php?contextid={$rating->context->id}&itemid={$rating->itemid}&scaleid={$rating->settings->scale->id}";
1449                 $nonpopuplink = new moodle_url($url);
1450                 $popuplink = new moodle_url("$url&popup=1");
1452                 $action = new popup_action('click', $popuplink, 'ratings', array('height' => 400, 'width' => 600));
1453                 $ratinghtml .= $this->action_link($nonpopuplink, $aggregatehtml, $action);
1454             } else {
1455                 $ratinghtml .= $aggregatehtml;
1456             }
1457         }
1459         $formstart = null;
1460         //if the item doesn't belong to the current user, the user has permission to rate
1461         //and we're within the assessable period
1462         if ($rating->itemuserid!=$USER->id
1463             && $rating->settings->permissions->rate
1464             && $rating->settings->pluginpermissions->rate
1465             && $inassessablewindow) {
1467             //start the rating form
1468             $formstart = html_writer::start_tag('form',
1469                 array('id'=>"postrating{$rating->itemid}", 'class'=>'postratingform', 'method'=>'post', 'action'=>"{$CFG->wwwroot}/rating/rate.php"));
1471             $formstart .= html_writer::start_tag('div', array('class'=>'ratingform'));
1473             //add the hidden inputs
1475             $attributes = array('type'=>'hidden', 'class'=>'ratinginput', 'name'=>'contextid', 'value'=>$rating->context->id);
1476             $formstart .= html_writer::empty_tag('input', $attributes);
1478             $attributes['name'] = 'itemid';
1479             $attributes['value'] = $rating->itemid;
1480             $formstart .= html_writer::empty_tag('input', $attributes);
1482             $attributes['name'] = 'scaleid';
1483             $attributes['value'] = $rating->settings->scale->id;
1484             $formstart .= html_writer::empty_tag('input', $attributes);
1486             $attributes['name'] = 'returnurl';
1487             $attributes['value'] = $rating->settings->returnurl;
1488             $formstart .= html_writer::empty_tag('input', $attributes);
1490             $attributes['name'] = 'rateduserid';
1491             $attributes['value'] = $rating->itemuserid;
1492             $formstart .= html_writer::empty_tag('input', $attributes);
1494             $attributes['name'] = 'aggregation';
1495             $attributes['value'] = $rating->settings->aggregationmethod;
1496             $formstart .= html_writer::empty_tag('input', $attributes);
1498             $attributes['name'] = 'sesskey';
1499             $attributes['value'] = sesskey();;
1500             $formstart .= html_writer::empty_tag('input', $attributes);
1502             if (empty($ratinghtml)) {
1503                 $ratinghtml .= $strrate.': ';
1504             }
1506             $ratinghtml = $formstart.$ratinghtml;
1508             //generate an array of values for numeric scales
1509             $scalearray = $rating->settings->scale->scaleitems;
1510             if (!is_array($scalearray)) { //almost certainly a numerical scale
1511                 $intscalearray = intval($scalearray);//just in case they've passed "5" instead of 5
1512                 $scalearray = array();
1513                 if( is_int($intscalearray) && $intscalearray>0 ) {
1514                     for($i=0; $i<=$rating->settings->scale->scaleitems; $i++) {
1515                         $scalearray[$i] = $i;
1516                     }
1517                 }
1518             }
1520             $scalearray = array(RATING_UNSET_RATING => $strrate.'...') + $scalearray;
1521             $ratinghtml .= html_writer::select($scalearray, 'rating', $rating->rating, false, array('class'=>'postratingmenu ratinginput','id'=>'menurating'.$rating->itemid));
1523             //output submit button
1525             $ratinghtml .= html_writer::start_tag('span', array('class'=>"ratingsubmit"));
1527             $attributes = array('type'=>'submit', 'class'=>'postratingmenusubmit', 'id'=>'postratingsubmit'.$rating->itemid, 'value'=>s(get_string('rate', 'rating')));
1528             $ratinghtml .= html_writer::empty_tag('input', $attributes);
1530             if (is_array($rating->settings->scale->scaleitems)) {
1531                 $ratinghtml .= $this->help_icon_scale($rating->settings->scale->courseid, $rating->settings->scale);
1532             }
1533             $ratinghtml .= html_writer::end_tag('span');
1534             $ratinghtml .= html_writer::end_tag('div');
1535             $ratinghtml .= html_writer::end_tag('form');
1536         }
1538         return $ratinghtml;
1539     }
1541     /*
1542      * Centered heading with attached help button (same title text)
1543      * and optional icon attached
1544      * @param string $text A heading text
1545      * @param string $helpidentifier The keyword that defines a help page
1546      * @param string $component component name
1547      * @param string|moodle_url $icon
1548      * @param string $iconalt icon alt text
1549      * @return string HTML fragment
1550      */
1551     public function heading_with_help($text, $helpidentifier, $component='moodle', $icon='', $iconalt='') {
1552         $image = '';
1553         if ($icon) {
1554             $image = $this->pix_icon($icon, $iconalt, $component, array('class'=>'icon'));
1555         }
1557         $help = '';
1558         if ($helpidentifier) {
1559             $help = $this->help_icon($helpidentifier, $component);
1560         }
1562         return $this->heading($image.$text.$help, 2, 'main help');
1563     }
1565     /**
1566      * Print a help icon.
1567      *
1568      * @deprecated since Moodle 2.0
1569      * @param string $page The keyword that defines a help page
1570      * @param string $title A descriptive text for accessibility only
1571      * @param string $component component name
1572      * @param string|bool $linktext true means use $title as link text, string means link text value
1573      * @return string HTML fragment
1574      */
1575     public function old_help_icon($helpidentifier, $title, $component = 'moodle', $linktext = '') {
1576         debugging('The method old_help_icon() is deprecated, please fix the code and use help_icon() method instead', DEBUG_DEVELOPER);
1577         $icon = new old_help_icon($helpidentifier, $title, $component);
1578         if ($linktext === true) {
1579             $icon->linktext = $title;
1580         } else if (!empty($linktext)) {
1581             $icon->linktext = $linktext;
1582         }
1583         return $this->render($icon);
1584     }
1586     /**
1587      * Implementation of user image rendering.
1588      * @param help_icon $helpicon
1589      * @return string HTML fragment
1590      */
1591     protected function render_old_help_icon(old_help_icon $helpicon) {
1592         global $CFG;
1594         // first get the help image icon
1595         $src = $this->pix_url('help');
1597         if (empty($helpicon->linktext)) {
1598             $alt = $helpicon->title;
1599         } else {
1600             $alt = get_string('helpwiththis');
1601         }
1603         $attributes = array('src'=>$src, 'alt'=>$alt, 'class'=>'iconhelp');
1604         $output = html_writer::empty_tag('img', $attributes);
1606         // add the link text if given
1607         if (!empty($helpicon->linktext)) {
1608             // the spacing has to be done through CSS
1609             $output .= $helpicon->linktext;
1610         }
1612         // now create the link around it
1613         $url = new moodle_url('/help.php', array('component' => $helpicon->component, 'identifier' => $helpicon->helpidentifier, 'lang'=>current_language()));
1615         // note: this title is displayed only if JS is disabled, otherwise the link will have the new ajax tooltip
1616         $title = get_string('helpprefix2', '', trim($helpicon->title, ". \t"));
1618         $attributes = array('href'=>$url, 'title'=>$title);
1619         $id = html_writer::random_id('helpicon');
1620         $attributes['id'] = $id;
1621         $output = html_writer::tag('a', $output, $attributes);
1623         $this->page->requires->js_init_call('M.util.help_icon.add', array(array('id'=>$id, 'url'=>$url->out(false))));
1625         // and finally span
1626         return html_writer::tag('span', $output, array('class' => 'helplink'));
1627     }
1629     /**
1630      * Print a help icon.
1631      *
1632      * @param string $identifier The keyword that defines a help page
1633      * @param string $component component name
1634      * @param string|bool $linktext true means use $title as link text, string means link text value
1635      * @return string HTML fragment
1636      */
1637     public function help_icon($identifier, $component = 'moodle', $linktext = '') {
1638         $icon = new help_icon($identifier, $component);
1639         $icon->diag_strings();
1640         if ($linktext === true) {
1641             $icon->linktext = get_string($icon->identifier, $icon->component);
1642         } else if (!empty($linktext)) {
1643             $icon->linktext = $linktext;
1644         }
1645         return $this->render($icon);
1646     }
1648     /**
1649      * Implementation of user image rendering.
1650      * @param help_icon $helpicon
1651      * @return string HTML fragment
1652      */
1653     protected function render_help_icon(help_icon $helpicon) {
1654         global $CFG;
1656         // first get the help image icon
1657         $src = $this->pix_url('help');
1659         $title = get_string($helpicon->identifier, $helpicon->component);
1661         if (empty($helpicon->linktext)) {
1662             $alt = $title;
1663         } else {
1664             $alt = get_string('helpwiththis');
1665         }
1667         $attributes = array('src'=>$src, 'alt'=>$alt, 'class'=>'iconhelp');
1668         $output = html_writer::empty_tag('img', $attributes);
1670         // add the link text if given
1671         if (!empty($helpicon->linktext)) {
1672             // the spacing has to be done through CSS
1673             $output .= $helpicon->linktext;
1674         }
1676         // now create the link around it
1677         $url = new moodle_url('/help.php', array('component' => $helpicon->component, 'identifier' => $helpicon->identifier, 'lang'=>current_language()));
1679         // note: this title is displayed only if JS is disabled, otherwise the link will have the new ajax tooltip
1680         $title = get_string('helpprefix2', '', trim($title, ". \t"));
1682         $attributes = array('href'=>$url, 'title'=>$title);
1683         $id = html_writer::random_id('helpicon');
1684         $attributes['id'] = $id;
1685         $output = html_writer::tag('a', $output, $attributes);
1687         $this->page->requires->js_init_call('M.util.help_icon.add', array(array('id'=>$id, 'url'=>$url->out(false))));
1689         // and finally span
1690         return html_writer::tag('span', $output, array('class' => 'helplink'));
1691     }
1693     /**
1694      * Print scale help icon.
1695      *
1696      * @param int $courseid
1697      * @param object $scale instance
1698      * @return string  HTML fragment
1699      */
1700     public function help_icon_scale($courseid, stdClass $scale) {
1701         global $CFG;
1703         $title = get_string('helpprefix2', '', $scale->name) .' ('.get_string('newwindow').')';
1705         $icon = $this->pix_icon('help', get_string('scales'), 'moodle', array('class'=>'iconhelp'));
1707         $link = new moodle_url('/course/scales.php', array('id' => $courseid, 'list' => true, 'scaleid' => $scale->id));
1708         $action = new popup_action('click', $link, 'ratingscale');
1710         return html_writer::tag('span', $this->action_link($link, $icon, $action), array('class' => 'helplink'));
1711     }
1713     /**
1714      * Creates and returns a spacer image with optional line break.
1715      *
1716      * @param array $attributes
1717      * @param boo spacer
1718      * @return string HTML fragment
1719      */
1720     public function spacer(array $attributes = null, $br = false) {
1721         $attributes = (array)$attributes;
1722         if (empty($attributes['width'])) {
1723             $attributes['width'] = 1;
1724         }
1725         if (empty($attributes['height'])) {
1726             $attributes['height'] = 1;
1727         }
1728         $attributes['class'] = 'spacer';
1730         $output = $this->pix_icon('spacer', '', 'moodle', $attributes);
1732         if (!empty($br)) {
1733             $output .= '<br />';
1734         }
1736         return $output;
1737     }
1739     /**
1740      * Print the specified user's avatar.
1741      *
1742      * User avatar may be obtained in two ways:
1743      * <pre>
1744      * // Option 1: (shortcut for simple cases, preferred way)
1745      * // $user has come from the DB and has fields id, picture, imagealt, firstname and lastname
1746      * $OUTPUT->user_picture($user, array('popup'=>true));
1747      *
1748      * // Option 2:
1749      * $userpic = new user_picture($user);
1750      * // Set properties of $userpic
1751      * $userpic->popup = true;
1752      * $OUTPUT->render($userpic);
1753      * </pre>
1754      *
1755      * @param object Object with at least fields id, picture, imagealt, firstname, lastname
1756      *     If any of these are missing, the database is queried. Avoid this
1757      *     if at all possible, particularly for reports. It is very bad for performance.
1758      * @param array $options associative array with user picture options, used only if not a user_picture object,
1759      *     options are:
1760      *     - courseid=$this->page->course->id (course id of user profile in link)
1761      *     - size=35 (size of image)
1762      *     - link=true (make image clickable - the link leads to user profile)
1763      *     - popup=false (open in popup)
1764      *     - alttext=true (add image alt attribute)
1765      *     - class = image class attribute (default 'userpicture')
1766      * @return string HTML fragment
1767      */
1768     public function user_picture(stdClass $user, array $options = null) {
1769         $userpicture = new user_picture($user);
1770         foreach ((array)$options as $key=>$value) {
1771             if (array_key_exists($key, $userpicture)) {
1772                 $userpicture->$key = $value;
1773             }
1774         }
1775         return $this->render($userpicture);
1776     }
1778     /**
1779      * Internal implementation of user image rendering.
1780      * @param user_picture $userpicture
1781      * @return string
1782      */
1783     protected function render_user_picture(user_picture $userpicture) {
1784         global $CFG, $DB;
1786         $user = $userpicture->user;
1788         if ($userpicture->alttext) {
1789             if (!empty($user->imagealt)) {
1790                 $alt = $user->imagealt;
1791             } else {
1792                 $alt = get_string('pictureof', '', fullname($user));
1793             }
1794         } else {
1795             $alt = '';
1796         }
1798         if (empty($userpicture->size)) {
1799             $file = 'f2';
1800             $size = 35;
1801         } else if ($userpicture->size === true or $userpicture->size == 1) {
1802             $file = 'f1';
1803             $size = 100;
1804         } else if ($userpicture->size >= 50) {
1805             $file = 'f1';
1806             $size = $userpicture->size;
1807         } else {
1808             $file = 'f2';
1809             $size = $userpicture->size;
1810         }
1812         $class = $userpicture->class;
1814         if ($user->picture == 1) {
1815             $usercontext = get_context_instance(CONTEXT_USER, $user->id);
1816             $src = moodle_url::make_pluginfile_url($usercontext->id, 'user', 'icon', NULL, '/', $file);
1818         } else if ($user->picture == 2) {
1819             //TODO: gravatar user icon support
1821         } else { // Print default user pictures (use theme version if available)
1822             $class .= ' defaultuserpic';
1823             $src = $this->pix_url('u/' . $file);
1824         }
1826         $attributes = array('src'=>$src, 'alt'=>$alt, 'title'=>$alt, 'class'=>$class, 'width'=>$size, 'height'=>$size);
1828         // get the image html output fisrt
1829         $output = html_writer::empty_tag('img', $attributes);;
1831         // then wrap it in link if needed
1832         if (!$userpicture->link) {
1833             return $output;
1834         }
1836         if (empty($userpicture->courseid)) {
1837             $courseid = $this->page->course->id;
1838         } else {
1839             $courseid = $userpicture->courseid;
1840         }
1842         if ($courseid == SITEID) {
1843             $url = new moodle_url('/user/profile.php', array('id' => $user->id));
1844         } else {
1845             $url = new moodle_url('/user/view.php', array('id' => $user->id, 'course' => $courseid));
1846         }
1848         $attributes = array('href'=>$url);
1850         if ($userpicture->popup) {
1851             $id = html_writer::random_id('userpicture');
1852             $attributes['id'] = $id;
1853             $this->add_action_handler(new popup_action('click', $url), $id);
1854         }
1856         return html_writer::tag('a', $output, $attributes);
1857     }
1859     /**
1860      * Internal implementation of file tree viewer items rendering.
1861      * @param array $dir
1862      * @return string
1863      */
1864     public function htmllize_file_tree($dir) {
1865         if (empty($dir['subdirs']) and empty($dir['files'])) {
1866             return '';
1867         }
1868         $result = '<ul>';
1869         foreach ($dir['subdirs'] as $subdir) {
1870             $result .= '<li>'.s($subdir['dirname']).' '.$this->htmllize_file_tree($subdir).'</li>';
1871         }
1872         foreach ($dir['files'] as $file) {
1873             $filename = $file->get_filename();
1874             $result .= '<li><span>'.html_writer::link($file->fileurl, $filename).'</span></li>';
1875         }
1876         $result .= '</ul>';
1878         return $result;
1879     }
1880     /**
1881      * Print the file picker
1882      *
1883      * <pre>
1884      * $OUTPUT->file_picker($options);
1885      * </pre>
1886      *
1887      * @param array $options associative array with file manager options
1888      *   options are:
1889      *       maxbytes=>-1,
1890      *       itemid=>0,
1891      *       client_id=>uniqid(),
1892      *       acepted_types=>'*',
1893      *       return_types=>FILE_INTERNAL,
1894      *       context=>$PAGE->context
1895      * @return string HTML fragment
1896      */
1897     public function file_picker($options) {
1898         $fp = new file_picker($options);
1899         return $this->render($fp);
1900     }
1901     /**
1902      * Internal implementation of file picker rendering.
1903      * @param file_picker $fp
1904      * @return string
1905      */
1906     public function render_file_picker(file_picker $fp) {
1907         global $CFG, $OUTPUT, $USER;
1908         $options = $fp->options;
1909         $client_id = $options->client_id;
1910         $strsaved = get_string('filesaved', 'repository');
1911         $straddfile = get_string('openpicker', 'repository');
1912         $strloading  = get_string('loading', 'repository');
1913         $icon_progress = $OUTPUT->pix_icon('i/loading_small', $strloading).'';
1915         $currentfile = $options->currentfile;
1916         if (empty($currentfile)) {
1917             $currentfile = get_string('nofilesattached', 'repository');
1918         }
1919         if ($options->maxbytes) {
1920             $size = $options->maxbytes;
1921         } else {
1922             $size = get_max_upload_file_size();
1923         }
1924         if ($size == -1) {
1925             $maxsize = '';
1926         } else {
1927             $maxsize = get_string('maxfilesize', 'moodle', display_size($size));
1928         }
1929         $html = <<<EOD
1930 <div class="filemanager-loading mdl-align" id='filepicker-loading-{$client_id}'>
1931 $icon_progress
1932 </div>
1933 <div id="filepicker-wrapper-{$client_id}" class="mdl-left" style="display:none">
1934     <div>
1935         <input type="button" id="filepicker-button-{$client_id}" value="{$straddfile}" />
1936         <span> $maxsize </span>
1937     </div>
1938 EOD;
1939         if ($options->env != 'url') {
1940             $html .= <<<EOD
1941     <div id="file_info_{$client_id}" class="mdl-left filepicker-filelist">$currentfile</div>
1942 EOD;
1943         }
1944         $html .= '</div>';
1945         return $html;
1946     }
1948     /**
1949      * Prints the 'Update this Modulename' button that appears on module pages.
1950      *
1951      * @param string $cmid the course_module id.
1952      * @param string $modulename the module name, eg. "forum", "quiz" or "workshop"
1953      * @return string the HTML for the button, if this user has permission to edit it, else an empty string.
1954      */
1955     public function update_module_button($cmid, $modulename) {
1956         global $CFG;
1957         if (has_capability('moodle/course:manageactivities', get_context_instance(CONTEXT_MODULE, $cmid))) {
1958             $modulename = get_string('modulename', $modulename);
1959             $string = get_string('updatethis', '', $modulename);
1960             $url = new moodle_url("$CFG->wwwroot/course/mod.php", array('update' => $cmid, 'return' => true, 'sesskey' => sesskey()));
1961             return $this->single_button($url, $string);
1962         } else {
1963             return '';
1964         }
1965     }
1967     /**
1968      * Prints a "Turn editing on/off" button in a form.
1969      * @param moodle_url $url The URL + params to send through when clicking the button
1970      * @return string HTML the button
1971      */
1972     public function edit_button(moodle_url $url) {
1974         $url->param('sesskey', sesskey());
1975         if ($this->page->user_is_editing()) {
1976             $url->param('edit', 'off');
1977             $editstring = get_string('turneditingoff');
1978         } else {
1979             $url->param('edit', 'on');
1980             $editstring = get_string('turneditingon');
1981         }
1983         return $this->single_button($url, $editstring);
1984     }
1986     /**
1987      * Prints a simple button to close a window
1988      *
1989      * @param string $text The lang string for the button's label (already output from get_string())
1990      * @return string html fragment
1991      */
1992     public function close_window_button($text='') {
1993         if (empty($text)) {
1994             $text = get_string('closewindow');
1995         }
1996         $button = new single_button(new moodle_url('#'), $text, 'get');
1997         $button->add_action(new component_action('click', 'close_window'));
1999         return $this->container($this->render($button), 'closewindow');
2000     }
2002     /**
2003      * Output an error message. By default wraps the error message in <span class="error">.
2004      * If the error message is blank, nothing is output.
2005      * @param string $message the error message.
2006      * @return string the HTML to output.
2007      */
2008     public function error_text($message) {
2009         if (empty($message)) {
2010             return '';
2011         }
2012         return html_writer::tag('span', $message, array('class' => 'error'));
2013     }
2015     /**
2016      * Do not call this function directly.
2017      *
2018      * To terminate the current script with a fatal error, call the {@link print_error}
2019      * function, or throw an exception. Doing either of those things will then call this
2020      * function to display the error, before terminating the execution.
2021      *
2022      * @param string $message The message to output
2023      * @param string $moreinfourl URL where more info can be found about the error
2024      * @param string $link Link for the Continue button
2025      * @param array $backtrace The execution backtrace
2026      * @param string $debuginfo Debugging information
2027      * @return string the HTML to output.
2028      */
2029     public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
2031         $output = '';
2032         $obbuffer = '';
2034         if ($this->has_started()) {
2035             // we can not always recover properly here, we have problems with output buffering,
2036             // html tables, etc.
2037             $output .= $this->opencontainers->pop_all_but_last();
2039         } else {
2040             // It is really bad if library code throws exception when output buffering is on,
2041             // because the buffered text would be printed before our start of page.
2042             // NOTE: this hack might be behave unexpectedly in case output buffering is enabled in PHP.ini
2043             while (ob_get_level() > 0) {
2044                 $obbuffer .= ob_get_clean();
2045             }
2047             // Header not yet printed
2048             if (isset($_SERVER['SERVER_PROTOCOL'])) {
2049                 // server protocol should be always present, because this render
2050                 // can not be used from command line or when outputting custom XML
2051                 @header($_SERVER['SERVER_PROTOCOL'] . ' 404 Not Found');
2052             }
2053             $this->page->set_context(null); // ugly hack - make sure page context is set to something, we do not want bogus warnings here
2054             $this->page->set_url('/'); // no url
2055             //$this->page->set_pagelayout('base'); //TODO: MDL-20676 blocks on error pages are weird, unfortunately it somehow detect the pagelayout from URL :-(
2056             $this->page->set_title(get_string('error'));
2057             $this->page->set_heading($this->page->course->fullname);
2058             $output .= $this->header();
2059         }
2061         $message = '<p class="errormessage">' . $message . '</p>'.
2062                 '<p class="errorcode"><a href="' . $moreinfourl . '">' .
2063                 get_string('moreinformation') . '</a></p>';
2064         $output .= $this->box($message, 'errorbox');
2066         if (debugging('', DEBUG_DEVELOPER)) {
2067             if (!empty($debuginfo)) {
2068                 $debuginfo = s($debuginfo); // removes all nasty JS
2069                 $debuginfo = str_replace("\n", '<br />', $debuginfo); // keep newlines
2070                 $output .= $this->notification('<strong>Debug info:</strong> '.$debuginfo, 'notifytiny');
2071             }
2072             if (!empty($backtrace)) {
2073                 $output .= $this->notification('<strong>Stack trace:</strong> '.format_backtrace($backtrace), 'notifytiny');
2074             }
2075             if ($obbuffer !== '' ) {
2076                 $output .= $this->notification('<strong>Output buffer:</strong> '.s($obbuffer), 'notifytiny');
2077             }
2078         }
2080         if (!empty($link)) {
2081             $output .= $this->continue_button($link);
2082         }
2084         $output .= $this->footer();
2086         // Padding to encourage IE to display our error page, rather than its own.
2087         $output .= str_repeat(' ', 512);
2089         return $output;
2090     }
2092     /**
2093      * Output a notification (that is, a status message about something that has
2094      * just happened).
2095      *
2096      * @param string $message the message to print out
2097      * @param string $classes normally 'notifyproblem' or 'notifysuccess'.
2098      * @return string the HTML to output.
2099      */
2100     public function notification($message, $classes = 'notifyproblem') {
2101         return html_writer::tag('div', clean_text($message), array('class' => renderer_base::prepare_classes($classes)));
2102     }
2104     /**
2105      * Print a continue button that goes to a particular URL.
2106      *
2107      * @param string|moodle_url $url The url the button goes to.
2108      * @return string the HTML to output.
2109      */
2110     public function continue_button($url) {
2111         if (!($url instanceof moodle_url)) {
2112             $url = new moodle_url($url);
2113         }
2114         $button = new single_button($url, get_string('continue'), 'get');
2115         $button->class = 'continuebutton';
2117         return $this->render($button);
2118     }
2120     /**
2121      * Prints a single paging bar to provide access to other pages  (usually in a search)
2122      *
2123      * @param int $totalcount The total number of entries available to be paged through
2124      * @param int $page The page you are currently viewing
2125      * @param int $perpage The number of entries that should be shown per page
2126      * @param string|moodle_url $baseurl url of the current page, the $pagevar parameter is added
2127      * @param string $pagevar name of page parameter that holds the page number
2128      * @return string the HTML to output.
2129      */
2130     public function paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar = 'page') {
2131         $pb = new paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar);
2132         return $this->render($pb);
2133     }
2135     /**
2136      * Internal implementation of paging bar rendering.
2137      * @param paging_bar $pagingbar
2138      * @return string
2139      */
2140     protected function render_paging_bar(paging_bar $pagingbar) {
2141         $output = '';
2142         $pagingbar = clone($pagingbar);
2143         $pagingbar->prepare($this, $this->page, $this->target);
2145         if ($pagingbar->totalcount > $pagingbar->perpage) {
2146             $output .= get_string('page') . ':';
2148             if (!empty($pagingbar->previouslink)) {
2149                 $output .= '&#160;(' . $pagingbar->previouslink . ')&#160;';
2150             }
2152             if (!empty($pagingbar->firstlink)) {
2153                 $output .= '&#160;' . $pagingbar->firstlink . '&#160;...';
2154             }
2156             foreach ($pagingbar->pagelinks as $link) {
2157                 $output .= "&#160;&#160;$link";
2158             }
2160             if (!empty($pagingbar->lastlink)) {
2161                 $output .= '&#160;...' . $pagingbar->lastlink . '&#160;';
2162             }
2164             if (!empty($pagingbar->nextlink)) {
2165                 $output .= '&#160;&#160;(' . $pagingbar->nextlink . ')';
2166             }
2167         }
2169         return html_writer::tag('div', $output, array('class' => 'paging'));
2170     }
2172     /**
2173      * Output the place a skip link goes to.
2174      * @param string $id The target name from the corresponding $PAGE->requires->skip_link_to($target) call.
2175      * @return string the HTML to output.
2176      */
2177     public function skip_link_target($id = null) {
2178         return html_writer::tag('span', '', array('id' => $id));
2179     }
2181     /**
2182      * Outputs a heading
2183      * @param string $text The text of the heading
2184      * @param int $level The level of importance of the heading. Defaulting to 2
2185      * @param string $classes A space-separated list of CSS classes
2186      * @param string $id An optional ID
2187      * @return string the HTML to output.
2188      */
2189     public function heading($text, $level = 2, $classes = 'main', $id = null) {
2190         $level = (integer) $level;
2191         if ($level < 1 or $level > 6) {
2192             throw new coding_exception('Heading level must be an integer between 1 and 6.');
2193         }
2194         return html_writer::tag('h' . $level, $text, array('id' => $id, 'class' => renderer_base::prepare_classes($classes)));
2195     }
2197     /**
2198      * Outputs a box.
2199      * @param string $contents The contents of the box
2200      * @param string $classes A space-separated list of CSS classes
2201      * @param string $id An optional ID
2202      * @return string the HTML to output.
2203      */
2204     public function box($contents, $classes = 'generalbox', $id = null) {
2205         return $this->box_start($classes, $id) . $contents . $this->box_end();
2206     }
2208     /**
2209      * Outputs the opening section of a box.
2210      * @param string $classes A space-separated list of CSS classes
2211      * @param string $id An optional ID
2212      * @return string the HTML to output.
2213      */
2214     public function box_start($classes = 'generalbox', $id = null) {
2215         $this->opencontainers->push('box', html_writer::end_tag('div'));
2216         return html_writer::start_tag('div', array('id' => $id,
2217                 'class' => 'box ' . renderer_base::prepare_classes($classes)));
2218     }
2220     /**
2221      * Outputs the closing section of a box.
2222      * @return string the HTML to output.
2223      */
2224     public function box_end() {
2225         return $this->opencontainers->pop('box');
2226     }
2228     /**
2229      * Outputs a container.
2230      * @param string $contents The contents of the box
2231      * @param string $classes A space-separated list of CSS classes
2232      * @param string $id An optional ID
2233      * @return string the HTML to output.
2234      */
2235     public function container($contents, $classes = null, $id = null) {
2236         return $this->container_start($classes, $id) . $contents . $this->container_end();
2237     }
2239     /**
2240      * Outputs the opening section of a container.
2241      * @param string $classes A space-separated list of CSS classes
2242      * @param string $id An optional ID
2243      * @return string the HTML to output.
2244      */
2245     public function container_start($classes = null, $id = null) {
2246         $this->opencontainers->push('container', html_writer::end_tag('div'));
2247         return html_writer::start_tag('div', array('id' => $id,
2248                 'class' => renderer_base::prepare_classes($classes)));
2249     }
2251     /**
2252      * Outputs the closing section of a container.
2253      * @return string the HTML to output.
2254      */
2255     public function container_end() {
2256         return $this->opencontainers->pop('container');
2257     }
2259     /**
2260      * Make nested HTML lists out of the items
2261      *
2262      * The resulting list will look something like this:
2263      *
2264      * <pre>
2265      * <<ul>>
2266      * <<li>><div class='tree_item parent'>(item contents)</div>
2267      *      <<ul>
2268      *      <<li>><div class='tree_item'>(item contents)</div><</li>>
2269      *      <</ul>>
2270      * <</li>>
2271      * <</ul>>
2272      * </pre>
2273      *
2274      * @param array[]tree_item $items
2275      * @param array[string]string $attrs html attributes passed to the top of
2276      * the list
2277      * @return string HTML
2278      */
2279     function tree_block_contents($items, $attrs=array()) {
2280         // exit if empty, we don't want an empty ul element
2281         if (empty($items)) {
2282             return '';
2283         }
2284         // array of nested li elements
2285         $lis = array();
2286         foreach ($items as $item) {
2287             // this applies to the li item which contains all child lists too
2288             $content = $item->content($this);
2289             $liclasses = array($item->get_css_type());
2290             if (!$item->forceopen || (!$item->forceopen && $item->collapse) || ($item->children->count()==0  && $item->nodetype==navigation_node::NODETYPE_BRANCH)) {
2291                 $liclasses[] = 'collapsed';
2292             }
2293             if ($item->isactive === true) {
2294                 $liclasses[] = 'current_branch';
2295             }
2296             $liattr = array('class'=>join(' ',$liclasses));
2297             // class attribute on the div item which only contains the item content
2298             $divclasses = array('tree_item');
2299             if ($item->children->count()>0  || $item->nodetype==navigation_node::NODETYPE_BRANCH) {
2300                 $divclasses[] = 'branch';
2301             } else {
2302                 $divclasses[] = 'leaf';
2303             }
2304             if (!empty($item->classes) && count($item->classes)>0) {
2305                 $divclasses[] = join(' ', $item->classes);
2306             }
2307             $divattr = array('class'=>join(' ', $divclasses));
2308             if (!empty($item->id)) {
2309                 $divattr['id'] = $item->id;
2310             }
2311             $content = html_writer::tag('p', $content, $divattr) . $this->tree_block_contents($item->children);
2312             if (!empty($item->preceedwithhr) && $item->preceedwithhr===true) {
2313                 $content = html_writer::empty_tag('hr') . $content;
2314             }
2315             $content = html_writer::tag('li', $content, $liattr);
2316             $lis[] = $content;
2317         }
2318         return html_writer::tag('ul', implode("\n", $lis), $attrs);
2319     }
2321     /**
2322      * Return the navbar content so that it can be echoed out by the layout
2323      * @return string XHTML navbar
2324      */
2325     public function navbar() {
2326         //return $this->page->navbar->content();
2328         $items = $this->page->navbar->get_items();
2330         $count = 0;
2332         $htmlblocks = array();
2333         // Iterate the navarray and display each node
2334         $itemcount = count($items);
2335         $separator = get_separator();
2336         for ($i=0;$i < $itemcount;$i++) {
2337             $item = $items[$i];
2338             $item->hideicon = true;
2339             if ($i===0) {
2340                 $content = html_writer::tag('li', $this->render($item));
2341             } else {
2342                 $content = html_writer::tag('li', $separator.$this->render($item));
2343             }
2344             $htmlblocks[] = $content;
2345         }
2347         //accessibility: heading for navbar list  (MDL-20446)
2348         $navbarcontent = html_writer::tag('span', get_string('pagepath'), array('class'=>'accesshide'));
2349         $navbarcontent .= html_writer::tag('ul', join('', $htmlblocks));
2350         // XHTML
2351         return $navbarcontent;
2352     }
2354     protected function render_navigation_node(navigation_node $item) {
2355         $content = $item->get_content();
2356         $title = $item->get_title();
2357         if ($item->icon instanceof renderable && !$item->hideicon) {
2358             $icon = $this->render($item->icon);
2359             $content = $icon.$content; // use CSS for spacing of icons
2360         }
2361         if ($item->helpbutton !== null) {
2362             $content = trim($item->helpbutton).html_writer::tag('span', $content, array('class'=>'clearhelpbutton'));
2363         }
2364         if ($content === '') {
2365             return '';
2366         }
2367         if ($item->action instanceof action_link) {
2368             //TODO: to be replaced with something else
2369             $link = $item->action;
2370             if ($item->hidden) {
2371                 $link->add_class('dimmed');
2372             }
2373             $content = $this->output->render($link);
2374         } else if ($item->action instanceof moodle_url) {
2375             $attributes = array();
2376             if ($title !== '') {
2377                 $attributes['title'] = $title;
2378             }
2379             if ($item->hidden) {
2380                 $attributes['class'] = 'dimmed_text';
2381             }
2382             $content = html_writer::link($item->action, $content, $attributes);
2384         } else if (is_string($item->action) || empty($item->action)) {
2385             $attributes = array();
2386             if ($title !== '') {
2387                 $attributes['title'] = $title;
2388             }
2389             if ($item->hidden) {
2390                 $attributes['class'] = 'dimmed_text';
2391             }
2392             $content = html_writer::tag('span', $content, $attributes);
2393         }
2394         return $content;
2395     }
2397     /**
2398      * Accessibility: Right arrow-like character is
2399      * used in the breadcrumb trail, course navigation menu
2400      * (previous/next activity), calendar, and search forum block.
2401      * If the theme does not set characters, appropriate defaults
2402      * are set automatically. Please DO NOT
2403      * use &lt; &gt; &raquo; - these are confusing for blind users.
2404      * @return string
2405      */
2406     public function rarrow() {
2407         return $this->page->theme->rarrow;
2408     }
2410     /**
2411      * Accessibility: Right arrow-like character is
2412      * used in the breadcrumb trail, course navigation menu
2413      * (previous/next activity), calendar, and search forum block.
2414      * If the theme does not set characters, appropriate defaults
2415      * are set automatically. Please DO NOT
2416      * use &lt; &gt; &raquo; - these are confusing for blind users.
2417      * @return string
2418      */
2419     public function larrow() {
2420         return $this->page->theme->larrow;
2421     }
2423     /**
2424      * Returns the colours of the small MP3 player
2425      * @return string
2426      */
2427     public function filter_mediaplugin_colors() {
2428         return $this->page->theme->filter_mediaplugin_colors;
2429     }
2431     /**
2432      * Returns the colours of the big MP3 player
2433      * @return string
2434      */
2435     public function resource_mp3player_colors() {
2436         return $this->page->theme->resource_mp3player_colors;
2437     }
2439     /**
2440      * Returns the custom menu if one has been set
2441      *
2442      * A custom menu can be configured by browsing to
2443      *    Settings: Administration > Appearance > Themes > Theme settings
2444      * and then configuring the custommenu config setting as described.
2445      *
2446      * @return string
2447      */
2448     public function custom_menu() {
2449         global $CFG;
2450         if (empty($CFG->custommenuitems)) {
2451             return '';
2452         }
2453         $custommenu = new custom_menu();
2454         return $this->render_custom_menu($custommenu);
2455     }
2457     /**
2458      * Renders a custom menu object (located in outputcomponents.php)
2459      *
2460      * The custom menu this method produces makes use of the YUI3 menunav widget
2461      * and requires very specific html elements and classes.
2462      *
2463      * @staticvar int $menucount
2464      * @param custom_menu $menu
2465      * @return string
2466      */
2467     protected function render_custom_menu(custom_menu $menu) {
2468         static $menucount = 0;
2469         // If the menu has no children return an empty string
2470         if (!$menu->has_children()) {
2471             return '';
2472         }
2473         // Increment the menu count. This is used for ID's that get worked with
2474         // in JavaScript as is essential
2475         $menucount++;
2476         // Initialise this custom menu
2477         $this->page->requires->js_init_call('M.core_custom_menu.init', array('custom_menu_'.$menucount));
2478         // Build the root nodes as required by YUI
2479         $content = html_writer::start_tag('div', array('id'=>'custom_menu_'.$menucount, 'class'=>'yui3-menu yui3-menu-horizontal javascript-disabled'));
2480         $content .= html_writer::start_tag('div', array('class'=>'yui3-menu-content'));
2481         $content .= html_writer::start_tag('ul');
2482         // Render each child
2483         foreach ($menu->get_children() as $item) {
2484             $content .= $this->render_custom_menu_item($item);
2485         }
2486         // Close the open tags
2487         $content .= html_writer::end_tag('ul');
2488         $content .= html_writer::end_tag('div');
2489         $content .= html_writer::end_tag('div');
2490         // Return the custom menu
2491         return $content;
2492     }
2494     /**
2495      * Renders a custom menu node as part of a submenu
2496      *
2497      * The custom menu this method produces makes use of the YUI3 menunav widget
2498      * and requires very specific html elements and classes.
2499      *
2500      * @see render_custom_menu()
2501      *
2502      * @staticvar int $submenucount
2503      * @param custom_menu_item $menunode
2504      * @return string
2505      */
2506     protected function render_custom_menu_item(custom_menu_item $menunode) {
2507         // Required to ensure we get unique trackable id's
2508         static $submenucount = 0;
2509         if ($menunode->has_children()) {
2510             // If the child has menus render it as a sub menu
2511             $submenucount++;
2512             $content = html_writer::start_tag('li');
2513             if ($menunode->get_url() !== null) {
2514                 $url = $menunode->get_url();
2515             } else {
2516                 $url = '#cm_submenu_'.$submenucount;
2517             }
2518             $content .= html_writer::link($url, $menunode->get_text(), array('class'=>'yui3-menu-label', 'title'=>$menunode->get_title()));
2519             $content .= html_writer::start_tag('div', array('id'=>'cm_submenu_'.$submenucount, 'class'=>'yui3-menu custom_menu_submenu'));
2520             $content .= html_writer::start_tag('div', array('class'=>'yui3-menu-content'));
2521             $content .= html_writer::start_tag('ul');
2522             foreach ($menunode->get_children() as $menunode) {
2523                 $content .= $this->render_custom_menu_item($menunode);
2524             }
2525             $content .= html_writer::end_tag('ul');
2526             $content .= html_writer::end_tag('div');
2527             $content .= html_writer::end_tag('div');
2528             $content .= html_writer::end_tag('li');
2529         } else {
2530             // The node doesn't have children so produce a final menuitem
2531             $content = html_writer::start_tag('li', array('class'=>'yui3-menuitem'));
2532             if ($menunode->get_url() !== null) {
2533                 $url = $menunode->get_url();
2534             } else {
2535                 $url = '#';
2536             }
2537             $content .= html_writer::link($url, $menunode->get_text(), array('class'=>'yui3-menuitem-content', 'title'=>$menunode->get_title()));
2538             $content .= html_writer::end_tag('li');
2539         }
2540         // Return the sub menu
2541         return $content;
2542     }
2544     /**
2545      * Renders the image_gallery component and initialises its JavaScript
2546      *
2547      * @param image_gallery $imagegallery
2548      * @return string
2549      */
2550     protected function render_image_gallery(image_gallery $imagegallery) {
2551         $this->page->requires->yui_module(array('gallery-lightbox','gallery-lightbox-skin'),
2552                  'Y.Lightbox.init', null, '2010.04.08-12-35');
2553         if (count($imagegallery->images) == 0) {
2554             return '';
2555         }
2556         $classes = array('image_gallery');
2557         if ($imagegallery->displayfirstimageonly) {
2558             $classes[] = 'oneimageonly';
2559         }
2560         $content = html_writer::start_tag('div', array('class'=>join(' ', $classes)));
2561         foreach ($imagegallery->images as $image) {
2562             $content .= html_writer::tag('a', html_writer::empty_tag('img', $image->thumb), $image->link);
2563         }
2564         $content .= html_writer::end_tag('div');
2565         return $content;
2566     }
2570 /// RENDERERS
2572 /**
2573  * A renderer that generates output for command-line scripts.
2574  *
2575  * The implementation of this renderer is probably incomplete.
2576  *
2577  * @copyright 2009 Tim Hunt
2578  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2579  * @since     Moodle 2.0
2580  */
2581 class core_renderer_cli extends core_renderer {
2582     /**
2583      * Returns the page header.
2584      * @return string HTML fragment
2585      */
2586     public function header() {
2587         return $this->page->heading . "\n";
2588     }
2590     /**
2591      * Returns a template fragment representing a Heading.
2592      * @param string $text The text of the heading
2593      * @param int $level The level of importance of the heading
2594      * @param string $classes A space-separated list of CSS classes
2595      * @param string $id An optional ID
2596      * @return string A template fragment for a heading
2597      */
2598     public function heading($text, $level = 2, $classes = 'main', $id = null) {
2599         $text .= "\n";
2600         switch ($level) {
2601             case 1:
2602                 return '=>' . $text;
2603             case 2:
2604                 return '-->' . $text;
2605             default:
2606                 return $text;
2607         }
2608     }
2610     /**
2611      * Returns a template fragment representing a fatal error.
2612      * @param string $message The message to output
2613      * @param string $moreinfourl URL where more info can be found about the error
2614      * @param string $link Link for the Continue button
2615      * @param array $backtrace The execution backtrace
2616      * @param string $debuginfo Debugging information
2617      * @return string A template fragment for a fatal error
2618      */
2619     public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
2620         $output = "!!! $message !!!\n";
2622         if (debugging('', DEBUG_DEVELOPER)) {
2623             if (!empty($debuginfo)) {
2624                 $this->notification($debuginfo, 'notifytiny');
2625             }
2626             if (!empty($backtrace)) {
2627                 $this->notification('Stack trace: ' . format_backtrace($backtrace, true), 'notifytiny');
2628             }
2629         }
2630     }
2632     /**
2633      * Returns a template fragment representing a notification.
2634      * @param string $message The message to include
2635      * @param string $classes A space-separated list of CSS classes
2636      * @return string A template fragment for a notification
2637      */
2638     public function notification($message, $classes = 'notifyproblem') {
2639         $message = clean_text($message);
2640         if ($classes === 'notifysuccess') {
2641             return "++ $message ++\n";
2642         }
2643         return "!! $message !!\n";
2644     }
2648 /**
2649  * A renderer that generates output for ajax scripts.
2650  *
2651  * This renderer prevents accidental sends back only json
2652  * encoded error messages, all other output is ignored.
2653  *
2654  * @copyright 2010 Petr Skoda
2655  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2656  * @since     Moodle 2.0
2657  */
2658 class core_renderer_ajax extends core_renderer {
2659     /**
2660      * Returns a template fragment representing a fatal error.
2661      * @param string $message The message to output
2662      * @param string $moreinfourl URL where more info can be found about the error
2663      * @param string $link Link for the Continue button
2664      * @param array $backtrace The execution backtrace
2665      * @param string $debuginfo Debugging information
2666      * @return string A template fragment for a fatal error
2667      */
2668     public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
2669         global $CFG;
2671         $this->page->set_context(null); // ugly hack - make sure page context is set to something, we do not want bogus warnings here
2673         $e = new stdClass();
2674         $e->error      = $message;
2675         $e->stacktrace = NULL;
2676         $e->debuginfo  = NULL;
2677         $e->reproductionlink = NULL;
2678         if (!empty($CFG->debug) and $CFG->debug >= DEBUG_DEVELOPER) {
2679             $e->reproductionlink = $link;
2680             if (!empty($debuginfo)) {
2681                 $e->debuginfo = $debuginfo;
2682             }
2683             if (!empty($backtrace)) {
2684                 $e->stacktrace = format_backtrace($backtrace, true);
2685             }
2686         }
2687         $this->header();
2688         return json_encode($e);
2689     }
2691     public function notification($message, $classes = 'notifyproblem') {
2692     }
2694     public function redirect_message($encodedurl, $message, $delay, $debugdisableredirect) {
2695     }
2697     public function header() {
2698         // unfortunately YUI iframe upload does not support application/json
2699         if (!empty($_FILES)) {
2700             @header('Content-type: text/plain');
2701         } else {
2702             @header('Content-type: application/json');
2703         }
2705         /// Headers to make it not cacheable and json
2706         @header('Cache-Control: no-store, no-cache, must-revalidate');
2707         @header('Cache-Control: post-check=0, pre-check=0', false);
2708         @header('Pragma: no-cache');
2709         @header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
2710         @header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
2711         @header('Accept-Ranges: none');
2712     }
2714     public function footer() {
2715     }
2717     public function heading($text, $level = 2, $classes = 'main', $id = null) {
2718     }