themes MDL-21589 Added a CSS rule to correct the show advanced buttons in themes...
[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 '';
402 } else if (!empty($USER->id)) {
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) {
5d0c95a5 701 $controlshtml[] = html_writer::tag('a', array('class' => 'icon',
d9c8f425 702 'title' => $control['caption'], 'href' => $control['url']),
b9bc2019 703 html_writer::empty_tag('img', array('src' => $this->pix_url($control['icon'])->out(false),
d9c8f425 704 'alt' => $control['caption'])));
705 }
5d0c95a5 706 return html_writer::tag('div', array('class' => 'commands'), implode('', $controlshtml));
d9c8f425 707 }
708
709 /**
710 * Prints a nice side block with an optional header.
711 *
712 * The content is described
713 * by a {@link block_contents} object.
714 *
715 * @param block_contents $bc HTML for the content
716 * @param string $region the region the block is appearing in.
717 * @return string the HTML to be output.
718 */
dd72b308 719 function block(block_contents $bc, $region) {
d9c8f425 720 $bc = clone($bc); // Avoid messing up the object passed in.
dd72b308
PS
721 if (empty($bc->blockinstanceid) || !strip_tags($bc->title)) {
722 $bc->collapsible = block_contents::NOT_HIDEABLE;
723 }
724 if ($bc->collapsible == block_contents::HIDDEN) {
725 $bc->add_class('hidden');
726 }
727 if (!empty($bc->controls)) {
728 $bc->add_class('block_with_controls');
729 }
d9c8f425 730
731 $skiptitle = strip_tags($bc->title);
732 if (empty($skiptitle)) {
733 $output = '';
734 $skipdest = '';
735 } else {
dd72b308 736 $output = html_writer::tag('a', array('href' => '#sb-' . $bc->skipid, 'class' => 'skip-block'), get_string('skipa', 'access', $skiptitle));
5d0c95a5 737 $skipdest = html_writer::tag('span', array('id' => 'sb-' . $bc->skipid, 'class' => 'skip-block-to'), '');
d9c8f425 738 }
739
5d0c95a5 740 $output .= html_writer::start_tag('div', $bc->attributes);
d9c8f425 741
742 $controlshtml = $this->block_controls($bc->controls);
743
744 $title = '';
745 if ($bc->title) {
5d0c95a5 746 $title = html_writer::tag('h2', null, $bc->title);
d9c8f425 747 }
748
749 if ($title || $controlshtml) {
5d0c95a5
PS
750 $output .= html_writer::tag('div', array('class' => 'header'),
751 html_writer::tag('div', array('class' => 'title'),
d9c8f425 752 $title . $controlshtml));
753 }
754
5d0c95a5 755 $output .= html_writer::start_tag('div', array('class' => 'content'));
d9c8f425 756 $output .= $bc->content;
757
758 if ($bc->footer) {
5d0c95a5 759 $output .= html_writer::tag('div', array('class' => 'footer'), $bc->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) {
5d0c95a5 766 $output .= html_writer::tag('div', array('class' => 'blockannotation'), $bc->annotation);
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
5d0c95a5 804 $item .= html_writer::tag('div', array('class' => 'icon column c0'), $icons[$key]);
d9c8f425 805 }
5d0c95a5
PS
806 $item .= html_writer::tag('div', array('class' => 'column c1'), $string);
807 $item .= html_writer::end_tag('li');
d9c8f425 808 $lis[] = $item;
809 $row = 1 - $row; // Flip even/odd.
810 }
5d0c95a5 811 return html_writer::tag('ul', array('class' => 'list'), implode("\n", $lis));
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) {
5d0c95a5
PS
841 return html_writer::tag('a', array('href' => $target->url, 'class' => 'blockmovetarget'),
842 html_writer::tag('span', array('class' => 'accesshide'), $target->text));
d9c8f425 843 }
844
574fbea4
PS
845 /**
846 * Renders a sepcial html link with attached action
847 *
848 * @param string|moodle_url $url
849 * @param string $text HTML fragment
850 * @param component_action $action
11820bac 851 * @param array $attributes associative array of html link attributes + disabled
574fbea4
PS
852 * @return HTML fragment
853 */
c63923bd 854 public function action_link($url, $text, component_action $action = null, array $attributes=null) {
574fbea4
PS
855 if (!($url instanceof moodle_url)) {
856 $url = new moodle_url($url);
857 }
858 $link = new action_link($url, $text, $action, $attributes);
859
f14b641b 860 return $this->render($link);
574fbea4
PS
861 }
862
863 /**
864 * Implementation of action_link rendering
865 * @param action_link $link
866 * @return string HTML fragment
867 */
868 protected function render_action_link(action_link $link) {
869 global $CFG;
870
871 // A disabled link is rendered as formatted text
872 if (!empty($link->attributes['disabled'])) {
873 // do not use div here due to nesting restriction in xhtml strict
874 return html_writer::tag('span', $link->text, array('class'=>'currentlink'));
875 }
11820bac 876
574fbea4
PS
877 $attributes = $link->attributes;
878 unset($link->attributes['disabled']);
879 $attributes['href'] = $link->url;
880
881 if ($link->actions) {
f14b641b 882 if (empty($attributes['id'])) {
574fbea4
PS
883 $id = html_writer::random_id('action_link');
884 $attributes['id'] = $id;
885 } else {
886 $id = $attributes['id'];
887 }
888 foreach ($link->actions as $action) {
c80877aa 889 $this->add_action_handler($action, $id);
574fbea4
PS
890 }
891 }
892
574fbea4
PS
893 return html_writer::tag('a', $attributes, $link->text);
894 }
895
c63923bd
PS
896
897 /**
898 * Similar to action_link, image is used instead of the text
899 *
900 * @param string|moodle_url $url A string URL or moodel_url
901 * @param pix_icon $pixicon
902 * @param component_action $action
903 * @param array $attributes associative array of html link attributes + disabled
904 * @param bool $linktext show title next to image in link
905 * @return string HTML fragment
906 */
907 public function action_icon($url, pix_icon $pixicon, component_action $action = null, array $attributes = null, $linktext=false) {
908 if (!($url instanceof moodle_url)) {
909 $url = new moodle_url($url);
910 }
911 $attributes = (array)$attributes;
912
913 if (empty($options['class'])) {
914 // let ppl override the class via $options
915 $attributes['class'] = 'action-icon';
916 }
917
918 $icon = $this->render($pixicon);
919
920 if ($linktext) {
921 $text = $pixicon->attributes['alt'];
922 } else {
923 $text = '';
924 }
925
926 return $this->action_link($url, $text.$icon, $action, $attributes);
927 }
928
d9c8f425 929 /**
0b634d75 930 * Print a message along with button choices for Continue/Cancel
931 *
4ed85790 932 * If a string or moodle_url is given instead of a single_button, method defaults to post.
0b634d75 933 *
d9c8f425 934 * @param string $message The question to ask the user
3ba60ee1
PS
935 * @param single_button|moodle_url|string $continue The single_button component representing the Continue answer. Can also be a moodle_url or string URL
936 * @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 937 * @return string HTML fragment
938 */
939 public function confirm($message, $continue, $cancel) {
4871a238 940 if ($continue instanceof single_button) {
11820bac 941 // ok
4871a238
PS
942 } else if (is_string($continue)) {
943 $continue = new single_button(new moodle_url($continue), get_string('continue'), 'post');
944 } else if ($continue instanceof moodle_url) {
26eab8d4 945 $continue = new single_button($continue, get_string('continue'), 'post');
d9c8f425 946 } else {
4ed85790 947 throw new coding_exception('The continue param to $OUTPUT->confirm() must be either a URL (string/moodle_url) or a single_button instance.');
d9c8f425 948 }
949
4871a238 950 if ($cancel instanceof single_button) {
11820bac 951 // ok
4871a238
PS
952 } else if (is_string($cancel)) {
953 $cancel = new single_button(new moodle_url($cancel), get_string('cancel'), 'get');
954 } else if ($cancel instanceof moodle_url) {
26eab8d4 955 $cancel = new single_button($cancel, get_string('cancel'), 'get');
d9c8f425 956 } else {
4ed85790 957 throw new coding_exception('The cancel param to $OUTPUT->confirm() must be either a URL (string/moodle_url) or a single_button instance.');
d9c8f425 958 }
959
d9c8f425 960 $output = $this->box_start('generalbox', 'notice');
5d0c95a5 961 $output .= html_writer::tag('p', array(), $message);
3ba60ee1 962 $output .= html_writer::tag('div', array('class' => 'buttons'), $this->render($continue) . $this->render($cancel));
d9c8f425 963 $output .= $this->box_end();
964 return $output;
965 }
966
3cd5305f 967 /**
3ba60ee1 968 * Returns a form with a single button.
3cd5305f 969 *
3ba60ee1 970 * @param string|moodle_url $url
3cd5305f
PS
971 * @param string $label button text
972 * @param string $method get or post submit method
3ba60ee1 973 * @param array $options associative array {disabled, title, etc.}
3cd5305f
PS
974 * @return string HTML fragment
975 */
3ba60ee1 976 public function single_button($url, $label, $method='post', array $options=null) {
574fbea4
PS
977 if (!($url instanceof moodle_url)) {
978 $url = new moodle_url($url);
3ba60ee1 979 }
574fbea4
PS
980 $button = new single_button($url, $label, $method);
981
3ba60ee1
PS
982 foreach ((array)$options as $key=>$value) {
983 if (array_key_exists($key, $button)) {
984 $button->$key = $value;
985 }
3cd5305f
PS
986 }
987
3ba60ee1 988 return $this->render($button);
3cd5305f
PS
989 }
990
d9c8f425 991 /**
3ba60ee1
PS
992 * Internal implementation of single_button rendering
993 * @param single_button $button
d9c8f425 994 * @return string HTML fragment
995 */
3ba60ee1
PS
996 protected function render_single_button(single_button $button) {
997 $attributes = array('type' => 'submit',
998 'value' => $button->label,
db09524d 999 'disabled' => $button->disabled ? 'disabled' : null,
3ba60ee1
PS
1000 'title' => $button->tooltip);
1001
1002 if ($button->actions) {
1003 $id = html_writer::random_id('single_button');
1004 $attributes['id'] = $id;
1005 foreach ($button->actions as $action) {
c80877aa 1006 $this->add_action_handler($action, $id);
3ba60ee1 1007 }
d9c8f425 1008 }
d9c8f425 1009
3ba60ee1
PS
1010 // first the input element
1011 $output = html_writer::empty_tag('input', $attributes);
d9c8f425 1012
3ba60ee1
PS
1013 // then hidden fields
1014 $params = $button->url->params();
1015 if ($button->method === 'post') {
1016 $params['sesskey'] = sesskey();
1017 }
1018 foreach ($params as $var => $val) {
1019 $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => $var, 'value' => $val));
1020 }
d9c8f425 1021
3ba60ee1
PS
1022 // then div wrapper for xhtml strictness
1023 $output = html_writer::tag('div', array(), $output);
d9c8f425 1024
3ba60ee1 1025 // now the form itself around it
eb788065 1026 $url = $button->url->out_omit_querystring(); // url without params
a6855934
PS
1027 if ($url === '') {
1028 $url = '#'; // there has to be always some action
1029 }
3ba60ee1 1030 $attributes = array('method' => $button->method,
a6855934 1031 'action' => $url,
3ba60ee1
PS
1032 'id' => $button->formid);
1033 $output = html_writer::tag('form', $attributes, $output);
d9c8f425 1034
3ba60ee1
PS
1035 // and finally one more wrapper with class
1036 return html_writer::tag('div', array('class' => $button->class), $output);
d9c8f425 1037 }
1038
a9967cf5 1039 /**
ab08be98 1040 * Returns a form with a single select widget.
a9967cf5
PS
1041 * @param moodle_url $url form action target, includes hidden fields
1042 * @param string $name name of selection field - the changing parameter in url
1043 * @param array $options list of options
1044 * @param string $selected selected element
1045 * @param array $nothing
f8dab966 1046 * @param string $formid
a9967cf5
PS
1047 * @return string HTML fragment
1048 */
f8dab966 1049 public function single_select($url, $name, array $options, $selected='', $nothing=array(''=>'choosedots'), $formid=null) {
a9967cf5
PS
1050 if (!($url instanceof moodle_url)) {
1051 $url = new moodle_url($url);
1052 }
f8dab966 1053 $select = new single_select($url, $name, $options, $selected, $nothing, $formid);
a9967cf5
PS
1054
1055 return $this->render($select);
1056 }
1057
1058 /**
1059 * Internal implementation of single_select rendering
1060 * @param single_select $select
1061 * @return string HTML fragment
1062 */
1063 protected function render_single_select(single_select $select) {
1064 $select = clone($select);
1065 if (empty($select->formid)) {
1066 $select->formid = html_writer::random_id('single_select_f');
1067 }
1068
1069 $output = '';
1070 $params = $select->url->params();
1071 if ($select->method === 'post') {
1072 $params['sesskey'] = sesskey();
1073 }
1074 foreach ($params as $name=>$value) {
1075 $output .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>$name, 'value'=>$value));
1076 }
1077
1078 if (empty($select->attributes['id'])) {
1079 $select->attributes['id'] = html_writer::random_id('single_select');
1080 }
1081
0b2cb132
PS
1082 if ($select->disabled) {
1083 $select->attributes['disabled'] = 'disabled';
1084 }
4d10e579 1085
a9967cf5
PS
1086 if ($select->tooltip) {
1087 $select->attributes['title'] = $select->tooltip;
1088 }
1089
1090 if ($select->label) {
1091 $output .= html_writer::tag('label', array('for'=>$select->attributes['id']), $select->label);
1092 }
1093
1094 if ($select->helpicon instanceof help_icon) {
1095 $output .= $this->render($select->helpicon);
1096 }
1097
1098 $output .= html_writer::select($select->options, $select->name, $select->selected, $select->nothing, $select->attributes);
1099
1100 $go = html_writer::empty_tag('input', array('type'=>'submit', 'value'=>get_string('go')));
1101 $output .= html_writer::tag('noscript', array('style'=>'inline'), $go);
1102
1103 $nothing = empty($select->nothing) ? false : key($select->nothing);
edc28287 1104 $this->page->requires->js_init_call('M.util.init_select_autosubmit', array($select->formid, $select->attributes['id'], $nothing));
a9967cf5
PS
1105
1106 // then div wrapper for xhtml strictness
1107 $output = html_writer::tag('div', array(), $output);
1108
1109 // now the form itself around it
1110 $formattributes = array('method' => $select->method,
1111 'action' => $select->url->out_omit_querystring(),
1112 'id' => $select->formid);
4d10e579
PS
1113 $output = html_writer::tag('form', $formattributes, $output);
1114
1115 // and finally one more wrapper with class
1116 return html_writer::tag('div', array('class' => $select->class), $output);
1117 }
1118
1119 /**
ab08be98 1120 * Returns a form with a url select widget.
4d10e579
PS
1121 * @param array $urls list of urls - array('/course/view.php?id=1'=>'Frontpage', ....)
1122 * @param string $selected selected element
1123 * @param array $nothing
1124 * @param string $formid
1125 * @return string HTML fragment
1126 */
1127 public function url_select(array $urls, $selected, $nothing=array(''=>'choosedots'), $formid=null) {
1128 $select = new url_select($urls, $selected, $nothing, $formid);
1129 return $this->render($select);
1130 }
1131
1132 /**
ab08be98 1133 * Internal implementation of url_select rendering
4d10e579
PS
1134 * @param single_select $select
1135 * @return string HTML fragment
1136 */
1137 protected function render_url_select(url_select $select) {
1138 $select = clone($select);
1139 if (empty($select->formid)) {
1140 $select->formid = html_writer::random_id('url_select_f');
1141 }
1142
1143 if (empty($select->attributes['id'])) {
1144 $select->attributes['id'] = html_writer::random_id('url_select');
1145 }
1146
1147 if ($select->disabled) {
1148 $select->attributes['disabled'] = 'disabled';
1149 }
1150
1151 if ($select->tooltip) {
1152 $select->attributes['title'] = $select->tooltip;
1153 }
1154
1155 $output = '';
1156
1157 if ($select->label) {
1158 $output .= html_writer::tag('label', array('for'=>$select->attributes['id']), $select->label);
1159 }
1160
1161 if ($select->helpicon instanceof help_icon) {
1162 $output .= $this->render($select->helpicon);
1163 }
1164
1165 $output .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'sesskey', 'value'=>sesskey()));
1166 $output .= html_writer::select($select->urls, 'jump', $select->selected, $select->nothing, $select->attributes);
1167
1168 $go = html_writer::empty_tag('input', array('type'=>'submit', 'value'=>get_string('go')));
1169 $output .= html_writer::tag('noscript', array('style'=>'inline'), $go);
1170
1171 $nothing = empty($select->nothing) ? false : key($select->nothing);
1172 $output .= $this->page->requires->js_init_call('M.util.init_url_select', array($select->formid, $select->attributes['id'], $nothing));
1173
1174 // then div wrapper for xhtml strictness
1175 $output = html_writer::tag('div', array(), $output);
1176
1177 // now the form itself around it
1178 $formattributes = array('method' => 'post',
1179 'action' => new moodle_url('/course/jumpto.php'),
1180 'id' => $select->formid);
a9967cf5
PS
1181 $output = html_writer::tag('form', $formattributes, $output);
1182
1183 // and finally one more wrapper with class
1184 return html_writer::tag('div', array('class' => $select->class), $output);
1185 }
1186
d9c8f425 1187 /**
1188 * Returns a string containing a link to the user documentation.
1189 * Also contains an icon by default. Shown to teachers and admin only.
1190 * @param string $path The page link after doc root and language, no leading slash.
1191 * @param string $text The text to be displayed for the link
8ae8bf8a 1192 * @retrun string
d9c8f425 1193 */
8ae8bf8a
PS
1194 public function doc_link($path, $text) {
1195 global $CFG;
1196
000c278c 1197 $icon = $this->pix_icon('docs', $text, 'moodle', array('class'=>'iconhelp'));
8ae8bf8a 1198
000c278c 1199 $url = new moodle_url(get_docs_url($path));
8ae8bf8a 1200
c80877aa 1201 $attributes = array('href'=>$url);
d9c8f425 1202 if (!empty($CFG->doctonewwindow)) {
c80877aa 1203 $attributes['id'] = $this->add_action_handler(new popup_action('click', $url));
d9c8f425 1204 }
c80877aa
PS
1205
1206 return html_writer::tag('a', $attributes, $icon.$text);
d9c8f425 1207 }
1208
000c278c
PS
1209 /**
1210 * Render icon
1211 * @param string $pix short pix name
1212 * @param string $alt mandatory alt attribute
1213 * @param strin $component standard compoennt name like 'moodle', 'mod_form', etc.
1214 * @param array $attributes htm lattributes
1215 * @return string HTML fragment
1216 */
1217 public function pix_icon($pix, $alt, $component='moodle', array $attributes = null) {
1218 $icon = new pix_icon($pix, $alt, $component, $attributes);
1219 return $this->render($icon);
1220 }
1221
1222 /**
1223 * Render icon
1224 * @param pix_icon $icon
1225 * @return string HTML fragment
1226 */
ce0110bf 1227 protected function render_pix_icon(pix_icon $icon) {
000c278c
PS
1228 $attributes = $icon->attributes;
1229 $attributes['src'] = $this->pix_url($icon->pix, $icon->component);
c80877aa 1230 return html_writer::empty_tag('img', $attributes);
000c278c
PS
1231 }
1232
d9c8f425 1233 /*
1234 * Centered heading with attached help button (same title text)
1235 * and optional icon attached
4bcc5118
PS
1236 * @param string $text A heading text
1237 * @param string $page The keyword that defines a help page
1238 * @param string $component component name
1239 * @param string|moodle_url $icon
1240 * @param string $iconalt icon alt text
d9c8f425 1241 * @return string HTML fragment
1242 */
4bcc5118
PS
1243 public function heading_with_help($text, $helppage, $component='moodle', $icon='', $iconalt='') {
1244 $image = '';
1245 if ($icon) {
0029a917 1246 $image = $this->pix_icon($icon, $iconalt, $component, array('class'=>'icon'));
d9c8f425 1247 }
4bcc5118
PS
1248
1249 $help = $this->help_icon($helppage, $text, $component);
1250
1251 return $this->heading($image.$text.$help, 2, 'main help');
d9c8f425 1252 }
1253
1254 /**
1255 * Print a help icon.
1256 *
4bcc5118 1257 * @param string $page The keyword that defines a help page
bf11293a 1258 * @param string $title A descriptive text for accessibility only
4bcc5118 1259 * @param string $component component name
bf11293a
PS
1260 * @param string|bool $linktext true means use $title as link text, string means link text value
1261 * @return string HTML fragment
1262 */
1263 public function help_icon($helppage, $title, $component = 'moodle', $linktext='') {
1264 $icon = new help_icon($helppage, $title, $component);
1265 if ($linktext === true) {
1266 $icon->linktext = $title;
1267 } else if (!empty($linktext)) {
1268 $icon->linktext = $linktext;
1269 }
1270 return $this->render($icon);
1271 }
4bcc5118 1272
bf11293a
PS
1273 /**
1274 * Implementation of user image rendering.
1275 * @param help_icon $helpicon
1276 * @return string HTML fragment
d9c8f425 1277 */
bf11293a
PS
1278 protected function render_help_icon(help_icon $helpicon) {
1279 global $CFG;
d9c8f425 1280
bf11293a
PS
1281 // first get the help image icon
1282 $src = $this->pix_url('help');
d9c8f425 1283
bf11293a
PS
1284 if (empty($helpicon->linktext)) {
1285 $alt = $helpicon->title;
1286 } else {
1287 $alt = get_string('helpwiththis');
1288 }
1289
1290 $attributes = array('src'=>$src, 'alt'=>$alt, 'class'=>'iconhelp');
1291 $output = html_writer::empty_tag('img', $attributes);
1292
1293 // add the link text if given
1294 if (!empty($helpicon->linktext)) {
1295 // the spacing has to be done through CSS
1296 $output .= $helpicon->linktext;
d9c8f425 1297 }
1298
bf11293a 1299 // now create the link around it - TODO: this will be changed during the big lang cleanup in 2.0
a6855934 1300 $url = new moodle_url('/help.php', array('module' => $helpicon->component, 'file' => $helpicon->helppage .'.html'));
bf11293a
PS
1301
1302 // note: this title is displayed only if JS is disabled, otherwise the link will have the new ajax tooltip
1303 $title = get_string('helpprefix2', '', trim($helpicon->title, ". \t"));
1304
1305 $attributes = array('href'=>$url, 'title'=>$title);
1306 $id = html_writer::random_id('helpicon');
1307 $attributes['id'] = $id;
c80877aa 1308 $this->add_action_handler(new popup_action('click', $url), $id);
bf11293a
PS
1309 $output = html_writer::tag('a', $attributes, $output);
1310
1311 // and finally span
1312 return html_writer::tag('span', array('class' => 'helplink'), $output);
d9c8f425 1313 }
1314
1315 /**
4bcc5118 1316 * Print scale help icon.
d9c8f425 1317 *
4bcc5118
PS
1318 * @param int $courseid
1319 * @param object $scale instance
1320 * @return string HTML fragment
d9c8f425 1321 */
4bcc5118
PS
1322 public function help_icon_scale($courseid, stdClass $scale) {
1323 global $CFG;
02f64f97 1324
4bcc5118 1325 $title = get_string('helpprefix2', '', $scale->name) .' ('.get_string('newwindow').')';
02f64f97 1326
0029a917 1327 $icon = $this->pix_icon('help', get_string('scales'), 'moodle', array('class'=>'iconhelp'));
02f64f97 1328
57cd3739
PS
1329 $link = new moodle_url('/course/scales.php', array('id' => $courseid, 'list' => true, 'scaleid' => $scale->id));
1330 $action = new popup_action('click', $link->url, 'ratingscale');
02f64f97 1331
57cd3739 1332 return html_writer::tag('span', array('class' => 'helplink'), $this->action_link($link, $icon, $action));
d9c8f425 1333 }
1334
1335 /**
1336 * Creates and returns a spacer image with optional line break.
1337 *
0029a917
PS
1338 * @param array $attributes
1339 * @param boo spacer
d9c8f425 1340 * @return string HTML fragment
1341 */
0029a917
PS
1342 public function spacer(array $attributes = null, $br = false) {
1343 $attributes = (array)$attributes;
1344 if (empty($attributes['width'])) {
1345 $attributes['width'] = 1;
1ba862ec
PS
1346 }
1347 if (empty($options['height'])) {
0029a917 1348 $attributes['height'] = 1;
d9c8f425 1349 }
0029a917 1350 $attributes['class'] = 'spacer';
d9c8f425 1351
0029a917 1352 $output = $this->pix_icon('spacer', '', 'moodle', $attributes);
b65bfc3e 1353
0029a917 1354 if (!empty($br)) {
1ba862ec
PS
1355 $output .= '<br />';
1356 }
d9c8f425 1357
1358 return $output;
1359 }
1360
d9c8f425 1361 /**
1362 * Print the specified user's avatar.
1363 *
5d0c95a5 1364 * User avatar may be obtained in two ways:
d9c8f425 1365 * <pre>
812dbaf7
PS
1366 * // Option 1: (shortcut for simple cases, preferred way)
1367 * // $user has come from the DB and has fields id, picture, imagealt, firstname and lastname
1368 * $OUTPUT->user_picture($user, array('popup'=>true));
1369 *
5d0c95a5
PS
1370 * // Option 2:
1371 * $userpic = new user_picture($user);
d9c8f425 1372 * // Set properties of $userpic
812dbaf7 1373 * $userpic->popup = true;
5d0c95a5 1374 * $OUTPUT->render($userpic);
d9c8f425 1375 * </pre>
1376 *
5d0c95a5 1377 * @param object Object with at least fields id, picture, imagealt, firstname, lastname
812dbaf7 1378 * If any of these are missing, the database is queried. Avoid this
d9c8f425 1379 * if at all possible, particularly for reports. It is very bad for performance.
812dbaf7
PS
1380 * @param array $options associative array with user picture options, used only if not a user_picture object,
1381 * options are:
1382 * - courseid=$this->page->course->id (course id of user profile in link)
1383 * - size=35 (size of image)
1384 * - link=true (make image clickable - the link leads to user profile)
1385 * - popup=false (open in popup)
1386 * - alttext=true (add image alt attribute)
5d0c95a5 1387 * - class = image class attribute (default 'userpicture')
d9c8f425 1388 * @return string HTML fragment
1389 */
5d0c95a5
PS
1390 public function user_picture(stdClass $user, array $options = null) {
1391 $userpicture = new user_picture($user);
1392 foreach ((array)$options as $key=>$value) {
1393 if (array_key_exists($key, $userpicture)) {
1394 $userpicture->$key = $value;
1395 }
1396 }
1397 return $this->render($userpicture);
1398 }
1399
1400 /**
1401 * Internal implementation of user image rendering.
1402 * @param user_picture $userpicture
1403 * @return string
1404 */
1405 protected function render_user_picture(user_picture $userpicture) {
1406 global $CFG, $DB;
812dbaf7 1407
5d0c95a5
PS
1408 $user = $userpicture->user;
1409
1410 if ($userpicture->alttext) {
1411 if (!empty($user->imagealt)) {
1412 $alt = $user->imagealt;
1413 } else {
1414 $alt = get_string('pictureof', '', fullname($user));
1415 }
d9c8f425 1416 } else {
97c10099 1417 $alt = '';
5d0c95a5
PS
1418 }
1419
1420 if (empty($userpicture->size)) {
1421 $file = 'f2';
1422 $size = 35;
1423 } else if ($userpicture->size === true or $userpicture->size == 1) {
1424 $file = 'f1';
1425 $size = 100;
1426 } else if ($userpicture->size >= 50) {
1427 $file = 'f1';
1428 $size = $userpicture->size;
1429 } else {
1430 $file = 'f2';
1431 $size = $userpicture->size;
d9c8f425 1432 }
1433
5d0c95a5 1434 $class = $userpicture->class;
d9c8f425 1435
5d0c95a5
PS
1436 if (!empty($user->picture)) {
1437 require_once($CFG->libdir.'/filelib.php');
1438 $src = new moodle_url(get_file_url($user->id.'/'.$file.'.jpg', null, 'user'));
1439 } else { // Print default user pictures (use theme version if available)
1440 $class .= ' defaultuserpic';
1441 $src = $this->pix_url('u/' . $file);
1442 }
d9c8f425 1443
5d0c95a5
PS
1444 $attributes = array('src'=>$src, 'alt'=>$alt, 'class'=>$class, 'width'=>$size, 'height'=>$size);
1445
1446 // get the image html output fisrt
1447 $output = html_writer::empty_tag('img', $attributes);;
1448
1449 // then wrap it in link if needed
1450 if (!$userpicture->link) {
1451 return $output;
d9c8f425 1452 }
1453
5d0c95a5
PS
1454 if (empty($userpicture->courseid)) {
1455 $courseid = $this->page->course->id;
1456 } else {
1457 $courseid = $userpicture->courseid;
1458 }
1459
a6855934 1460 $url = new moodle_url('/user/view.php', array('id' => $user->id, 'course' => $courseid));
5d0c95a5
PS
1461
1462 $attributes = array('href'=>$url);
1463
1464 if ($userpicture->popup) {
1465 $id = html_writer::random_id('userpicture');
1466 $attributes['id'] = $id;
c80877aa 1467 $this->add_action_handler(new popup_action('click', $url), $id);
5d0c95a5
PS
1468 }
1469
1470 return html_writer::tag('a', $attributes, $output);
d9c8f425 1471 }
1472
1473 /**
1474 * Prints the 'Update this Modulename' button that appears on module pages.
1475 *
1476 * @param string $cmid the course_module id.
1477 * @param string $modulename the module name, eg. "forum", "quiz" or "workshop"
1478 * @return string the HTML for the button, if this user has permission to edit it, else an empty string.
1479 */
1480 public function update_module_button($cmid, $modulename) {
1481 global $CFG;
1482 if (has_capability('moodle/course:manageactivities', get_context_instance(CONTEXT_MODULE, $cmid))) {
1483 $modulename = get_string('modulename', $modulename);
1484 $string = get_string('updatethis', '', $modulename);
3ba60ee1
PS
1485 $url = new moodle_url("$CFG->wwwroot/course/mod.php", array('update' => $cmid, 'return' => true, 'sesskey' => sesskey()));
1486 return $this->single_button($url, $string);
d9c8f425 1487 } else {
1488 return '';
1489 }
1490 }
1491
1492 /**
1493 * Prints a "Turn editing on/off" button in a form.
1494 * @param moodle_url $url The URL + params to send through when clicking the button
1495 * @return string HTML the button
1496 */
1497 public function edit_button(moodle_url $url) {
1498 global $USER;
1499 if (!empty($USER->editing)) {
1500 $string = get_string('turneditingoff');
1501 $edit = '0';
1502 } else {
1503 $string = get_string('turneditingon');
1504 $edit = '1';
1505 }
1506
3ba60ee1 1507 $url = new moodle_url($url, array('edit'=>$edit));
d9c8f425 1508
3ba60ee1 1509 return $this->single_button($url, $string);
d9c8f425 1510 }
1511
d9c8f425 1512 /**
1513 * Prints a simple button to close a window
1514 *
d9c8f425 1515 * @param string $text The lang string for the button's label (already output from get_string())
3ba60ee1 1516 * @return string html fragment
d9c8f425 1517 */
7a5c78e0 1518 public function close_window_button($text='') {
d9c8f425 1519 if (empty($text)) {
1520 $text = get_string('closewindow');
1521 }
a6855934
PS
1522 $button = new single_button(new moodle_url('#'), $text, 'get');
1523 $button->add_action(new component_action('click', 'close_window'));
3ba60ee1
PS
1524
1525 return $this->container($this->render($button), 'closewindow');
d9c8f425 1526 }
1527
d9c8f425 1528 /**
1529 * Output an error message. By default wraps the error message in <span class="error">.
1530 * If the error message is blank, nothing is output.
1531 * @param string $message the error message.
1532 * @return string the HTML to output.
1533 */
1534 public function error_text($message) {
1535 if (empty($message)) {
1536 return '';
1537 }
5d0c95a5 1538 return html_writer::tag('span', array('class' => 'error'), $message);
d9c8f425 1539 }
1540
1541 /**
1542 * Do not call this function directly.
1543 *
1544 * To terminate the current script with a fatal error, call the {@link print_error}
1545 * function, or throw an exception. Doing either of those things will then call this
1546 * function to display the error, before terminating the execution.
1547 *
1548 * @param string $message The message to output
1549 * @param string $moreinfourl URL where more info can be found about the error
1550 * @param string $link Link for the Continue button
1551 * @param array $backtrace The execution backtrace
1552 * @param string $debuginfo Debugging information
d9c8f425 1553 * @return string the HTML to output.
1554 */
83267ec0 1555 public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
d9c8f425 1556
1557 $output = '';
6f8f4d83 1558 $obbuffer = '';
e57c283d 1559
d9c8f425 1560 if ($this->has_started()) {
50764d37
PS
1561 // we can not always recover properly here, we have problems with output buffering,
1562 // html tables, etc.
d9c8f425 1563 $output .= $this->opencontainers->pop_all_but_last();
50764d37 1564
d9c8f425 1565 } else {
50764d37
PS
1566 // It is really bad if library code throws exception when output buffering is on,
1567 // because the buffered text would be printed before our start of page.
1568 // NOTE: this hack might be behave unexpectedly in case output buffering is enabled in PHP.ini
1569 while (ob_get_level() > 0) {
6f8f4d83 1570 $obbuffer .= ob_get_clean();
50764d37 1571 }
6f8f4d83 1572
d9c8f425 1573 // Header not yet printed
85309744 1574 if (isset($_SERVER['SERVER_PROTOCOL'])) {
78946b9b
PS
1575 // server protocol should be always present, because this render
1576 // can not be used from command line or when outputting custom XML
85309744
PS
1577 @header($_SERVER['SERVER_PROTOCOL'] . ' 404 Not Found');
1578 }
7fde1e4b 1579 $this->page->set_url('/'); // no url
191b267b 1580 //$this->page->set_pagelayout('base'); //TODO: MDL-20676 blocks on error pages are weird, unfortunately it somehow detect the pagelayout from URL :-(
d9c8f425 1581 $this->page->set_title(get_string('error'));
1582 $output .= $this->header();
1583 }
1584
1585 $message = '<p class="errormessage">' . $message . '</p>'.
1586 '<p class="errorcode"><a href="' . $moreinfourl . '">' .
1587 get_string('moreinformation') . '</a></p>';
1588 $output .= $this->box($message, 'errorbox');
1589
6f8f4d83
PS
1590 if (debugging('', DEBUG_DEVELOPER)) {
1591 if (!empty($debuginfo)) {
1592 $output .= $this->notification('<strong>Debug info:</strong> '.s($debuginfo), 'notifytiny');
1593 }
1594 if (!empty($backtrace)) {
1595 $output .= $this->notification('<strong>Stack trace:</strong> '.format_backtrace($backtrace), 'notifytiny');
1596 }
1597 if ($obbuffer !== '' ) {
1598 $output .= $this->notification('<strong>Output buffer:</strong> '.s($obbuffer), 'notifytiny');
1599 }
d9c8f425 1600 }
1601
1602 if (!empty($link)) {
1603 $output .= $this->continue_button($link);
1604 }
1605
1606 $output .= $this->footer();
1607
1608 // Padding to encourage IE to display our error page, rather than its own.
1609 $output .= str_repeat(' ', 512);
1610
1611 return $output;
1612 }
1613
1614 /**
1615 * Output a notification (that is, a status message about something that has
1616 * just happened).
1617 *
1618 * @param string $message the message to print out
1619 * @param string $classes normally 'notifyproblem' or 'notifysuccess'.
1620 * @return string the HTML to output.
1621 */
1622 public function notification($message, $classes = 'notifyproblem') {
5d0c95a5 1623 return html_writer::tag('div', array('class' =>
78946b9b 1624 renderer_base::prepare_classes($classes)), clean_text($message));
d9c8f425 1625 }
1626
1627 /**
1628 * Print a continue button that goes to a particular URL.
1629 *
3ba60ee1 1630 * @param string|moodle_url $url The url the button goes to.
d9c8f425 1631 * @return string the HTML to output.
1632 */
3ba60ee1
PS
1633 public function continue_button($url) {
1634 if (!($url instanceof moodle_url)) {
1635 $url = new moodle_url($url);
d9c8f425 1636 }
3ba60ee1
PS
1637 $button = new single_button($url, get_string('continue'), 'get');
1638 $button->class = 'continuebutton';
d9c8f425 1639
3ba60ee1 1640 return $this->render($button);
d9c8f425 1641 }
1642
1643 /**
1644 * Prints a single paging bar to provide access to other pages (usually in a search)
1645 *
929d7a83
PS
1646 * @param int $totalcount Thetotal number of entries available to be paged through
1647 * @param int $page The page you are currently viewing
1648 * @param int $perpage The number of entries that should be shown per page
1649 * @param string|moodle_url $baseurl url of the current page, the $pagevar parameter is added
1650 * @param string $pagevar name of page parameter that holds the page number
d9c8f425 1651 * @return string the HTML to output.
1652 */
929d7a83
PS
1653 public function paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar = 'page') {
1654 $pb = new paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar);
1655 return $this->render($pb);
1656 }
1657
1658 /**
1659 * Internal implementation of paging bar rendering.
1660 * @param paging_bar $pagingbar
1661 * @return string
1662 */
1663 protected function render_paging_bar(paging_bar $pagingbar) {
d9c8f425 1664 $output = '';
1665 $pagingbar = clone($pagingbar);
34059565 1666 $pagingbar->prepare($this, $this->page, $this->target);
d9c8f425 1667
1668 if ($pagingbar->totalcount > $pagingbar->perpage) {
1669 $output .= get_string('page') . ':';
1670
1671 if (!empty($pagingbar->previouslink)) {
56ddb719 1672 $output .= '&#160;(' . $pagingbar->previouslink . ')&#160;';
d9c8f425 1673 }
1674
1675 if (!empty($pagingbar->firstlink)) {
56ddb719 1676 $output .= '&#160;' . $pagingbar->firstlink . '&#160;...';
d9c8f425 1677 }
1678
1679 foreach ($pagingbar->pagelinks as $link) {
56ddb719 1680 $output .= "&#160;&#160;$link";
d9c8f425 1681 }
1682
1683 if (!empty($pagingbar->lastlink)) {
56ddb719 1684 $output .= '&#160;...' . $pagingbar->lastlink . '&#160;';
d9c8f425 1685 }
1686
1687 if (!empty($pagingbar->nextlink)) {
56ddb719 1688 $output .= '&#160;&#160;(' . $pagingbar->nextlink . ')';
d9c8f425 1689 }
1690 }
1691
5d0c95a5 1692 return html_writer::tag('div', array('class' => 'paging'), $output);
d9c8f425 1693 }
1694
1695 /**
1696 * Render a HTML table
1697 *
1698 * @param object $table {@link html_table} instance containing all the information needed
1699 * @return string the HTML to output.
1700 */
1701 public function table(html_table $table) {
1702 $table = clone($table);
34059565 1703 $table->prepare($this, $this->page, $this->target);
d9c8f425 1704 $attributes = array(
1705 'id' => $table->id,
1706 'width' => $table->width,
1707 'summary' => $table->summary,
1708 'cellpadding' => $table->cellpadding,
1709 'cellspacing' => $table->cellspacing,
1710 'class' => $table->get_classes_string());
5d0c95a5 1711 $output = html_writer::start_tag('table', $attributes) . "\n";
d9c8f425 1712
1713 $countcols = 0;
1714
1715 if (!empty($table->head)) {
1716 $countcols = count($table->head);
5d0c95a5
PS
1717 $output .= html_writer::start_tag('thead', $table->headclasses) . "\n";
1718 $output .= html_writer::start_tag('tr', array()) . "\n";
d9c8f425 1719 $keys = array_keys($table->head);
1720 $lastkey = end($keys);
54a007e8 1721
d9c8f425 1722 foreach ($table->head as $key => $heading) {
54a007e8 1723 // Convert plain string headings into html_table_cell objects
1724 if (!($heading instanceof html_table_cell)) {
1725 $headingtext = $heading;
1726 $heading = new html_table_cell();
1727 $heading->text = $headingtext;
1728 $heading->header = true;
1729 }
f2a51402 1730
a4998d01 1731 if ($heading->header !== false) {
1732 $heading->header = true;
1733 }
54a007e8 1734
54a007e8 1735 $heading->add_classes(array('header', 'c' . $key));
d9c8f425 1736 if (isset($table->headspan[$key]) && $table->headspan[$key] > 1) {
54a007e8 1737 $heading->colspan = $table->headspan[$key];
d9c8f425 1738 $countcols += $table->headspan[$key] - 1;
21237187 1739 }
54a007e8 1740
d9c8f425 1741 if ($key == $lastkey) {
54a007e8 1742 $heading->add_class('lastcol');
d9c8f425 1743 }
1744 if (isset($table->colclasses[$key])) {
54a007e8 1745 $heading->add_class($table->colclasses[$key]);
d9c8f425 1746 }
1747 if ($table->rotateheaders) {
1748 // we need to wrap the heading content
5d0c95a5 1749 $heading->text = html_writer::tag('span', null, $heading->text);
d9c8f425 1750 }
54a007e8 1751
d9c8f425 1752 $attributes = array(
54a007e8 1753 'style' => $table->align[$key] . $table->size[$key] . $heading->style,
1754 'class' => $heading->get_classes_string(),
1755 'scope' => $heading->scope,
1756 'colspan' => $heading->colspan);
21237187 1757
a4998d01 1758 $tagtype = 'td';
1759 if ($heading->header === true) {
1760 $tagtype = 'th';
1761 }
5d0c95a5 1762 $output .= html_writer::tag($tagtype, $attributes, $heading->text) . "\n";
d9c8f425 1763 }
5d0c95a5
PS
1764 $output .= html_writer::end_tag('tr') . "\n";
1765 $output .= html_writer::end_tag('thead') . "\n";
50557529
SH
1766
1767 if (empty($table->data)) {
1768 // For valid XHTML strict every table must contain either a valid tr
1769 // or a valid tbody... both of which must contain a valid td
1770 $output .= html_writer::start_tag('tbody', array('class' => renderer_base::prepare_classes($table->bodyclasses).' empty'));
1771 $output .= html_writer::tag('tr', null, html_writer::tag('td', array('colspan'=>count($table->head)), ''));
1772 $output .= html_writer::end_tag('tbody');
1773 }
d9c8f425 1774 }
1775
1776 if (!empty($table->data)) {
1777 $oddeven = 1;
1778 $keys = array_keys($table->data);
1779 $lastrowkey = end($keys);
5d0c95a5 1780 $output .= html_writer::start_tag('tbody', array('class' => renderer_base::prepare_classes($table->bodyclasses))) . "\n";
d9c8f425 1781
1782 foreach ($table->data as $key => $row) {
1783 if (($row === 'hr') && ($countcols)) {
5d0c95a5
PS
1784 $output .= html_writer::tag('td', array('colspan' => $countcols),
1785 html_writer::tag('div', array('class' => 'tabledivider'), '')) . "\n";
d9c8f425 1786 } else {
1787 // Convert array rows to html_table_rows and cell strings to html_table_cell objects
1788 if (!($row instanceof html_table_row)) {
1789 $newrow = new html_table_row();
1790
1791 foreach ($row as $unused => $item) {
1792 $cell = new html_table_cell();
1793 $cell->text = $item;
1794 $newrow->cells[] = $cell;
1795 }
1796 $row = $newrow;
1797 }
21237187 1798
d9c8f425 1799 $oddeven = $oddeven ? 0 : 1;
1800 if (isset($table->rowclasses[$key])) {
6dd7d7f0 1801 $row->add_classes(array_unique(html_component::clean_classes($table->rowclasses[$key])));
d9c8f425 1802 }
1803
1804 $row->add_class('r' . $oddeven);
1805 if ($key == $lastrowkey) {
1806 $row->add_class('lastrow');
1807 }
1808
5d0c95a5 1809 $output .= html_writer::start_tag('tr', array('class' => $row->get_classes_string(), 'style' => $row->style, 'id' => $row->id)) . "\n";
d9c8f425 1810 $keys2 = array_keys($row->cells);
1811 $lastkey = end($keys2);
1812
1813 foreach ($row->cells as $key => $cell) {
54a007e8 1814 if (!($cell instanceof html_table_cell)) {
1815 $mycell = new html_table_cell();
1816 $mycell->text = $cell;
54a007e8 1817 $cell = $mycell;
1818 }
1819
d9c8f425 1820 if (isset($table->colclasses[$key])) {
6dd7d7f0 1821 $cell->add_classes(array_unique(html_component::clean_classes($table->colclasses[$key])));
d9c8f425 1822 }
1823
1824 $cell->add_classes('cell');
1825 $cell->add_classes('c' . $key);
1826 if ($key == $lastkey) {
1827 $cell->add_classes('lastcol');
1828 }
1829 $tdstyle = '';
1830 $tdstyle .= isset($table->align[$key]) ? $table->align[$key] : '';
1831 $tdstyle .= isset($table->size[$key]) ? $table->size[$key] : '';
1832 $tdstyle .= isset($table->wrap[$key]) ? $table->wrap[$key] : '';
1833 $tdattributes = array(
1834 'style' => $tdstyle . $cell->style,
1835 'colspan' => $cell->colspan,
1836 'rowspan' => $cell->rowspan,
1837 'id' => $cell->id,
1838 'class' => $cell->get_classes_string(),
1839 'abbr' => $cell->abbr,
e09e9d55 1840 'scope' => $cell->scope,
a2431800 1841 'title' => $cell->title);
1ae3767a 1842 $tagtype = 'td';
a4998d01 1843 if ($cell->header === true) {
1ae3767a 1844 $tagtype = 'th';
1845 }
5d0c95a5 1846 $output .= html_writer::tag($tagtype, $tdattributes, $cell->text) . "\n";
d9c8f425 1847 }
1848 }
5d0c95a5 1849 $output .= html_writer::end_tag('tr') . "\n";
d9c8f425 1850 }
5d0c95a5 1851 $output .= html_writer::end_tag('tbody') . "\n";
d9c8f425 1852 }
5d0c95a5 1853 $output .= html_writer::end_tag('table') . "\n";
d9c8f425 1854
1855 if ($table->rotateheaders && can_use_rotated_text()) {
f44b10ed 1856 $this->page->requires->yui2_lib('event');
9dec75db 1857 $this->page->requires->js('/course/report/progress/textrotate.js');
d9c8f425 1858 }
1859
1860 return $output;
1861 }
1862
1863 /**
1864 * Output the place a skip link goes to.
1865 * @param string $id The target name from the corresponding $PAGE->requires->skip_link_to($target) call.
1866 * @return string the HTML to output.
1867 */
fe213365 1868 public function skip_link_target($id = null) {
5d0c95a5 1869 return html_writer::tag('span', array('id' => $id), '');
d9c8f425 1870 }
1871
1872 /**
1873 * Outputs a heading
1874 * @param string $text The text of the heading
1875 * @param int $level The level of importance of the heading. Defaulting to 2
1876 * @param string $classes A space-separated list of CSS classes
1877 * @param string $id An optional ID
1878 * @return string the HTML to output.
1879 */
fe213365 1880 public function heading($text, $level = 2, $classes = 'main', $id = null) {
d9c8f425 1881 $level = (integer) $level;
1882 if ($level < 1 or $level > 6) {
1883 throw new coding_exception('Heading level must be an integer between 1 and 6.');
1884 }
5d0c95a5 1885 return html_writer::tag('h' . $level,
78946b9b 1886 array('id' => $id, 'class' => renderer_base::prepare_classes($classes)), $text);
d9c8f425 1887 }
1888
1889 /**
1890 * Outputs a box.
1891 * @param string $contents The contents of the box
1892 * @param string $classes A space-separated list of CSS classes
1893 * @param string $id An optional ID
1894 * @return string the HTML to output.
1895 */
fe213365 1896 public function box($contents, $classes = 'generalbox', $id = null) {
d9c8f425 1897 return $this->box_start($classes, $id) . $contents . $this->box_end();
1898 }
1899
1900 /**
1901 * Outputs the opening section of a box.
1902 * @param string $classes A space-separated list of CSS classes
1903 * @param string $id An optional ID
1904 * @return string the HTML to output.
1905 */
fe213365 1906 public function box_start($classes = 'generalbox', $id = null) {
5d0c95a5
PS
1907 $this->opencontainers->push('box', html_writer::end_tag('div'));
1908 return html_writer::start_tag('div', array('id' => $id,
78946b9b 1909 'class' => 'box ' . renderer_base::prepare_classes($classes)));
d9c8f425 1910 }
1911
1912 /**
1913 * Outputs the closing section of a box.
1914 * @return string the HTML to output.
1915 */
1916 public function box_end() {
1917 return $this->opencontainers->pop('box');
1918 }
1919
1920 /**
1921 * Outputs a container.
1922 * @param string $contents The contents of the box
1923 * @param string $classes A space-separated list of CSS classes
1924 * @param string $id An optional ID
1925 * @return string the HTML to output.
1926 */
fe213365 1927 public function container($contents, $classes = null, $id = null) {
d9c8f425 1928 return $this->container_start($classes, $id) . $contents . $this->container_end();
1929 }
1930
1931 /**
1932 * Outputs the opening section of a container.
1933 * @param string $classes A space-separated list of CSS classes
1934 * @param string $id An optional ID
1935 * @return string the HTML to output.
1936 */
fe213365 1937 public function container_start($classes = null, $id = null) {
5d0c95a5
PS
1938 $this->opencontainers->push('container', html_writer::end_tag('div'));
1939 return html_writer::start_tag('div', array('id' => $id,
78946b9b 1940 'class' => renderer_base::prepare_classes($classes)));
d9c8f425 1941 }
1942
1943 /**
1944 * Outputs the closing section of a container.
1945 * @return string the HTML to output.
1946 */
1947 public function container_end() {
1948 return $this->opencontainers->pop('container');
1949 }
7d2a0492 1950
1951 /**
1952 * Make nested HTML lists out of the items
1953 *
1954 * The resulting list will look something like this:
1955 *
1956 * <pre>
1957 * <<ul>>
1958 * <<li>><div class='tree_item parent'>(item contents)</div>
1959 * <<ul>
1960 * <<li>><div class='tree_item'>(item contents)</div><</li>>
1961 * <</ul>>
1962 * <</li>>
1963 * <</ul>>
1964 * </pre>
1965 *
1966 * @param array[]tree_item $items
1967 * @param array[string]string $attrs html attributes passed to the top of
1968 * the list
1969 * @return string HTML
1970 */
1971 function tree_block_contents($items, $attrs=array()) {
1972 // exit if empty, we don't want an empty ul element
1973 if (empty($items)) {
1974 return '';
1975 }
1976 // array of nested li elements
1977 $lis = array();
1978 foreach ($items as $item) {
1979 // this applies to the li item which contains all child lists too
1980 $content = $item->content($this);
1981 $liclasses = array($item->get_css_type());
1982 if (!$item->forceopen || (!$item->forceopen && $item->collapse) || (count($item->children)==0 && $item->nodetype==navigation_node::NODETYPE_BRANCH)) {
1983 $liclasses[] = 'collapsed';
1984 }
1985 if ($item->isactive === true) {
1986 $liclasses[] = 'current_branch';
1987 }
1988 $liattr = array('class'=>join(' ',$liclasses));
1989 // class attribute on the div item which only contains the item content
1990 $divclasses = array('tree_item');
1991 if (!empty($item->children) || $item->nodetype==navigation_node::NODETYPE_BRANCH) {
1992 $divclasses[] = 'branch';
1993 } else {
1994 $divclasses[] = 'leaf';
1995 }
1996 if (!empty($item->classes) && count($item->classes)>0) {
1997 $divclasses[] = join(' ', $item->classes);
1998 }
1999 $divattr = array('class'=>join(' ', $divclasses));
2000 if (!empty($item->id)) {
2001 $divattr['id'] = $item->id;
2002 }
5d0c95a5 2003 $content = html_writer::tag('p', $divattr, $content) . $this->tree_block_contents($item->children);
7d2a0492 2004 if (!empty($item->preceedwithhr) && $item->preceedwithhr===true) {
5d0c95a5 2005 $content = html_writer::tag('hr', array(), null).$content;
7d2a0492 2006 }
5d0c95a5 2007 $content = html_writer::tag('li', $liattr, $content);
7d2a0492 2008 $lis[] = $content;
2009 }
5d0c95a5 2010 return html_writer::tag('ul', $attrs, implode("\n", $lis));
7d2a0492 2011 }
2012
2013 /**
2014 * Return the navbar content so that it can be echoed out by the layout
2015 * @return string XHTML navbar
2016 */
2017 public function navbar() {
2018 return $this->page->navbar->content();
2019 }
92e01ab7
PS
2020
2021 /**
2022 * Accessibility: Right arrow-like character is
2023 * used in the breadcrumb trail, course navigation menu
2024 * (previous/next activity), calendar, and search forum block.
2025 * If the theme does not set characters, appropriate defaults
2026 * are set automatically. Please DO NOT
2027 * use &lt; &gt; &raquo; - these are confusing for blind users.
2028 * @return string
2029 */
2030 public function rarrow() {
2031 return $this->page->theme->rarrow;
2032 }
2033
2034 /**
2035 * Accessibility: Right arrow-like character is
2036 * used in the breadcrumb trail, course navigation menu
2037 * (previous/next activity), calendar, and search forum block.
2038 * If the theme does not set characters, appropriate defaults
2039 * are set automatically. Please DO NOT
2040 * use &lt; &gt; &raquo; - these are confusing for blind users.
2041 * @return string
2042 */
2043 public function larrow() {
2044 return $this->page->theme->larrow;
2045 }
088ccb43
PS
2046
2047 /**
2048 * Returns the colours of the small MP3 player
2049 * @return string
2050 */
2051 public function filter_mediaplugin_colors() {
2052 return $this->page->theme->filter_mediaplugin_colors;
2053 }
2054
2055 /**
2056 * Returns the colours of the big MP3 player
2057 * @return string
2058 */
2059 public function resource_mp3player_colors() {
2060 return $this->page->theme->resource_mp3player_colors;
2061 }
78946b9b 2062}
d9c8f425 2063
2064
2065/// RENDERERS
2066
2067/**
2068 * A renderer that generates output for command-line scripts.
2069 *
2070 * The implementation of this renderer is probably incomplete.
2071 *
2072 * @copyright 2009 Tim Hunt
2073 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2074 * @since Moodle 2.0
2075 */
56cbc53b 2076class core_renderer_cli extends core_renderer {
d9c8f425 2077 /**
2078 * Returns the page header.
2079 * @return string HTML fragment
2080 */
2081 public function header() {
2082 output_starting_hook();
2083 return $this->page->heading . "\n";
2084 }
2085
2086 /**
2087 * Returns a template fragment representing a Heading.
2088 * @param string $text The text of the heading
2089 * @param int $level The level of importance of the heading
2090 * @param string $classes A space-separated list of CSS classes
2091 * @param string $id An optional ID
2092 * @return string A template fragment for a heading
2093 */
fe213365 2094 public function heading($text, $level, $classes = 'main', $id = null) {
d9c8f425 2095 $text .= "\n";
2096 switch ($level) {
2097 case 1:
2098 return '=>' . $text;
2099 case 2:
2100 return '-->' . $text;
2101 default:
2102 return $text;
2103 }
2104 }
2105
2106 /**
2107 * Returns a template fragment representing a fatal error.
2108 * @param string $message The message to output
2109 * @param string $moreinfourl URL where more info can be found about the error
2110 * @param string $link Link for the Continue button
2111 * @param array $backtrace The execution backtrace
2112 * @param string $debuginfo Debugging information
d9c8f425 2113 * @return string A template fragment for a fatal error
2114 */
83267ec0 2115 public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
d9c8f425 2116 $output = "!!! $message !!!\n";
2117
2118 if (debugging('', DEBUG_DEVELOPER)) {
2119 if (!empty($debuginfo)) {
2120 $this->notification($debuginfo, 'notifytiny');
2121 }
2122 if (!empty($backtrace)) {
2123 $this->notification('Stack trace: ' . format_backtrace($backtrace, true), 'notifytiny');
2124 }
2125 }
2126 }
2127
2128 /**
2129 * Returns a template fragment representing a notification.
2130 * @param string $message The message to include
2131 * @param string $classes A space-separated list of CSS classes
2132 * @return string A template fragment for a notification
2133 */
2134 public function notification($message, $classes = 'notifyproblem') {
2135 $message = clean_text($message);
2136 if ($classes === 'notifysuccess') {
2137 return "++ $message ++\n";
2138 }
2139 return "!! $message !!\n";
2140 }
2141}
2142