MDL-21695 help files replaced by standard strings - basic infrastructure in place...
[moodle.git] / lib / outputrenderers.php
CommitLineData
d9c8f425 1<?php
2
3// This file is part of Moodle - http://moodle.org/
4//
5// Moodle is free software: you can redistribute it and/or modify
6// it under the terms of the GNU General Public License as published by
7// the Free Software Foundation, either version 3 of the License, or
8// (at your option) any later version.
9//
10// Moodle is distributed in the hope that it will be useful,
11// but WITHOUT ANY WARRANTY; without even the implied warranty of
12// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13// GNU General Public License for more details.
14//
15// You should have received a copy of the GNU General Public License
16// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
17
18/**
19 * Classes for rendering HTML output for Moodle.
20 *
21 * Please see http://docs.moodle.org/en/Developement:How_Moodle_outputs_HTML
22 * for an overview.
23 *
24 * @package moodlecore
25 * @copyright 2009 Tim Hunt
26 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27 */
28
29/**
30 * Simple base class for Moodle renderers.
31 *
32 * Tracks the xhtml_container_stack to use, which is passed in in the constructor.
33 *
34 * Also has methods to facilitate generating HTML output.
35 *
36 * @copyright 2009 Tim Hunt
37 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
38 * @since Moodle 2.0
39 */
78946b9b 40class renderer_base {
d9c8f425 41 /** @var xhtml_container_stack the xhtml_container_stack to use. */
42 protected $opencontainers;
43 /** @var moodle_page the page we are rendering for. */
44 protected $page;
c927e35c
PS
45 /** @var requested rendering target conatnt */
46 protected $target;
d9c8f425 47
48 /**
49 * Constructor
50 * @param moodle_page $page the page we are doing output for.
c927e35c 51 * @param string $target one of rendering target constants
d9c8f425 52 */
c927e35c 53 public function __construct(moodle_page $page, $target) {
d9c8f425 54 $this->opencontainers = $page->opencontainers;
55 $this->page = $page;
c927e35c 56 $this->target = $target;
d9c8f425 57 }
58
59 /**
5d0c95a5
PS
60 * Returns rendered widget.
61 * @param renderable $widget intence with renderable interface
62 * @return string
d9c8f425 63 */
5d0c95a5
PS
64 public function render(renderable $widget) {
65 $rendermethod = 'render_'.get_class($widget);
66 if (method_exists($this, $rendermethod)) {
67 return $this->$rendermethod($widget);
68 }
69 throw new coding_exception('Can not render widget, renderer method ('.$rendermethod.') not found.');
d9c8f425 70 }
71
72 /**
5d0c95a5 73 * Adds JS handlers needed for event execution for one html element id
5d0c95a5 74 * @param component_action $actions
c80877aa
PS
75 * @param string $id
76 * @return string id of element, either original submitted or random new if not supplied
d9c8f425 77 */
c80877aa
PS
78 public function add_action_handler(component_action $action, $id=null) {
79 if (!$id) {
80 $id = html_writer::random_id($action->event);
81 }
d96d8f03 82 $this->page->requires->event_handler("#$id", $action->event, $action->jsfunction, $action->jsfunctionargs);
c80877aa 83 return $id;
d9c8f425 84 }
85
86 /**
5d0c95a5
PS
87 * Have we started output yet?
88 * @return boolean true if the header has been printed.
d9c8f425 89 */
5d0c95a5
PS
90 public function has_started() {
91 return $this->page->state >= moodle_page::STATE_IN_BODY;
d9c8f425 92 }
93
94 /**
95 * Given an array or space-separated list of classes, prepares and returns the HTML class attribute value
96 * @param mixed $classes Space-separated string or array of classes
97 * @return string HTML class attribute value
98 */
99 public static function prepare_classes($classes) {
100 if (is_array($classes)) {
101 return implode(' ', array_unique($classes));
102 }
103 return $classes;
104 }
105
d9c8f425 106 /**
897e902b
PS
107 * Return the moodle_url for an image.
108 * The exact image location and extension is determined
109 * automatically by searching for gif|png|jpg|jpeg, please
110 * note there can not be diferent images with the different
111 * extension. The imagename is for historical reasons
112 * a relative path name, it may be changed later for core
113 * images. It is recommended to not use subdirectories
114 * in plugin and theme pix directories.
d9c8f425 115 *
897e902b
PS
116 * There are three types of images:
117 * 1/ theme images - stored in theme/mytheme/pix/,
118 * use component 'theme'
119 * 2/ core images - stored in /pix/,
120 * overridden via theme/mytheme/pix_core/
121 * 3/ plugin images - stored in mod/mymodule/pix,
122 * overridden via theme/mytheme/pix_plugins/mod/mymodule/,
123 * example: pix_url('comment', 'mod_glossary')
124 *
125 * @param string $imagename the pathname of the image
126 * @param string $component full plugin name (aka component) or 'theme'
78946b9b 127 * @return moodle_url
d9c8f425 128 */
c927e35c 129 public function pix_url($imagename, $component = 'moodle') {
c39e5ba2 130 return $this->page->theme->pix_url($imagename, $component);
d9c8f425 131 }
d9c8f425 132}
133
c927e35c 134
75590935
PS
135/**
136 * Basis for all plugin renderers.
137 *
c927e35c
PS
138 * @author Petr Skoda (skodak)
139 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
140 * @since Moodle 2.0
75590935
PS
141 */
142class plugin_renderer_base extends renderer_base {
143 /**
144 * A reference to the current general renderer probably {@see core_renderer}
145 * @var renderer_base
146 */
147 protected $output;
148
149 /**
150 * Contructor method, calls the parent constructor
151 * @param moodle_page $page
c927e35c 152 * @param string $target one of rendering target constants
75590935 153 */
c927e35c
PS
154 public function __construct(moodle_page $page, $target) {
155 $this->output = $page->get_renderer('core', null, $target);
156 parent::__construct($page, $target);
75590935 157 }
ff5265c6 158
5d0c95a5
PS
159 /**
160 * Returns rendered widget.
161 * @param renderable $widget intence with renderable interface
162 * @return string
163 */
164 public function render(renderable $widget) {
165 $rendermethod = 'render_'.get_class($widget);
166 if (method_exists($this, $rendermethod)) {
167 return $this->$rendermethod($widget);
168 }
169 // pass to core renderer if method not found here
170 $this->output->render($widget);
171 }
172
ff5265c6
PS
173 /**
174 * Magic method used to pass calls otherwise meant for the standard renderer
175 * to it to ensure we don't go causing unnessecary greif.
176 *
177 * @param string $method
178 * @param array $arguments
179 * @return mixed
180 */
181 public function __call($method, $arguments) {
37b5b18e
PS
182 if (method_exists('renderer_base', $method)) {
183 throw new coding_exception('Protected method called against '.__CLASS__.' :: '.$method);
184 }
ff5265c6
PS
185 if (method_exists($this->output, $method)) {
186 return call_user_func_array(array($this->output, $method), $arguments);
187 } else {
188 throw new coding_exception('Unknown method called against '.__CLASS__.' :: '.$method);
189 }
190 }
75590935 191}
d9c8f425 192
c927e35c 193
d9c8f425 194/**
78946b9b 195 * The standard implementation of the core_renderer interface.
d9c8f425 196 *
197 * @copyright 2009 Tim Hunt
198 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
199 * @since Moodle 2.0
200 */
78946b9b 201class core_renderer extends renderer_base {
d9c8f425 202 /** @var string used in {@link header()}. */
203 const PERFORMANCE_INFO_TOKEN = '%%PERFORMANCEINFO%%';
204 /** @var string used in {@link header()}. */
205 const END_HTML_TOKEN = '%%ENDHTML%%';
206 /** @var string used in {@link header()}. */
207 const MAIN_CONTENT_TOKEN = '[MAIN CONTENT GOES HERE]';
208 /** @var string used to pass information from {@link doctype()} to {@link standard_head_html()}. */
209 protected $contenttype;
210 /** @var string used by {@link redirect_message()} method to communicate with {@link header()}. */
211 protected $metarefreshtag = '';
212
213 /**
214 * Get the DOCTYPE declaration that should be used with this page. Designed to
215 * be called in theme layout.php files.
216 * @return string the DOCTYPE declaration (and any XML prologue) that should be used.
217 */
218 public function doctype() {
219 global $CFG;
220
221 $doctype = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">' . "\n";
222 $this->contenttype = 'text/html; charset=utf-8';
223
224 if (empty($CFG->xmlstrictheaders)) {
225 return $doctype;
226 }
227
228 // We want to serve the page with an XML content type, to force well-formedness errors to be reported.
229 $prolog = '<?xml version="1.0" encoding="utf-8"?>' . "\n";
230 if (isset($_SERVER['HTTP_ACCEPT']) && strpos($_SERVER['HTTP_ACCEPT'], 'application/xhtml+xml') !== false) {
231 // Firefox and other browsers that can cope natively with XHTML.
232 $this->contenttype = 'application/xhtml+xml; charset=utf-8';
233
234 } else if (preg_match('/MSIE.*Windows NT/', $_SERVER['HTTP_USER_AGENT'])) {
235 // IE can't cope with application/xhtml+xml, but it will cope if we send application/xml with an XSL stylesheet.
236 $this->contenttype = 'application/xml; charset=utf-8';
237 $prolog .= '<?xml-stylesheet type="text/xsl" href="' . $CFG->httpswwwroot . '/lib/xhtml.xsl"?>' . "\n";
238
239 } else {
240 $prolog = '';
241 }
242
243 return $prolog . $doctype;
244 }
245
246 /**
247 * The attributes that should be added to the <html> tag. Designed to
248 * be called in theme layout.php files.
249 * @return string HTML fragment.
250 */
251 public function htmlattributes() {
252 return get_html_lang(true) . ' xmlns="http://www.w3.org/1999/xhtml"';
253 }
254
255 /**
256 * The standard tags (meta tags, links to stylesheets and JavaScript, etc.)
257 * that should be included in the <head> tag. Designed to be called in theme
258 * layout.php files.
259 * @return string HTML fragment.
260 */
261 public function standard_head_html() {
b5bbeaf0 262 global $CFG, $SESSION;
d9c8f425 263 $output = '';
264 $output .= '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />' . "\n";
265 $output .= '<meta name="keywords" content="moodle, ' . $this->page->title . '" />' . "\n";
266 if (!$this->page->cacheable) {
267 $output .= '<meta http-equiv="pragma" content="no-cache" />' . "\n";
268 $output .= '<meta http-equiv="expires" content="0" />' . "\n";
269 }
270 // This is only set by the {@link redirect()} method
271 $output .= $this->metarefreshtag;
272
273 // Check if a periodic refresh delay has been set and make sure we arn't
274 // already meta refreshing
275 if ($this->metarefreshtag=='' && $this->page->periodicrefreshdelay!==null) {
276 $output .= '<meta http-equiv="refresh" content="'.$this->page->periodicrefreshdelay.';url='.$this->page->url->out().'" />';
277 }
278
7d2a0492 279 $this->page->requires->js_function_call('setTimeout', array('fix_column_widths()', 20));
d9c8f425 280
281 $focus = $this->page->focuscontrol;
282 if (!empty($focus)) {
283 if (preg_match("#forms\['([a-zA-Z0-9]+)'\].elements\['([a-zA-Z0-9]+)'\]#", $focus, $matches)) {
284 // This is a horrifically bad way to handle focus but it is passed in
285 // through messy formslib::moodleform
7d2a0492 286 $this->page->requires->js_function_call('old_onload_focus', array($matches[1], $matches[2]));
d9c8f425 287 } else if (strpos($focus, '.')!==false) {
288 // Old style of focus, bad way to do it
289 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);
290 $this->page->requires->js_function_call('old_onload_focus', explode('.', $focus, 2));
291 } else {
292 // Focus element with given id
7d2a0492 293 $this->page->requires->js_function_call('focuscontrol', array($focus));
d9c8f425 294 }
295 }
296
78946b9b
PS
297 // Get the theme stylesheet - this has to be always first CSS, this loads also styles.css from all plugins;
298 // any other custom CSS can not be overridden via themes and is highly discouraged
efaa4c08 299 $urls = $this->page->theme->css_urls($this->page);
78946b9b 300 foreach ($urls as $url) {
c0467479 301 $this->page->requires->css_theme($url);
78946b9b
PS
302 }
303
04c01408 304 // Get the theme javascript head and footer
04c01408 305 $jsurl = $this->page->theme->javascript_url(true);
baeb20bb
PS
306 $this->page->requires->js($jsurl, true);
307 $jsurl = $this->page->theme->javascript_url(false);
8ce04d51 308 $this->page->requires->js($jsurl);
5d0c95a5 309
78946b9b 310 // Perform a browser environment check for the flash version. Should only run once per login session.
2c0d7839 311 if (!NO_MOODLE_COOKIES && isloggedin() && !empty($CFG->excludeoldflashclients) && empty($SESSION->flashversion)) {
4abd5b9b
PS
312 $this->page->requires->js('/lib/swfobject/swfobject.js');
313 $this->page->requires->js_init_call('M.core_flashdetect.init');
b5bbeaf0 314 }
315
d9c8f425 316 // Get any HTML from the page_requirements_manager.
945f19f7 317 $output .= $this->page->requires->get_head_code($this->page, $this);
d9c8f425 318
319 // List alternate versions.
320 foreach ($this->page->alternateversions as $type => $alt) {
5d0c95a5 321 $output .= html_writer::empty_tag('link', array('rel' => 'alternate',
d9c8f425 322 'type' => $type, 'title' => $alt->title, 'href' => $alt->url));
323 }
324
325 return $output;
326 }
327
328 /**
329 * The standard tags (typically skip links) that should be output just inside
330 * the start of the <body> tag. Designed to be called in theme layout.php files.
331 * @return string HTML fragment.
332 */
333 public function standard_top_of_body_html() {
334 return $this->page->requires->get_top_of_body_code();
335 }
336
337 /**
338 * The standard tags (typically performance information and validation links,
339 * if we are in developer debug mode) that should be output in the footer area
340 * of the page. Designed to be called in theme layout.php files.
341 * @return string HTML fragment.
342 */
343 public function standard_footer_html() {
344 global $CFG;
345
346 // This function is normally called from a layout.php file in {@link header()}
347 // but some of the content won't be known until later, so we return a placeholder
348 // for now. This will be replaced with the real content in {@link footer()}.
349 $output = self::PERFORMANCE_INFO_TOKEN;
350 if (!empty($CFG->debugpageinfo)) {
351 $output .= '<div class="performanceinfo">This page is: ' . $this->page->debug_summary() . '</div>';
352 }
353 if (!empty($CFG->debugvalidators)) {
354 $output .= '<div class="validators"><ul>
355 <li><a href="http://validator.w3.org/check?verbose=1&amp;ss=1&amp;uri=' . urlencode(qualified_me()) . '">Validate HTML</a></li>
356 <li><a href="http://www.contentquality.com/mynewtester/cynthia.exe?rptmode=-1&amp;url1=' . urlencode(qualified_me()) . '">Section 508 Check</a></li>
357 <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>
358 </ul></div>';
359 }
360 return $output;
361 }
362
363 /**
364 * The standard tags (typically script tags that are not needed earlier) that
365 * should be output after everything else, . Designed to be called in theme layout.php files.
366 * @return string HTML fragment.
367 */
368 public function standard_end_of_body_html() {
369 // This function is normally called from a layout.php file in {@link header()}
370 // but some of the content won't be known until later, so we return a placeholder
371 // for now. This will be replaced with the real content in {@link footer()}.
372 echo self::END_HTML_TOKEN;
373 }
374
375 /**
376 * Return the standard string that says whether you are logged in (and switched
377 * roles/logged in as another user).
378 * @return string HTML fragment.
379 */
380 public function login_info() {
244a32c6 381 global $USER, $CFG, $DB;
4bcc5118 382
244a32c6
PS
383 if (during_initial_install()) {
384 return '';
385 }
4bcc5118 386
244a32c6 387 $course = $this->page->course;
4bcc5118 388
244a32c6
PS
389 if (session_is_loggedinas()) {
390 $realuser = session_get_realuser();
391 $fullname = fullname($realuser, true);
4aea3cc7 392 $realuserinfo = " [<a href=\"$CFG->wwwroot/course/loginas.php?id=$course->id&amp;return=1&amp;sesskey=".sesskey()."\">$fullname</a>] ";
244a32c6
PS
393 } else {
394 $realuserinfo = '';
395 }
4bcc5118 396
244a32c6 397 $loginurl = get_login_url();
4bcc5118 398
244a32c6
PS
399 if (empty($course->id)) {
400 // $course->id is not defined during installation
401 return '';
4f0c2d00 402 } else if (isloggedin()) {
244a32c6 403 $context = get_context_instance(CONTEXT_COURSE, $course->id);
4bcc5118 404
244a32c6 405 $fullname = fullname($USER, true);
4aea3cc7 406 $username = "<a href=\"$CFG->wwwroot/user/view.php?id=$USER->id&amp;course=$course->id\">$fullname</a>";
244a32c6 407 if (is_mnet_remote_user($USER) and $idprovider = $DB->get_record('mnet_host', array('id'=>$USER->mnethostid))) {
4aea3cc7 408 $username .= " from <a href=\"{$idprovider->wwwroot}\">{$idprovider->name}</a>";
244a32c6
PS
409 }
410 if (isset($USER->username) && $USER->username == 'guest') {
411 $loggedinas = $realuserinfo.get_string('loggedinasguest').
4aea3cc7 412 " (<a href=\"$loginurl\">".get_string('login').'</a>)';
244a32c6
PS
413 } else if (!empty($USER->access['rsw'][$context->path])) {
414 $rolename = '';
415 if ($role = $DB->get_record('role', array('id'=>$USER->access['rsw'][$context->path]))) {
416 $rolename = ': '.format_string($role->name);
417 }
418 $loggedinas = get_string('loggedinas', 'moodle', $username).$rolename.
4aea3cc7 419 " (<a href=\"$CFG->wwwroot/course/view.php?id=$course->id&amp;switchrole=0&amp;sesskey=".sesskey()."\">".get_string('switchrolereturn').'</a>)';
244a32c6
PS
420 } else {
421 $loggedinas = $realuserinfo.get_string('loggedinas', 'moodle', $username).' '.
4aea3cc7 422 " (<a href=\"$CFG->wwwroot/login/logout.php?sesskey=".sesskey()."\">".get_string('logout').'</a>)';
244a32c6
PS
423 }
424 } else {
425 $loggedinas = get_string('loggedinnot', 'moodle').
4aea3cc7 426 " (<a href=\"$loginurl\">".get_string('login').'</a>)';
244a32c6 427 }
4bcc5118 428
244a32c6 429 $loggedinas = '<div class="logininfo">'.$loggedinas.'</div>';
4bcc5118 430
244a32c6
PS
431 if (isset($SESSION->justloggedin)) {
432 unset($SESSION->justloggedin);
433 if (!empty($CFG->displayloginfailures)) {
434 if (!empty($USER->username) and $USER->username != 'guest') {
435 if ($count = count_login_failures($CFG->displayloginfailures, $USER->username, $USER->lastlogin)) {
436 $loggedinas .= '&nbsp;<div class="loginfailures">';
437 if (empty($count->accounts)) {
438 $loggedinas .= get_string('failedloginattempts', '', $count);
439 } else {
440 $loggedinas .= get_string('failedloginattemptsall', '', $count);
441 }
442 if (has_capability('coursereport/log:view', get_context_instance(CONTEXT_SYSTEM))) {
443 $loggedinas .= ' (<a href="'.$CFG->wwwroot.'/course/report/log/index.php'.
444 '?chooselog=1&amp;id=1&amp;modid=site_errors">'.get_string('logs').'</a>)';
445 }
446 $loggedinas .= '</div>';
447 }
448 }
449 }
450 }
4bcc5118 451
244a32c6 452 return $loggedinas;
d9c8f425 453 }
454
455 /**
456 * Return the 'back' link that normally appears in the footer.
457 * @return string HTML fragment.
458 */
459 public function home_link() {
460 global $CFG, $SITE;
461
462 if ($this->page->pagetype == 'site-index') {
463 // Special case for site home page - please do not remove
464 return '<div class="sitelink">' .
34dff6aa 465 '<a title="Moodle" href="http://moodle.org/">' .
53228896 466 '<img style="width:100px;height:30px" src="' . $this->pix_url('moodlelogo') . '" alt="moodlelogo" /></a></div>';
d9c8f425 467
468 } else if (!empty($CFG->target_release) && $CFG->target_release != $CFG->release) {
469 // Special case for during install/upgrade.
470 return '<div class="sitelink">'.
34dff6aa 471 '<a title="Moodle" href="http://docs.moodle.org/en/Administrator_documentation" onclick="this.target=\'_blank\'">' .
53228896 472 '<img style="width:100px;height:30px" src="' . $this->pix_url('moodlelogo') . '" alt="moodlelogo" /></a></div>';
d9c8f425 473
474 } else if ($this->page->course->id == $SITE->id || strpos($this->page->pagetype, 'course-view') === 0) {
475 return '<div class="homelink"><a href="' . $CFG->wwwroot . '/">' .
476 get_string('home') . '</a></div>';
477
478 } else {
479 return '<div class="homelink"><a href="' . $CFG->wwwroot . '/course/view.php?id=' . $this->page->course->id . '">' .
480 format_string($this->page->course->shortname) . '</a></div>';
481 }
482 }
483
484 /**
485 * Redirects the user by any means possible given the current state
486 *
487 * This function should not be called directly, it should always be called using
488 * the redirect function in lib/weblib.php
489 *
490 * The redirect function should really only be called before page output has started
491 * however it will allow itself to be called during the state STATE_IN_BODY
492 *
493 * @param string $encodedurl The URL to send to encoded if required
494 * @param string $message The message to display to the user if any
495 * @param int $delay The delay before redirecting a user, if $message has been
496 * set this is a requirement and defaults to 3, set to 0 no delay
497 * @param boolean $debugdisableredirect this redirect has been disabled for
498 * debugging purposes. Display a message that explains, and don't
499 * trigger the redirect.
500 * @return string The HTML to display to the user before dying, may contain
501 * meta refresh, javascript refresh, and may have set header redirects
502 */
503 public function redirect_message($encodedurl, $message, $delay, $debugdisableredirect) {
504 global $CFG;
505 $url = str_replace('&amp;', '&', $encodedurl);
506
507 switch ($this->page->state) {
508 case moodle_page::STATE_BEFORE_HEADER :
509 // No output yet it is safe to delivery the full arsenal of redirect methods
510 if (!$debugdisableredirect) {
511 // Don't use exactly the same time here, it can cause problems when both redirects fire at the same time.
512 $this->metarefreshtag = '<meta http-equiv="refresh" content="'. $delay .'; url='. $encodedurl .'" />'."\n";
593f9b87 513 $this->page->requires->js_function_call('document.location.replace', array($url), false, ($delay + 3));
d9c8f425 514 }
515 $output = $this->header();
516 break;
517 case moodle_page::STATE_PRINTING_HEADER :
518 // We should hopefully never get here
519 throw new coding_exception('You cannot redirect while printing the page header');
520 break;
521 case moodle_page::STATE_IN_BODY :
522 // We really shouldn't be here but we can deal with this
523 debugging("You should really redirect before you start page output");
524 if (!$debugdisableredirect) {
593f9b87 525 $this->page->requires->js_function_call('document.location.replace', array($url), false, $delay);
d9c8f425 526 }
527 $output = $this->opencontainers->pop_all_but_last();
528 break;
529 case moodle_page::STATE_DONE :
530 // Too late to be calling redirect now
531 throw new coding_exception('You cannot redirect after the entire page has been generated');
532 break;
533 }
534 $output .= $this->notification($message, 'redirectmessage');
535 $output .= '<a href="'. $encodedurl .'">'. get_string('continue') .'</a>';
536 if ($debugdisableredirect) {
537 $output .= '<p><strong>Error output, so disabling automatic redirect.</strong></p>';
538 }
539 $output .= $this->footer();
540 return $output;
541 }
542
543 /**
544 * Start output by sending the HTTP headers, and printing the HTML <head>
545 * and the start of the <body>.
546 *
547 * To control what is printed, you should set properties on $PAGE. If you
548 * are familiar with the old {@link print_header()} function from Moodle 1.9
549 * you will find that there are properties on $PAGE that correspond to most
550 * of the old parameters to could be passed to print_header.
551 *
552 * Not that, in due course, the remaining $navigation, $menu parameters here
553 * will be replaced by more properties of $PAGE, but that is still to do.
554 *
d9c8f425 555 * @return string HTML that you must output this, preferably immediately.
556 */
e120c61d 557 public function header() {
d9c8f425 558 global $USER, $CFG;
559
560 $this->page->set_state(moodle_page::STATE_PRINTING_HEADER);
561
78946b9b
PS
562 // Find the appropriate page layout file, based on $this->page->pagelayout.
563 $layoutfile = $this->page->theme->layout_file($this->page->pagelayout);
564 // Render the layout using the layout file.
565 $rendered = $this->render_page_layout($layoutfile);
67e84a7f 566
78946b9b
PS
567 // Slice the rendered output into header and footer.
568 $cutpos = strpos($rendered, self::MAIN_CONTENT_TOKEN);
d9c8f425 569 if ($cutpos === false) {
78946b9b 570 throw new coding_exception('page layout file ' . $layoutfile .
d9c8f425 571 ' does not contain the string "' . self::MAIN_CONTENT_TOKEN . '".');
572 }
78946b9b
PS
573 $header = substr($rendered, 0, $cutpos);
574 $footer = substr($rendered, $cutpos + strlen(self::MAIN_CONTENT_TOKEN));
d9c8f425 575
576 if (empty($this->contenttype)) {
78946b9b 577 debugging('The page layout file did not call $OUTPUT->doctype()');
67e84a7f 578 $header = $this->doctype() . $header;
d9c8f425 579 }
580
581 send_headers($this->contenttype, $this->page->cacheable);
67e84a7f 582
d9c8f425 583 $this->opencontainers->push('header/footer', $footer);
584 $this->page->set_state(moodle_page::STATE_IN_BODY);
67e84a7f 585
d9c8f425 586 return $header . $this->skip_link_target();
587 }
588
589 /**
78946b9b
PS
590 * Renders and outputs the page layout file.
591 * @param string $layoutfile The name of the layout file
d9c8f425 592 * @return string HTML code
593 */
78946b9b 594 protected function render_page_layout($layoutfile) {
92e01ab7 595 global $CFG, $SITE, $USER;
d9c8f425 596 // The next lines are a bit tricky. The point is, here we are in a method
597 // of a renderer class, and this object may, or may not, be the same as
78946b9b 598 // the global $OUTPUT object. When rendering the page layout file, we want to use
d9c8f425 599 // this object. However, people writing Moodle code expect the current
600 // renderer to be called $OUTPUT, not $this, so define a variable called
601 // $OUTPUT pointing at $this. The same comment applies to $PAGE and $COURSE.
602 $OUTPUT = $this;
603 $PAGE = $this->page;
604 $COURSE = $this->page->course;
605
d9c8f425 606 ob_start();
78946b9b
PS
607 include($layoutfile);
608 $rendered = ob_get_contents();
d9c8f425 609 ob_end_clean();
78946b9b 610 return $rendered;
d9c8f425 611 }
612
613 /**
614 * Outputs the page's footer
615 * @return string HTML fragment
616 */
617 public function footer() {
d5a8d9aa 618 global $CFG, $DB;
0f0801f4 619
f6794ace 620 $output = $this->container_end_all(true);
d9c8f425 621
622 $footer = $this->opencontainers->pop('header/footer');
623
d5a8d9aa 624 if (debugging() and $DB and $DB->is_transaction_started()) {
03221650 625 // TODO: MDL-20625 print warning - transaction will be rolled back
d5a8d9aa
PS
626 }
627
d9c8f425 628 // Provide some performance info if required
629 $performanceinfo = '';
630 if (defined('MDL_PERF') || (!empty($CFG->perfdebug) and $CFG->perfdebug > 7)) {
631 $perf = get_performance_info();
632 if (defined('MDL_PERFTOLOG') && !function_exists('register_shutdown_function')) {
633 error_log("PERF: " . $perf['txt']);
634 }
635 if (defined('MDL_PERFTOFOOT') || debugging() || $CFG->perfdebug > 7) {
636 $performanceinfo = $perf['html'];
637 }
638 }
639 $footer = str_replace(self::PERFORMANCE_INFO_TOKEN, $performanceinfo, $footer);
640
641 $footer = str_replace(self::END_HTML_TOKEN, $this->page->requires->get_end_code(), $footer);
642
643 $this->page->set_state(moodle_page::STATE_DONE);
644
645
646 return $output . $footer;
647 }
648
f6794ace
PS
649 /**
650 * Close all but the last open container. This is useful in places like error
651 * handling, where you want to close all the open containers (apart from <body>)
652 * before outputting the error message.
653 * @param bool $shouldbenone assert that the stack should be empty now - causes a
654 * developer debug warning if it isn't.
655 * @return string the HTML required to close any open containers inside <body>.
656 */
657 public function container_end_all($shouldbenone = false) {
658 return $this->opencontainers->pop_all_but_last($shouldbenone);
659 }
660
244a32c6
PS
661 /**
662 * Returns lang menu or '', this method also checks forcing of languages in courses.
663 * @return string
664 */
665 public function lang_menu() {
666 global $CFG;
667
668 if (empty($CFG->langmenu)) {
669 return '';
670 }
671
672 if ($this->page->course != SITEID and !empty($this->page->course->lang)) {
673 // do not show lang menu if language forced
674 return '';
675 }
676
677 $currlang = current_language();
678 $langs = get_list_of_languages();
4bcc5118 679
244a32c6
PS
680 if (count($langs) < 2) {
681 return '';
682 }
683
a9967cf5
PS
684 $s = new single_select($this->page->url, 'lang', $langs, $currlang, null);
685 $s->label = get_accesshide(get_string('language'));
686 $s->class = 'langmenu';
687 return $this->render($s);
244a32c6
PS
688 }
689
d9c8f425 690 /**
691 * Output the row of editing icons for a block, as defined by the controls array.
692 * @param array $controls an array like {@link block_contents::$controls}.
693 * @return HTML fragment.
694 */
695 public function block_controls($controls) {
696 if (empty($controls)) {
697 return '';
698 }
699 $controlshtml = array();
700 foreach ($controls as $control) {
f4ed6fc4 701 $controlshtml[] = html_writer::tag('a',
26acc814 702 html_writer::empty_tag('img', array('src' => $this->pix_url($control['icon'])->out(false), 'alt' => $control['caption'])),
f4ed6fc4 703 array('class' => 'icon','title' => $control['caption'], 'href' => $control['url']));
d9c8f425 704 }
26acc814 705 return html_writer::tag('div', implode('', $controlshtml), array('class' => 'commands'));
d9c8f425 706 }
707
708 /**
709 * Prints a nice side block with an optional header.
710 *
711 * The content is described
712 * by a {@link block_contents} object.
713 *
714 * @param block_contents $bc HTML for the content
715 * @param string $region the region the block is appearing in.
716 * @return string the HTML to be output.
717 */
dd72b308 718 function block(block_contents $bc, $region) {
d9c8f425 719 $bc = clone($bc); // Avoid messing up the object passed in.
dd72b308
PS
720 if (empty($bc->blockinstanceid) || !strip_tags($bc->title)) {
721 $bc->collapsible = block_contents::NOT_HIDEABLE;
722 }
723 if ($bc->collapsible == block_contents::HIDDEN) {
724 $bc->add_class('hidden');
725 }
726 if (!empty($bc->controls)) {
727 $bc->add_class('block_with_controls');
728 }
d9c8f425 729
730 $skiptitle = strip_tags($bc->title);
731 if (empty($skiptitle)) {
732 $output = '';
733 $skipdest = '';
734 } else {
26acc814
PS
735 $output = html_writer::tag('a', get_string('skipa', 'access', $skiptitle), array('href' => '#sb-' . $bc->skipid, 'class' => 'skip-block'));
736 $skipdest = html_writer::tag('span', '', array('id' => 'sb-' . $bc->skipid, 'class' => 'skip-block-to'));
d9c8f425 737 }
738
5d0c95a5 739 $output .= html_writer::start_tag('div', $bc->attributes);
d9c8f425 740
741 $controlshtml = $this->block_controls($bc->controls);
742
743 $title = '';
744 if ($bc->title) {
26acc814 745 $title = html_writer::tag('h2', $bc->title, null);
d9c8f425 746 }
747
748 if ($title || $controlshtml) {
46de77b6 749 $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'));
d9c8f425 750 }
751
5d0c95a5 752 $output .= html_writer::start_tag('div', array('class' => 'content'));
46de77b6
SH
753 if (!$title && !$controlshtml) {
754 $output .= html_writer::tag('div', '', array('class'=>'block_action notitle'));
755 }
d9c8f425 756 $output .= $bc->content;
757
758 if ($bc->footer) {
26acc814 759 $output .= html_writer::tag('div', $bc->footer, array('class' => 'footer'));
d9c8f425 760 }
761
5d0c95a5
PS
762 $output .= html_writer::end_tag('div');
763 $output .= html_writer::end_tag('div');
d9c8f425 764
765 if ($bc->annotation) {
26acc814 766 $output .= html_writer::tag('div', $bc->annotation, array('class' => 'blockannotation'));
d9c8f425 767 }
768 $output .= $skipdest;
769
770 $this->init_block_hider_js($bc);
771 return $output;
772 }
773
774 /**
775 * Calls the JS require function to hide a block.
776 * @param block_contents $bc A block_contents object
777 * @return void
778 */
dd72b308
PS
779 protected function init_block_hider_js(block_contents $bc) {
780 if (!empty($bc->attributes['id']) and $bc->collapsible != block_contents::NOT_HIDEABLE) {
d9c8f425 781 $userpref = 'block' . $bc->blockinstanceid . 'hidden';
782 user_preference_allow_ajax_update($userpref, PARAM_BOOL);
f44b10ed
PS
783 $this->page->requires->yui2_lib('dom');
784 $this->page->requires->yui2_lib('event');
d9c8f425 785 $plaintitle = strip_tags($bc->title);
dd72b308 786 $this->page->requires->js_function_call('new block_hider', array($bc->attributes['id'], $userpref,
d9c8f425 787 get_string('hideblocka', 'access', $plaintitle), get_string('showblocka', 'access', $plaintitle),
b9bc2019 788 $this->pix_url('t/switch_minus')->out(false), $this->pix_url('t/switch_plus')->out(false)));
d9c8f425 789 }
790 }
791
792 /**
793 * Render the contents of a block_list.
794 * @param array $icons the icon for each item.
795 * @param array $items the content of each item.
796 * @return string HTML
797 */
798 public function list_block_contents($icons, $items) {
799 $row = 0;
800 $lis = array();
801 foreach ($items as $key => $string) {
5d0c95a5 802 $item = html_writer::start_tag('li', array('class' => 'r' . $row));
2c5ec833 803 if (!empty($icons[$key])) { //test if the content has an assigned icon
26acc814 804 $item .= html_writer::tag('div', $icons[$key], array('class' => 'icon column c0'));
d9c8f425 805 }
26acc814 806 $item .= html_writer::tag('div', $string, array('class' => 'column c1'));
5d0c95a5 807 $item .= html_writer::end_tag('li');
d9c8f425 808 $lis[] = $item;
809 $row = 1 - $row; // Flip even/odd.
810 }
26acc814 811 return html_writer::tag('ul', implode("\n", $lis), array('class' => 'list'));
d9c8f425 812 }
813
814 /**
815 * Output all the blocks in a particular region.
816 * @param string $region the name of a region on this page.
817 * @return string the HTML to be output.
818 */
819 public function blocks_for_region($region) {
820 $blockcontents = $this->page->blocks->get_content_for_region($region, $this);
821
822 $output = '';
823 foreach ($blockcontents as $bc) {
824 if ($bc instanceof block_contents) {
825 $output .= $this->block($bc, $region);
826 } else if ($bc instanceof block_move_target) {
827 $output .= $this->block_move_target($bc);
828 } else {
829 throw new coding_exception('Unexpected type of thing (' . get_class($bc) . ') found in list of block contents.');
830 }
831 }
832 return $output;
833 }
834
835 /**
836 * Output a place where the block that is currently being moved can be dropped.
837 * @param block_move_target $target with the necessary details.
838 * @return string the HTML to be output.
839 */
840 public function block_move_target($target) {
6ee744b3 841 return html_writer::tag('a', html_writer::tag('span', $target->text, array('class' => 'accesshide')), array('href' => $target->url, 'class' => 'blockmovetarget'));
d9c8f425 842 }
843
574fbea4
PS
844 /**
845 * Renders a sepcial html link with attached action
846 *
847 * @param string|moodle_url $url
848 * @param string $text HTML fragment
849 * @param component_action $action
11820bac 850 * @param array $attributes associative array of html link attributes + disabled
574fbea4
PS
851 * @return HTML fragment
852 */
c63923bd 853 public function action_link($url, $text, component_action $action = null, array $attributes=null) {
574fbea4
PS
854 if (!($url instanceof moodle_url)) {
855 $url = new moodle_url($url);
856 }
857 $link = new action_link($url, $text, $action, $attributes);
858
f14b641b 859 return $this->render($link);
574fbea4
PS
860 }
861
862 /**
863 * Implementation of action_link rendering
864 * @param action_link $link
865 * @return string HTML fragment
866 */
867 protected function render_action_link(action_link $link) {
868 global $CFG;
869
870 // A disabled link is rendered as formatted text
871 if (!empty($link->attributes['disabled'])) {
872 // do not use div here due to nesting restriction in xhtml strict
873 return html_writer::tag('span', $link->text, array('class'=>'currentlink'));
874 }
11820bac 875
574fbea4
PS
876 $attributes = $link->attributes;
877 unset($link->attributes['disabled']);
878 $attributes['href'] = $link->url;
879
880 if ($link->actions) {
f14b641b 881 if (empty($attributes['id'])) {
574fbea4
PS
882 $id = html_writer::random_id('action_link');
883 $attributes['id'] = $id;
884 } else {
885 $id = $attributes['id'];
886 }
887 foreach ($link->actions as $action) {
c80877aa 888 $this->add_action_handler($action, $id);
574fbea4
PS
889 }
890 }
891
26acc814 892 return html_writer::tag('a', $link->text, $attributes);
574fbea4
PS
893 }
894
c63923bd
PS
895
896 /**
897 * Similar to action_link, image is used instead of the text
898 *
899 * @param string|moodle_url $url A string URL or moodel_url
900 * @param pix_icon $pixicon
901 * @param component_action $action
902 * @param array $attributes associative array of html link attributes + disabled
903 * @param bool $linktext show title next to image in link
904 * @return string HTML fragment
905 */
906 public function action_icon($url, pix_icon $pixicon, component_action $action = null, array $attributes = null, $linktext=false) {
907 if (!($url instanceof moodle_url)) {
908 $url = new moodle_url($url);
909 }
910 $attributes = (array)$attributes;
911
524645e7 912 if (empty($attributes['class'])) {
c63923bd
PS
913 // let ppl override the class via $options
914 $attributes['class'] = 'action-icon';
915 }
916
917 $icon = $this->render($pixicon);
918
919 if ($linktext) {
920 $text = $pixicon->attributes['alt'];
921 } else {
922 $text = '';
923 }
924
925 return $this->action_link($url, $text.$icon, $action, $attributes);
926 }
927
d9c8f425 928 /**
0b634d75 929 * Print a message along with button choices for Continue/Cancel
930 *
4ed85790 931 * If a string or moodle_url is given instead of a single_button, method defaults to post.
0b634d75 932 *
d9c8f425 933 * @param string $message The question to ask the user
3ba60ee1
PS
934 * @param single_button|moodle_url|string $continue The single_button component representing the Continue answer. Can also be a moodle_url or string URL
935 * @param single_button|moodle_url|string $cancel The single_button component representing the Cancel answer. Can also be a moodle_url or string URL
d9c8f425 936 * @return string HTML fragment
937 */
938 public function confirm($message, $continue, $cancel) {
4871a238 939 if ($continue instanceof single_button) {
11820bac 940 // ok
4871a238
PS
941 } else if (is_string($continue)) {
942 $continue = new single_button(new moodle_url($continue), get_string('continue'), 'post');
943 } else if ($continue instanceof moodle_url) {
26eab8d4 944 $continue = new single_button($continue, get_string('continue'), 'post');
d9c8f425 945 } else {
4ed85790 946 throw new coding_exception('The continue param to $OUTPUT->confirm() must be either a URL (string/moodle_url) or a single_button instance.');
d9c8f425 947 }
948
4871a238 949 if ($cancel instanceof single_button) {
11820bac 950 // ok
4871a238
PS
951 } else if (is_string($cancel)) {
952 $cancel = new single_button(new moodle_url($cancel), get_string('cancel'), 'get');
953 } else if ($cancel instanceof moodle_url) {
26eab8d4 954 $cancel = new single_button($cancel, get_string('cancel'), 'get');
d9c8f425 955 } else {
4ed85790 956 throw new coding_exception('The cancel param to $OUTPUT->confirm() must be either a URL (string/moodle_url) or a single_button instance.');
d9c8f425 957 }
958
d9c8f425 959 $output = $this->box_start('generalbox', 'notice');
26acc814
PS
960 $output .= html_writer::tag('p', $message);
961 $output .= html_writer::tag('div', $this->render($continue) . $this->render($cancel), array('class' => 'buttons'));
d9c8f425 962 $output .= $this->box_end();
963 return $output;
964 }
965
3cd5305f 966 /**
3ba60ee1 967 * Returns a form with a single button.
3cd5305f 968 *
3ba60ee1 969 * @param string|moodle_url $url
3cd5305f
PS
970 * @param string $label button text
971 * @param string $method get or post submit method
3ba60ee1 972 * @param array $options associative array {disabled, title, etc.}
3cd5305f
PS
973 * @return string HTML fragment
974 */
3ba60ee1 975 public function single_button($url, $label, $method='post', array $options=null) {
574fbea4
PS
976 if (!($url instanceof moodle_url)) {
977 $url = new moodle_url($url);
3ba60ee1 978 }
574fbea4
PS
979 $button = new single_button($url, $label, $method);
980
3ba60ee1
PS
981 foreach ((array)$options as $key=>$value) {
982 if (array_key_exists($key, $button)) {
983 $button->$key = $value;
984 }
3cd5305f
PS
985 }
986
3ba60ee1 987 return $this->render($button);
3cd5305f
PS
988 }
989
d9c8f425 990 /**
3ba60ee1
PS
991 * Internal implementation of single_button rendering
992 * @param single_button $button
d9c8f425 993 * @return string HTML fragment
994 */
3ba60ee1
PS
995 protected function render_single_button(single_button $button) {
996 $attributes = array('type' => 'submit',
997 'value' => $button->label,
db09524d 998 'disabled' => $button->disabled ? 'disabled' : null,
3ba60ee1
PS
999 'title' => $button->tooltip);
1000
1001 if ($button->actions) {
1002 $id = html_writer::random_id('single_button');
1003 $attributes['id'] = $id;
1004 foreach ($button->actions as $action) {
c80877aa 1005 $this->add_action_handler($action, $id);
3ba60ee1 1006 }
d9c8f425 1007 }
d9c8f425 1008
3ba60ee1
PS
1009 // first the input element
1010 $output = html_writer::empty_tag('input', $attributes);
d9c8f425 1011
3ba60ee1
PS
1012 // then hidden fields
1013 $params = $button->url->params();
1014 if ($button->method === 'post') {
1015 $params['sesskey'] = sesskey();
1016 }
1017 foreach ($params as $var => $val) {
1018 $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => $var, 'value' => $val));
1019 }
d9c8f425 1020
3ba60ee1 1021 // then div wrapper for xhtml strictness
26acc814 1022 $output = html_writer::tag('div', $output);
d9c8f425 1023
3ba60ee1 1024 // now the form itself around it
eb788065 1025 $url = $button->url->out_omit_querystring(); // url without params
a6855934
PS
1026 if ($url === '') {
1027 $url = '#'; // there has to be always some action
1028 }
3ba60ee1 1029 $attributes = array('method' => $button->method,
a6855934 1030 'action' => $url,
3ba60ee1 1031 'id' => $button->formid);
26acc814 1032 $output = html_writer::tag('form', $output, $attributes);
d9c8f425 1033
3ba60ee1 1034 // and finally one more wrapper with class
26acc814 1035 return html_writer::tag('div', $output, array('class' => $button->class));
d9c8f425 1036 }
1037
a9967cf5 1038 /**
ab08be98 1039 * Returns a form with a single select widget.
a9967cf5
PS
1040 * @param moodle_url $url form action target, includes hidden fields
1041 * @param string $name name of selection field - the changing parameter in url
1042 * @param array $options list of options
1043 * @param string $selected selected element
1044 * @param array $nothing
f8dab966 1045 * @param string $formid
a9967cf5
PS
1046 * @return string HTML fragment
1047 */
f8dab966 1048 public function single_select($url, $name, array $options, $selected='', $nothing=array(''=>'choosedots'), $formid=null) {
a9967cf5
PS
1049 if (!($url instanceof moodle_url)) {
1050 $url = new moodle_url($url);
1051 }
f8dab966 1052 $select = new single_select($url, $name, $options, $selected, $nothing, $formid);
a9967cf5
PS
1053
1054 return $this->render($select);
1055 }
1056
1057 /**
1058 * Internal implementation of single_select rendering
1059 * @param single_select $select
1060 * @return string HTML fragment
1061 */
1062 protected function render_single_select(single_select $select) {
1063 $select = clone($select);
1064 if (empty($select->formid)) {
1065 $select->formid = html_writer::random_id('single_select_f');
1066 }
1067
1068 $output = '';
1069 $params = $select->url->params();
1070 if ($select->method === 'post') {
1071 $params['sesskey'] = sesskey();
1072 }
1073 foreach ($params as $name=>$value) {
1074 $output .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>$name, 'value'=>$value));
1075 }
1076
1077 if (empty($select->attributes['id'])) {
1078 $select->attributes['id'] = html_writer::random_id('single_select');
1079 }
1080
0b2cb132
PS
1081 if ($select->disabled) {
1082 $select->attributes['disabled'] = 'disabled';
1083 }
4d10e579 1084
a9967cf5
PS
1085 if ($select->tooltip) {
1086 $select->attributes['title'] = $select->tooltip;
1087 }
1088
1089 if ($select->label) {
26acc814 1090 $output .= html_writer::tag('label', $select->label, array('for'=>$select->attributes['id']));
a9967cf5
PS
1091 }
1092
1093 if ($select->helpicon instanceof help_icon) {
1094 $output .= $this->render($select->helpicon);
1095 }
1096
1097 $output .= html_writer::select($select->options, $select->name, $select->selected, $select->nothing, $select->attributes);
1098
1099 $go = html_writer::empty_tag('input', array('type'=>'submit', 'value'=>get_string('go')));
26acc814 1100 $output .= html_writer::tag('noscript', $go, array('style'=>'inline'));
a9967cf5
PS
1101
1102 $nothing = empty($select->nothing) ? false : key($select->nothing);
edc28287 1103 $this->page->requires->js_init_call('M.util.init_select_autosubmit', array($select->formid, $select->attributes['id'], $nothing));
a9967cf5
PS
1104
1105 // then div wrapper for xhtml strictness
26acc814 1106 $output = html_writer::tag('div', $output);
a9967cf5
PS
1107
1108 // now the form itself around it
1109 $formattributes = array('method' => $select->method,
1110 'action' => $select->url->out_omit_querystring(),
1111 'id' => $select->formid);
26acc814 1112 $output = html_writer::tag('form', $output, $formattributes);
4d10e579
PS
1113
1114 // and finally one more wrapper with class
26acc814 1115 return html_writer::tag('div', $output, array('class' => $select->class));
4d10e579
PS
1116 }
1117
1118 /**
ab08be98 1119 * Returns a form with a url select widget.
4d10e579
PS
1120 * @param array $urls list of urls - array('/course/view.php?id=1'=>'Frontpage', ....)
1121 * @param string $selected selected element
1122 * @param array $nothing
1123 * @param string $formid
1124 * @return string HTML fragment
1125 */
1126 public function url_select(array $urls, $selected, $nothing=array(''=>'choosedots'), $formid=null) {
1127 $select = new url_select($urls, $selected, $nothing, $formid);
1128 return $this->render($select);
1129 }
1130
1131 /**
ab08be98 1132 * Internal implementation of url_select rendering
4d10e579
PS
1133 * @param single_select $select
1134 * @return string HTML fragment
1135 */
1136 protected function render_url_select(url_select $select) {
1137 $select = clone($select);
1138 if (empty($select->formid)) {
1139 $select->formid = html_writer::random_id('url_select_f');
1140 }
1141
1142 if (empty($select->attributes['id'])) {
1143 $select->attributes['id'] = html_writer::random_id('url_select');
1144 }
1145
1146 if ($select->disabled) {
1147 $select->attributes['disabled'] = 'disabled';
1148 }
1149
1150 if ($select->tooltip) {
1151 $select->attributes['title'] = $select->tooltip;
1152 }
1153
1154 $output = '';
1155
1156 if ($select->label) {
26acc814 1157 $output .= html_writer::tag('label', $select->label, array('for'=>$select->attributes['id']));
4d10e579
PS
1158 }
1159
1160 if ($select->helpicon instanceof help_icon) {
1161 $output .= $this->render($select->helpicon);
1162 }
1163
1164 $output .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'sesskey', 'value'=>sesskey()));
1165 $output .= html_writer::select($select->urls, 'jump', $select->selected, $select->nothing, $select->attributes);
1166
1167 $go = html_writer::empty_tag('input', array('type'=>'submit', 'value'=>get_string('go')));
26acc814 1168 $output .= html_writer::tag('noscript', $go, array('style'=>'inline'));
4d10e579
PS
1169
1170 $nothing = empty($select->nothing) ? false : key($select->nothing);
1171 $output .= $this->page->requires->js_init_call('M.util.init_url_select', array($select->formid, $select->attributes['id'], $nothing));
1172
1173 // then div wrapper for xhtml strictness
26acc814 1174 $output = html_writer::tag('div', $output);
4d10e579
PS
1175
1176 // now the form itself around it
1177 $formattributes = array('method' => 'post',
1178 'action' => new moodle_url('/course/jumpto.php'),
1179 'id' => $select->formid);
26acc814 1180 $output = html_writer::tag('form', $output, $formattributes);
a9967cf5
PS
1181
1182 // and finally one more wrapper with class
26acc814 1183 return html_writer::tag('div', $output, array('class' => $select->class));
a9967cf5
PS
1184 }
1185
d9c8f425 1186 /**
1187 * Returns a string containing a link to the user documentation.
1188 * Also contains an icon by default. Shown to teachers and admin only.
1189 * @param string $path The page link after doc root and language, no leading slash.
1190 * @param string $text The text to be displayed for the link
8ae8bf8a 1191 * @retrun string
d9c8f425 1192 */
8ae8bf8a
PS
1193 public function doc_link($path, $text) {
1194 global $CFG;
1195
000c278c 1196 $icon = $this->pix_icon('docs', $text, 'moodle', array('class'=>'iconhelp'));
8ae8bf8a 1197
000c278c 1198 $url = new moodle_url(get_docs_url($path));
8ae8bf8a 1199
c80877aa 1200 $attributes = array('href'=>$url);
d9c8f425 1201 if (!empty($CFG->doctonewwindow)) {
c80877aa 1202 $attributes['id'] = $this->add_action_handler(new popup_action('click', $url));
d9c8f425 1203 }
1adaa404 1204
26acc814 1205 return html_writer::tag('a', $icon.$text, $attributes);
d9c8f425 1206 }
1207
000c278c
PS
1208 /**
1209 * Render icon
1210 * @param string $pix short pix name
1211 * @param string $alt mandatory alt attribute
1212 * @param strin $component standard compoennt name like 'moodle', 'mod_form', etc.
1213 * @param array $attributes htm lattributes
1214 * @return string HTML fragment
1215 */
1216 public function pix_icon($pix, $alt, $component='moodle', array $attributes = null) {
1217 $icon = new pix_icon($pix, $alt, $component, $attributes);
1218 return $this->render($icon);
1219 }
1220
1221 /**
1222 * Render icon
1223 * @param pix_icon $icon
1224 * @return string HTML fragment
1225 */
ce0110bf 1226 protected function render_pix_icon(pix_icon $icon) {
000c278c
PS
1227 $attributes = $icon->attributes;
1228 $attributes['src'] = $this->pix_url($icon->pix, $icon->component);
c80877aa 1229 return html_writer::empty_tag('img', $attributes);
000c278c
PS
1230 }
1231
a09aeee4
AD
1232 /**
1233 * Produces the html that represents this rating in the UI
1234 * @param $page the page object on which this rating will appear
1235 */
1236 function render_rating(rating $rating) {
7ac928a7 1237 global $CFG, $USER;
a09aeee4
AD
1238 static $havesetupjavascript = false;
1239
b1721f67
AD
1240 $useajax = !empty($CFG->enableajax);
1241
1242 //include required Javascript
1243 if( !$havesetupjavascript && $useajax ) {
3dcdf440 1244 $this->page->requires->js_init_call('M.core_rating.init');
a09aeee4
AD
1245 $havesetupjavascript = true;
1246 }
1247
f1f6a755
AD
1248 $strrate = get_string("rate", "rating");
1249 $strratings = ''; //the string we'll return
a09aeee4 1250
8b69c341 1251 if($rating->settings->permissions->canview || $rating->settings->permissions->canviewall) {
a09aeee4
AD
1252 switch ($rating->settings->aggregationmethod) {
1253 case RATING_AGGREGATE_AVERAGE :
1254 $strratings .= get_string("aggregateavg", "forum");
1255 break;
1256 case RATING_AGGREGATE_COUNT :
1257 $strratings .= get_string("aggregatecount", "forum");
1258 break;
1259 case RATING_AGGREGATE_MAXIMUM :
1260 $strratings .= get_string("aggregatemax", "forum");
1261 break;
1262 case RATING_AGGREGATE_MINIMUM :
1263 $strratings .= get_string("aggregatemin", "forum");
1264 break;
1265 case RATING_AGGREGATE_SUM :
1266 $strratings .= get_string("aggregatesum", "forum");
1267 break;
1268 }
1269
1270 if (empty($strratings)) {
1271 $strratings .= $strrate;
1272 }
1273 $strratings .= ': ';
1274
1275 $scalemax = 0;
1276 $ratingstr = null;
1277
1278 if ( is_array($rating->settings->scale->scaleitems) ) {
1279 $scalemax = $rating->settings->scale->scaleitems[ count($rating->settings->scale->scaleitems)-1 ];
1280 $ratingstr = $rating->settings->scale->scaleitems[$rating->rating];
1281 }
1282 else { //its numeric
1283 $scalemax = $rating->settings->scale->scaleitems;
1284 $ratingstr = round($rating->aggregate,1);
1285 }
1adaa404 1286
a09aeee4
AD
1287 $aggstr = "{$ratingstr} / $scalemax ({$rating->count}) ";
1288
8b69c341 1289 if ($rating->settings->permissions->canviewall) {
a09aeee4
AD
1290 $link = new moodle_url("/rating/index.php?contextid={$rating->context->id}&itemid={$rating->itemid}&scaleid={$rating->scaleid}");
1291 $action = new popup_action('click', $link, 'ratings', array('height' => 400, 'width' => 600));
1292 $strratings .= $this->action_link($link, $aggstr, $action);
8b69c341 1293 } else if ($rating->settings->permissions->canview) {
a09aeee4
AD
1294 $strratings .= $aggstr;
1295 }
1296 }
1297
1298 //todo andrew alter the below if to deny guest users the ability to post ratings.
1299 //Petr to define "guest"
1300 $formstart = null;
8b69c341 1301 if($rating->settings->permissions->canrate) {
a09aeee4
AD
1302 //dont use $rating->userid below as it will be null if the user hasnt already rated the item
1303 $formstart = <<<END
1304<form id="postrating{$rating->itemid}" class="postratingform" method="post" action="rating/rate.php">
1305<div class="ratingform">
1306<input type="hidden" class="ratinginput" name="contextid" value="{$rating->context->id}" />
1307<input type="hidden" class="ratinginput" name="itemid" value="{$rating->itemid}" />
1308<input type="hidden" class="ratinginput" name="scaleid" value="{$rating->settings->scale->id}" />
1309<input type="hidden" class="ratinginput" name="returnurl" value="{$rating->settings->returnurl}" />
1310END;
1311 $strratings = $formstart.$strratings;
1312
1313 //generate an array of values for numeric scales
1314 $scalearray = $rating->settings->scale->scaleitems;
6c5fcef7
AD
1315 if( !is_array($scalearray) ) { //almost certainly a numerical scale
1316 $intscalearray = intval($scalearray);//just in case theyve passed "5" instead of 5
1317 if( is_int($intscalearray) && $intscalearray>0 ){
1318 $scalearray = array();
1319 for($i=0; $i<=$rating->settings->scale->scaleitems; $i++) {
1320 $scalearray[$i] = $i;
1321 }
a09aeee4
AD
1322 }
1323 }
6c5fcef7 1324
a09aeee4 1325 $scalearray = array(RATING_UNSET_RATING => $strrate.'...') + $scalearray;
c82ed0a8 1326 $strratings .= html_writer::select($scalearray, 'rating', $rating->rating, false, array('class'=>'postratingmenu ratinginput','id'=>'menurating'.$rating->itemid));
a09aeee4
AD
1327
1328 //output submit button
f1f6a755 1329 $strratings .= '<span class="ratingsubmit"><input type="submit" class="postratingmenusubmit" id="postratingsubmit'.$rating->itemid.'" value="'.s(get_string('rate', 'rating')).'" />';
a09aeee4 1330
a09aeee4
AD
1331 if ( is_array($rating->settings->scale) ) {
1332 //todo andrew where can we get the course id from?
1333 //$strratings .= $this->help_icon_scale($course->id, $scale);
1334 $strratings .= $this->help_icon_scale(1, $rating->settings->scale);
1335 }
1336 $strratings .= '</span></div></form>';
1337 }
1338
1339 return $strratings;
1340 }
1341
d9c8f425 1342 /*
1343 * Centered heading with attached help button (same title text)
1344 * and optional icon attached
4bcc5118 1345 * @param string $text A heading text
53a78cef 1346 * @param string $helpidentifier The keyword that defines a help page
4bcc5118
PS
1347 * @param string $component component name
1348 * @param string|moodle_url $icon
1349 * @param string $iconalt icon alt text
d9c8f425 1350 * @return string HTML fragment
1351 */
53a78cef 1352 public function heading_with_help($text, $helpidentifier, $component='moodle', $icon='', $iconalt='') {
4bcc5118
PS
1353 $image = '';
1354 if ($icon) {
0029a917 1355 $image = $this->pix_icon($icon, $iconalt, $component, array('class'=>'icon'));
d9c8f425 1356 }
4bcc5118 1357
53a78cef 1358 $help = $this->help_icon($helpidentifier, $text, $component);
4bcc5118
PS
1359
1360 return $this->heading($image.$text.$help, 2, 'main help');
d9c8f425 1361 }
1362
1363 /**
1364 * Print a help icon.
1365 *
4bcc5118 1366 * @param string $page The keyword that defines a help page
bf11293a 1367 * @param string $title A descriptive text for accessibility only
4bcc5118 1368 * @param string $component component name
bf11293a
PS
1369 * @param string|bool $linktext true means use $title as link text, string means link text value
1370 * @return string HTML fragment
1371 */
53a78cef
PS
1372 public function help_icon($helpidentifier, $title, $component = 'moodle', $linktext = '') {
1373 $icon = new help_icon($helpidentifier, $title, $component);
bf11293a
PS
1374 if ($linktext === true) {
1375 $icon->linktext = $title;
1376 } else if (!empty($linktext)) {
1377 $icon->linktext = $linktext;
1378 }
1379 return $this->render($icon);
1380 }
4bcc5118 1381
bf11293a
PS
1382 /**
1383 * Implementation of user image rendering.
1384 * @param help_icon $helpicon
1385 * @return string HTML fragment
d9c8f425 1386 */
bf11293a
PS
1387 protected function render_help_icon(help_icon $helpicon) {
1388 global $CFG;
d9c8f425 1389
bf11293a
PS
1390 // first get the help image icon
1391 $src = $this->pix_url('help');
d9c8f425 1392
bf11293a
PS
1393 if (empty($helpicon->linktext)) {
1394 $alt = $helpicon->title;
1395 } else {
1396 $alt = get_string('helpwiththis');
1397 }
1398
1399 $attributes = array('src'=>$src, 'alt'=>$alt, 'class'=>'iconhelp');
1400 $output = html_writer::empty_tag('img', $attributes);
1401
1402 // add the link text if given
1403 if (!empty($helpicon->linktext)) {
1404 // the spacing has to be done through CSS
1405 $output .= $helpicon->linktext;
d9c8f425 1406 }
1407
53a78cef
PS
1408 // now create the link around it
1409 $url = new moodle_url('/help.php', array('component' => $helpicon->component, 'identifier' => $helpicon->helpidentifier, 'lang'=>current_language()));
bf11293a
PS
1410
1411 // note: this title is displayed only if JS is disabled, otherwise the link will have the new ajax tooltip
1412 $title = get_string('helpprefix2', '', trim($helpicon->title, ". \t"));
1413
1414 $attributes = array('href'=>$url, 'title'=>$title);
1415 $id = html_writer::random_id('helpicon');
1416 $attributes['id'] = $id;
c80877aa 1417 $this->add_action_handler(new popup_action('click', $url), $id);
26acc814 1418 $output = html_writer::tag('a', $output, $attributes);
bf11293a
PS
1419
1420 // and finally span
26acc814 1421 return html_writer::tag('span', $output, array('class' => 'helplink'));
d9c8f425 1422 }
1423
1424 /**
4bcc5118 1425 * Print scale help icon.
d9c8f425 1426 *
4bcc5118
PS
1427 * @param int $courseid
1428 * @param object $scale instance
1429 * @return string HTML fragment
d9c8f425 1430 */
4bcc5118
PS
1431 public function help_icon_scale($courseid, stdClass $scale) {
1432 global $CFG;
02f64f97 1433
4bcc5118 1434 $title = get_string('helpprefix2', '', $scale->name) .' ('.get_string('newwindow').')';
02f64f97 1435
0029a917 1436 $icon = $this->pix_icon('help', get_string('scales'), 'moodle', array('class'=>'iconhelp'));
02f64f97 1437
57cd3739 1438 $link = new moodle_url('/course/scales.php', array('id' => $courseid, 'list' => true, 'scaleid' => $scale->id));
230ec401 1439 $action = new popup_action('click', $link, 'ratingscale');
02f64f97 1440
26acc814 1441 return html_writer::tag('span', $this->action_link($link, $icon, $action), array('class' => 'helplink'));
d9c8f425 1442 }
1443
1444 /**
1445 * Creates and returns a spacer image with optional line break.
1446 *
0029a917
PS
1447 * @param array $attributes
1448 * @param boo spacer
d9c8f425 1449 * @return string HTML fragment
1450 */
0029a917
PS
1451 public function spacer(array $attributes = null, $br = false) {
1452 $attributes = (array)$attributes;
1453 if (empty($attributes['width'])) {
1454 $attributes['width'] = 1;
1ba862ec
PS
1455 }
1456 if (empty($options['height'])) {
0029a917 1457 $attributes['height'] = 1;
d9c8f425 1458 }
0029a917 1459 $attributes['class'] = 'spacer';
d9c8f425 1460
0029a917 1461 $output = $this->pix_icon('spacer', '', 'moodle', $attributes);
b65bfc3e 1462
0029a917 1463 if (!empty($br)) {
1ba862ec
PS
1464 $output .= '<br />';
1465 }
d9c8f425 1466
1467 return $output;
1468 }
1469
d9c8f425 1470 /**
1471 * Print the specified user's avatar.
1472 *
5d0c95a5 1473 * User avatar may be obtained in two ways:
d9c8f425 1474 * <pre>
812dbaf7
PS
1475 * // Option 1: (shortcut for simple cases, preferred way)
1476 * // $user has come from the DB and has fields id, picture, imagealt, firstname and lastname
1477 * $OUTPUT->user_picture($user, array('popup'=>true));
1478 *
5d0c95a5
PS
1479 * // Option 2:
1480 * $userpic = new user_picture($user);
d9c8f425 1481 * // Set properties of $userpic
812dbaf7 1482 * $userpic->popup = true;
5d0c95a5 1483 * $OUTPUT->render($userpic);
d9c8f425 1484 * </pre>
1485 *
5d0c95a5 1486 * @param object Object with at least fields id, picture, imagealt, firstname, lastname
812dbaf7 1487 * If any of these are missing, the database is queried. Avoid this
d9c8f425 1488 * if at all possible, particularly for reports. It is very bad for performance.
812dbaf7
PS
1489 * @param array $options associative array with user picture options, used only if not a user_picture object,
1490 * options are:
1491 * - courseid=$this->page->course->id (course id of user profile in link)
1492 * - size=35 (size of image)
1493 * - link=true (make image clickable - the link leads to user profile)
1494 * - popup=false (open in popup)
1495 * - alttext=true (add image alt attribute)
5d0c95a5 1496 * - class = image class attribute (default 'userpicture')
d9c8f425 1497 * @return string HTML fragment
1498 */
5d0c95a5
PS
1499 public function user_picture(stdClass $user, array $options = null) {
1500 $userpicture = new user_picture($user);
1501 foreach ((array)$options as $key=>$value) {
1502 if (array_key_exists($key, $userpicture)) {
1503 $userpicture->$key = $value;
1504 }
1505 }
1506 return $this->render($userpicture);
1507 }
1508
1509 /**
1510 * Internal implementation of user image rendering.
1511 * @param user_picture $userpicture
1512 * @return string
1513 */
1514 protected function render_user_picture(user_picture $userpicture) {
1515 global $CFG, $DB;
812dbaf7 1516
5d0c95a5
PS
1517 $user = $userpicture->user;
1518
1519 if ($userpicture->alttext) {
1520 if (!empty($user->imagealt)) {
1521 $alt = $user->imagealt;
1522 } else {
1523 $alt = get_string('pictureof', '', fullname($user));
1524 }
d9c8f425 1525 } else {
97c10099 1526 $alt = '';
5d0c95a5
PS
1527 }
1528
1529 if (empty($userpicture->size)) {
1530 $file = 'f2';
1531 $size = 35;
1532 } else if ($userpicture->size === true or $userpicture->size == 1) {
1533 $file = 'f1';
1534 $size = 100;
1535 } else if ($userpicture->size >= 50) {
1536 $file = 'f1';
1537 $size = $userpicture->size;
1538 } else {
1539 $file = 'f2';
1540 $size = $userpicture->size;
d9c8f425 1541 }
1542
5d0c95a5 1543 $class = $userpicture->class;
d9c8f425 1544
5d0c95a5
PS
1545 if (!empty($user->picture)) {
1546 require_once($CFG->libdir.'/filelib.php');
1547 $src = new moodle_url(get_file_url($user->id.'/'.$file.'.jpg', null, 'user'));
1548 } else { // Print default user pictures (use theme version if available)
1549 $class .= ' defaultuserpic';
1550 $src = $this->pix_url('u/' . $file);
1551 }
d9c8f425 1552
5d0c95a5
PS
1553 $attributes = array('src'=>$src, 'alt'=>$alt, 'class'=>$class, 'width'=>$size, 'height'=>$size);
1554
1555 // get the image html output fisrt
1556 $output = html_writer::empty_tag('img', $attributes);;
1557
1558 // then wrap it in link if needed
1559 if (!$userpicture->link) {
1560 return $output;
d9c8f425 1561 }
1562
5d0c95a5
PS
1563 if (empty($userpicture->courseid)) {
1564 $courseid = $this->page->course->id;
1565 } else {
1566 $courseid = $userpicture->courseid;
1567 }
1568
a6855934 1569 $url = new moodle_url('/user/view.php', array('id' => $user->id, 'course' => $courseid));
5d0c95a5
PS
1570
1571 $attributes = array('href'=>$url);
1572
1573 if ($userpicture->popup) {
1574 $id = html_writer::random_id('userpicture');
1575 $attributes['id'] = $id;
c80877aa 1576 $this->add_action_handler(new popup_action('click', $url), $id);
5d0c95a5
PS
1577 }
1578
26acc814 1579 return html_writer::tag('a', $output, $attributes);
d9c8f425 1580 }
1581
1582 /**
1583 * Prints the 'Update this Modulename' button that appears on module pages.
1584 *
1585 * @param string $cmid the course_module id.
1586 * @param string $modulename the module name, eg. "forum", "quiz" or "workshop"
1587 * @return string the HTML for the button, if this user has permission to edit it, else an empty string.
1588 */
1589 public function update_module_button($cmid, $modulename) {
1590 global $CFG;
1591 if (has_capability('moodle/course:manageactivities', get_context_instance(CONTEXT_MODULE, $cmid))) {
1592 $modulename = get_string('modulename', $modulename);
1593 $string = get_string('updatethis', '', $modulename);
3ba60ee1
PS
1594 $url = new moodle_url("$CFG->wwwroot/course/mod.php", array('update' => $cmid, 'return' => true, 'sesskey' => sesskey()));
1595 return $this->single_button($url, $string);
d9c8f425 1596 } else {
1597 return '';
1598 }
1599 }
1600
1601 /**
1602 * Prints a "Turn editing on/off" button in a form.
1603 * @param moodle_url $url The URL + params to send through when clicking the button
1604 * @return string HTML the button
1605 */
1606 public function edit_button(moodle_url $url) {
1607 global $USER;
1608 if (!empty($USER->editing)) {
1609 $string = get_string('turneditingoff');
1610 $edit = '0';
1611 } else {
1612 $string = get_string('turneditingon');
1613 $edit = '1';
1614 }
1615
3ba60ee1 1616 $url = new moodle_url($url, array('edit'=>$edit));
d9c8f425 1617
3ba60ee1 1618 return $this->single_button($url, $string);
d9c8f425 1619 }
1620
d9c8f425 1621 /**
1622 * Prints a simple button to close a window
1623 *
d9c8f425 1624 * @param string $text The lang string for the button's label (already output from get_string())
3ba60ee1 1625 * @return string html fragment
d9c8f425 1626 */
7a5c78e0 1627 public function close_window_button($text='') {
d9c8f425 1628 if (empty($text)) {
1629 $text = get_string('closewindow');
1630 }
a6855934
PS
1631 $button = new single_button(new moodle_url('#'), $text, 'get');
1632 $button->add_action(new component_action('click', 'close_window'));
3ba60ee1
PS
1633
1634 return $this->container($this->render($button), 'closewindow');
d9c8f425 1635 }
1636
d9c8f425 1637 /**
1638 * Output an error message. By default wraps the error message in <span class="error">.
1639 * If the error message is blank, nothing is output.
1640 * @param string $message the error message.
1641 * @return string the HTML to output.
1642 */
1643 public function error_text($message) {
1644 if (empty($message)) {
1645 return '';
1646 }
26acc814 1647 return html_writer::tag('span', $message, array('class' => 'error'));
d9c8f425 1648 }
1649
1650 /**
1651 * Do not call this function directly.
1652 *
1653 * To terminate the current script with a fatal error, call the {@link print_error}
1654 * function, or throw an exception. Doing either of those things will then call this
1655 * function to display the error, before terminating the execution.
1656 *
1657 * @param string $message The message to output
1658 * @param string $moreinfourl URL where more info can be found about the error
1659 * @param string $link Link for the Continue button
1660 * @param array $backtrace The execution backtrace
1661 * @param string $debuginfo Debugging information
d9c8f425 1662 * @return string the HTML to output.
1663 */
83267ec0 1664 public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
d9c8f425 1665
1666 $output = '';
6f8f4d83 1667 $obbuffer = '';
e57c283d 1668
d9c8f425 1669 if ($this->has_started()) {
50764d37
PS
1670 // we can not always recover properly here, we have problems with output buffering,
1671 // html tables, etc.
d9c8f425 1672 $output .= $this->opencontainers->pop_all_but_last();
50764d37 1673
d9c8f425 1674 } else {
50764d37
PS
1675 // It is really bad if library code throws exception when output buffering is on,
1676 // because the buffered text would be printed before our start of page.
1677 // NOTE: this hack might be behave unexpectedly in case output buffering is enabled in PHP.ini
1678 while (ob_get_level() > 0) {
6f8f4d83 1679 $obbuffer .= ob_get_clean();
50764d37 1680 }
6f8f4d83 1681
d9c8f425 1682 // Header not yet printed
85309744 1683 if (isset($_SERVER['SERVER_PROTOCOL'])) {
78946b9b
PS
1684 // server protocol should be always present, because this render
1685 // can not be used from command line or when outputting custom XML
85309744
PS
1686 @header($_SERVER['SERVER_PROTOCOL'] . ' 404 Not Found');
1687 }
7fde1e4b 1688 $this->page->set_url('/'); // no url
191b267b 1689 //$this->page->set_pagelayout('base'); //TODO: MDL-20676 blocks on error pages are weird, unfortunately it somehow detect the pagelayout from URL :-(
d9c8f425 1690 $this->page->set_title(get_string('error'));
1691 $output .= $this->header();
1692 }
1693
1694 $message = '<p class="errormessage">' . $message . '</p>'.
1695 '<p class="errorcode"><a href="' . $moreinfourl . '">' .
1696 get_string('moreinformation') . '</a></p>';
1697 $output .= $this->box($message, 'errorbox');
1698
6f8f4d83
PS
1699 if (debugging('', DEBUG_DEVELOPER)) {
1700 if (!empty($debuginfo)) {
c5d18164
PS
1701 $debuginfo = s($debuginfo); // removes all nasty JS
1702 $debuginfo = str_replace("\n", '<br />', $debuginfo); // keep newlines
1703 $output .= $this->notification('<strong>Debug info:</strong> '.$debuginfo, 'notifytiny');
6f8f4d83
PS
1704 }
1705 if (!empty($backtrace)) {
1706 $output .= $this->notification('<strong>Stack trace:</strong> '.format_backtrace($backtrace), 'notifytiny');
1707 }
1708 if ($obbuffer !== '' ) {
1709 $output .= $this->notification('<strong>Output buffer:</strong> '.s($obbuffer), 'notifytiny');
1710 }
d9c8f425 1711 }
1712
1713 if (!empty($link)) {
1714 $output .= $this->continue_button($link);
1715 }
1716
1717 $output .= $this->footer();
1718
1719 // Padding to encourage IE to display our error page, rather than its own.
1720 $output .= str_repeat(' ', 512);
1721
1722 return $output;
1723 }
1724
1725 /**
1726 * Output a notification (that is, a status message about something that has
1727 * just happened).
1728 *
1729 * @param string $message the message to print out
1730 * @param string $classes normally 'notifyproblem' or 'notifysuccess'.
1731 * @return string the HTML to output.
1732 */
1733 public function notification($message, $classes = 'notifyproblem') {
26acc814 1734 return html_writer::tag('div', clean_text($message), array('class' => renderer_base::prepare_classes($classes)));
d9c8f425 1735 }
1736
1737 /**
1738 * Print a continue button that goes to a particular URL.
1739 *
3ba60ee1 1740 * @param string|moodle_url $url The url the button goes to.
d9c8f425 1741 * @return string the HTML to output.
1742 */
3ba60ee1
PS
1743 public function continue_button($url) {
1744 if (!($url instanceof moodle_url)) {
1745 $url = new moodle_url($url);
d9c8f425 1746 }
3ba60ee1
PS
1747 $button = new single_button($url, get_string('continue'), 'get');
1748 $button->class = 'continuebutton';
d9c8f425 1749
3ba60ee1 1750 return $this->render($button);
d9c8f425 1751 }
1752
1753 /**
1754 * Prints a single paging bar to provide access to other pages (usually in a search)
1755 *
929d7a83
PS
1756 * @param int $totalcount Thetotal number of entries available to be paged through
1757 * @param int $page The page you are currently viewing
1758 * @param int $perpage The number of entries that should be shown per page
1759 * @param string|moodle_url $baseurl url of the current page, the $pagevar parameter is added
1760 * @param string $pagevar name of page parameter that holds the page number
d9c8f425 1761 * @return string the HTML to output.
1762 */
929d7a83
PS
1763 public function paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar = 'page') {
1764 $pb = new paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar);
1765 return $this->render($pb);
1766 }
1767
1768 /**
1769 * Internal implementation of paging bar rendering.
1770 * @param paging_bar $pagingbar
1771 * @return string
1772 */
1773 protected function render_paging_bar(paging_bar $pagingbar) {
d9c8f425 1774 $output = '';
1775 $pagingbar = clone($pagingbar);
34059565 1776 $pagingbar->prepare($this, $this->page, $this->target);
d9c8f425 1777
1778 if ($pagingbar->totalcount > $pagingbar->perpage) {
1779 $output .= get_string('page') . ':';
1780
1781 if (!empty($pagingbar->previouslink)) {
56ddb719 1782 $output .= '&#160;(' . $pagingbar->previouslink . ')&#160;';
d9c8f425 1783 }
1784
1785 if (!empty($pagingbar->firstlink)) {
56ddb719 1786 $output .= '&#160;' . $pagingbar->firstlink . '&#160;...';
d9c8f425 1787 }
1788
1789 foreach ($pagingbar->pagelinks as $link) {
56ddb719 1790 $output .= "&#160;&#160;$link";
d9c8f425 1791 }
1792
1793 if (!empty($pagingbar->lastlink)) {
56ddb719 1794 $output .= '&#160;...' . $pagingbar->lastlink . '&#160;';
d9c8f425 1795 }
1796
1797 if (!empty($pagingbar->nextlink)) {
56ddb719 1798 $output .= '&#160;&#160;(' . $pagingbar->nextlink . ')';
d9c8f425 1799 }
1800 }
1801
26acc814 1802 return html_writer::tag('div', $output, array('class' => 'paging'));
d9c8f425 1803 }
1804
d9c8f425 1805 /**
1806 * Output the place a skip link goes to.
1807 * @param string $id The target name from the corresponding $PAGE->requires->skip_link_to($target) call.
1808 * @return string the HTML to output.
1809 */
fe213365 1810 public function skip_link_target($id = null) {
26acc814 1811 return html_writer::tag('span', '', array('id' => $id));
d9c8f425 1812 }
1813
1814 /**
1815 * Outputs a heading
1816 * @param string $text The text of the heading
1817 * @param int $level The level of importance of the heading. Defaulting to 2
1818 * @param string $classes A space-separated list of CSS classes
1819 * @param string $id An optional ID
1820 * @return string the HTML to output.
1821 */
fe213365 1822 public function heading($text, $level = 2, $classes = 'main', $id = null) {
d9c8f425 1823 $level = (integer) $level;
1824 if ($level < 1 or $level > 6) {
1825 throw new coding_exception('Heading level must be an integer between 1 and 6.');
1826 }
26acc814 1827 return html_writer::tag('h' . $level, $text, array('id' => $id, 'class' => renderer_base::prepare_classes($classes)));
d9c8f425 1828 }
1829
1830 /**
1831 * Outputs a box.
1832 * @param string $contents The contents of the box
1833 * @param string $classes A space-separated list of CSS classes
1834 * @param string $id An optional ID
1835 * @return string the HTML to output.
1836 */
fe213365 1837 public function box($contents, $classes = 'generalbox', $id = null) {
d9c8f425 1838 return $this->box_start($classes, $id) . $contents . $this->box_end();
1839 }
1840
1841 /**
1842 * Outputs the opening section of a box.
1843 * @param string $classes A space-separated list of CSS classes
1844 * @param string $id An optional ID
1845 * @return string the HTML to output.
1846 */
fe213365 1847 public function box_start($classes = 'generalbox', $id = null) {
5d0c95a5
PS
1848 $this->opencontainers->push('box', html_writer::end_tag('div'));
1849 return html_writer::start_tag('div', array('id' => $id,
78946b9b 1850 'class' => 'box ' . renderer_base::prepare_classes($classes)));
d9c8f425 1851 }
1852
1853 /**
1854 * Outputs the closing section of a box.
1855 * @return string the HTML to output.
1856 */
1857 public function box_end() {
1858 return $this->opencontainers->pop('box');
1859 }
1860
1861 /**
1862 * Outputs a container.
1863 * @param string $contents The contents of the box
1864 * @param string $classes A space-separated list of CSS classes
1865 * @param string $id An optional ID
1866 * @return string the HTML to output.
1867 */
fe213365 1868 public function container($contents, $classes = null, $id = null) {
d9c8f425 1869 return $this->container_start($classes, $id) . $contents . $this->container_end();
1870 }
1871
1872 /**
1873 * Outputs the opening section of a container.
1874 * @param string $classes A space-separated list of CSS classes
1875 * @param string $id An optional ID
1876 * @return string the HTML to output.
1877 */
fe213365 1878 public function container_start($classes = null, $id = null) {
5d0c95a5
PS
1879 $this->opencontainers->push('container', html_writer::end_tag('div'));
1880 return html_writer::start_tag('div', array('id' => $id,
78946b9b 1881 'class' => renderer_base::prepare_classes($classes)));
d9c8f425 1882 }
1883
1884 /**
1885 * Outputs the closing section of a container.
1886 * @return string the HTML to output.
1887 */
1888 public function container_end() {
1889 return $this->opencontainers->pop('container');
1890 }
7d2a0492 1891
1892 /**
1893 * Make nested HTML lists out of the items
1894 *
1895 * The resulting list will look something like this:
1896 *
1897 * <pre>
1898 * <<ul>>
1899 * <<li>><div class='tree_item parent'>(item contents)</div>
1900 * <<ul>
1901 * <<li>><div class='tree_item'>(item contents)</div><</li>>
1902 * <</ul>>
1903 * <</li>>
1904 * <</ul>>
1905 * </pre>
1906 *
1907 * @param array[]tree_item $items
1908 * @param array[string]string $attrs html attributes passed to the top of
1909 * the list
1910 * @return string HTML
1911 */
1912 function tree_block_contents($items, $attrs=array()) {
1913 // exit if empty, we don't want an empty ul element
1914 if (empty($items)) {
1915 return '';
1916 }
1917 // array of nested li elements
1918 $lis = array();
1919 foreach ($items as $item) {
1920 // this applies to the li item which contains all child lists too
1921 $content = $item->content($this);
1922 $liclasses = array($item->get_css_type());
1923 if (!$item->forceopen || (!$item->forceopen && $item->collapse) || (count($item->children)==0 && $item->nodetype==navigation_node::NODETYPE_BRANCH)) {
1924 $liclasses[] = 'collapsed';
1925 }
1926 if ($item->isactive === true) {
1927 $liclasses[] = 'current_branch';
1928 }
1929 $liattr = array('class'=>join(' ',$liclasses));
1930 // class attribute on the div item which only contains the item content
1931 $divclasses = array('tree_item');
1932 if (!empty($item->children) || $item->nodetype==navigation_node::NODETYPE_BRANCH) {
1933 $divclasses[] = 'branch';
1934 } else {
1935 $divclasses[] = 'leaf';
1936 }
1937 if (!empty($item->classes) && count($item->classes)>0) {
1938 $divclasses[] = join(' ', $item->classes);
1939 }
1940 $divattr = array('class'=>join(' ', $divclasses));
1941 if (!empty($item->id)) {
1942 $divattr['id'] = $item->id;
1943 }
26acc814 1944 $content = html_writer::tag('p', $content, $divattr) . $this->tree_block_contents($item->children);
7d2a0492 1945 if (!empty($item->preceedwithhr) && $item->preceedwithhr===true) {
26acc814 1946 $content = html_writer::empty_tag('hr') . $content;
7d2a0492 1947 }
26acc814 1948 $content = html_writer::tag('li', $content, $liattr);
7d2a0492 1949 $lis[] = $content;
1950 }
26acc814 1951 return html_writer::tag('ul', implode("\n", $lis), $attrs);
7d2a0492 1952 }
1953
1954 /**
1955 * Return the navbar content so that it can be echoed out by the layout
1956 * @return string XHTML navbar
1957 */
1958 public function navbar() {
1959 return $this->page->navbar->content();
1960 }
92e01ab7
PS
1961
1962 /**
1963 * Accessibility: Right arrow-like character is
1964 * used in the breadcrumb trail, course navigation menu
1965 * (previous/next activity), calendar, and search forum block.
1966 * If the theme does not set characters, appropriate defaults
1967 * are set automatically. Please DO NOT
1968 * use &lt; &gt; &raquo; - these are confusing for blind users.
1969 * @return string
1970 */
1971 public function rarrow() {
1972 return $this->page->theme->rarrow;
1973 }
1974
1975 /**
1976 * Accessibility: Right arrow-like character is
1977 * used in the breadcrumb trail, course navigation menu
1978 * (previous/next activity), calendar, and search forum block.
1979 * If the theme does not set characters, appropriate defaults
1980 * are set automatically. Please DO NOT
1981 * use &lt; &gt; &raquo; - these are confusing for blind users.
1982 * @return string
1983 */
1984 public function larrow() {
1985 return $this->page->theme->larrow;
1986 }
088ccb43
PS
1987
1988 /**
1989 * Returns the colours of the small MP3 player
1990 * @return string
1991 */
1992 public function filter_mediaplugin_colors() {
1993 return $this->page->theme->filter_mediaplugin_colors;
1994 }
1995
1996 /**
1997 * Returns the colours of the big MP3 player
1998 * @return string
1999 */
2000 public function resource_mp3player_colors() {
2001 return $this->page->theme->resource_mp3player_colors;
2002 }
78946b9b 2003}
d9c8f425 2004
2005
2006/// RENDERERS
2007
2008/**
2009 * A renderer that generates output for command-line scripts.
2010 *
2011 * The implementation of this renderer is probably incomplete.
2012 *
2013 * @copyright 2009 Tim Hunt
2014 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2015 * @since Moodle 2.0
2016 */
56cbc53b 2017class core_renderer_cli extends core_renderer {
d9c8f425 2018 /**
2019 * Returns the page header.
2020 * @return string HTML fragment
2021 */
2022 public function header() {
2023 output_starting_hook();
2024 return $this->page->heading . "\n";
2025 }
2026
2027 /**
2028 * Returns a template fragment representing a Heading.
2029 * @param string $text The text of the heading
2030 * @param int $level The level of importance of the heading
2031 * @param string $classes A space-separated list of CSS classes
2032 * @param string $id An optional ID
2033 * @return string A template fragment for a heading
2034 */
fe213365 2035 public function heading($text, $level, $classes = 'main', $id = null) {
d9c8f425 2036 $text .= "\n";
2037 switch ($level) {
2038 case 1:
2039 return '=>' . $text;
2040 case 2:
2041 return '-->' . $text;
2042 default:
2043 return $text;
2044 }
2045 }
2046
2047 /**
2048 * Returns a template fragment representing a fatal error.
2049 * @param string $message The message to output
2050 * @param string $moreinfourl URL where more info can be found about the error
2051 * @param string $link Link for the Continue button
2052 * @param array $backtrace The execution backtrace
2053 * @param string $debuginfo Debugging information
d9c8f425 2054 * @return string A template fragment for a fatal error
2055 */
83267ec0 2056 public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
d9c8f425 2057 $output = "!!! $message !!!\n";
2058
2059 if (debugging('', DEBUG_DEVELOPER)) {
2060 if (!empty($debuginfo)) {
2061 $this->notification($debuginfo, 'notifytiny');
2062 }
2063 if (!empty($backtrace)) {
2064 $this->notification('Stack trace: ' . format_backtrace($backtrace, true), 'notifytiny');
2065 }
2066 }
2067 }
2068
2069 /**
2070 * Returns a template fragment representing a notification.
2071 * @param string $message The message to include
2072 * @param string $classes A space-separated list of CSS classes
2073 * @return string A template fragment for a notification
2074 */
2075 public function notification($message, $classes = 'notifyproblem') {
2076 $message = clean_text($message);
2077 if ($classes === 'notifysuccess') {
2078 return "++ $message ++\n";
2079 }
2080 return "!! $message !!\n";
2081 }
2082}
2083
1adaa404
PS
2084
2085/**
2086 * A renderer that generates output for ajax scripts.
2087 *
2088 * This renderer prevents accidental sends back only json
2089 * encoded error messages, all other output is ignored.
2090 *
2091 * @copyright 2010 Petr Skoda
2092 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2093 * @since Moodle 2.0
2094 */
2095class core_renderer_ajax extends core_renderer {
2096 /**
2097 * Returns a template fragment representing a fatal error.
2098 * @param string $message The message to output
2099 * @param string $moreinfourl URL where more info can be found about the error
2100 * @param string $link Link for the Continue button
2101 * @param array $backtrace The execution backtrace
2102 * @param string $debuginfo Debugging information
2103 * @return string A template fragment for a fatal error
2104 */
2105 public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
2106 $e = new stdClass();
2107 $e->error = $message;
2108 $e->stacktrace = NULL;
2109 $e->debuginfo = NULL;
2110 if (!empty($CFG->debug) and $CFG->debug >= DEBUG_DEVELOPER) {
2111 if (!empty($debuginfo)) {
2112 $e->debuginfo = $debuginfo;
2113 }
2114 if (!empty($backtrace)) {
2115 $e->stacktrace = format_backtrace($backtrace, true);
2116 }
2117 }
2118 return json_encode($e);
2119 }
2120
2121 public function notification($message, $classes = 'notifyproblem') {
2122 }
2123 public function redirect_message($encodedurl, $message, $delay, $debugdisableredirect) {
2124 }
2125 public function header() {
2126 }
2127 public function footer() {
2128 }
2129 public function heading($text, $level, $classes = 'main', $id = null) {
2130 }
2131}
2132