weekly release 2.4dev
[moodle.git] / lib / outputrenderers.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Classes for rendering HTML output for Moodle.
19  *
20  * Please see {@link http://docs.moodle.org/en/Developement:How_Moodle_outputs_HTML}
21  * for an overview.
22  *
23  * Included in this file are the primary renderer classes:
24  *     - renderer_base:         The renderer outline class that all renderers
25  *                              should inherit from.
26  *     - core_renderer:         The standard HTML renderer.
27  *     - core_renderer_cli:     An adaption of the standard renderer for CLI scripts.
28  *     - core_renderer_ajax:    An adaption of the standard renderer for AJAX scripts.
29  *     - plugin_renderer_base:  A renderer class that should be extended by all
30  *                              plugin renderers.
31  *
32  * @package core
33  * @category output
34  * @copyright  2009 Tim Hunt
35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
38 defined('MOODLE_INTERNAL') || die();
40 /**
41  * Simple base class for Moodle renderers.
42  *
43  * Tracks the xhtml_container_stack to use, which is passed in in the constructor.
44  *
45  * Also has methods to facilitate generating HTML output.
46  *
47  * @copyright 2009 Tim Hunt
48  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
49  * @since Moodle 2.0
50  * @package core
51  * @category output
52  */
53 class renderer_base {
54     /**
55      * @var xhtml_container_stack The xhtml_container_stack to use.
56      */
57     protected $opencontainers;
59     /**
60      * @var moodle_page The Moodle page the renderer has been created to assist with.
61      */
62     protected $page;
64     /**
65      * @var string The requested rendering target.
66      */
67     protected $target;
69     /**
70      * Constructor
71      *
72      * The constructor takes two arguments. The first is the page that the renderer
73      * has been created to assist with, and the second is the target.
74      * The target is an additional identifier that can be used to load different
75      * renderers for different options.
76      *
77      * @param moodle_page $page the page we are doing output for.
78      * @param string $target one of rendering target constants
79      */
80     public function __construct(moodle_page $page, $target) {
81         $this->opencontainers = $page->opencontainers;
82         $this->page = $page;
83         $this->target = $target;
84     }
86     /**
87      * Returns rendered widget.
88      *
89      * The provided widget needs to be an object that extends the renderable
90      * interface.
91      * If will then be rendered by a method based upon the classname for the widget.
92      * For instance a widget of class `crazywidget` will be rendered by a protected
93      * render_crazywidget method of this renderer.
94      *
95      * @param renderable $widget instance with renderable interface
96      * @return string
97      */
98     public function render(renderable $widget) {
99         $rendermethod = 'render_'.get_class($widget);
100         if (method_exists($this, $rendermethod)) {
101             return $this->$rendermethod($widget);
102         }
103         throw new coding_exception('Can not render widget, renderer method ('.$rendermethod.') not found.');
104     }
106     /**
107      * Adds a JS action for the element with the provided id.
108      *
109      * This method adds a JS event for the provided component action to the page
110      * and then returns the id that the event has been attached to.
111      * If no id has been provided then a new ID is generated by {@link html_writer::random_id()}
112      *
113      * @param component_action $action
114      * @param string $id
115      * @return string id of element, either original submitted or random new if not supplied
116      */
117     public function add_action_handler(component_action $action, $id = null) {
118         if (!$id) {
119             $id = html_writer::random_id($action->event);
120         }
121         $this->page->requires->event_handler("#$id", $action->event, $action->jsfunction, $action->jsfunctionargs);
122         return $id;
123     }
125     /**
126      * Returns true is output has already started, and false if not.
127      *
128      * @return boolean true if the header has been printed.
129      */
130     public function has_started() {
131         return $this->page->state >= moodle_page::STATE_IN_BODY;
132     }
134     /**
135      * Given an array or space-separated list of classes, prepares and returns the HTML class attribute value
136      *
137      * @param mixed $classes Space-separated string or array of classes
138      * @return string HTML class attribute value
139      */
140     public static function prepare_classes($classes) {
141         if (is_array($classes)) {
142             return implode(' ', array_unique($classes));
143         }
144         return $classes;
145     }
147     /**
148      * Return the moodle_url for an image.
149      *
150      * The exact image location and extension is determined
151      * automatically by searching for gif|png|jpg|jpeg, please
152      * note there can not be diferent images with the different
153      * extension. The imagename is for historical reasons
154      * a relative path name, it may be changed later for core
155      * images. It is recommended to not use subdirectories
156      * in plugin and theme pix directories.
157      *
158      * There are three types of images:
159      * 1/ theme images  - stored in theme/mytheme/pix/,
160      *                    use component 'theme'
161      * 2/ core images   - stored in /pix/,
162      *                    overridden via theme/mytheme/pix_core/
163      * 3/ plugin images - stored in mod/mymodule/pix,
164      *                    overridden via theme/mytheme/pix_plugins/mod/mymodule/,
165      *                    example: pix_url('comment', 'mod_glossary')
166      *
167      * @param string $imagename the pathname of the image
168      * @param string $component full plugin name (aka component) or 'theme'
169      * @return moodle_url
170      */
171     public function pix_url($imagename, $component = 'moodle') {
172         return $this->page->theme->pix_url($imagename, $component);
173     }
177 /**
178  * Basis for all plugin renderers.
179  *
180  * @copyright Petr Skoda (skodak)
181  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
182  * @since Moodle 2.0
183  * @package core
184  * @category output
185  */
186 class plugin_renderer_base extends renderer_base {
188     /**
189      * @var renderer_base|core_renderer A reference to the current renderer.
190      * The renderer provided here will be determined by the page but will in 90%
191      * of cases by the {@link core_renderer}
192      */
193     protected $output;
195     /**
196      * Constructor method, calls the parent constructor
197      *
198      * @param moodle_page $page
199      * @param string $target one of rendering target constants
200      */
201     public function __construct(moodle_page $page, $target) {
202         $this->output = $page->get_renderer('core', null, $target);
203         parent::__construct($page, $target);
204     }
206     /**
207      * Renders the provided widget and returns the HTML to display it.
208      *
209      * @param renderable $widget instance with renderable interface
210      * @return string
211      */
212     public function render(renderable $widget) {
213         $rendermethod = 'render_'.get_class($widget);
214         if (method_exists($this, $rendermethod)) {
215             return $this->$rendermethod($widget);
216         }
217         // pass to core renderer if method not found here
218         return $this->output->render($widget);
219     }
221     /**
222      * Magic method used to pass calls otherwise meant for the standard renderer
223      * to it to ensure we don't go causing unnecessary grief.
224      *
225      * @param string $method
226      * @param array $arguments
227      * @return mixed
228      */
229     public function __call($method, $arguments) {
230         if (method_exists('renderer_base', $method)) {
231             throw new coding_exception('Protected method called against '.get_class($this).' :: '.$method);
232         }
233         if (method_exists($this->output, $method)) {
234             return call_user_func_array(array($this->output, $method), $arguments);
235         } else {
236             throw new coding_exception('Unknown method called against '.get_class($this).' :: '.$method);
237         }
238     }
242 /**
243  * The standard implementation of the core_renderer interface.
244  *
245  * @copyright 2009 Tim Hunt
246  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
247  * @since Moodle 2.0
248  * @package core
249  * @category output
250  */
251 class core_renderer extends renderer_base {
252     /**
253      * Do NOT use, please use <?php echo $OUTPUT->main_content() ?>
254      * in layout files instead.
255      * @deprecated
256      * @var string used in {@link core_renderer::header()}.
257      */
258     const MAIN_CONTENT_TOKEN = '[MAIN CONTENT GOES HERE]';
260     /**
261      * @var string Used to pass information from {@link core_renderer::doctype()} to
262      * {@link core_renderer::standard_head_html()}.
263      */
264     protected $contenttype;
266     /**
267      * @var string Used by {@link core_renderer::redirect_message()} method to communicate
268      * with {@link core_renderer::header()}.
269      */
270     protected $metarefreshtag = '';
272     /**
273      * @var string Unique token for the closing HTML
274      */
275     protected $unique_end_html_token;
277     /**
278      * @var string Unique token for performance information
279      */
280     protected $unique_performance_info_token;
282     /**
283      * @var string Unique token for the main content.
284      */
285     protected $unique_main_content_token;
287     /**
288      * Constructor
289      *
290      * @param moodle_page $page the page we are doing output for.
291      * @param string $target one of rendering target constants
292      */
293     public function __construct(moodle_page $page, $target) {
294         $this->opencontainers = $page->opencontainers;
295         $this->page = $page;
296         $this->target = $target;
298         $this->unique_end_html_token = '%%ENDHTML-'.sesskey().'%%';
299         $this->unique_performance_info_token = '%%PERFORMANCEINFO-'.sesskey().'%%';
300         $this->unique_main_content_token = '[MAIN CONTENT GOES HERE - '.sesskey().']';
301     }
303     /**
304      * Get the DOCTYPE declaration that should be used with this page. Designed to
305      * be called in theme layout.php files.
306      *
307      * @return string the DOCTYPE declaration that should be used.
308      */
309     public function doctype() {
310         if ($this->page->theme->doctype === 'html5') {
311             $this->contenttype = 'text/html; charset=utf-8';
312             return "<!DOCTYPE html>\n";
314         } else if ($this->page->theme->doctype === 'xhtml5') {
315             $this->contenttype = 'application/xhtml+xml; charset=utf-8';
316             return "<!DOCTYPE html>\n";
318         } else {
319             // legacy xhtml 1.0
320             $this->contenttype = 'text/html; charset=utf-8';
321             return ('<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">' . "\n");
322         }
323     }
325     /**
326      * The attributes that should be added to the <html> tag. Designed to
327      * be called in theme layout.php files.
328      *
329      * @return string HTML fragment.
330      */
331     public function htmlattributes() {
332         $return = get_html_lang(true);
333         if ($this->page->theme->doctype !== 'html5') {
334             $return .= ' xmlns="http://www.w3.org/1999/xhtml"';
335         }
336         return $return;
337     }
339     /**
340      * The standard tags (meta tags, links to stylesheets and JavaScript, etc.)
341      * that should be included in the <head> tag. Designed to be called in theme
342      * layout.php files.
343      *
344      * @return string HTML fragment.
345      */
346     public function standard_head_html() {
347         global $CFG, $SESSION;
348         $output = '';
349         if ($this->page->theme->doctype === 'html5' or $this->page->theme->doctype === 'xhtml5') {
350             // Make sure we set 'X-UA-Compatible' only if script did not request something else (such as MDL-29213).
351             if (empty($CFG->additionalhtmlhead) or stripos($CFG->additionalhtmlhead, 'X-UA-Compatible') === false) {
352                 $output .= '<meta http-equiv="X-UA-Compatible" content="IE=edge" />' . "\n";
353             }
354         }
355         $output .= '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />' . "\n";
356         $output .= '<meta name="keywords" content="moodle, ' . $this->page->title . '" />' . "\n";
357         if (!$this->page->cacheable) {
358             $output .= '<meta http-equiv="pragma" content="no-cache" />' . "\n";
359             $output .= '<meta http-equiv="expires" content="0" />' . "\n";
360         }
361         // This is only set by the {@link redirect()} method
362         $output .= $this->metarefreshtag;
364         // Check if a periodic refresh delay has been set and make sure we arn't
365         // already meta refreshing
366         if ($this->metarefreshtag=='' && $this->page->periodicrefreshdelay!==null) {
367             $output .= '<meta http-equiv="refresh" content="'.$this->page->periodicrefreshdelay.';url='.$this->page->url->out().'" />';
368         }
370         // flow player embedding support
371         $this->page->requires->js_function_call('M.util.load_flowplayer');
373         $this->page->requires->js_function_call('setTimeout', array('fix_column_widths()', 20));
375         $focus = $this->page->focuscontrol;
376         if (!empty($focus)) {
377             if (preg_match("#forms\['([a-zA-Z0-9]+)'\].elements\['([a-zA-Z0-9]+)'\]#", $focus, $matches)) {
378                 // This is a horrifically bad way to handle focus but it is passed in
379                 // through messy formslib::moodleform
380                 $this->page->requires->js_function_call('old_onload_focus', array($matches[1], $matches[2]));
381             } else if (strpos($focus, '.')!==false) {
382                 // Old style of focus, bad way to do it
383                 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);
384                 $this->page->requires->js_function_call('old_onload_focus', explode('.', $focus, 2));
385             } else {
386                 // Focus element with given id
387                 $this->page->requires->js_function_call('focuscontrol', array($focus));
388             }
389         }
391         // Get the theme stylesheet - this has to be always first CSS, this loads also styles.css from all plugins;
392         // any other custom CSS can not be overridden via themes and is highly discouraged
393         $urls = $this->page->theme->css_urls($this->page);
394         foreach ($urls as $url) {
395             $this->page->requires->css_theme($url);
396         }
398         // Get the theme javascript head and footer
399         $jsurl = $this->page->theme->javascript_url(true);
400         $this->page->requires->js($jsurl, true);
401         $jsurl = $this->page->theme->javascript_url(false);
402         $this->page->requires->js($jsurl);
404         // Get any HTML from the page_requirements_manager.
405         $output .= $this->page->requires->get_head_code($this->page, $this);
407         // List alternate versions.
408         foreach ($this->page->alternateversions as $type => $alt) {
409             $output .= html_writer::empty_tag('link', array('rel' => 'alternate',
410                     'type' => $type, 'title' => $alt->title, 'href' => $alt->url));
411         }
413         if (!empty($CFG->additionalhtmlhead)) {
414             $output .= "\n".$CFG->additionalhtmlhead;
415         }
417         return $output;
418     }
420     /**
421      * The standard tags (typically skip links) that should be output just inside
422      * the start of the <body> tag. Designed to be called in theme layout.php files.
423      *
424      * @return string HTML fragment.
425      */
426     public function standard_top_of_body_html() {
427         global $CFG;
428         $output = $this->page->requires->get_top_of_body_code();
429         if (!empty($CFG->additionalhtmltopofbody)) {
430             $output .= "\n".$CFG->additionalhtmltopofbody;
431         }
432         return $output;
433     }
435     /**
436      * The standard tags (typically performance information and validation links,
437      * if we are in developer debug mode) that should be output in the footer area
438      * of the page. Designed to be called in theme layout.php files.
439      *
440      * @return string HTML fragment.
441      */
442     public function standard_footer_html() {
443         global $CFG, $SCRIPT;
445         // This function is normally called from a layout.php file in {@link core_renderer::header()}
446         // but some of the content won't be known until later, so we return a placeholder
447         // for now. This will be replaced with the real content in {@link core_renderer::footer()}.
448         $output = $this->unique_performance_info_token;
449         if ($this->page->devicetypeinuse == 'legacy') {
450             // The legacy theme is in use print the notification
451             $output .= html_writer::tag('div', get_string('legacythemeinuse'), array('class'=>'legacythemeinuse'));
452         }
454         // Get links to switch device types (only shown for users not on a default device)
455         $output .= $this->theme_switch_links();
457         if (!empty($CFG->debugpageinfo)) {
458             $output .= '<div class="performanceinfo pageinfo">This page is: ' . $this->page->debug_summary() . '</div>';
459         }
460         if (debugging(null, DEBUG_DEVELOPER) and has_capability('moodle/site:config', context_system::instance())) {  // Only in developer mode
461             // Add link to profiling report if necessary
462             if (function_exists('profiling_is_running') && profiling_is_running()) {
463                 $txt = get_string('profiledscript', 'admin');
464                 $title = get_string('profiledscriptview', 'admin');
465                 $url = $CFG->wwwroot . '/admin/tool/profiling/index.php?script=' . urlencode($SCRIPT);
466                 $link= '<a title="' . $title . '" href="' . $url . '">' . $txt . '</a>';
467                 $output .= '<div class="profilingfooter">' . $link . '</div>';
468             }
469             $output .= '<div class="purgecaches"><a href="'.$CFG->wwwroot.'/'.$CFG->admin.'/purgecaches.php?confirm=1&amp;sesskey='.sesskey().'">'.get_string('purgecaches', 'admin').'</a></div>';
470         }
471         if (!empty($CFG->debugvalidators)) {
472             // NOTE: this is not a nice hack, $PAGE->url is not always accurate and $FULLME neither, it is not a bug if it fails. --skodak
473             $output .= '<div class="validators"><ul>
474               <li><a href="http://validator.w3.org/check?verbose=1&amp;ss=1&amp;uri=' . urlencode(qualified_me()) . '">Validate HTML</a></li>
475               <li><a href="http://www.contentquality.com/mynewtester/cynthia.exe?rptmode=-1&amp;url1=' . urlencode(qualified_me()) . '">Section 508 Check</a></li>
476               <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>
477             </ul></div>';
478         }
479         if (!empty($CFG->additionalhtmlfooter)) {
480             $output .= "\n".$CFG->additionalhtmlfooter;
481         }
482         return $output;
483     }
485     /**
486      * Returns standard main content placeholder.
487      * Designed to be called in theme layout.php files.
488      *
489      * @return string HTML fragment.
490      */
491     public function main_content() {
492         return $this->unique_main_content_token;
493     }
495     /**
496      * The standard tags (typically script tags that are not needed earlier) that
497      * should be output after everything else, . Designed to be called in theme layout.php files.
498      *
499      * @return string HTML fragment.
500      */
501     public function standard_end_of_body_html() {
502         // This function is normally called from a layout.php file in {@link core_renderer::header()}
503         // but some of the content won't be known until later, so we return a placeholder
504         // for now. This will be replaced with the real content in {@link core_renderer::footer()}.
505         return $this->unique_end_html_token;
506     }
508     /**
509      * Return the standard string that says whether you are logged in (and switched
510      * roles/logged in as another user).
511      *
512      * @return string HTML fragment.
513      */
514     public function login_info() {
515         global $USER, $CFG, $DB, $SESSION;
517         if (during_initial_install()) {
518             return '';
519         }
521         $loginpage = ((string)$this->page->url === get_login_url());
522         $course = $this->page->course;
524         if (session_is_loggedinas()) {
525             $realuser = session_get_realuser();
526             $fullname = fullname($realuser, true);
527             $realuserinfo = " [<a href=\"$CFG->wwwroot/course/loginas.php?id=$course->id&amp;sesskey=".sesskey()."\">$fullname</a>] ";
528         } else {
529             $realuserinfo = '';
530         }
532         $loginurl = get_login_url();
534         if (empty($course->id)) {
535             // $course->id is not defined during installation
536             return '';
537         } else if (isloggedin()) {
538             $context = context_course::instance($course->id);
540             $fullname = fullname($USER, true);
541             // Since Moodle 2.0 this link always goes to the public profile page (not the course profile page)
542             $username = "<a href=\"$CFG->wwwroot/user/profile.php?id=$USER->id\">$fullname</a>";
543             if (is_mnet_remote_user($USER) and $idprovider = $DB->get_record('mnet_host', array('id'=>$USER->mnethostid))) {
544                 $username .= " from <a href=\"{$idprovider->wwwroot}\">{$idprovider->name}</a>";
545             }
546             if (isguestuser()) {
547                 $loggedinas = $realuserinfo.get_string('loggedinasguest');
548                 if (!$loginpage) {
549                     $loggedinas .= " (<a href=\"$loginurl\">".get_string('login').'</a>)';
550                 }
551             } else if (is_role_switched($course->id)) { // Has switched roles
552                 $rolename = '';
553                 if ($role = $DB->get_record('role', array('id'=>$USER->access['rsw'][$context->path]))) {
554                     $rolename = ': '.format_string($role->name);
555                 }
556                 $loggedinas = get_string('loggedinas', 'moodle', $username).$rolename.
557                           " (<a href=\"$CFG->wwwroot/course/view.php?id=$course->id&amp;switchrole=0&amp;sesskey=".sesskey()."\">".get_string('switchrolereturn').'</a>)';
558             } else {
559                 $loggedinas = $realuserinfo.get_string('loggedinas', 'moodle', $username).' '.
560                           " (<a href=\"$CFG->wwwroot/login/logout.php?sesskey=".sesskey()."\">".get_string('logout').'</a>)';
561             }
562         } else {
563             $loggedinas = get_string('loggedinnot', 'moodle');
564             if (!$loginpage) {
565                 $loggedinas .= " (<a href=\"$loginurl\">".get_string('login').'</a>)';
566             }
567         }
569         $loggedinas = '<div class="logininfo">'.$loggedinas.'</div>';
571         if (isset($SESSION->justloggedin)) {
572             unset($SESSION->justloggedin);
573             if (!empty($CFG->displayloginfailures)) {
574                 if (!isguestuser()) {
575                     if ($count = count_login_failures($CFG->displayloginfailures, $USER->username, $USER->lastlogin)) {
576                         $loggedinas .= '&nbsp;<div class="loginfailures">';
577                         if (empty($count->accounts)) {
578                             $loggedinas .= get_string('failedloginattempts', '', $count);
579                         } else {
580                             $loggedinas .= get_string('failedloginattemptsall', '', $count);
581                         }
582                         if (file_exists("$CFG->dirroot/report/log/index.php") and has_capability('report/log:view', context_system::instance())) {
583                             $loggedinas .= ' (<a href="'.$CFG->wwwroot.'/report/log/index.php'.
584                                                  '?chooselog=1&amp;id=1&amp;modid=site_errors">'.get_string('logs').'</a>)';
585                         }
586                         $loggedinas .= '</div>';
587                     }
588                 }
589             }
590         }
592         return $loggedinas;
593     }
595     /**
596      * Return the 'back' link that normally appears in the footer.
597      *
598      * @return string HTML fragment.
599      */
600     public function home_link() {
601         global $CFG, $SITE;
603         if ($this->page->pagetype == 'site-index') {
604             // Special case for site home page - please do not remove
605             return '<div class="sitelink">' .
606                    '<a title="Moodle" href="http://moodle.org/">' .
607                    '<img style="width:100px;height:30px" src="' . $this->pix_url('moodlelogo') . '" alt="moodlelogo" /></a></div>';
609         } else if (!empty($CFG->target_release) && $CFG->target_release != $CFG->release) {
610             // Special case for during install/upgrade.
611             return '<div class="sitelink">'.
612                    '<a title="Moodle" href="http://docs.moodle.org/en/Administrator_documentation" onclick="this.target=\'_blank\'">' .
613                    '<img style="width:100px;height:30px" src="' . $this->pix_url('moodlelogo') . '" alt="moodlelogo" /></a></div>';
615         } else if ($this->page->course->id == $SITE->id || strpos($this->page->pagetype, 'course-view') === 0) {
616             return '<div class="homelink"><a href="' . $CFG->wwwroot . '/">' .
617                     get_string('home') . '</a></div>';
619         } else {
620             return '<div class="homelink"><a href="' . $CFG->wwwroot . '/course/view.php?id=' . $this->page->course->id . '">' .
621                     format_string($this->page->course->shortname, true, array('context' => $this->page->context)) . '</a></div>';
622         }
623     }
625     /**
626      * Redirects the user by any means possible given the current state
627      *
628      * This function should not be called directly, it should always be called using
629      * the redirect function in lib/weblib.php
630      *
631      * The redirect function should really only be called before page output has started
632      * however it will allow itself to be called during the state STATE_IN_BODY
633      *
634      * @param string $encodedurl The URL to send to encoded if required
635      * @param string $message The message to display to the user if any
636      * @param int $delay The delay before redirecting a user, if $message has been
637      *         set this is a requirement and defaults to 3, set to 0 no delay
638      * @param boolean $debugdisableredirect this redirect has been disabled for
639      *         debugging purposes. Display a message that explains, and don't
640      *         trigger the redirect.
641      * @return string The HTML to display to the user before dying, may contain
642      *         meta refresh, javascript refresh, and may have set header redirects
643      */
644     public function redirect_message($encodedurl, $message, $delay, $debugdisableredirect) {
645         global $CFG;
646         $url = str_replace('&amp;', '&', $encodedurl);
648         switch ($this->page->state) {
649             case moodle_page::STATE_BEFORE_HEADER :
650                 // No output yet it is safe to delivery the full arsenal of redirect methods
651                 if (!$debugdisableredirect) {
652                     // Don't use exactly the same time here, it can cause problems when both redirects fire at the same time.
653                     $this->metarefreshtag = '<meta http-equiv="refresh" content="'. $delay .'; url='. $encodedurl .'" />'."\n";
654                     $this->page->requires->js_function_call('document.location.replace', array($url), false, ($delay + 3));
655                 }
656                 $output = $this->header();
657                 break;
658             case moodle_page::STATE_PRINTING_HEADER :
659                 // We should hopefully never get here
660                 throw new coding_exception('You cannot redirect while printing the page header');
661                 break;
662             case moodle_page::STATE_IN_BODY :
663                 // We really shouldn't be here but we can deal with this
664                 debugging("You should really redirect before you start page output");
665                 if (!$debugdisableredirect) {
666                     $this->page->requires->js_function_call('document.location.replace', array($url), false, $delay);
667                 }
668                 $output = $this->opencontainers->pop_all_but_last();
669                 break;
670             case moodle_page::STATE_DONE :
671                 // Too late to be calling redirect now
672                 throw new coding_exception('You cannot redirect after the entire page has been generated');
673                 break;
674         }
675         $output .= $this->notification($message, 'redirectmessage');
676         $output .= '<div class="continuebutton">(<a href="'. $encodedurl .'">'. get_string('continue') .'</a>)</div>';
677         if ($debugdisableredirect) {
678             $output .= '<p><strong>Error output, so disabling automatic redirect.</strong></p>';
679         }
680         $output .= $this->footer();
681         return $output;
682     }
684     /**
685      * Start output by sending the HTTP headers, and printing the HTML <head>
686      * and the start of the <body>.
687      *
688      * To control what is printed, you should set properties on $PAGE. If you
689      * are familiar with the old {@link print_header()} function from Moodle 1.9
690      * you will find that there are properties on $PAGE that correspond to most
691      * of the old parameters to could be passed to print_header.
692      *
693      * Not that, in due course, the remaining $navigation, $menu parameters here
694      * will be replaced by more properties of $PAGE, but that is still to do.
695      *
696      * @return string HTML that you must output this, preferably immediately.
697      */
698     public function header() {
699         global $USER, $CFG;
701         if (session_is_loggedinas()) {
702             $this->page->add_body_class('userloggedinas');
703         }
705         $this->page->set_state(moodle_page::STATE_PRINTING_HEADER);
707         // Find the appropriate page layout file, based on $this->page->pagelayout.
708         $layoutfile = $this->page->theme->layout_file($this->page->pagelayout);
709         // Render the layout using the layout file.
710         $rendered = $this->render_page_layout($layoutfile);
712         // Slice the rendered output into header and footer.
713         $cutpos = strpos($rendered, $this->unique_main_content_token);
714         if ($cutpos === false) {
715             $cutpos = strpos($rendered, self::MAIN_CONTENT_TOKEN);
716             $token = self::MAIN_CONTENT_TOKEN;
717         } else {
718             $token = $this->unique_main_content_token;
719         }
721         if ($cutpos === false) {
722             throw new coding_exception('page layout file ' . $layoutfile . ' does not contain the main content placeholder, please include "<?php echo $OUTPUT->main_content() ?>" in theme layout file.');
723         }
724         $header = substr($rendered, 0, $cutpos);
725         $footer = substr($rendered, $cutpos + strlen($token));
727         if (empty($this->contenttype)) {
728             debugging('The page layout file did not call $OUTPUT->doctype()');
729             $header = $this->doctype() . $header;
730         }
732         send_headers($this->contenttype, $this->page->cacheable);
734         $this->opencontainers->push('header/footer', $footer);
735         $this->page->set_state(moodle_page::STATE_IN_BODY);
737         return $header . $this->skip_link_target('maincontent');
738     }
740     /**
741      * Renders and outputs the page layout file.
742      *
743      * This is done by preparing the normal globals available to a script, and
744      * then including the layout file provided by the current theme for the
745      * requested layout.
746      *
747      * @param string $layoutfile The name of the layout file
748      * @return string HTML code
749      */
750     protected function render_page_layout($layoutfile) {
751         global $CFG, $SITE, $USER;
752         // The next lines are a bit tricky. The point is, here we are in a method
753         // of a renderer class, and this object may, or may not, be the same as
754         // the global $OUTPUT object. When rendering the page layout file, we want to use
755         // this object. However, people writing Moodle code expect the current
756         // renderer to be called $OUTPUT, not $this, so define a variable called
757         // $OUTPUT pointing at $this. The same comment applies to $PAGE and $COURSE.
758         $OUTPUT = $this;
759         $PAGE = $this->page;
760         $COURSE = $this->page->course;
762         ob_start();
763         include($layoutfile);
764         $rendered = ob_get_contents();
765         ob_end_clean();
766         return $rendered;
767     }
769     /**
770      * Outputs the page's footer
771      *
772      * @return string HTML fragment
773      */
774     public function footer() {
775         global $CFG, $DB;
777         $output = $this->container_end_all(true);
779         $footer = $this->opencontainers->pop('header/footer');
781         if (debugging() and $DB and $DB->is_transaction_started()) {
782             // TODO: MDL-20625 print warning - transaction will be rolled back
783         }
785         // Provide some performance info if required
786         $performanceinfo = '';
787         if (defined('MDL_PERF') || (!empty($CFG->perfdebug) and $CFG->perfdebug > 7)) {
788             $perf = get_performance_info();
789             if (defined('MDL_PERFTOLOG') && !function_exists('register_shutdown_function')) {
790                 error_log("PERF: " . $perf['txt']);
791             }
792             if (defined('MDL_PERFTOFOOT') || debugging() || $CFG->perfdebug > 7) {
793                 $performanceinfo = $perf['html'];
794             }
795         }
796         $footer = str_replace($this->unique_performance_info_token, $performanceinfo, $footer);
798         $footer = str_replace($this->unique_end_html_token, $this->page->requires->get_end_code(), $footer);
800         $this->page->set_state(moodle_page::STATE_DONE);
802         return $output . $footer;
803     }
805     /**
806      * Close all but the last open container. This is useful in places like error
807      * handling, where you want to close all the open containers (apart from <body>)
808      * before outputting the error message.
809      *
810      * @param bool $shouldbenone assert that the stack should be empty now - causes a
811      *      developer debug warning if it isn't.
812      * @return string the HTML required to close any open containers inside <body>.
813      */
814     public function container_end_all($shouldbenone = false) {
815         return $this->opencontainers->pop_all_but_last($shouldbenone);
816     }
818     /**
819      * Returns lang menu or '', this method also checks forcing of languages in courses.
820      *
821      * @return string The lang menu HTML or empty string
822      */
823     public function lang_menu() {
824         global $CFG;
826         if (empty($CFG->langmenu)) {
827             return '';
828         }
830         if ($this->page->course != SITEID and !empty($this->page->course->lang)) {
831             // do not show lang menu if language forced
832             return '';
833         }
835         $currlang = current_language();
836         $langs = get_string_manager()->get_list_of_translations();
838         if (count($langs) < 2) {
839             return '';
840         }
842         $s = new single_select($this->page->url, 'lang', $langs, $currlang, null);
843         $s->label = get_accesshide(get_string('language'));
844         $s->class = 'langmenu';
845         return $this->render($s);
846     }
848     /**
849      * Output the row of editing icons for a block, as defined by the controls array.
850      *
851      * @param array $controls an array like {@link block_contents::$controls}.
852      * @return string HTML fragment.
853      */
854     public function block_controls($controls) {
855         if (empty($controls)) {
856             return '';
857         }
858         $controlshtml = array();
859         foreach ($controls as $control) {
860             $controlshtml[] = html_writer::tag('a',
861                     html_writer::empty_tag('img',  array('src' => $this->pix_url($control['icon'])->out(false), 'alt' => $control['caption'])),
862                     array('class' => 'icon ' . $control['class'],'title' => $control['caption'], 'href' => $control['url']));
863         }
864         return html_writer::tag('div', implode('', $controlshtml), array('class' => 'commands'));
865     }
867     /**
868      * Prints a nice side block with an optional header.
869      *
870      * The content is described
871      * by a {@link core_renderer::block_contents} object.
872      *
873      * <div id="inst{$instanceid}" class="block_{$blockname} block">
874      *      <div class="header"></div>
875      *      <div class="content">
876      *          ...CONTENT...
877      *          <div class="footer">
878      *          </div>
879      *      </div>
880      *      <div class="annotation">
881      *      </div>
882      * </div>
883      *
884      * @param block_contents $bc HTML for the content
885      * @param string $region the region the block is appearing in.
886      * @return string the HTML to be output.
887      */
888     public function block(block_contents $bc, $region) {
889         $bc = clone($bc); // Avoid messing up the object passed in.
890         if (empty($bc->blockinstanceid) || !strip_tags($bc->title)) {
891             $bc->collapsible = block_contents::NOT_HIDEABLE;
892         }
893         if ($bc->collapsible == block_contents::HIDDEN) {
894             $bc->add_class('hidden');
895         }
896         if (!empty($bc->controls)) {
897             $bc->add_class('block_with_controls');
898         }
900         $skiptitle = strip_tags($bc->title);
901         if (empty($skiptitle)) {
902             $output = '';
903             $skipdest = '';
904         } else {
905             $output = html_writer::tag('a', get_string('skipa', 'access', $skiptitle), array('href' => '#sb-' . $bc->skipid, 'class' => 'skip-block'));
906             $skipdest = html_writer::tag('span', '', array('id' => 'sb-' . $bc->skipid, 'class' => 'skip-block-to'));
907         }
909         $output .= html_writer::start_tag('div', $bc->attributes);
911         $output .= $this->block_header($bc);
912         $output .= $this->block_content($bc);
914         $output .= html_writer::end_tag('div');
916         $output .= $this->block_annotation($bc);
918         $output .= $skipdest;
920         $this->init_block_hider_js($bc);
921         return $output;
922     }
924     /**
925      * Produces a header for a block
926      *
927      * @param block_contents $bc
928      * @return string
929      */
930     protected function block_header(block_contents $bc) {
932         $title = '';
933         if ($bc->title) {
934             $title = html_writer::tag('h2', $bc->title, null);
935         }
937         $controlshtml = $this->block_controls($bc->controls);
939         $output = '';
940         if ($title || $controlshtml) {
941             $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'));
942         }
943         return $output;
944     }
946     /**
947      * Produces the content area for a block
948      *
949      * @param block_contents $bc
950      * @return string
951      */
952     protected function block_content(block_contents $bc) {
953         $output = html_writer::start_tag('div', array('class' => 'content'));
954         if (!$bc->title && !$this->block_controls($bc->controls)) {
955             $output .= html_writer::tag('div', '', array('class'=>'block_action notitle'));
956         }
957         $output .= $bc->content;
958         $output .= $this->block_footer($bc);
959         $output .= html_writer::end_tag('div');
961         return $output;
962     }
964     /**
965      * Produces the footer for a block
966      *
967      * @param block_contents $bc
968      * @return string
969      */
970     protected function block_footer(block_contents $bc) {
971         $output = '';
972         if ($bc->footer) {
973             $output .= html_writer::tag('div', $bc->footer, array('class' => 'footer'));
974         }
975         return $output;
976     }
978     /**
979      * Produces the annotation for a block
980      *
981      * @param block_contents $bc
982      * @return string
983      */
984     protected function block_annotation(block_contents $bc) {
985         $output = '';
986         if ($bc->annotation) {
987             $output .= html_writer::tag('div', $bc->annotation, array('class' => 'blockannotation'));
988         }
989         return $output;
990     }
992     /**
993      * Calls the JS require function to hide a block.
994      *
995      * @param block_contents $bc A block_contents object
996      */
997     protected function init_block_hider_js(block_contents $bc) {
998         if (!empty($bc->attributes['id']) and $bc->collapsible != block_contents::NOT_HIDEABLE) {
999             $config = new stdClass;
1000             $config->id = $bc->attributes['id'];
1001             $config->title = strip_tags($bc->title);
1002             $config->preference = 'block' . $bc->blockinstanceid . 'hidden';
1003             $config->tooltipVisible = get_string('hideblocka', 'access', $config->title);
1004             $config->tooltipHidden = get_string('showblocka', 'access', $config->title);
1006             $this->page->requires->js_init_call('M.util.init_block_hider', array($config));
1007             user_preference_allow_ajax_update($config->preference, PARAM_BOOL);
1008         }
1009     }
1011     /**
1012      * Render the contents of a block_list.
1013      *
1014      * @param array $icons the icon for each item.
1015      * @param array $items the content of each item.
1016      * @return string HTML
1017      */
1018     public function list_block_contents($icons, $items) {
1019         $row = 0;
1020         $lis = array();
1021         foreach ($items as $key => $string) {
1022             $item = html_writer::start_tag('li', array('class' => 'r' . $row));
1023             if (!empty($icons[$key])) { //test if the content has an assigned icon
1024                 $item .= html_writer::tag('div', $icons[$key], array('class' => 'icon column c0'));
1025             }
1026             $item .= html_writer::tag('div', $string, array('class' => 'column c1'));
1027             $item .= html_writer::end_tag('li');
1028             $lis[] = $item;
1029             $row = 1 - $row; // Flip even/odd.
1030         }
1031         return html_writer::tag('ul', implode("\n", $lis), array('class' => 'unlist'));
1032     }
1034     /**
1035      * Output all the blocks in a particular region.
1036      *
1037      * @param string $region the name of a region on this page.
1038      * @return string the HTML to be output.
1039      */
1040     public function blocks_for_region($region) {
1041         $blockcontents = $this->page->blocks->get_content_for_region($region, $this);
1043         $output = '';
1044         foreach ($blockcontents as $bc) {
1045             if ($bc instanceof block_contents) {
1046                 $output .= $this->block($bc, $region);
1047             } else if ($bc instanceof block_move_target) {
1048                 $output .= $this->block_move_target($bc);
1049             } else {
1050                 throw new coding_exception('Unexpected type of thing (' . get_class($bc) . ') found in list of block contents.');
1051             }
1052         }
1053         return $output;
1054     }
1056     /**
1057      * Output a place where the block that is currently being moved can be dropped.
1058      *
1059      * @param block_move_target $target with the necessary details.
1060      * @return string the HTML to be output.
1061      */
1062     public function block_move_target($target) {
1063         return html_writer::tag('a', html_writer::tag('span', $target->text, array('class' => 'accesshide')), array('href' => $target->url, 'class' => 'blockmovetarget'));
1064     }
1066     /**
1067      * Renders a special html link with attached action
1068      *
1069      * @param string|moodle_url $url
1070      * @param string $text HTML fragment
1071      * @param component_action $action
1072      * @param array $attributes associative array of html link attributes + disabled
1073      * @return string HTML fragment
1074      */
1075     public function action_link($url, $text, component_action $action = null, array $attributes=null) {
1076         if (!($url instanceof moodle_url)) {
1077             $url = new moodle_url($url);
1078         }
1079         $link = new action_link($url, $text, $action, $attributes);
1081         return $this->render($link);
1082     }
1084     /**
1085      * Renders an action_link object.
1086      *
1087      * The provided link is renderer and the HTML returned. At the same time the
1088      * associated actions are setup in JS by {@link core_renderer::add_action_handler()}
1089      *
1090      * @param action_link $link
1091      * @return string HTML fragment
1092      */
1093     protected function render_action_link(action_link $link) {
1094         global $CFG;
1096         if ($link->text instanceof renderable) {
1097             $text = $this->render($link->text);
1098         } else {
1099             $text = $link->text;
1100         }
1102         // A disabled link is rendered as formatted text
1103         if (!empty($link->attributes['disabled'])) {
1104             // do not use div here due to nesting restriction in xhtml strict
1105             return html_writer::tag('span', $text, array('class'=>'currentlink'));
1106         }
1108         $attributes = $link->attributes;
1109         unset($link->attributes['disabled']);
1110         $attributes['href'] = $link->url;
1112         if ($link->actions) {
1113             if (empty($attributes['id'])) {
1114                 $id = html_writer::random_id('action_link');
1115                 $attributes['id'] = $id;
1116             } else {
1117                 $id = $attributes['id'];
1118             }
1119             foreach ($link->actions as $action) {
1120                 $this->add_action_handler($action, $id);
1121             }
1122         }
1124         return html_writer::tag('a', $text, $attributes);
1125     }
1128     /**
1129      * Renders an action_icon.
1130      *
1131      * This function uses the {@link core_renderer::action_link()} method for the
1132      * most part. What it does different is prepare the icon as HTML and use it
1133      * as the link text.
1134      *
1135      * @param string|moodle_url $url A string URL or moodel_url
1136      * @param pix_icon $pixicon
1137      * @param component_action $action
1138      * @param array $attributes associative array of html link attributes + disabled
1139      * @param bool $linktext show title next to image in link
1140      * @return string HTML fragment
1141      */
1142     public function action_icon($url, pix_icon $pixicon, component_action $action = null, array $attributes = null, $linktext=false) {
1143         if (!($url instanceof moodle_url)) {
1144             $url = new moodle_url($url);
1145         }
1146         $attributes = (array)$attributes;
1148         if (empty($attributes['class'])) {
1149             // let ppl override the class via $options
1150             $attributes['class'] = 'action-icon';
1151         }
1153         $icon = $this->render($pixicon);
1155         if ($linktext) {
1156             $text = $pixicon->attributes['alt'];
1157         } else {
1158             $text = '';
1159         }
1161         return $this->action_link($url, $text.$icon, $action, $attributes);
1162     }
1164    /**
1165     * Print a message along with button choices for Continue/Cancel
1166     *
1167     * If a string or moodle_url is given instead of a single_button, method defaults to post.
1168     *
1169     * @param string $message The question to ask the user
1170     * @param single_button|moodle_url|string $continue The single_button component representing the Continue answer. Can also be a moodle_url or string URL
1171     * @param single_button|moodle_url|string $cancel The single_button component representing the Cancel answer. Can also be a moodle_url or string URL
1172     * @return string HTML fragment
1173     */
1174     public function confirm($message, $continue, $cancel) {
1175         if ($continue instanceof single_button) {
1176             // ok
1177         } else if (is_string($continue)) {
1178             $continue = new single_button(new moodle_url($continue), get_string('continue'), 'post');
1179         } else if ($continue instanceof moodle_url) {
1180             $continue = new single_button($continue, get_string('continue'), 'post');
1181         } else {
1182             throw new coding_exception('The continue param to $OUTPUT->confirm() must be either a URL (string/moodle_url) or a single_button instance.');
1183         }
1185         if ($cancel instanceof single_button) {
1186             // ok
1187         } else if (is_string($cancel)) {
1188             $cancel = new single_button(new moodle_url($cancel), get_string('cancel'), 'get');
1189         } else if ($cancel instanceof moodle_url) {
1190             $cancel = new single_button($cancel, get_string('cancel'), 'get');
1191         } else {
1192             throw new coding_exception('The cancel param to $OUTPUT->confirm() must be either a URL (string/moodle_url) or a single_button instance.');
1193         }
1195         $output = $this->box_start('generalbox', 'notice');
1196         $output .= html_writer::tag('p', $message);
1197         $output .= html_writer::tag('div', $this->render($continue) . $this->render($cancel), array('class' => 'buttons'));
1198         $output .= $this->box_end();
1199         return $output;
1200     }
1202     /**
1203      * Returns a form with a single button.
1204      *
1205      * @param string|moodle_url $url
1206      * @param string $label button text
1207      * @param string $method get or post submit method
1208      * @param array $options associative array {disabled, title, etc.}
1209      * @return string HTML fragment
1210      */
1211     public function single_button($url, $label, $method='post', array $options=null) {
1212         if (!($url instanceof moodle_url)) {
1213             $url = new moodle_url($url);
1214         }
1215         $button = new single_button($url, $label, $method);
1217         foreach ((array)$options as $key=>$value) {
1218             if (array_key_exists($key, $button)) {
1219                 $button->$key = $value;
1220             }
1221         }
1223         return $this->render($button);
1224     }
1226     /**
1227      * Renders a single button widget.
1228      *
1229      * This will return HTML to display a form containing a single button.
1230      *
1231      * @param single_button $button
1232      * @return string HTML fragment
1233      */
1234     protected function render_single_button(single_button $button) {
1235         $attributes = array('type'     => 'submit',
1236                             'value'    => $button->label,
1237                             'disabled' => $button->disabled ? 'disabled' : null,
1238                             'title'    => $button->tooltip);
1240         if ($button->actions) {
1241             $id = html_writer::random_id('single_button');
1242             $attributes['id'] = $id;
1243             foreach ($button->actions as $action) {
1244                 $this->add_action_handler($action, $id);
1245             }
1246         }
1248         // first the input element
1249         $output = html_writer::empty_tag('input', $attributes);
1251         // then hidden fields
1252         $params = $button->url->params();
1253         if ($button->method === 'post') {
1254             $params['sesskey'] = sesskey();
1255         }
1256         foreach ($params as $var => $val) {
1257             $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => $var, 'value' => $val));
1258         }
1260         // then div wrapper for xhtml strictness
1261         $output = html_writer::tag('div', $output);
1263         // now the form itself around it
1264         if ($button->method === 'get') {
1265             $url = $button->url->out_omit_querystring(true); // url without params, the anchor part allowed
1266         } else {
1267             $url = $button->url->out_omit_querystring();     // url without params, the anchor part not allowed
1268         }
1269         if ($url === '') {
1270             $url = '#'; // there has to be always some action
1271         }
1272         $attributes = array('method' => $button->method,
1273                             'action' => $url,
1274                             'id'     => $button->formid);
1275         $output = html_writer::tag('form', $output, $attributes);
1277         // and finally one more wrapper with class
1278         return html_writer::tag('div', $output, array('class' => $button->class));
1279     }
1281     /**
1282      * Returns a form with a single select widget.
1283      *
1284      * @param moodle_url $url form action target, includes hidden fields
1285      * @param string $name name of selection field - the changing parameter in url
1286      * @param array $options list of options
1287      * @param string $selected selected element
1288      * @param array $nothing
1289      * @param string $formid
1290      * @return string HTML fragment
1291      */
1292     public function single_select($url, $name, array $options, $selected = '', $nothing = array('' => 'choosedots'), $formid = null) {
1293         if (!($url instanceof moodle_url)) {
1294             $url = new moodle_url($url);
1295         }
1296         $select = new single_select($url, $name, $options, $selected, $nothing, $formid);
1298         return $this->render($select);
1299     }
1301     /**
1302      * Internal implementation of single_select rendering
1303      *
1304      * @param single_select $select
1305      * @return string HTML fragment
1306      */
1307     protected function render_single_select(single_select $select) {
1308         $select = clone($select);
1309         if (empty($select->formid)) {
1310             $select->formid = html_writer::random_id('single_select_f');
1311         }
1313         $output = '';
1314         $params = $select->url->params();
1315         if ($select->method === 'post') {
1316             $params['sesskey'] = sesskey();
1317         }
1318         foreach ($params as $name=>$value) {
1319             $output .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>$name, 'value'=>$value));
1320         }
1322         if (empty($select->attributes['id'])) {
1323             $select->attributes['id'] = html_writer::random_id('single_select');
1324         }
1326         if ($select->disabled) {
1327             $select->attributes['disabled'] = 'disabled';
1328         }
1330         if ($select->tooltip) {
1331             $select->attributes['title'] = $select->tooltip;
1332         }
1334         if ($select->label) {
1335             $output .= html_writer::label($select->label, $select->attributes['id'], false, $select->labelattributes);
1336         }
1338         if ($select->helpicon instanceof help_icon) {
1339             $output .= $this->render($select->helpicon);
1340         } else if ($select->helpicon instanceof old_help_icon) {
1341             $output .= $this->render($select->helpicon);
1342         }
1343         $output .= html_writer::select($select->options, $select->name, $select->selected, $select->nothing, $select->attributes);
1345         $go = html_writer::empty_tag('input', array('type'=>'submit', 'value'=>get_string('go')));
1346         $output .= html_writer::tag('noscript', html_writer::tag('div', $go), array('style'=>'inline'));
1348         $nothing = empty($select->nothing) ? false : key($select->nothing);
1349         $this->page->requires->js_init_call('M.util.init_select_autosubmit', array($select->formid, $select->attributes['id'], $nothing));
1351         // then div wrapper for xhtml strictness
1352         $output = html_writer::tag('div', $output);
1354         // now the form itself around it
1355         if ($select->method === 'get') {
1356             $url = $select->url->out_omit_querystring(true); // url without params, the anchor part allowed
1357         } else {
1358             $url = $select->url->out_omit_querystring();     // url without params, the anchor part not allowed
1359         }
1360         $formattributes = array('method' => $select->method,
1361                                 'action' => $url,
1362                                 'id'     => $select->formid);
1363         $output = html_writer::tag('form', $output, $formattributes);
1365         // and finally one more wrapper with class
1366         return html_writer::tag('div', $output, array('class' => $select->class));
1367     }
1369     /**
1370      * Returns a form with a url select widget.
1371      *
1372      * @param array $urls list of urls - array('/course/view.php?id=1'=>'Frontpage', ....)
1373      * @param string $selected selected element
1374      * @param array $nothing
1375      * @param string $formid
1376      * @return string HTML fragment
1377      */
1378     public function url_select(array $urls, $selected, $nothing = array('' => 'choosedots'), $formid = null) {
1379         $select = new url_select($urls, $selected, $nothing, $formid);
1380         return $this->render($select);
1381     }
1383     /**
1384      * Internal implementation of url_select rendering
1385      *
1386      * @param url_select $select
1387      * @return string HTML fragment
1388      */
1389     protected function render_url_select(url_select $select) {
1390         global $CFG;
1392         $select = clone($select);
1393         if (empty($select->formid)) {
1394             $select->formid = html_writer::random_id('url_select_f');
1395         }
1397         if (empty($select->attributes['id'])) {
1398             $select->attributes['id'] = html_writer::random_id('url_select');
1399         }
1401         if ($select->disabled) {
1402             $select->attributes['disabled'] = 'disabled';
1403         }
1405         if ($select->tooltip) {
1406             $select->attributes['title'] = $select->tooltip;
1407         }
1409         $output = '';
1411         if ($select->label) {
1412             $output .= html_writer::label($select->label, $select->attributes['id'], false, $select->labelattributes);
1413         }
1415         if ($select->helpicon instanceof help_icon) {
1416             $output .= $this->render($select->helpicon);
1417         } else if ($select->helpicon instanceof old_help_icon) {
1418             $output .= $this->render($select->helpicon);
1419         }
1421         // For security reasons, the script course/jumpto.php requires URL starting with '/'. To keep
1422         // backward compatibility, we are removing heading $CFG->wwwroot from URLs here.
1423         $urls = array();
1424         foreach ($select->urls as $k=>$v) {
1425             if (is_array($v)) {
1426                 // optgroup structure
1427                 foreach ($v as $optgrouptitle => $optgroupoptions) {
1428                     foreach ($optgroupoptions as $optionurl => $optiontitle) {
1429                         if (empty($optionurl)) {
1430                             $safeoptionurl = '';
1431                         } else if (strpos($optionurl, $CFG->wwwroot.'/') === 0) {
1432                             // debugging('URLs passed to url_select should be in local relative form - please fix the code.', DEBUG_DEVELOPER);
1433                             $safeoptionurl = str_replace($CFG->wwwroot, '', $optionurl);
1434                         } else if (strpos($optionurl, '/') !== 0) {
1435                             debugging("Invalid url_select urls parameter inside optgroup: url '$optionurl' is not local relative url!");
1436                             continue;
1437                         } else {
1438                             $safeoptionurl = $optionurl;
1439                         }
1440                         $urls[$k][$optgrouptitle][$safeoptionurl] = $optiontitle;
1441                     }
1442                 }
1443             } else {
1444                 // plain list structure
1445                 if (empty($k)) {
1446                     // nothing selected option
1447                 } else if (strpos($k, $CFG->wwwroot.'/') === 0) {
1448                     $k = str_replace($CFG->wwwroot, '', $k);
1449                 } else if (strpos($k, '/') !== 0) {
1450                     debugging("Invalid url_select urls parameter: url '$k' is not local relative url!");
1451                     continue;
1452                 }
1453                 $urls[$k] = $v;
1454             }
1455         }
1456         $selected = $select->selected;
1457         if (!empty($selected)) {
1458             if (strpos($select->selected, $CFG->wwwroot.'/') === 0) {
1459                 $selected = str_replace($CFG->wwwroot, '', $selected);
1460             } else if (strpos($selected, '/') !== 0) {
1461                 debugging("Invalid value of parameter 'selected': url '$selected' is not local relative url!");
1462             }
1463         }
1465         $output .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'sesskey', 'value'=>sesskey()));
1466         $output .= html_writer::select($urls, 'jump', $selected, $select->nothing, $select->attributes);
1468         if (!$select->showbutton) {
1469             $go = html_writer::empty_tag('input', array('type'=>'submit', 'value'=>get_string('go')));
1470             $output .= html_writer::tag('noscript', html_writer::tag('div', $go), array('style'=>'inline'));
1471             $nothing = empty($select->nothing) ? false : key($select->nothing);
1472             $output .= $this->page->requires->js_init_call('M.util.init_url_select', array($select->formid, $select->attributes['id'], $nothing));
1473         } else {
1474             $output .= html_writer::empty_tag('input', array('type'=>'submit', 'value'=>$select->showbutton));
1475         }
1477         // then div wrapper for xhtml strictness
1478         $output = html_writer::tag('div', $output);
1480         // now the form itself around it
1481         $formattributes = array('method' => 'post',
1482                                 'action' => new moodle_url('/course/jumpto.php'),
1483                                 'id'     => $select->formid);
1484         $output = html_writer::tag('form', $output, $formattributes);
1486         // and finally one more wrapper with class
1487         return html_writer::tag('div', $output, array('class' => $select->class));
1488     }
1490     /**
1491      * Returns a string containing a link to the user documentation.
1492      * Also contains an icon by default. Shown to teachers and admin only.
1493      *
1494      * @param string $path The page link after doc root and language, no leading slash.
1495      * @param string $text The text to be displayed for the link
1496      * @return string
1497      */
1498     public function doc_link($path, $text = '') {
1499         global $CFG;
1501         $icon = $this->pix_icon('docs', $text, 'moodle', array('class'=>'iconhelp'));
1503         $url = new moodle_url(get_docs_url($path));
1505         $attributes = array('href'=>$url);
1506         if (!empty($CFG->doctonewwindow)) {
1507             $attributes['id'] = $this->add_action_handler(new popup_action('click', $url));
1508         }
1510         return html_writer::tag('a', $icon.$text, $attributes);
1511     }
1513     /**
1514      * Return HTML for a pix_icon.
1515      *
1516      * @param string $pix short pix name
1517      * @param string $alt mandatory alt attribute
1518      * @param string $component standard compoennt name like 'moodle', 'mod_forum', etc.
1519      * @param array $attributes htm lattributes
1520      * @return string HTML fragment
1521      */
1522     public function pix_icon($pix, $alt, $component='moodle', array $attributes = null) {
1523         $icon = new pix_icon($pix, $alt, $component, $attributes);
1524         return $this->render($icon);
1525     }
1527     /**
1528      * Renders a pix_icon widget and returns the HTML to display it.
1529      *
1530      * @param pix_icon $icon
1531      * @return string HTML fragment
1532      */
1533     protected function render_pix_icon(pix_icon $icon) {
1534         $attributes = $icon->attributes;
1535         $attributes['src'] = $this->pix_url($icon->pix, $icon->component);
1536         return html_writer::empty_tag('img', $attributes);
1537     }
1539     /**
1540      * Return HTML to display an emoticon icon.
1541      *
1542      * @param pix_emoticon $emoticon
1543      * @return string HTML fragment
1544      */
1545     protected function render_pix_emoticon(pix_emoticon $emoticon) {
1546         $attributes = $emoticon->attributes;
1547         $attributes['src'] = $this->pix_url($emoticon->pix, $emoticon->component);
1548         return html_writer::empty_tag('img', $attributes);
1549     }
1551     /**
1552      * Produces the html that represents this rating in the UI
1553      *
1554      * @param rating $rating the page object on which this rating will appear
1555      * @return string
1556      */
1557     function render_rating(rating $rating) {
1558         global $CFG, $USER;
1560         if ($rating->settings->aggregationmethod == RATING_AGGREGATE_NONE) {
1561             return null;//ratings are turned off
1562         }
1564         $ratingmanager = new rating_manager();
1565         // Initialise the JavaScript so ratings can be done by AJAX.
1566         $ratingmanager->initialise_rating_javascript($this->page);
1568         $strrate = get_string("rate", "rating");
1569         $ratinghtml = ''; //the string we'll return
1571         // permissions check - can they view the aggregate?
1572         if ($rating->user_can_view_aggregate()) {
1574             $aggregatelabel = $ratingmanager->get_aggregate_label($rating->settings->aggregationmethod);
1575             $aggregatestr   = $rating->get_aggregate_string();
1577             $aggregatehtml  = html_writer::tag('span', $aggregatestr, array('id' => 'ratingaggregate'.$rating->itemid, 'class' => 'ratingaggregate')).' ';
1578             if ($rating->count > 0) {
1579                 $countstr = "({$rating->count})";
1580             } else {
1581                 $countstr = '-';
1582             }
1583             $aggregatehtml .= html_writer::tag('span', $countstr, array('id'=>"ratingcount{$rating->itemid}", 'class' => 'ratingcount')).' ';
1585             $ratinghtml .= html_writer::tag('span', $aggregatelabel, array('class'=>'rating-aggregate-label'));
1586             if ($rating->settings->permissions->viewall && $rating->settings->pluginpermissions->viewall) {
1588                 $nonpopuplink = $rating->get_view_ratings_url();
1589                 $popuplink = $rating->get_view_ratings_url(true);
1591                 $action = new popup_action('click', $popuplink, 'ratings', array('height' => 400, 'width' => 600));
1592                 $ratinghtml .= $this->action_link($nonpopuplink, $aggregatehtml, $action);
1593             } else {
1594                 $ratinghtml .= $aggregatehtml;
1595             }
1596         }
1598         $formstart = null;
1599         // if the item doesn't belong to the current user, the user has permission to rate
1600         // and we're within the assessable period
1601         if ($rating->user_can_rate()) {
1603             $rateurl = $rating->get_rate_url();
1604             $inputs = $rateurl->params();
1606             //start the rating form
1607             $formattrs = array(
1608                 'id'     => "postrating{$rating->itemid}",
1609                 'class'  => 'postratingform',
1610                 'method' => 'post',
1611                 'action' => $rateurl->out_omit_querystring()
1612             );
1613             $formstart  = html_writer::start_tag('form', $formattrs);
1614             $formstart .= html_writer::start_tag('div', array('class' => 'ratingform'));
1616             // add the hidden inputs
1617             foreach ($inputs as $name => $value) {
1618                 $attributes = array('type' => 'hidden', 'class' => 'ratinginput', 'name' => $name, 'value' => $value);
1619                 $formstart .= html_writer::empty_tag('input', $attributes);
1620             }
1622             if (empty($ratinghtml)) {
1623                 $ratinghtml .= $strrate.': ';
1624             }
1625             $ratinghtml = $formstart.$ratinghtml;
1627             $scalearray = array(RATING_UNSET_RATING => $strrate.'...') + $rating->settings->scale->scaleitems;
1628             $scaleattrs = array('class'=>'postratingmenu ratinginput','id'=>'menurating'.$rating->itemid);
1629             $ratinghtml .= html_writer::label($rating->rating, 'menurating'.$rating->itemid, false, array('class' => 'accesshide'));
1630             $ratinghtml .= html_writer::select($scalearray, 'rating', $rating->rating, false, $scaleattrs);
1632             //output submit button
1633             $ratinghtml .= html_writer::start_tag('span', array('class'=>"ratingsubmit"));
1635             $attributes = array('type' => 'submit', 'class' => 'postratingmenusubmit', 'id' => 'postratingsubmit'.$rating->itemid, 'value' => s(get_string('rate', 'rating')));
1636             $ratinghtml .= html_writer::empty_tag('input', $attributes);
1638             if (!$rating->settings->scale->isnumeric) {
1639                 $ratinghtml .= $this->help_icon_scale($rating->settings->scale->courseid, $rating->settings->scale);
1640             }
1641             $ratinghtml .= html_writer::end_tag('span');
1642             $ratinghtml .= html_writer::end_tag('div');
1643             $ratinghtml .= html_writer::end_tag('form');
1644         }
1646         return $ratinghtml;
1647     }
1649     /**
1650      * Centered heading with attached help button (same title text)
1651      * and optional icon attached.
1652      *
1653      * @param string $text A heading text
1654      * @param string $helpidentifier The keyword that defines a help page
1655      * @param string $component component name
1656      * @param string|moodle_url $icon
1657      * @param string $iconalt icon alt text
1658      * @return string HTML fragment
1659      */
1660     public function heading_with_help($text, $helpidentifier, $component = 'moodle', $icon = '', $iconalt = '') {
1661         $image = '';
1662         if ($icon) {
1663             $image = $this->pix_icon($icon, $iconalt, $component, array('class'=>'icon'));
1664         }
1666         $help = '';
1667         if ($helpidentifier) {
1668             $help = $this->help_icon($helpidentifier, $component);
1669         }
1671         return $this->heading($image.$text.$help, 2, 'main help');
1672     }
1674     /**
1675      * Returns HTML to display a help icon.
1676      *
1677      * @deprecated since Moodle 2.0
1678      * @param string $helpidentifier The keyword that defines a help page
1679      * @param string $title A descriptive text for accessibility only
1680      * @param string $component component name
1681      * @param string|bool $linktext true means use $title as link text, string means link text value
1682      * @return string HTML fragment
1683      */
1684     public function old_help_icon($helpidentifier, $title, $component = 'moodle', $linktext = '') {
1685         debugging('The method old_help_icon() is deprecated, please fix the code and use help_icon() method instead', DEBUG_DEVELOPER);
1686         $icon = new old_help_icon($helpidentifier, $title, $component);
1687         if ($linktext === true) {
1688             $icon->linktext = $title;
1689         } else if (!empty($linktext)) {
1690             $icon->linktext = $linktext;
1691         }
1692         return $this->render($icon);
1693     }
1695     /**
1696      * Implementation of user image rendering.
1697      *
1698      * @param old_help_icon $helpicon A help icon instance
1699      * @return string HTML fragment
1700      */
1701     protected function render_old_help_icon(old_help_icon $helpicon) {
1702         global $CFG;
1704         // first get the help image icon
1705         $src = $this->pix_url('help');
1707         if (empty($helpicon->linktext)) {
1708             $alt = $helpicon->title;
1709         } else {
1710             $alt = get_string('helpwiththis');
1711         }
1713         $attributes = array('src'=>$src, 'alt'=>$alt, 'class'=>'iconhelp');
1714         $output = html_writer::empty_tag('img', $attributes);
1716         // add the link text if given
1717         if (!empty($helpicon->linktext)) {
1718             // the spacing has to be done through CSS
1719             $output .= $helpicon->linktext;
1720         }
1722         // now create the link around it - we need https on loginhttps pages
1723         $url = new moodle_url($CFG->httpswwwroot.'/help.php', array('component' => $helpicon->component, 'identifier' => $helpicon->helpidentifier, 'lang'=>current_language()));
1725         // note: this title is displayed only if JS is disabled, otherwise the link will have the new ajax tooltip
1726         $title = get_string('helpprefix2', '', trim($helpicon->title, ". \t"));
1728         $attributes = array('href'=>$url, 'title'=>$title);
1729         $id = html_writer::random_id('helpicon');
1730         $attributes['id'] = $id;
1731         $output = html_writer::tag('a', $output, $attributes);
1733         $this->page->requires->js_init_call('M.util.help_icon.add', array(array('id'=>$id, 'url'=>$url->out(false))));
1735         // and finally span
1736         return html_writer::tag('span', $output, array('class' => 'helplink'));
1737     }
1739     /**
1740      * Returns HTML to display a help icon.
1741      *
1742      * @param string $identifier The keyword that defines a help page
1743      * @param string $component component name
1744      * @param string|bool $linktext true means use $title as link text, string means link text value
1745      * @return string HTML fragment
1746      */
1747     public function help_icon($identifier, $component = 'moodle', $linktext = '') {
1748         $icon = new help_icon($identifier, $component);
1749         $icon->diag_strings();
1750         if ($linktext === true) {
1751             $icon->linktext = get_string($icon->identifier, $icon->component);
1752         } else if (!empty($linktext)) {
1753             $icon->linktext = $linktext;
1754         }
1755         return $this->render($icon);
1756     }
1758     /**
1759      * Implementation of user image rendering.
1760      *
1761      * @param help_icon $helpicon A help icon instance
1762      * @return string HTML fragment
1763      */
1764     protected function render_help_icon(help_icon $helpicon) {
1765         global $CFG;
1767         // first get the help image icon
1768         $src = $this->pix_url('help');
1770         $title = get_string($helpicon->identifier, $helpicon->component);
1772         if (empty($helpicon->linktext)) {
1773             $alt = get_string('helpprefix2', '', trim($title, ". \t"));
1774         } else {
1775             $alt = get_string('helpwiththis');
1776         }
1778         $attributes = array('src'=>$src, 'alt'=>$alt, 'class'=>'iconhelp');
1779         $output = html_writer::empty_tag('img', $attributes);
1781         // add the link text if given
1782         if (!empty($helpicon->linktext)) {
1783             // the spacing has to be done through CSS
1784             $output .= $helpicon->linktext;
1785         }
1787         // now create the link around it - we need https on loginhttps pages
1788         $url = new moodle_url($CFG->httpswwwroot.'/help.php', array('component' => $helpicon->component, 'identifier' => $helpicon->identifier, 'lang'=>current_language()));
1790         // note: this title is displayed only if JS is disabled, otherwise the link will have the new ajax tooltip
1791         $title = get_string('helpprefix2', '', trim($title, ". \t"));
1793         $attributes = array('href'=>$url, 'title'=>$title);
1794         $id = html_writer::random_id('helpicon');
1795         $attributes['id'] = $id;
1796         $output = html_writer::tag('a', $output, $attributes);
1798         $this->page->requires->js_init_call('M.util.help_icon.add', array(array('id'=>$id, 'url'=>$url->out(false))));
1800         // and finally span
1801         return html_writer::tag('span', $output, array('class' => 'helplink'));
1802     }
1804     /**
1805      * Returns HTML to display a scale help icon.
1806      *
1807      * @param int $courseid
1808      * @param stdClass $scale instance
1809      * @return string HTML fragment
1810      */
1811     public function help_icon_scale($courseid, stdClass $scale) {
1812         global $CFG;
1814         $title = get_string('helpprefix2', '', $scale->name) .' ('.get_string('newwindow').')';
1816         $icon = $this->pix_icon('help', get_string('scales'), 'moodle', array('class'=>'iconhelp'));
1818         $scaleid = abs($scale->id);
1820         $link = new moodle_url('/course/scales.php', array('id' => $courseid, 'list' => true, 'scaleid' => $scaleid));
1821         $action = new popup_action('click', $link, 'ratingscale');
1823         return html_writer::tag('span', $this->action_link($link, $icon, $action), array('class' => 'helplink'));
1824     }
1826     /**
1827      * Creates and returns a spacer image with optional line break.
1828      *
1829      * @param array $attributes Any HTML attributes to add to the spaced.
1830      * @param bool $br Include a BR after the spacer.... DON'T USE THIS. Don't be
1831      *     laxy do it with CSS which is a much better solution.
1832      * @return string HTML fragment
1833      */
1834     public function spacer(array $attributes = null, $br = false) {
1835         $attributes = (array)$attributes;
1836         if (empty($attributes['width'])) {
1837             $attributes['width'] = 1;
1838         }
1839         if (empty($attributes['height'])) {
1840             $attributes['height'] = 1;
1841         }
1842         $attributes['class'] = 'spacer';
1844         $output = $this->pix_icon('spacer', '', 'moodle', $attributes);
1846         if (!empty($br)) {
1847             $output .= '<br />';
1848         }
1850         return $output;
1851     }
1853     /**
1854      * Returns HTML to display the specified user's avatar.
1855      *
1856      * User avatar may be obtained in two ways:
1857      * <pre>
1858      * // Option 1: (shortcut for simple cases, preferred way)
1859      * // $user has come from the DB and has fields id, picture, imagealt, firstname and lastname
1860      * $OUTPUT->user_picture($user, array('popup'=>true));
1861      *
1862      * // Option 2:
1863      * $userpic = new user_picture($user);
1864      * // Set properties of $userpic
1865      * $userpic->popup = true;
1866      * $OUTPUT->render($userpic);
1867      * </pre>
1868      *
1869      * @param stdClass $user Object with at least fields id, picture, imagealt, firstname, lastname
1870      *     If any of these are missing, the database is queried. Avoid this
1871      *     if at all possible, particularly for reports. It is very bad for performance.
1872      * @param array $options associative array with user picture options, used only if not a user_picture object,
1873      *     options are:
1874      *     - courseid=$this->page->course->id (course id of user profile in link)
1875      *     - size=35 (size of image)
1876      *     - link=true (make image clickable - the link leads to user profile)
1877      *     - popup=false (open in popup)
1878      *     - alttext=true (add image alt attribute)
1879      *     - class = image class attribute (default 'userpicture')
1880      * @return string HTML fragment
1881      */
1882     public function user_picture(stdClass $user, array $options = null) {
1883         $userpicture = new user_picture($user);
1884         foreach ((array)$options as $key=>$value) {
1885             if (array_key_exists($key, $userpicture)) {
1886                 $userpicture->$key = $value;
1887             }
1888         }
1889         return $this->render($userpicture);
1890     }
1892     /**
1893      * Internal implementation of user image rendering.
1894      *
1895      * @param user_picture $userpicture
1896      * @return string
1897      */
1898     protected function render_user_picture(user_picture $userpicture) {
1899         global $CFG, $DB;
1901         $user = $userpicture->user;
1903         if ($userpicture->alttext) {
1904             if (!empty($user->imagealt)) {
1905                 $alt = $user->imagealt;
1906             } else {
1907                 $alt = get_string('pictureof', '', fullname($user));
1908             }
1909         } else {
1910             $alt = '';
1911         }
1913         if (empty($userpicture->size)) {
1914             $size = 35;
1915         } else if ($userpicture->size === true or $userpicture->size == 1) {
1916             $size = 100;
1917         } else {
1918             $size = $userpicture->size;
1919         }
1921         $class = $userpicture->class;
1923         if ($user->picture == 0) {
1924             $class .= ' defaultuserpic';
1925         }
1927         $src = $userpicture->get_url($this->page, $this);
1929         $attributes = array('src'=>$src, 'alt'=>$alt, 'title'=>$alt, 'class'=>$class, 'width'=>$size, 'height'=>$size);
1931         // get the image html output fisrt
1932         $output = html_writer::empty_tag('img', $attributes);;
1934         // then wrap it in link if needed
1935         if (!$userpicture->link) {
1936             return $output;
1937         }
1939         if (empty($userpicture->courseid)) {
1940             $courseid = $this->page->course->id;
1941         } else {
1942             $courseid = $userpicture->courseid;
1943         }
1945         if ($courseid == SITEID) {
1946             $url = new moodle_url('/user/profile.php', array('id' => $user->id));
1947         } else {
1948             $url = new moodle_url('/user/view.php', array('id' => $user->id, 'course' => $courseid));
1949         }
1951         $attributes = array('href'=>$url);
1953         if ($userpicture->popup) {
1954             $id = html_writer::random_id('userpicture');
1955             $attributes['id'] = $id;
1956             $this->add_action_handler(new popup_action('click', $url), $id);
1957         }
1959         return html_writer::tag('a', $output, $attributes);
1960     }
1962     /**
1963      * Internal implementation of file tree viewer items rendering.
1964      *
1965      * @param array $dir
1966      * @return string
1967      */
1968     public function htmllize_file_tree($dir) {
1969         if (empty($dir['subdirs']) and empty($dir['files'])) {
1970             return '';
1971         }
1972         $result = '<ul>';
1973         foreach ($dir['subdirs'] as $subdir) {
1974             $result .= '<li>'.s($subdir['dirname']).' '.$this->htmllize_file_tree($subdir).'</li>';
1975         }
1976         foreach ($dir['files'] as $file) {
1977             $filename = $file->get_filename();
1978             $result .= '<li><span>'.html_writer::link($file->fileurl, $filename).'</span></li>';
1979         }
1980         $result .= '</ul>';
1982         return $result;
1983     }
1985     /**
1986      * Returns HTML to display the file picker
1987      *
1988      * <pre>
1989      * $OUTPUT->file_picker($options);
1990      * </pre>
1991      *
1992      * @param array $options associative array with file manager options
1993      *   options are:
1994      *       maxbytes=>-1,
1995      *       itemid=>0,
1996      *       client_id=>uniqid(),
1997      *       acepted_types=>'*',
1998      *       return_types=>FILE_INTERNAL,
1999      *       context=>$PAGE->context
2000      * @return string HTML fragment
2001      */
2002     public function file_picker($options) {
2003         $fp = new file_picker($options);
2004         return $this->render($fp);
2005     }
2007     /**
2008      * Internal implementation of file picker rendering.
2009      *
2010      * @param file_picker $fp
2011      * @return string
2012      */
2013     public function render_file_picker(file_picker $fp) {
2014         global $CFG, $OUTPUT, $USER;
2015         $options = $fp->options;
2016         $client_id = $options->client_id;
2017         $strsaved = get_string('filesaved', 'repository');
2018         $straddfile = get_string('openpicker', 'repository');
2019         $strloading  = get_string('loading', 'repository');
2020         $strdndenabled = get_string('dndenabled_inbox', 'moodle');
2021         $strdroptoupload = get_string('droptoupload', 'moodle');
2022         $icon_progress = $OUTPUT->pix_icon('i/loading_small', $strloading).'';
2024         $currentfile = $options->currentfile;
2025         if (empty($currentfile)) {
2026             $currentfile = '';
2027         } else {
2028             $currentfile .= ' - ';
2029         }
2030         if ($options->maxbytes) {
2031             $size = $options->maxbytes;
2032         } else {
2033             $size = get_max_upload_file_size();
2034         }
2035         if ($size == -1) {
2036             $maxsize = '';
2037         } else {
2038             $maxsize = get_string('maxfilesize', 'moodle', display_size($size));
2039         }
2040         if ($options->buttonname) {
2041             $buttonname = ' name="' . $options->buttonname . '"';
2042         } else {
2043             $buttonname = '';
2044         }
2045         $html = <<<EOD
2046 <div class="filemanager-loading mdl-align" id='filepicker-loading-{$client_id}'>
2047 $icon_progress
2048 </div>
2049 <div id="filepicker-wrapper-{$client_id}" class="mdl-left" style="display:none">
2050     <div>
2051         <input type="button" class="fp-btn-choose" id="filepicker-button-{$client_id}" value="{$straddfile}"{$buttonname}/>
2052         <span> $maxsize </span>
2053     </div>
2054 EOD;
2055         if ($options->env != 'url') {
2056             $html .= <<<EOD
2057     <div id="file_info_{$client_id}" class="mdl-left filepicker-filelist" style="position: relative">
2058     <div class="filepicker-filename">
2059         <div class="filepicker-container">$currentfile<span class="dndupload-message">$strdndenabled <br/><span class="dndupload-arrow"></span></span></div>
2060     </div>
2061     <div><div class="dndupload-target">{$strdroptoupload}<br/><span class="dndupload-arrow"></span></div></div>
2062     </div>
2063 EOD;
2064         }
2065         $html .= '</div>';
2066         return $html;
2067     }
2069     /**
2070      * Returns HTML to display the 'Update this Modulename' button that appears on module pages.
2071      *
2072      * @param string $cmid the course_module id.
2073      * @param string $modulename the module name, eg. "forum", "quiz" or "workshop"
2074      * @return string the HTML for the button, if this user has permission to edit it, else an empty string.
2075      */
2076     public function update_module_button($cmid, $modulename) {
2077         global $CFG;
2078         if (has_capability('moodle/course:manageactivities', context_module::instance($cmid))) {
2079             $modulename = get_string('modulename', $modulename);
2080             $string = get_string('updatethis', '', $modulename);
2081             $url = new moodle_url("$CFG->wwwroot/course/mod.php", array('update' => $cmid, 'return' => true, 'sesskey' => sesskey()));
2082             return $this->single_button($url, $string);
2083         } else {
2084             return '';
2085         }
2086     }
2088     /**
2089      * Returns HTML to display a "Turn editing on/off" button in a form.
2090      *
2091      * @param moodle_url $url The URL + params to send through when clicking the button
2092      * @return string HTML the button
2093      */
2094     public function edit_button(moodle_url $url) {
2096         $url->param('sesskey', sesskey());
2097         if ($this->page->user_is_editing()) {
2098             $url->param('edit', 'off');
2099             $editstring = get_string('turneditingoff');
2100         } else {
2101             $url->param('edit', 'on');
2102             $editstring = get_string('turneditingon');
2103         }
2105         return $this->single_button($url, $editstring);
2106     }
2108     /**
2109      * Returns HTML to display a simple button to close a window
2110      *
2111      * @param string $text The lang string for the button's label (already output from get_string())
2112      * @return string html fragment
2113      */
2114     public function close_window_button($text='') {
2115         if (empty($text)) {
2116             $text = get_string('closewindow');
2117         }
2118         $button = new single_button(new moodle_url('#'), $text, 'get');
2119         $button->add_action(new component_action('click', 'close_window'));
2121         return $this->container($this->render($button), 'closewindow');
2122     }
2124     /**
2125      * Output an error message. By default wraps the error message in <span class="error">.
2126      * If the error message is blank, nothing is output.
2127      *
2128      * @param string $message the error message.
2129      * @return string the HTML to output.
2130      */
2131     public function error_text($message) {
2132         if (empty($message)) {
2133             return '';
2134         }
2135         return html_writer::tag('span', $message, array('class' => 'error'));
2136     }
2138     /**
2139      * Do not call this function directly.
2140      *
2141      * To terminate the current script with a fatal error, call the {@link print_error}
2142      * function, or throw an exception. Doing either of those things will then call this
2143      * function to display the error, before terminating the execution.
2144      *
2145      * @param string $message The message to output
2146      * @param string $moreinfourl URL where more info can be found about the error
2147      * @param string $link Link for the Continue button
2148      * @param array $backtrace The execution backtrace
2149      * @param string $debuginfo Debugging information
2150      * @return string the HTML to output.
2151      */
2152     public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
2153         global $CFG;
2155         $output = '';
2156         $obbuffer = '';
2158         if ($this->has_started()) {
2159             // we can not always recover properly here, we have problems with output buffering,
2160             // html tables, etc.
2161             $output .= $this->opencontainers->pop_all_but_last();
2163         } else {
2164             // It is really bad if library code throws exception when output buffering is on,
2165             // because the buffered text would be printed before our start of page.
2166             // NOTE: this hack might be behave unexpectedly in case output buffering is enabled in PHP.ini
2167             error_reporting(0); // disable notices from gzip compression, etc.
2168             while (ob_get_level() > 0) {
2169                 $buff = ob_get_clean();
2170                 if ($buff === false) {
2171                     break;
2172                 }
2173                 $obbuffer .= $buff;
2174             }
2175             error_reporting($CFG->debug);
2177             // Header not yet printed
2178             if (isset($_SERVER['SERVER_PROTOCOL'])) {
2179                 // server protocol should be always present, because this render
2180                 // can not be used from command line or when outputting custom XML
2181                 @header($_SERVER['SERVER_PROTOCOL'] . ' 404 Not Found');
2182             }
2183             $this->page->set_context(null); // ugly hack - make sure page context is set to something, we do not want bogus warnings here
2184             $this->page->set_url('/'); // no url
2185             //$this->page->set_pagelayout('base'); //TODO: MDL-20676 blocks on error pages are weird, unfortunately it somehow detect the pagelayout from URL :-(
2186             $this->page->set_title(get_string('error'));
2187             $this->page->set_heading($this->page->course->fullname);
2188             $output .= $this->header();
2189         }
2191         $message = '<p class="errormessage">' . $message . '</p>'.
2192                 '<p class="errorcode"><a href="' . $moreinfourl . '">' .
2193                 get_string('moreinformation') . '</a></p>';
2194         if (empty($CFG->rolesactive)) {
2195             $message .= '<p class="errormessage">' . get_string('installproblem', 'error') . '</p>';
2196             //It is usually not possible to recover from errors triggered during installation, you may need to create a new database or use a different database prefix for new installation.
2197         }
2198         $output .= $this->box($message, 'errorbox');
2200         if (debugging('', DEBUG_DEVELOPER)) {
2201             if (!empty($debuginfo)) {
2202                 $debuginfo = s($debuginfo); // removes all nasty JS
2203                 $debuginfo = str_replace("\n", '<br />', $debuginfo); // keep newlines
2204                 $output .= $this->notification('<strong>Debug info:</strong> '.$debuginfo, 'notifytiny');
2205             }
2206             if (!empty($backtrace)) {
2207                 $output .= $this->notification('<strong>Stack trace:</strong> '.format_backtrace($backtrace), 'notifytiny');
2208             }
2209             if ($obbuffer !== '' ) {
2210                 $output .= $this->notification('<strong>Output buffer:</strong> '.s($obbuffer), 'notifytiny');
2211             }
2212         }
2214         if (empty($CFG->rolesactive)) {
2215             // continue does not make much sense if moodle is not installed yet because error is most probably not recoverable
2216         } else if (!empty($link)) {
2217             $output .= $this->continue_button($link);
2218         }
2220         $output .= $this->footer();
2222         // Padding to encourage IE to display our error page, rather than its own.
2223         $output .= str_repeat(' ', 512);
2225         return $output;
2226     }
2228     /**
2229      * Output a notification (that is, a status message about something that has
2230      * just happened).
2231      *
2232      * @param string $message the message to print out
2233      * @param string $classes normally 'notifyproblem' or 'notifysuccess'.
2234      * @return string the HTML to output.
2235      */
2236     public function notification($message, $classes = 'notifyproblem') {
2237         return html_writer::tag('div', clean_text($message), array('class' => renderer_base::prepare_classes($classes)));
2238     }
2240     /**
2241      * Returns HTML to display a continue button that goes to a particular URL.
2242      *
2243      * @param string|moodle_url $url The url the button goes to.
2244      * @return string the HTML to output.
2245      */
2246     public function continue_button($url) {
2247         if (!($url instanceof moodle_url)) {
2248             $url = new moodle_url($url);
2249         }
2250         $button = new single_button($url, get_string('continue'), 'get');
2251         $button->class = 'continuebutton';
2253         return $this->render($button);
2254     }
2256     /**
2257      * Returns HTML to display a single paging bar to provide access to other pages  (usually in a search)
2258      *
2259      * @param int $totalcount The total number of entries available to be paged through
2260      * @param int $page The page you are currently viewing
2261      * @param int $perpage The number of entries that should be shown per page
2262      * @param string|moodle_url $baseurl url of the current page, the $pagevar parameter is added
2263      * @param string $pagevar name of page parameter that holds the page number
2264      * @return string the HTML to output.
2265      */
2266     public function paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar = 'page') {
2267         $pb = new paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar);
2268         return $this->render($pb);
2269     }
2271     /**
2272      * Internal implementation of paging bar rendering.
2273      *
2274      * @param paging_bar $pagingbar
2275      * @return string
2276      */
2277     protected function render_paging_bar(paging_bar $pagingbar) {
2278         $output = '';
2279         $pagingbar = clone($pagingbar);
2280         $pagingbar->prepare($this, $this->page, $this->target);
2282         if ($pagingbar->totalcount > $pagingbar->perpage) {
2283             $output .= get_string('page') . ':';
2285             if (!empty($pagingbar->previouslink)) {
2286                 $output .= '&#160;(' . $pagingbar->previouslink . ')&#160;';
2287             }
2289             if (!empty($pagingbar->firstlink)) {
2290                 $output .= '&#160;' . $pagingbar->firstlink . '&#160;...';
2291             }
2293             foreach ($pagingbar->pagelinks as $link) {
2294                 $output .= "&#160;&#160;$link";
2295             }
2297             if (!empty($pagingbar->lastlink)) {
2298                 $output .= '&#160;...' . $pagingbar->lastlink . '&#160;';
2299             }
2301             if (!empty($pagingbar->nextlink)) {
2302                 $output .= '&#160;&#160;(' . $pagingbar->nextlink . ')';
2303             }
2304         }
2306         return html_writer::tag('div', $output, array('class' => 'paging'));
2307     }
2309     /**
2310      * Output the place a skip link goes to.
2311      *
2312      * @param string $id The target name from the corresponding $PAGE->requires->skip_link_to($target) call.
2313      * @return string the HTML to output.
2314      */
2315     public function skip_link_target($id = null) {
2316         return html_writer::tag('span', '', array('id' => $id));
2317     }
2319     /**
2320      * Outputs a heading
2321      *
2322      * @param string $text The text of the heading
2323      * @param int $level The level of importance of the heading. Defaulting to 2
2324      * @param string $classes A space-separated list of CSS classes
2325      * @param string $id An optional ID
2326      * @return string the HTML to output.
2327      */
2328     public function heading($text, $level = 2, $classes = 'main', $id = null) {
2329         $level = (integer) $level;
2330         if ($level < 1 or $level > 6) {
2331             throw new coding_exception('Heading level must be an integer between 1 and 6.');
2332         }
2333         return html_writer::tag('h' . $level, $text, array('id' => $id, 'class' => renderer_base::prepare_classes($classes)));
2334     }
2336     /**
2337      * Outputs a box.
2338      *
2339      * @param string $contents The contents of the box
2340      * @param string $classes A space-separated list of CSS classes
2341      * @param string $id An optional ID
2342      * @return string the HTML to output.
2343      */
2344     public function box($contents, $classes = 'generalbox', $id = null) {
2345         return $this->box_start($classes, $id) . $contents . $this->box_end();
2346     }
2348     /**
2349      * Outputs the opening section of a box.
2350      *
2351      * @param string $classes A space-separated list of CSS classes
2352      * @param string $id An optional ID
2353      * @return string the HTML to output.
2354      */
2355     public function box_start($classes = 'generalbox', $id = null) {
2356         $this->opencontainers->push('box', html_writer::end_tag('div'));
2357         return html_writer::start_tag('div', array('id' => $id,
2358                 'class' => 'box ' . renderer_base::prepare_classes($classes)));
2359     }
2361     /**
2362      * Outputs the closing section of a box.
2363      *
2364      * @return string the HTML to output.
2365      */
2366     public function box_end() {
2367         return $this->opencontainers->pop('box');
2368     }
2370     /**
2371      * Outputs a container.
2372      *
2373      * @param string $contents The contents of the box
2374      * @param string $classes A space-separated list of CSS classes
2375      * @param string $id An optional ID
2376      * @return string the HTML to output.
2377      */
2378     public function container($contents, $classes = null, $id = null) {
2379         return $this->container_start($classes, $id) . $contents . $this->container_end();
2380     }
2382     /**
2383      * Outputs the opening section of a container.
2384      *
2385      * @param string $classes A space-separated list of CSS classes
2386      * @param string $id An optional ID
2387      * @return string the HTML to output.
2388      */
2389     public function container_start($classes = null, $id = null) {
2390         $this->opencontainers->push('container', html_writer::end_tag('div'));
2391         return html_writer::start_tag('div', array('id' => $id,
2392                 'class' => renderer_base::prepare_classes($classes)));
2393     }
2395     /**
2396      * Outputs the closing section of a container.
2397      *
2398      * @return string the HTML to output.
2399      */
2400     public function container_end() {
2401         return $this->opencontainers->pop('container');
2402     }
2404     /**
2405      * Make nested HTML lists out of the items
2406      *
2407      * The resulting list will look something like this:
2408      *
2409      * <pre>
2410      * <<ul>>
2411      * <<li>><div class='tree_item parent'>(item contents)</div>
2412      *      <<ul>
2413      *      <<li>><div class='tree_item'>(item contents)</div><</li>>
2414      *      <</ul>>
2415      * <</li>>
2416      * <</ul>>
2417      * </pre>
2418      *
2419      * @param array $items
2420      * @param array $attrs html attributes passed to the top ofs the list
2421      * @return string HTML
2422      */
2423     public function tree_block_contents($items, $attrs = array()) {
2424         // exit if empty, we don't want an empty ul element
2425         if (empty($items)) {
2426             return '';
2427         }
2428         // array of nested li elements
2429         $lis = array();
2430         foreach ($items as $item) {
2431             // this applies to the li item which contains all child lists too
2432             $content = $item->content($this);
2433             $liclasses = array($item->get_css_type());
2434             if (!$item->forceopen || (!$item->forceopen && $item->collapse) || ($item->children->count()==0  && $item->nodetype==navigation_node::NODETYPE_BRANCH)) {
2435                 $liclasses[] = 'collapsed';
2436             }
2437             if ($item->isactive === true) {
2438                 $liclasses[] = 'current_branch';
2439             }
2440             $liattr = array('class'=>join(' ',$liclasses));
2441             // class attribute on the div item which only contains the item content
2442             $divclasses = array('tree_item');
2443             if ($item->children->count()>0  || $item->nodetype==navigation_node::NODETYPE_BRANCH) {
2444                 $divclasses[] = 'branch';
2445             } else {
2446                 $divclasses[] = 'leaf';
2447             }
2448             if (!empty($item->classes) && count($item->classes)>0) {
2449                 $divclasses[] = join(' ', $item->classes);
2450             }
2451             $divattr = array('class'=>join(' ', $divclasses));
2452             if (!empty($item->id)) {
2453                 $divattr['id'] = $item->id;
2454             }
2455             $content = html_writer::tag('p', $content, $divattr) . $this->tree_block_contents($item->children);
2456             if (!empty($item->preceedwithhr) && $item->preceedwithhr===true) {
2457                 $content = html_writer::empty_tag('hr') . $content;
2458             }
2459             $content = html_writer::tag('li', $content, $liattr);
2460             $lis[] = $content;
2461         }
2462         return html_writer::tag('ul', implode("\n", $lis), $attrs);
2463     }
2465     /**
2466      * Return the navbar content so that it can be echoed out by the layout
2467      *
2468      * @return string XHTML navbar
2469      */
2470     public function navbar() {
2471         $items = $this->page->navbar->get_items();
2473         $htmlblocks = array();
2474         // Iterate the navarray and display each node
2475         $itemcount = count($items);
2476         $separator = get_separator();
2477         for ($i=0;$i < $itemcount;$i++) {
2478             $item = $items[$i];
2479             $item->hideicon = true;
2480             if ($i===0) {
2481                 $content = html_writer::tag('li', $this->render($item));
2482             } else {
2483                 $content = html_writer::tag('li', $separator.$this->render($item));
2484             }
2485             $htmlblocks[] = $content;
2486         }
2488         //accessibility: heading for navbar list  (MDL-20446)
2489         $navbarcontent = html_writer::tag('span', get_string('pagepath'), array('class'=>'accesshide'));
2490         $navbarcontent .= html_writer::tag('ul', join('', $htmlblocks));
2491         // XHTML
2492         return $navbarcontent;
2493     }
2495     /**
2496      * Renders a navigation node object.
2497      *
2498      * @param navigation_node $item The navigation node to render.
2499      * @return string HTML fragment
2500      */
2501     protected function render_navigation_node(navigation_node $item) {
2502         $content = $item->get_content();
2503         $title = $item->get_title();
2504         if ($item->icon instanceof renderable && !$item->hideicon) {
2505             $icon = $this->render($item->icon);
2506             $content = $icon.$content; // use CSS for spacing of icons
2507         }
2508         if ($item->helpbutton !== null) {
2509             $content = trim($item->helpbutton).html_writer::tag('span', $content, array('class'=>'clearhelpbutton', 'tabindex'=>'0'));
2510         }
2511         if ($content === '') {
2512             return '';
2513         }
2514         if ($item->action instanceof action_link) {
2515             $link = $item->action;
2516             if ($item->hidden) {
2517                 $link->add_class('dimmed');
2518             }
2519             if (!empty($content)) {
2520                 // Providing there is content we will use that for the link content.
2521                 $link->text = $content;
2522             }
2523             $content = $this->render($link);
2524         } else if ($item->action instanceof moodle_url) {
2525             $attributes = array();
2526             if ($title !== '') {
2527                 $attributes['title'] = $title;
2528             }
2529             if ($item->hidden) {
2530                 $attributes['class'] = 'dimmed_text';
2531             }
2532             $content = html_writer::link($item->action, $content, $attributes);
2534         } else if (is_string($item->action) || empty($item->action)) {
2535             $attributes = array('tabindex'=>'0'); //add tab support to span but still maintain character stream sequence.
2536             if ($title !== '') {
2537                 $attributes['title'] = $title;
2538             }
2539             if ($item->hidden) {
2540                 $attributes['class'] = 'dimmed_text';
2541             }
2542             $content = html_writer::tag('span', $content, $attributes);
2543         }
2544         return $content;
2545     }
2547     /**
2548      * Accessibility: Right arrow-like character is
2549      * used in the breadcrumb trail, course navigation menu
2550      * (previous/next activity), calendar, and search forum block.
2551      * If the theme does not set characters, appropriate defaults
2552      * are set automatically. Please DO NOT
2553      * use &lt; &gt; &raquo; - these are confusing for blind users.
2554      *
2555      * @return string
2556      */
2557     public function rarrow() {
2558         return $this->page->theme->rarrow;
2559     }
2561     /**
2562      * Accessibility: Right arrow-like character is
2563      * used in the breadcrumb trail, course navigation menu
2564      * (previous/next activity), calendar, and search forum block.
2565      * If the theme does not set characters, appropriate defaults
2566      * are set automatically. Please DO NOT
2567      * use &lt; &gt; &raquo; - these are confusing for blind users.
2568      *
2569      * @return string
2570      */
2571     public function larrow() {
2572         return $this->page->theme->larrow;
2573     }
2575     /**
2576      * Returns the custom menu if one has been set
2577      *
2578      * A custom menu can be configured by browsing to
2579      *    Settings: Administration > Appearance > Themes > Theme settings
2580      * and then configuring the custommenu config setting as described.
2581      *
2582      * @param string $custommenuitems - custom menuitems set by theme instead of global theme settings
2583      * @return string
2584      */
2585     public function custom_menu($custommenuitems = '') {
2586         global $CFG;
2587         if (empty($custommenuitems) && !empty($CFG->custommenuitems)) {
2588             $custommenuitems = $CFG->custommenuitems;
2589         }
2590         if (empty($custommenuitems)) {
2591             return '';
2592         }
2593         $custommenu = new custom_menu($custommenuitems, current_language());
2594         return $this->render_custom_menu($custommenu);
2595     }
2597     /**
2598      * Renders a custom menu object (located in outputcomponents.php)
2599      *
2600      * The custom menu this method produces makes use of the YUI3 menunav widget
2601      * and requires very specific html elements and classes.
2602      *
2603      * @staticvar int $menucount
2604      * @param custom_menu $menu
2605      * @return string
2606      */
2607     protected function render_custom_menu(custom_menu $menu) {
2608         static $menucount = 0;
2609         // If the menu has no children return an empty string
2610         if (!$menu->has_children()) {
2611             return '';
2612         }
2613         // Increment the menu count. This is used for ID's that get worked with
2614         // in JavaScript as is essential
2615         $menucount++;
2616         // Initialise this custom menu (the custom menu object is contained in javascript-static
2617         $jscode = js_writer::function_call_with_Y('M.core_custom_menu.init', array('custom_menu_'.$menucount));
2618         $jscode = "(function(){{$jscode}})";
2619         $this->page->requires->yui_module('node-menunav', $jscode);
2620         // Build the root nodes as required by YUI
2621         $content = html_writer::start_tag('div', array('id'=>'custom_menu_'.$menucount, 'class'=>'yui3-menu yui3-menu-horizontal javascript-disabled'));
2622         $content .= html_writer::start_tag('div', array('class'=>'yui3-menu-content'));
2623         $content .= html_writer::start_tag('ul');
2624         // Render each child
2625         foreach ($menu->get_children() as $item) {
2626             $content .= $this->render_custom_menu_item($item);
2627         }
2628         // Close the open tags
2629         $content .= html_writer::end_tag('ul');
2630         $content .= html_writer::end_tag('div');
2631         $content .= html_writer::end_tag('div');
2632         // Return the custom menu
2633         return $content;
2634     }
2636     /**
2637      * Renders a custom menu node as part of a submenu
2638      *
2639      * The custom menu this method produces makes use of the YUI3 menunav widget
2640      * and requires very specific html elements and classes.
2641      *
2642      * @see core:renderer::render_custom_menu()
2643      *
2644      * @staticvar int $submenucount
2645      * @param custom_menu_item $menunode
2646      * @return string
2647      */
2648     protected function render_custom_menu_item(custom_menu_item $menunode) {
2649         // Required to ensure we get unique trackable id's
2650         static $submenucount = 0;
2651         if ($menunode->has_children()) {
2652             // If the child has menus render it as a sub menu
2653             $submenucount++;
2654             $content = html_writer::start_tag('li');
2655             if ($menunode->get_url() !== null) {
2656                 $url = $menunode->get_url();
2657             } else {
2658                 $url = '#cm_submenu_'.$submenucount;
2659             }
2660             $content .= html_writer::link($url, $menunode->get_text(), array('class'=>'yui3-menu-label', 'title'=>$menunode->get_title()));
2661             $content .= html_writer::start_tag('div', array('id'=>'cm_submenu_'.$submenucount, 'class'=>'yui3-menu custom_menu_submenu'));
2662             $content .= html_writer::start_tag('div', array('class'=>'yui3-menu-content'));
2663             $content .= html_writer::start_tag('ul');
2664             foreach ($menunode->get_children() as $menunode) {
2665                 $content .= $this->render_custom_menu_item($menunode);
2666             }
2667             $content .= html_writer::end_tag('ul');
2668             $content .= html_writer::end_tag('div');
2669             $content .= html_writer::end_tag('div');
2670             $content .= html_writer::end_tag('li');
2671         } else {
2672             // The node doesn't have children so produce a final menuitem
2673             $content = html_writer::start_tag('li', array('class'=>'yui3-menuitem'));
2674             if ($menunode->get_url() !== null) {
2675                 $url = $menunode->get_url();
2676             } else {
2677                 $url = '#';
2678             }
2679             $content .= html_writer::link($url, $menunode->get_text(), array('class'=>'yui3-menuitem-content', 'title'=>$menunode->get_title()));
2680             $content .= html_writer::end_tag('li');
2681         }
2682         // Return the sub menu
2683         return $content;
2684     }
2686     /**
2687      * Renders theme links for switching between default and other themes.
2688      *
2689      * @return string
2690      */
2691     protected function theme_switch_links() {
2693         $actualdevice = get_device_type();
2694         $currentdevice = $this->page->devicetypeinuse;
2695         $switched = ($actualdevice != $currentdevice);
2697         if (!$switched && $currentdevice == 'default' && $actualdevice == 'default') {
2698             // The user is using the a default device and hasn't switched so don't shown the switch
2699             // device links.
2700             return '';
2701         }
2703         if ($switched) {
2704             $linktext = get_string('switchdevicerecommended');
2705             $devicetype = $actualdevice;
2706         } else {
2707             $linktext = get_string('switchdevicedefault');
2708             $devicetype = 'default';
2709         }
2710         $linkurl = new moodle_url('/theme/switchdevice.php', array('url' => $this->page->url, 'device' => $devicetype, 'sesskey' => sesskey()));
2712         $content  = html_writer::start_tag('div', array('id' => 'theme_switch_link'));
2713         $content .= html_writer::link($linkurl, $linktext);
2714         $content .= html_writer::end_tag('div');
2716         return $content;
2717     }
2720 /**
2721  * A renderer that generates output for command-line scripts.
2722  *
2723  * The implementation of this renderer is probably incomplete.
2724  *
2725  * @copyright 2009 Tim Hunt
2726  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2727  * @since Moodle 2.0
2728  * @package core
2729  * @category output
2730  */
2731 class core_renderer_cli extends core_renderer {
2733     /**
2734      * Returns the page header.
2735      *
2736      * @return string HTML fragment
2737      */
2738     public function header() {
2739         return $this->page->heading . "\n";
2740     }
2742     /**
2743      * Returns a template fragment representing a Heading.
2744      *
2745      * @param string $text The text of the heading
2746      * @param int $level The level of importance of the heading
2747      * @param string $classes A space-separated list of CSS classes
2748      * @param string $id An optional ID
2749      * @return string A template fragment for a heading
2750      */
2751     public function heading($text, $level = 2, $classes = 'main', $id = null) {
2752         $text .= "\n";
2753         switch ($level) {
2754             case 1:
2755                 return '=>' . $text;
2756             case 2:
2757                 return '-->' . $text;
2758             default:
2759                 return $text;
2760         }
2761     }
2763     /**
2764      * Returns a template fragment representing a fatal error.
2765      *
2766      * @param string $message The message to output
2767      * @param string $moreinfourl URL where more info can be found about the error
2768      * @param string $link Link for the Continue button
2769      * @param array $backtrace The execution backtrace
2770      * @param string $debuginfo Debugging information
2771      * @return string A template fragment for a fatal error
2772      */
2773     public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
2774         $output = "!!! $message !!!\n";
2776         if (debugging('', DEBUG_DEVELOPER)) {
2777             if (!empty($debuginfo)) {
2778                 $output .= $this->notification($debuginfo, 'notifytiny');
2779             }
2780             if (!empty($backtrace)) {
2781                 $output .= $this->notification('Stack trace: ' . format_backtrace($backtrace, true), 'notifytiny');
2782             }
2783         }
2785         return $output;
2786     }
2788     /**
2789      * Returns a template fragment representing a notification.
2790      *
2791      * @param string $message The message to include
2792      * @param string $classes A space-separated list of CSS classes
2793      * @return string A template fragment for a notification
2794      */
2795     public function notification($message, $classes = 'notifyproblem') {
2796         $message = clean_text($message);
2797         if ($classes === 'notifysuccess') {
2798             return "++ $message ++\n";
2799         }
2800         return "!! $message !!\n";
2801     }
2805 /**
2806  * A renderer that generates output for ajax scripts.
2807  *
2808  * This renderer prevents accidental sends back only json
2809  * encoded error messages, all other output is ignored.
2810  *
2811  * @copyright 2010 Petr Skoda
2812  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2813  * @since Moodle 2.0
2814  * @package core
2815  * @category output
2816  */
2817 class core_renderer_ajax extends core_renderer {
2819     /**
2820      * Returns a template fragment representing a fatal error.
2821      *
2822      * @param string $message The message to output
2823      * @param string $moreinfourl URL where more info can be found about the error
2824      * @param string $link Link for the Continue button
2825      * @param array $backtrace The execution backtrace
2826      * @param string $debuginfo Debugging information
2827      * @return string A template fragment for a fatal error
2828      */
2829     public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
2830         global $CFG;
2832         $this->page->set_context(null); // ugly hack - make sure page context is set to something, we do not want bogus warnings here
2834         $e = new stdClass();
2835         $e->error      = $message;
2836         $e->stacktrace = NULL;
2837         $e->debuginfo  = NULL;
2838         $e->reproductionlink = NULL;
2839         if (!empty($CFG->debug) and $CFG->debug >= DEBUG_DEVELOPER) {
2840             $e->reproductionlink = $link;
2841             if (!empty($debuginfo)) {
2842                 $e->debuginfo = $debuginfo;
2843             }
2844             if (!empty($backtrace)) {
2845                 $e->stacktrace = format_backtrace($backtrace, true);
2846             }
2847         }
2848         $this->header();
2849         return json_encode($e);
2850     }
2852     /**
2853      * Used to display a notification.
2854      * For the AJAX notifications are discarded.
2855      *
2856      * @param string $message
2857      * @param string $classes
2858      */
2859     public function notification($message, $classes = 'notifyproblem') {}
2861     /**
2862      * Used to display a redirection message.
2863      * AJAX redirections should not occur and as such redirection messages
2864      * are discarded.
2865      *
2866      * @param moodle_url|string $encodedurl
2867      * @param string $message
2868      * @param int $delay
2869      * @param bool $debugdisableredirect
2870      */
2871     public function redirect_message($encodedurl, $message, $delay, $debugdisableredirect) {}
2873     /**
2874      * Prepares the start of an AJAX output.
2875      */
2876     public function header() {
2877         // unfortunately YUI iframe upload does not support application/json
2878         if (!empty($_FILES)) {
2879             @header('Content-type: text/plain; charset=utf-8');
2880         } else {
2881             @header('Content-type: application/json; charset=utf-8');
2882         }
2884         // Headers to make it not cacheable and json
2885         @header('Cache-Control: no-store, no-cache, must-revalidate');
2886         @header('Cache-Control: post-check=0, pre-check=0', false);
2887         @header('Pragma: no-cache');
2888         @header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
2889         @header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
2890         @header('Accept-Ranges: none');
2891     }
2893     /**
2894      * There is no footer for an AJAX request, however we must override the
2895      * footer method to prevent the default footer.
2896      */
2897     public function footer() {}
2899     /**
2900      * No need for headers in an AJAX request... this should never happen.
2901      * @param string $text
2902      * @param int $level
2903      * @param string $classes
2904      * @param string $id
2905      */
2906     public function heading($text, $level = 2, $classes = 'main', $id = null) {}
2910 /**
2911  * Renderer for media files.
2912  *
2913  * Used in file resources, media filter, and any other places that need to
2914  * output embedded media.
2915  *
2916  * @copyright 2011 The Open University
2917  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2918  */
2919 class core_media_renderer extends plugin_renderer_base {
2920     /** @var array Array of available 'player' objects */
2921     private $players;
2922     /** @var string Regex pattern for links which may contain embeddable content */
2923     private $embeddablemarkers;
2925     /**
2926      * Constructor requires medialib.php.
2927      *
2928      * This is needed in the constructor (not later) so that you can use the
2929      * constants and static functions that are defined in core_media class
2930      * before you call renderer functions.
2931      */
2932     public function __construct() {
2933         global $CFG;
2934         require_once($CFG->libdir . '/medialib.php');
2935     }
2937     /**
2938      * Obtains the list of core_media_player objects currently in use to render
2939      * items.
2940      *
2941      * The list is in rank order (highest first) and does not include players
2942      * which are disabled.
2943      *
2944      * @return array Array of core_media_player objects in rank order
2945      */
2946     protected function get_players() {
2947         global $CFG;
2949         // Save time by only building the list once.
2950         if (!$this->players) {
2951             // Get raw list of players.
2952             $players = $this->get_players_raw();
2954             // Chuck all the ones that are disabled.
2955             foreach ($players as $key => $player) {
2956                 if (!$player->is_enabled()) {
2957                     unset($players[$key]);
2958                 }
2959             }
2961             // Sort in rank order (highest first).
2962             usort($players, array('core_media_player', 'compare_by_rank'));
2963             $this->players = $players;
2964         }
2965         return $this->players;
2966     }
2968     /**
2969      * Obtains a raw list of player objects that includes objects regardless
2970      * of whether they are disabled or not, and without sorting.
2971      *
2972      * You can override this in a subclass if you need to add additional
2973      * players.
2974      *
2975      * The return array is be indexed by player name to make it easier to
2976      * remove players in a subclass.
2977      *
2978      * @return array $players Array of core_media_player objects in any order
2979      */
2980     protected function get_players_raw() {
2981         return array(
2982             'vimeo' => new core_media_player_vimeo(),
2983             'youtube' => new core_media_player_youtube(),
2984             'youtube_playlist' => new core_media_player_youtube_playlist(),
2985             'html5video' => new core_media_player_html5video(),
2986             'html5audio' => new core_media_player_html5audio(),
2987             'mp3' => new core_media_player_mp3(),
2988             'flv' => new core_media_player_flv(),
2989             'wmp' => new core_media_player_wmp(),
2990             'qt' => new core_media_player_qt(),
2991             'rm' => new core_media_player_rm(),
2992             'swf' => new core_media_player_swf(),
2993             'link' => new core_media_player_link(),
2994         );
2995     }
2997     /**
2998      * Renders a media file (audio or video) using suitable embedded player.
2999      *
3000      * See embed_alternatives function for full description of parameters.
3001      * This function calls through to that one.
3002      *
3003      * When using this function you can also specify width and height in the
3004      * URL by including ?d=100x100 at the end. If specified in the URL, this
3005      * will override the $width and $height parameters.
3006      *
3007      * @param moodle_url $url Full URL of media file
3008      * @param string $name Optional user-readable name to display in download link
3009      * @param int $width Width in pixels (optional)
3010      * @param int $height Height in pixels (optional)
3011      * @param array $options Array of key/value pairs
3012      * @return string HTML content of embed
3013      */
3014     public function embed_url(moodle_url $url, $name = '', $width = 0, $height = 0,
3015             $options = array()) {
3017         // Get width and height from URL if specified (overrides parameters in
3018         // function call).
3019         $rawurl = $url->out(false);
3020         if (preg_match('/[?#]d=([\d]{1,4}%?)x([\d]{1,4}%?)/', $rawurl, $matches)) {
3021             $width = $matches[1];
3022             $height = $matches[2];
3023             $url = new moodle_url(str_replace($matches[0], '', $rawurl));
3024         }
3026         // Defer to array version of function.
3027         return $this->embed_alternatives(array($url), $name, $width, $height, $options);
3028     }
3030     /**
3031      * Renders media files (audio or video) using suitable embedded player.
3032      * The list of URLs should be alternative versions of the same content in
3033      * multiple formats. If there is only one format it should have a single
3034      * entry.
3035      *
3036      * If the media files are not in a supported format, this will give students
3037      * a download link to each format. The download link uses the filename
3038      * unless you supply the optional name parameter.
3039      *
3040      * Width and height are optional. If specified, these are suggested sizes
3041      * and should be the exact values supplied by the user, if they come from
3042      * user input. These will be treated as relating to the size of the video
3043      * content, not including any player control bar.
3044      *
3045      * For audio files, height will be ignored. For video files, a few formats
3046      * work if you specify only width, but in general if you specify width
3047      * you must specify height as well.
3048      *
3049      * The $options array is passed through to the core_media_player classes
3050      * that render the object tag. The keys can contain values from
3051      * core_media::OPTION_xx.
3052      *
3053      * @param array $alternatives Array of moodle_url to media files
3054      * @param string $name Optional user-readable name to display in download link
3055      * @param int $width Width in pixels (optional)
3056      * @param int $height Height in pixels (optional)
3057      * @param array $options Array of key/value pairs
3058      * @return string HTML content of embed
3059      */
3060     public function embed_alternatives($alternatives, $name = '', $width = 0, $height = 0,
3061             $options = array()) {
3063         // Get list of player plugins (will also require the library).
3064         $players = $this->get_players();
3066         // Set up initial text which will be replaced by first player that
3067         // supports any of the formats.
3068         $out = core_media_player::PLACEHOLDER;
3070         // Loop through all players that support any of these URLs.
3071         foreach ($players as $player) {
3072             // Option: When no other player matched, don't do the default link player.
3073             if (!empty($options[core_media::OPTION_FALLBACK_TO_BLANK]) &&
3074                     $player->get_rank() === 0 && $out === core_media_player::PLACEHOLDER) {
3075                 continue;
3076             }
3078             $supported = $player->list_supported_urls($alternatives, $options);
3079             if ($supported) {
3080                 // Embed.
3081                 $text = $player->embed($supported, $name, $width, $height, $options);
3083                 // Put this in place of the 'fallback' slot in the previous text.
3084                 $out = str_replace(core_media_player::PLACEHOLDER, $text, $out);
3085             }
3086         }
3088         // Remove 'fallback' slot from final version and return it.
3089         $out = str_replace(core_media_player::PLACEHOLDER, '', $out);
3090         if (!empty($options[core_media::OPTION_BLOCK]) && $out !== '') {
3091             $out = html_writer::tag('div', $out, array('class' => 'resourcecontent'));
3092         }
3093         return $out;
3094     }
3096     /**
3097      * Checks whether a file can be embedded. If this returns true you will get
3098      * an embedded player; if this returns false, you will just get a download
3099      * link.
3100      *
3101      * This is a wrapper for can_embed_urls.
3102      *
3103      * @param moodle_url $url URL of media file
3104      * @param array $options Options (same as when embedding)
3105      * @return bool True if file can be embedded
3106      */
3107     public function can_embed_url(moodle_url $url, $options = array()) {
3108         return $this->can_embed_urls(array($url), $options);
3109     }
3111     /**
3112      * Checks whether a file can be embedded. If this returns true you will get
3113      * an embedded player; if this returns false, you will just get a download
3114      * link.
3115      *
3116      * @param array $urls URL of media file and any alternatives (moodle_url)
3117      * @param array $options Options (same as when embedding)
3118      * @return bool True if file can be embedded
3119      */
3120     public function can_embed_urls(array $urls, $options = array()) {
3121         // Check all players to see if any of them support it.
3122         foreach ($this->get_players() as $player) {
3123             // Link player (always last on list) doesn't count!
3124             if ($player->get_rank() <= 0) {
3125                 break;
3126             }
3127             // First player that supports it, return true.
3128             if ($player->list_supported_urls($urls, $options)) {
3129                 return true;
3130             }
3131         }
3132         return false;
3133     }
3135     /**
3136      * Obtains a list of markers that can be used in a regular expression when
3137      * searching for URLs that can be embedded by any player type.
3138      *
3139      * This string is used to improve peformance of regex matching by ensuring
3140      * that the (presumably C) regex code can do a quick keyword check on the
3141      * URL part of a link to see if it matches one of these, rather than having
3142      * to go into PHP code for every single link to see if it can be embedded.
3143      *
3144      * @return string String suitable for use in regex such as '(\.mp4|\.flv)'
3145      */
3146     public function get_embeddable_markers() {
3147         if (empty($this->embeddablemarkers)) {
3148             $markers = '';
3149             foreach ($this->get_players() as $player) {
3150                 foreach ($player->get_embeddable_markers() as $marker) {
3151                     if ($markers !== '') {
3152                         $markers .= '|';
3153                     }
3154                     $markers .= preg_quote($marker);
3155                 }
3156             }
3157             $this->embeddablemarkers = $markers;
3158         }
3159         return $this->embeddablemarkers;
3160     }