MDL-24650 xhtml strict fix of hidden "Go" buttons
[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 *
78bfb562
PS
24 * @package core
25 * @subpackage lib
26 * @copyright 2009 Tim Hunt
27 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
d9c8f425 28 */
29
78bfb562
PS
30defined('MOODLE_INTERNAL') || die();
31
d9c8f425 32/**
33 * Simple base class for Moodle renderers.
34 *
35 * Tracks the xhtml_container_stack to use, which is passed in in the constructor.
36 *
37 * Also has methods to facilitate generating HTML output.
38 *
39 * @copyright 2009 Tim Hunt
40 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
41 * @since Moodle 2.0
42 */
78946b9b 43class renderer_base {
d9c8f425 44 /** @var xhtml_container_stack the xhtml_container_stack to use. */
45 protected $opencontainers;
46 /** @var moodle_page the page we are rendering for. */
47 protected $page;
996b1e0c 48 /** @var requested rendering target */
c927e35c 49 protected $target;
d9c8f425 50
51 /**
52 * Constructor
53 * @param moodle_page $page the page we are doing output for.
c927e35c 54 * @param string $target one of rendering target constants
d9c8f425 55 */
c927e35c 56 public function __construct(moodle_page $page, $target) {
d9c8f425 57 $this->opencontainers = $page->opencontainers;
58 $this->page = $page;
c927e35c 59 $this->target = $target;
d9c8f425 60 }
61
62 /**
5d0c95a5 63 * Returns rendered widget.
996b1e0c 64 * @param renderable $widget instance with renderable interface
5d0c95a5 65 * @return string
d9c8f425 66 */
5d0c95a5 67 public function render(renderable $widget) {
2cf81209 68 $rendermethod = 'render_'.get_class($widget);
5d0c95a5
PS
69 if (method_exists($this, $rendermethod)) {
70 return $this->$rendermethod($widget);
71 }
72 throw new coding_exception('Can not render widget, renderer method ('.$rendermethod.') not found.');
d9c8f425 73 }
74
75 /**
5d0c95a5 76 * Adds JS handlers needed for event execution for one html element id
5d0c95a5 77 * @param component_action $actions
c80877aa
PS
78 * @param string $id
79 * @return string id of element, either original submitted or random new if not supplied
d9c8f425 80 */
c80877aa
PS
81 public function add_action_handler(component_action $action, $id=null) {
82 if (!$id) {
83 $id = html_writer::random_id($action->event);
84 }
d96d8f03 85 $this->page->requires->event_handler("#$id", $action->event, $action->jsfunction, $action->jsfunctionargs);
c80877aa 86 return $id;
d9c8f425 87 }
88
89 /**
5d0c95a5
PS
90 * Have we started output yet?
91 * @return boolean true if the header has been printed.
d9c8f425 92 */
5d0c95a5
PS
93 public function has_started() {
94 return $this->page->state >= moodle_page::STATE_IN_BODY;
d9c8f425 95 }
96
97 /**
98 * Given an array or space-separated list of classes, prepares and returns the HTML class attribute value
99 * @param mixed $classes Space-separated string or array of classes
100 * @return string HTML class attribute value
101 */
102 public static function prepare_classes($classes) {
103 if (is_array($classes)) {
104 return implode(' ', array_unique($classes));
105 }
106 return $classes;
107 }
108
d9c8f425 109 /**
897e902b
PS
110 * Return the moodle_url for an image.
111 * The exact image location and extension is determined
112 * automatically by searching for gif|png|jpg|jpeg, please
113 * note there can not be diferent images with the different
114 * extension. The imagename is for historical reasons
115 * a relative path name, it may be changed later for core
116 * images. It is recommended to not use subdirectories
117 * in plugin and theme pix directories.
d9c8f425 118 *
897e902b
PS
119 * There are three types of images:
120 * 1/ theme images - stored in theme/mytheme/pix/,
121 * use component 'theme'
122 * 2/ core images - stored in /pix/,
123 * overridden via theme/mytheme/pix_core/
124 * 3/ plugin images - stored in mod/mymodule/pix,
125 * overridden via theme/mytheme/pix_plugins/mod/mymodule/,
126 * example: pix_url('comment', 'mod_glossary')
127 *
128 * @param string $imagename the pathname of the image
129 * @param string $component full plugin name (aka component) or 'theme'
78946b9b 130 * @return moodle_url
d9c8f425 131 */
c927e35c 132 public function pix_url($imagename, $component = 'moodle') {
c39e5ba2 133 return $this->page->theme->pix_url($imagename, $component);
d9c8f425 134 }
d9c8f425 135}
136
c927e35c 137
75590935
PS
138/**
139 * Basis for all plugin renderers.
140 *
c927e35c
PS
141 * @author Petr Skoda (skodak)
142 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
143 * @since Moodle 2.0
75590935
PS
144 */
145class plugin_renderer_base extends renderer_base {
146 /**
147 * A reference to the current general renderer probably {@see core_renderer}
148 * @var renderer_base
149 */
150 protected $output;
151
152 /**
996b1e0c 153 * Constructor method, calls the parent constructor
75590935 154 * @param moodle_page $page
c927e35c 155 * @param string $target one of rendering target constants
75590935 156 */
c927e35c
PS
157 public function __construct(moodle_page $page, $target) {
158 $this->output = $page->get_renderer('core', null, $target);
159 parent::__construct($page, $target);
75590935 160 }
ff5265c6 161
5d0c95a5
PS
162 /**
163 * Returns rendered widget.
71c03ac1 164 * @param renderable $widget instance with renderable interface
5d0c95a5
PS
165 * @return string
166 */
167 public function render(renderable $widget) {
168 $rendermethod = 'render_'.get_class($widget);
169 if (method_exists($this, $rendermethod)) {
170 return $this->$rendermethod($widget);
171 }
172 // pass to core renderer if method not found here
469bf7a4 173 return $this->output->render($widget);
5d0c95a5
PS
174 }
175
ff5265c6
PS
176 /**
177 * Magic method used to pass calls otherwise meant for the standard renderer
996b1e0c 178 * to it to ensure we don't go causing unnecessary grief.
ff5265c6
PS
179 *
180 * @param string $method
181 * @param array $arguments
182 * @return mixed
183 */
184 public function __call($method, $arguments) {
37b5b18e
PS
185 if (method_exists('renderer_base', $method)) {
186 throw new coding_exception('Protected method called against '.__CLASS__.' :: '.$method);
187 }
ff5265c6
PS
188 if (method_exists($this->output, $method)) {
189 return call_user_func_array(array($this->output, $method), $arguments);
190 } else {
191 throw new coding_exception('Unknown method called against '.__CLASS__.' :: '.$method);
192 }
193 }
75590935 194}
d9c8f425 195
c927e35c 196
d9c8f425 197/**
78946b9b 198 * The standard implementation of the core_renderer interface.
d9c8f425 199 *
200 * @copyright 2009 Tim Hunt
201 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
202 * @since Moodle 2.0
203 */
78946b9b 204class core_renderer extends renderer_base {
d9c8f425 205 /** @var string used in {@link header()}. */
206 const PERFORMANCE_INFO_TOKEN = '%%PERFORMANCEINFO%%';
207 /** @var string used in {@link header()}. */
208 const END_HTML_TOKEN = '%%ENDHTML%%';
209 /** @var string used in {@link header()}. */
210 const MAIN_CONTENT_TOKEN = '[MAIN CONTENT GOES HERE]';
211 /** @var string used to pass information from {@link doctype()} to {@link standard_head_html()}. */
212 protected $contenttype;
213 /** @var string used by {@link redirect_message()} method to communicate with {@link header()}. */
214 protected $metarefreshtag = '';
215
216 /**
217 * Get the DOCTYPE declaration that should be used with this page. Designed to
218 * be called in theme layout.php files.
219 * @return string the DOCTYPE declaration (and any XML prologue) that should be used.
220 */
221 public function doctype() {
222 global $CFG;
223
224 $doctype = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">' . "\n";
225 $this->contenttype = 'text/html; charset=utf-8';
226
227 if (empty($CFG->xmlstrictheaders)) {
228 return $doctype;
229 }
230
231 // We want to serve the page with an XML content type, to force well-formedness errors to be reported.
232 $prolog = '<?xml version="1.0" encoding="utf-8"?>' . "\n";
233 if (isset($_SERVER['HTTP_ACCEPT']) && strpos($_SERVER['HTTP_ACCEPT'], 'application/xhtml+xml') !== false) {
234 // Firefox and other browsers that can cope natively with XHTML.
235 $this->contenttype = 'application/xhtml+xml; charset=utf-8';
236
237 } else if (preg_match('/MSIE.*Windows NT/', $_SERVER['HTTP_USER_AGENT'])) {
238 // IE can't cope with application/xhtml+xml, but it will cope if we send application/xml with an XSL stylesheet.
239 $this->contenttype = 'application/xml; charset=utf-8';
240 $prolog .= '<?xml-stylesheet type="text/xsl" href="' . $CFG->httpswwwroot . '/lib/xhtml.xsl"?>' . "\n";
241
242 } else {
243 $prolog = '';
244 }
245
246 return $prolog . $doctype;
247 }
248
249 /**
250 * The attributes that should be added to the <html> tag. Designed to
251 * be called in theme layout.php files.
252 * @return string HTML fragment.
253 */
254 public function htmlattributes() {
255 return get_html_lang(true) . ' xmlns="http://www.w3.org/1999/xhtml"';
256 }
257
258 /**
259 * The standard tags (meta tags, links to stylesheets and JavaScript, etc.)
260 * that should be included in the <head> tag. Designed to be called in theme
261 * layout.php files.
262 * @return string HTML fragment.
263 */
264 public function standard_head_html() {
b5bbeaf0 265 global $CFG, $SESSION;
d9c8f425 266 $output = '';
267 $output .= '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />' . "\n";
268 $output .= '<meta name="keywords" content="moodle, ' . $this->page->title . '" />' . "\n";
269 if (!$this->page->cacheable) {
270 $output .= '<meta http-equiv="pragma" content="no-cache" />' . "\n";
271 $output .= '<meta http-equiv="expires" content="0" />' . "\n";
272 }
273 // This is only set by the {@link redirect()} method
274 $output .= $this->metarefreshtag;
275
276 // Check if a periodic refresh delay has been set and make sure we arn't
277 // already meta refreshing
278 if ($this->metarefreshtag=='' && $this->page->periodicrefreshdelay!==null) {
279 $output .= '<meta http-equiv="refresh" content="'.$this->page->periodicrefreshdelay.';url='.$this->page->url->out().'" />';
280 }
281
7d2a0492 282 $this->page->requires->js_function_call('setTimeout', array('fix_column_widths()', 20));
d9c8f425 283
284 $focus = $this->page->focuscontrol;
285 if (!empty($focus)) {
286 if (preg_match("#forms\['([a-zA-Z0-9]+)'\].elements\['([a-zA-Z0-9]+)'\]#", $focus, $matches)) {
287 // This is a horrifically bad way to handle focus but it is passed in
288 // through messy formslib::moodleform
7d2a0492 289 $this->page->requires->js_function_call('old_onload_focus', array($matches[1], $matches[2]));
d9c8f425 290 } else if (strpos($focus, '.')!==false) {
291 // Old style of focus, bad way to do it
292 debugging('This code is using the old style focus event, Please update this code to focus on an element id or the moodleform focus method.', DEBUG_DEVELOPER);
293 $this->page->requires->js_function_call('old_onload_focus', explode('.', $focus, 2));
294 } else {
295 // Focus element with given id
7d2a0492 296 $this->page->requires->js_function_call('focuscontrol', array($focus));
d9c8f425 297 }
298 }
299
78946b9b
PS
300 // Get the theme stylesheet - this has to be always first CSS, this loads also styles.css from all plugins;
301 // any other custom CSS can not be overridden via themes and is highly discouraged
efaa4c08 302 $urls = $this->page->theme->css_urls($this->page);
78946b9b 303 foreach ($urls as $url) {
c0467479 304 $this->page->requires->css_theme($url);
78946b9b
PS
305 }
306
04c01408 307 // Get the theme javascript head and footer
04c01408 308 $jsurl = $this->page->theme->javascript_url(true);
baeb20bb
PS
309 $this->page->requires->js($jsurl, true);
310 $jsurl = $this->page->theme->javascript_url(false);
8ce04d51 311 $this->page->requires->js($jsurl);
5d0c95a5 312
78946b9b 313 // Perform a browser environment check for the flash version. Should only run once per login session.
2c0d7839 314 if (!NO_MOODLE_COOKIES && isloggedin() && !empty($CFG->excludeoldflashclients) && empty($SESSION->flashversion)) {
4abd5b9b
PS
315 $this->page->requires->js('/lib/swfobject/swfobject.js');
316 $this->page->requires->js_init_call('M.core_flashdetect.init');
b5bbeaf0 317 }
318
d9c8f425 319 // Get any HTML from the page_requirements_manager.
945f19f7 320 $output .= $this->page->requires->get_head_code($this->page, $this);
d9c8f425 321
322 // List alternate versions.
323 foreach ($this->page->alternateversions as $type => $alt) {
5d0c95a5 324 $output .= html_writer::empty_tag('link', array('rel' => 'alternate',
d9c8f425 325 'type' => $type, 'title' => $alt->title, 'href' => $alt->url));
326 }
327
328 return $output;
329 }
330
331 /**
332 * The standard tags (typically skip links) that should be output just inside
333 * the start of the <body> tag. Designed to be called in theme layout.php files.
334 * @return string HTML fragment.
335 */
336 public function standard_top_of_body_html() {
337 return $this->page->requires->get_top_of_body_code();
338 }
339
340 /**
341 * The standard tags (typically performance information and validation links,
342 * if we are in developer debug mode) that should be output in the footer area
343 * of the page. Designed to be called in theme layout.php files.
344 * @return string HTML fragment.
345 */
346 public function standard_footer_html() {
347 global $CFG;
348
349 // This function is normally called from a layout.php file in {@link header()}
350 // but some of the content won't be known until later, so we return a placeholder
351 // for now. This will be replaced with the real content in {@link footer()}.
352 $output = self::PERFORMANCE_INFO_TOKEN;
ee8df661
SH
353 if ($this->page->legacythemeinuse) {
354 // The legacy theme is in use print the notification
355 $output .= html_writer::tag('div', get_string('legacythemeinuse'), array('class'=>'legacythemeinuse'));
356 }
d9c8f425 357 if (!empty($CFG->debugpageinfo)) {
d4c3f025 358 $output .= '<div class="performanceinfo pageinfo">This page is: ' . $this->page->debug_summary() . '</div>';
d9c8f425 359 }
1b396b18 360 if (debugging(null, DEBUG_DEVELOPER) and has_capability('moodle/site:config', get_context_instance(CONTEXT_SYSTEM))) { // Only in developer mode
ba6c97ee
MD
361 $output .= '<div class="purgecaches"><a href="'.$CFG->wwwroot.'/admin/purgecaches.php?confirm=1&amp;sesskey='.sesskey().'">'.get_string('purgecaches', 'admin').'</a></div>';
362 }
d9c8f425 363 if (!empty($CFG->debugvalidators)) {
364 $output .= '<div class="validators"><ul>
365 <li><a href="http://validator.w3.org/check?verbose=1&amp;ss=1&amp;uri=' . urlencode(qualified_me()) . '">Validate HTML</a></li>
366 <li><a href="http://www.contentquality.com/mynewtester/cynthia.exe?rptmode=-1&amp;url1=' . urlencode(qualified_me()) . '">Section 508 Check</a></li>
367 <li><a href="http://www.contentquality.com/mynewtester/cynthia.exe?rptmode=0&amp;warnp2n3e=1&amp;url1=' . urlencode(qualified_me()) . '">WCAG 1 (2,3) Check</a></li>
368 </ul></div>';
369 }
370 return $output;
371 }
372
373 /**
374 * The standard tags (typically script tags that are not needed earlier) that
375 * should be output after everything else, . Designed to be called in theme layout.php files.
376 * @return string HTML fragment.
377 */
378 public function standard_end_of_body_html() {
379 // This function is normally called from a layout.php file in {@link header()}
380 // but some of the content won't be known until later, so we return a placeholder
381 // for now. This will be replaced with the real content in {@link footer()}.
382 echo self::END_HTML_TOKEN;
383 }
384
385 /**
386 * Return the standard string that says whether you are logged in (and switched
387 * roles/logged in as another user).
388 * @return string HTML fragment.
389 */
390 public function login_info() {
8f0fe0b8 391 global $USER, $CFG, $DB, $SESSION;
4bcc5118 392
244a32c6
PS
393 if (during_initial_install()) {
394 return '';
395 }
4bcc5118 396
244a32c6 397 $course = $this->page->course;
4bcc5118 398
244a32c6
PS
399 if (session_is_loggedinas()) {
400 $realuser = session_get_realuser();
401 $fullname = fullname($realuser, true);
e884f63a 402 $realuserinfo = " [<a href=\"$CFG->wwwroot/course/loginas.php?id=$course->id&amp;sesskey=".sesskey()."\">$fullname</a>] ";
244a32c6
PS
403 } else {
404 $realuserinfo = '';
405 }
4bcc5118 406
244a32c6 407 $loginurl = get_login_url();
4bcc5118 408
244a32c6
PS
409 if (empty($course->id)) {
410 // $course->id is not defined during installation
411 return '';
4f0c2d00 412 } else if (isloggedin()) {
244a32c6 413 $context = get_context_instance(CONTEXT_COURSE, $course->id);
4bcc5118 414
244a32c6 415 $fullname = fullname($USER, true);
03d9401e
MD
416 // Since Moodle 2.0 this link always goes to the public profile page (not the course profile page)
417 $username = "<a href=\"$CFG->wwwroot/user/profile.php?id=$USER->id\">$fullname</a>";
244a32c6 418 if (is_mnet_remote_user($USER) and $idprovider = $DB->get_record('mnet_host', array('id'=>$USER->mnethostid))) {
4aea3cc7 419 $username .= " from <a href=\"{$idprovider->wwwroot}\">{$idprovider->name}</a>";
244a32c6 420 }
b3df1764 421 if (isguestuser()) {
244a32c6 422 $loggedinas = $realuserinfo.get_string('loggedinasguest').
4aea3cc7 423 " (<a href=\"$loginurl\">".get_string('login').'</a>)';
f5c1e621 424 } else if (is_role_switched($course->id)) { // Has switched roles
244a32c6
PS
425 $rolename = '';
426 if ($role = $DB->get_record('role', array('id'=>$USER->access['rsw'][$context->path]))) {
427 $rolename = ': '.format_string($role->name);
428 }
429 $loggedinas = get_string('loggedinas', 'moodle', $username).$rolename.
4aea3cc7 430 " (<a href=\"$CFG->wwwroot/course/view.php?id=$course->id&amp;switchrole=0&amp;sesskey=".sesskey()."\">".get_string('switchrolereturn').'</a>)';
244a32c6
PS
431 } else {
432 $loggedinas = $realuserinfo.get_string('loggedinas', 'moodle', $username).' '.
4aea3cc7 433 " (<a href=\"$CFG->wwwroot/login/logout.php?sesskey=".sesskey()."\">".get_string('logout').'</a>)';
244a32c6
PS
434 }
435 } else {
436 $loggedinas = get_string('loggedinnot', 'moodle').
4aea3cc7 437 " (<a href=\"$loginurl\">".get_string('login').'</a>)';
244a32c6 438 }
4bcc5118 439
244a32c6 440 $loggedinas = '<div class="logininfo">'.$loggedinas.'</div>';
4bcc5118 441
244a32c6
PS
442 if (isset($SESSION->justloggedin)) {
443 unset($SESSION->justloggedin);
444 if (!empty($CFG->displayloginfailures)) {
b3df1764 445 if (!isguestuser()) {
244a32c6
PS
446 if ($count = count_login_failures($CFG->displayloginfailures, $USER->username, $USER->lastlogin)) {
447 $loggedinas .= '&nbsp;<div class="loginfailures">';
448 if (empty($count->accounts)) {
449 $loggedinas .= get_string('failedloginattempts', '', $count);
450 } else {
451 $loggedinas .= get_string('failedloginattemptsall', '', $count);
452 }
453 if (has_capability('coursereport/log:view', get_context_instance(CONTEXT_SYSTEM))) {
454 $loggedinas .= ' (<a href="'.$CFG->wwwroot.'/course/report/log/index.php'.
455 '?chooselog=1&amp;id=1&amp;modid=site_errors">'.get_string('logs').'</a>)';
456 }
457 $loggedinas .= '</div>';
458 }
459 }
460 }
461 }
4bcc5118 462
244a32c6 463 return $loggedinas;
d9c8f425 464 }
465
466 /**
467 * Return the 'back' link that normally appears in the footer.
468 * @return string HTML fragment.
469 */
470 public function home_link() {
471 global $CFG, $SITE;
472
473 if ($this->page->pagetype == 'site-index') {
474 // Special case for site home page - please do not remove
475 return '<div class="sitelink">' .
34dff6aa 476 '<a title="Moodle" href="http://moodle.org/">' .
53228896 477 '<img style="width:100px;height:30px" src="' . $this->pix_url('moodlelogo') . '" alt="moodlelogo" /></a></div>';
d9c8f425 478
479 } else if (!empty($CFG->target_release) && $CFG->target_release != $CFG->release) {
480 // Special case for during install/upgrade.
481 return '<div class="sitelink">'.
34dff6aa 482 '<a title="Moodle" href="http://docs.moodle.org/en/Administrator_documentation" onclick="this.target=\'_blank\'">' .
53228896 483 '<img style="width:100px;height:30px" src="' . $this->pix_url('moodlelogo') . '" alt="moodlelogo" /></a></div>';
d9c8f425 484
485 } else if ($this->page->course->id == $SITE->id || strpos($this->page->pagetype, 'course-view') === 0) {
486 return '<div class="homelink"><a href="' . $CFG->wwwroot . '/">' .
487 get_string('home') . '</a></div>';
488
489 } else {
490 return '<div class="homelink"><a href="' . $CFG->wwwroot . '/course/view.php?id=' . $this->page->course->id . '">' .
491 format_string($this->page->course->shortname) . '</a></div>';
492 }
493 }
494
495 /**
496 * Redirects the user by any means possible given the current state
497 *
498 * This function should not be called directly, it should always be called using
499 * the redirect function in lib/weblib.php
500 *
501 * The redirect function should really only be called before page output has started
502 * however it will allow itself to be called during the state STATE_IN_BODY
503 *
504 * @param string $encodedurl The URL to send to encoded if required
505 * @param string $message The message to display to the user if any
506 * @param int $delay The delay before redirecting a user, if $message has been
507 * set this is a requirement and defaults to 3, set to 0 no delay
508 * @param boolean $debugdisableredirect this redirect has been disabled for
509 * debugging purposes. Display a message that explains, and don't
510 * trigger the redirect.
511 * @return string The HTML to display to the user before dying, may contain
512 * meta refresh, javascript refresh, and may have set header redirects
513 */
514 public function redirect_message($encodedurl, $message, $delay, $debugdisableredirect) {
515 global $CFG;
516 $url = str_replace('&amp;', '&', $encodedurl);
517
518 switch ($this->page->state) {
519 case moodle_page::STATE_BEFORE_HEADER :
520 // No output yet it is safe to delivery the full arsenal of redirect methods
521 if (!$debugdisableredirect) {
522 // Don't use exactly the same time here, it can cause problems when both redirects fire at the same time.
523 $this->metarefreshtag = '<meta http-equiv="refresh" content="'. $delay .'; url='. $encodedurl .'" />'."\n";
593f9b87 524 $this->page->requires->js_function_call('document.location.replace', array($url), false, ($delay + 3));
d9c8f425 525 }
526 $output = $this->header();
527 break;
528 case moodle_page::STATE_PRINTING_HEADER :
529 // We should hopefully never get here
530 throw new coding_exception('You cannot redirect while printing the page header');
531 break;
532 case moodle_page::STATE_IN_BODY :
533 // We really shouldn't be here but we can deal with this
534 debugging("You should really redirect before you start page output");
535 if (!$debugdisableredirect) {
593f9b87 536 $this->page->requires->js_function_call('document.location.replace', array($url), false, $delay);
d9c8f425 537 }
538 $output = $this->opencontainers->pop_all_but_last();
539 break;
540 case moodle_page::STATE_DONE :
541 // Too late to be calling redirect now
542 throw new coding_exception('You cannot redirect after the entire page has been generated');
543 break;
544 }
545 $output .= $this->notification($message, 'redirectmessage');
3ab2e357 546 $output .= '<div class="continuebutton">(<a href="'. $encodedurl .'">'. get_string('continue') .'</a>)</div>';
d9c8f425 547 if ($debugdisableredirect) {
548 $output .= '<p><strong>Error output, so disabling automatic redirect.</strong></p>';
549 }
550 $output .= $this->footer();
551 return $output;
552 }
553
554 /**
555 * Start output by sending the HTTP headers, and printing the HTML <head>
556 * and the start of the <body>.
557 *
558 * To control what is printed, you should set properties on $PAGE. If you
559 * are familiar with the old {@link print_header()} function from Moodle 1.9
560 * you will find that there are properties on $PAGE that correspond to most
561 * of the old parameters to could be passed to print_header.
562 *
563 * Not that, in due course, the remaining $navigation, $menu parameters here
564 * will be replaced by more properties of $PAGE, but that is still to do.
565 *
d9c8f425 566 * @return string HTML that you must output this, preferably immediately.
567 */
e120c61d 568 public function header() {
d9c8f425 569 global $USER, $CFG;
570
e884f63a
PS
571 if (session_is_loggedinas()) {
572 $this->page->add_body_class('userloggedinas');
573 }
574
d9c8f425 575 $this->page->set_state(moodle_page::STATE_PRINTING_HEADER);
576
78946b9b
PS
577 // Find the appropriate page layout file, based on $this->page->pagelayout.
578 $layoutfile = $this->page->theme->layout_file($this->page->pagelayout);
579 // Render the layout using the layout file.
580 $rendered = $this->render_page_layout($layoutfile);
67e84a7f 581
78946b9b
PS
582 // Slice the rendered output into header and footer.
583 $cutpos = strpos($rendered, self::MAIN_CONTENT_TOKEN);
d9c8f425 584 if ($cutpos === false) {
78946b9b 585 throw new coding_exception('page layout file ' . $layoutfile .
d9c8f425 586 ' does not contain the string "' . self::MAIN_CONTENT_TOKEN . '".');
587 }
78946b9b
PS
588 $header = substr($rendered, 0, $cutpos);
589 $footer = substr($rendered, $cutpos + strlen(self::MAIN_CONTENT_TOKEN));
d9c8f425 590
591 if (empty($this->contenttype)) {
78946b9b 592 debugging('The page layout file did not call $OUTPUT->doctype()');
67e84a7f 593 $header = $this->doctype() . $header;
d9c8f425 594 }
595
596 send_headers($this->contenttype, $this->page->cacheable);
67e84a7f 597
d9c8f425 598 $this->opencontainers->push('header/footer', $footer);
599 $this->page->set_state(moodle_page::STATE_IN_BODY);
67e84a7f 600
29ba64e5 601 return $header . $this->skip_link_target('maincontent');
d9c8f425 602 }
603
604 /**
78946b9b
PS
605 * Renders and outputs the page layout file.
606 * @param string $layoutfile The name of the layout file
d9c8f425 607 * @return string HTML code
608 */
78946b9b 609 protected function render_page_layout($layoutfile) {
92e01ab7 610 global $CFG, $SITE, $USER;
d9c8f425 611 // The next lines are a bit tricky. The point is, here we are in a method
612 // of a renderer class, and this object may, or may not, be the same as
78946b9b 613 // the global $OUTPUT object. When rendering the page layout file, we want to use
d9c8f425 614 // this object. However, people writing Moodle code expect the current
615 // renderer to be called $OUTPUT, not $this, so define a variable called
616 // $OUTPUT pointing at $this. The same comment applies to $PAGE and $COURSE.
617 $OUTPUT = $this;
618 $PAGE = $this->page;
619 $COURSE = $this->page->course;
620
d9c8f425 621 ob_start();
78946b9b
PS
622 include($layoutfile);
623 $rendered = ob_get_contents();
d9c8f425 624 ob_end_clean();
78946b9b 625 return $rendered;
d9c8f425 626 }
627
628 /**
629 * Outputs the page's footer
630 * @return string HTML fragment
631 */
632 public function footer() {
d5a8d9aa 633 global $CFG, $DB;
0f0801f4 634
f6794ace 635 $output = $this->container_end_all(true);
4d2ee4c2 636
d9c8f425 637 $footer = $this->opencontainers->pop('header/footer');
638
d5a8d9aa 639 if (debugging() and $DB and $DB->is_transaction_started()) {
03221650 640 // TODO: MDL-20625 print warning - transaction will be rolled back
d5a8d9aa
PS
641 }
642
d9c8f425 643 // Provide some performance info if required
644 $performanceinfo = '';
645 if (defined('MDL_PERF') || (!empty($CFG->perfdebug) and $CFG->perfdebug > 7)) {
646 $perf = get_performance_info();
647 if (defined('MDL_PERFTOLOG') && !function_exists('register_shutdown_function')) {
648 error_log("PERF: " . $perf['txt']);
649 }
650 if (defined('MDL_PERFTOFOOT') || debugging() || $CFG->perfdebug > 7) {
651 $performanceinfo = $perf['html'];
652 }
653 }
654 $footer = str_replace(self::PERFORMANCE_INFO_TOKEN, $performanceinfo, $footer);
655
656 $footer = str_replace(self::END_HTML_TOKEN, $this->page->requires->get_end_code(), $footer);
657
658 $this->page->set_state(moodle_page::STATE_DONE);
d9c8f425 659
660 return $output . $footer;
661 }
662
f6794ace
PS
663 /**
664 * Close all but the last open container. This is useful in places like error
665 * handling, where you want to close all the open containers (apart from <body>)
666 * before outputting the error message.
667 * @param bool $shouldbenone assert that the stack should be empty now - causes a
668 * developer debug warning if it isn't.
669 * @return string the HTML required to close any open containers inside <body>.
670 */
671 public function container_end_all($shouldbenone = false) {
672 return $this->opencontainers->pop_all_but_last($shouldbenone);
673 }
674
244a32c6
PS
675 /**
676 * Returns lang menu or '', this method also checks forcing of languages in courses.
677 * @return string
678 */
679 public function lang_menu() {
680 global $CFG;
681
682 if (empty($CFG->langmenu)) {
683 return '';
684 }
685
686 if ($this->page->course != SITEID and !empty($this->page->course->lang)) {
687 // do not show lang menu if language forced
688 return '';
689 }
690
691 $currlang = current_language();
1f96e907 692 $langs = get_string_manager()->get_list_of_translations();
4bcc5118 693
244a32c6
PS
694 if (count($langs) < 2) {
695 return '';
696 }
697
a9967cf5
PS
698 $s = new single_select($this->page->url, 'lang', $langs, $currlang, null);
699 $s->label = get_accesshide(get_string('language'));
700 $s->class = 'langmenu';
701 return $this->render($s);
244a32c6
PS
702 }
703
d9c8f425 704 /**
705 * Output the row of editing icons for a block, as defined by the controls array.
706 * @param array $controls an array like {@link block_contents::$controls}.
707 * @return HTML fragment.
708 */
709 public function block_controls($controls) {
710 if (empty($controls)) {
711 return '';
712 }
713 $controlshtml = array();
714 foreach ($controls as $control) {
f4ed6fc4 715 $controlshtml[] = html_writer::tag('a',
26acc814 716 html_writer::empty_tag('img', array('src' => $this->pix_url($control['icon'])->out(false), 'alt' => $control['caption'])),
f4ed6fc4 717 array('class' => 'icon','title' => $control['caption'], 'href' => $control['url']));
d9c8f425 718 }
26acc814 719 return html_writer::tag('div', implode('', $controlshtml), array('class' => 'commands'));
d9c8f425 720 }
721
722 /**
723 * Prints a nice side block with an optional header.
724 *
725 * The content is described
726 * by a {@link block_contents} object.
727 *
cbb54cce
SH
728 * <div id="inst{$instanceid}" class="block_{$blockname} block">
729 * <div class="header"></div>
730 * <div class="content">
731 * ...CONTENT...
732 * <div class="footer">
733 * </div>
734 * </div>
735 * <div class="annotation">
736 * </div>
737 * </div>
738 *
d9c8f425 739 * @param block_contents $bc HTML for the content
740 * @param string $region the region the block is appearing in.
741 * @return string the HTML to be output.
742 */
dd72b308 743 function block(block_contents $bc, $region) {
d9c8f425 744 $bc = clone($bc); // Avoid messing up the object passed in.
dd72b308
PS
745 if (empty($bc->blockinstanceid) || !strip_tags($bc->title)) {
746 $bc->collapsible = block_contents::NOT_HIDEABLE;
747 }
748 if ($bc->collapsible == block_contents::HIDDEN) {
749 $bc->add_class('hidden');
750 }
751 if (!empty($bc->controls)) {
752 $bc->add_class('block_with_controls');
753 }
d9c8f425 754
755 $skiptitle = strip_tags($bc->title);
756 if (empty($skiptitle)) {
757 $output = '';
758 $skipdest = '';
759 } else {
26acc814
PS
760 $output = html_writer::tag('a', get_string('skipa', 'access', $skiptitle), array('href' => '#sb-' . $bc->skipid, 'class' => 'skip-block'));
761 $skipdest = html_writer::tag('span', '', array('id' => 'sb-' . $bc->skipid, 'class' => 'skip-block-to'));
d9c8f425 762 }
4d2ee4c2 763
5d0c95a5 764 $output .= html_writer::start_tag('div', $bc->attributes);
d9c8f425 765
9f5c39b5
SH
766 $output .= $this->block_header($bc);
767 $output .= $this->block_content($bc);
768
769 $output .= html_writer::end_tag('div');
770
771 $output .= $this->block_annotation($bc);
772
773 $output .= $skipdest;
774
775 $this->init_block_hider_js($bc);
776 return $output;
777 }
778
779 /**
780 * Produces a header for a block
fa7f2a45 781 *
9f5c39b5
SH
782 * @param block_contents $bc
783 * @return string
784 */
785 protected function block_header(block_contents $bc) {
d9c8f425 786
787 $title = '';
788 if ($bc->title) {
26acc814 789 $title = html_writer::tag('h2', $bc->title, null);
d9c8f425 790 }
791
9f5c39b5
SH
792 $controlshtml = $this->block_controls($bc->controls);
793
794 $output = '';
d9c8f425 795 if ($title || $controlshtml) {
46de77b6 796 $output .= html_writer::tag('div', html_writer::tag('div', html_writer::tag('div', '', array('class'=>'block_action')). $title . $controlshtml, array('class' => 'title')), array('class' => 'header'));
d9c8f425 797 }
9f5c39b5
SH
798 return $output;
799 }
d9c8f425 800
9f5c39b5
SH
801 /**
802 * Produces the content area for a block
803 *
804 * @param block_contents $bc
805 * @return string
806 */
807 protected function block_content(block_contents $bc) {
808 $output = html_writer::start_tag('div', array('class' => 'content'));
809 if (!$bc->title && !$this->block_controls($bc->controls)) {
46de77b6
SH
810 $output .= html_writer::tag('div', '', array('class'=>'block_action notitle'));
811 }
d9c8f425 812 $output .= $bc->content;
9f5c39b5
SH
813 $output .= $this->block_footer($bc);
814 $output .= html_writer::end_tag('div');
fa7f2a45 815
9f5c39b5
SH
816 return $output;
817 }
d9c8f425 818
9f5c39b5
SH
819 /**
820 * Produces the footer for a block
821 *
822 * @param block_contents $bc
823 * @return string
824 */
825 protected function block_footer(block_contents $bc) {
826 $output = '';
d9c8f425 827 if ($bc->footer) {
26acc814 828 $output .= html_writer::tag('div', $bc->footer, array('class' => 'footer'));
d9c8f425 829 }
9f5c39b5
SH
830 return $output;
831 }
d9c8f425 832
9f5c39b5
SH
833 /**
834 * Produces the annotation for a block
835 *
836 * @param block_contents $bc
837 * @return string
838 */
839 protected function block_annotation(block_contents $bc) {
840 $output = '';
d9c8f425 841 if ($bc->annotation) {
26acc814 842 $output .= html_writer::tag('div', $bc->annotation, array('class' => 'blockannotation'));
d9c8f425 843 }
d9c8f425 844 return $output;
845 }
846
847 /**
848 * Calls the JS require function to hide a block.
849 * @param block_contents $bc A block_contents object
850 * @return void
851 */
dd72b308
PS
852 protected function init_block_hider_js(block_contents $bc) {
853 if (!empty($bc->attributes['id']) and $bc->collapsible != block_contents::NOT_HIDEABLE) {
cbb54cce
SH
854 $config = new stdClass;
855 $config->id = $bc->attributes['id'];
856 $config->title = strip_tags($bc->title);
857 $config->preference = 'block' . $bc->blockinstanceid . 'hidden';
858 $config->tooltipVisible = get_string('hideblocka', 'access', $config->title);
859 $config->tooltipHidden = get_string('showblocka', 'access', $config->title);
860
861 $this->page->requires->js_init_call('M.util.init_block_hider', array($config));
862 user_preference_allow_ajax_update($config->preference, PARAM_BOOL);
d9c8f425 863 }
864 }
865
866 /**
867 * Render the contents of a block_list.
868 * @param array $icons the icon for each item.
869 * @param array $items the content of each item.
870 * @return string HTML
871 */
872 public function list_block_contents($icons, $items) {
873 $row = 0;
874 $lis = array();
875 foreach ($items as $key => $string) {
5d0c95a5 876 $item = html_writer::start_tag('li', array('class' => 'r' . $row));
2c5ec833 877 if (!empty($icons[$key])) { //test if the content has an assigned icon
26acc814 878 $item .= html_writer::tag('div', $icons[$key], array('class' => 'icon column c0'));
d9c8f425 879 }
26acc814 880 $item .= html_writer::tag('div', $string, array('class' => 'column c1'));
5d0c95a5 881 $item .= html_writer::end_tag('li');
d9c8f425 882 $lis[] = $item;
883 $row = 1 - $row; // Flip even/odd.
884 }
26acc814 885 return html_writer::tag('ul', implode("\n", $lis), array('class' => 'list'));
d9c8f425 886 }
887
888 /**
889 * Output all the blocks in a particular region.
890 * @param string $region the name of a region on this page.
891 * @return string the HTML to be output.
892 */
893 public function blocks_for_region($region) {
894 $blockcontents = $this->page->blocks->get_content_for_region($region, $this);
895
896 $output = '';
897 foreach ($blockcontents as $bc) {
898 if ($bc instanceof block_contents) {
899 $output .= $this->block($bc, $region);
900 } else if ($bc instanceof block_move_target) {
901 $output .= $this->block_move_target($bc);
902 } else {
903 throw new coding_exception('Unexpected type of thing (' . get_class($bc) . ') found in list of block contents.');
904 }
905 }
906 return $output;
907 }
908
909 /**
910 * Output a place where the block that is currently being moved can be dropped.
911 * @param block_move_target $target with the necessary details.
912 * @return string the HTML to be output.
913 */
914 public function block_move_target($target) {
6ee744b3 915 return html_writer::tag('a', html_writer::tag('span', $target->text, array('class' => 'accesshide')), array('href' => $target->url, 'class' => 'blockmovetarget'));
d9c8f425 916 }
917
574fbea4 918 /**
996b1e0c 919 * Renders a special html link with attached action
574fbea4
PS
920 *
921 * @param string|moodle_url $url
922 * @param string $text HTML fragment
923 * @param component_action $action
11820bac 924 * @param array $attributes associative array of html link attributes + disabled
574fbea4
PS
925 * @return HTML fragment
926 */
c63923bd 927 public function action_link($url, $text, component_action $action = null, array $attributes=null) {
574fbea4
PS
928 if (!($url instanceof moodle_url)) {
929 $url = new moodle_url($url);
930 }
931 $link = new action_link($url, $text, $action, $attributes);
932
f14b641b 933 return $this->render($link);
574fbea4
PS
934 }
935
936 /**
937 * Implementation of action_link rendering
938 * @param action_link $link
939 * @return string HTML fragment
940 */
941 protected function render_action_link(action_link $link) {
942 global $CFG;
943
944 // A disabled link is rendered as formatted text
945 if (!empty($link->attributes['disabled'])) {
946 // do not use div here due to nesting restriction in xhtml strict
947 return html_writer::tag('span', $link->text, array('class'=>'currentlink'));
948 }
11820bac 949
574fbea4
PS
950 $attributes = $link->attributes;
951 unset($link->attributes['disabled']);
952 $attributes['href'] = $link->url;
953
954 if ($link->actions) {
f14b641b 955 if (empty($attributes['id'])) {
574fbea4
PS
956 $id = html_writer::random_id('action_link');
957 $attributes['id'] = $id;
958 } else {
959 $id = $attributes['id'];
960 }
961 foreach ($link->actions as $action) {
c80877aa 962 $this->add_action_handler($action, $id);
574fbea4
PS
963 }
964 }
965
26acc814 966 return html_writer::tag('a', $link->text, $attributes);
574fbea4
PS
967 }
968
c63923bd
PS
969
970 /**
971 * Similar to action_link, image is used instead of the text
972 *
973 * @param string|moodle_url $url A string URL or moodel_url
974 * @param pix_icon $pixicon
975 * @param component_action $action
976 * @param array $attributes associative array of html link attributes + disabled
977 * @param bool $linktext show title next to image in link
978 * @return string HTML fragment
979 */
980 public function action_icon($url, pix_icon $pixicon, component_action $action = null, array $attributes = null, $linktext=false) {
981 if (!($url instanceof moodle_url)) {
982 $url = new moodle_url($url);
983 }
984 $attributes = (array)$attributes;
985
524645e7 986 if (empty($attributes['class'])) {
c63923bd
PS
987 // let ppl override the class via $options
988 $attributes['class'] = 'action-icon';
989 }
990
991 $icon = $this->render($pixicon);
992
993 if ($linktext) {
994 $text = $pixicon->attributes['alt'];
995 } else {
996 $text = '';
997 }
998
999 return $this->action_link($url, $text.$icon, $action, $attributes);
1000 }
1001
d9c8f425 1002 /**
0b634d75 1003 * Print a message along with button choices for Continue/Cancel
1004 *
4ed85790 1005 * If a string or moodle_url is given instead of a single_button, method defaults to post.
0b634d75 1006 *
d9c8f425 1007 * @param string $message The question to ask the user
3ba60ee1
PS
1008 * @param single_button|moodle_url|string $continue The single_button component representing the Continue answer. Can also be a moodle_url or string URL
1009 * @param single_button|moodle_url|string $cancel The single_button component representing the Cancel answer. Can also be a moodle_url or string URL
d9c8f425 1010 * @return string HTML fragment
1011 */
1012 public function confirm($message, $continue, $cancel) {
4871a238 1013 if ($continue instanceof single_button) {
11820bac 1014 // ok
4871a238
PS
1015 } else if (is_string($continue)) {
1016 $continue = new single_button(new moodle_url($continue), get_string('continue'), 'post');
1017 } else if ($continue instanceof moodle_url) {
26eab8d4 1018 $continue = new single_button($continue, get_string('continue'), 'post');
d9c8f425 1019 } else {
4ed85790 1020 throw new coding_exception('The continue param to $OUTPUT->confirm() must be either a URL (string/moodle_url) or a single_button instance.');
d9c8f425 1021 }
1022
4871a238 1023 if ($cancel instanceof single_button) {
11820bac 1024 // ok
4871a238
PS
1025 } else if (is_string($cancel)) {
1026 $cancel = new single_button(new moodle_url($cancel), get_string('cancel'), 'get');
1027 } else if ($cancel instanceof moodle_url) {
26eab8d4 1028 $cancel = new single_button($cancel, get_string('cancel'), 'get');
d9c8f425 1029 } else {
4ed85790 1030 throw new coding_exception('The cancel param to $OUTPUT->confirm() must be either a URL (string/moodle_url) or a single_button instance.');
d9c8f425 1031 }
1032
d9c8f425 1033 $output = $this->box_start('generalbox', 'notice');
26acc814
PS
1034 $output .= html_writer::tag('p', $message);
1035 $output .= html_writer::tag('div', $this->render($continue) . $this->render($cancel), array('class' => 'buttons'));
d9c8f425 1036 $output .= $this->box_end();
1037 return $output;
1038 }
1039
3cd5305f 1040 /**
3ba60ee1 1041 * Returns a form with a single button.
3cd5305f 1042 *
3ba60ee1 1043 * @param string|moodle_url $url
3cd5305f
PS
1044 * @param string $label button text
1045 * @param string $method get or post submit method
3ba60ee1 1046 * @param array $options associative array {disabled, title, etc.}
3cd5305f
PS
1047 * @return string HTML fragment
1048 */
3ba60ee1 1049 public function single_button($url, $label, $method='post', array $options=null) {
574fbea4
PS
1050 if (!($url instanceof moodle_url)) {
1051 $url = new moodle_url($url);
3ba60ee1 1052 }
574fbea4
PS
1053 $button = new single_button($url, $label, $method);
1054
3ba60ee1
PS
1055 foreach ((array)$options as $key=>$value) {
1056 if (array_key_exists($key, $button)) {
1057 $button->$key = $value;
1058 }
3cd5305f
PS
1059 }
1060
3ba60ee1 1061 return $this->render($button);
3cd5305f
PS
1062 }
1063
d9c8f425 1064 /**
3ba60ee1
PS
1065 * Internal implementation of single_button rendering
1066 * @param single_button $button
d9c8f425 1067 * @return string HTML fragment
1068 */
3ba60ee1
PS
1069 protected function render_single_button(single_button $button) {
1070 $attributes = array('type' => 'submit',
1071 'value' => $button->label,
db09524d 1072 'disabled' => $button->disabled ? 'disabled' : null,
3ba60ee1
PS
1073 'title' => $button->tooltip);
1074
1075 if ($button->actions) {
1076 $id = html_writer::random_id('single_button');
1077 $attributes['id'] = $id;
1078 foreach ($button->actions as $action) {
c80877aa 1079 $this->add_action_handler($action, $id);
3ba60ee1 1080 }
d9c8f425 1081 }
d9c8f425 1082
3ba60ee1
PS
1083 // first the input element
1084 $output = html_writer::empty_tag('input', $attributes);
d9c8f425 1085
3ba60ee1
PS
1086 // then hidden fields
1087 $params = $button->url->params();
1088 if ($button->method === 'post') {
1089 $params['sesskey'] = sesskey();
1090 }
1091 foreach ($params as $var => $val) {
1092 $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => $var, 'value' => $val));
1093 }
d9c8f425 1094
3ba60ee1 1095 // then div wrapper for xhtml strictness
26acc814 1096 $output = html_writer::tag('div', $output);
d9c8f425 1097
3ba60ee1 1098 // now the form itself around it
eb788065 1099 $url = $button->url->out_omit_querystring(); // url without params
a6855934
PS
1100 if ($url === '') {
1101 $url = '#'; // there has to be always some action
1102 }
3ba60ee1 1103 $attributes = array('method' => $button->method,
a6855934 1104 'action' => $url,
3ba60ee1 1105 'id' => $button->formid);
26acc814 1106 $output = html_writer::tag('form', $output, $attributes);
d9c8f425 1107
3ba60ee1 1108 // and finally one more wrapper with class
26acc814 1109 return html_writer::tag('div', $output, array('class' => $button->class));
d9c8f425 1110 }
1111
a9967cf5 1112 /**
ab08be98 1113 * Returns a form with a single select widget.
a9967cf5
PS
1114 * @param moodle_url $url form action target, includes hidden fields
1115 * @param string $name name of selection field - the changing parameter in url
1116 * @param array $options list of options
1117 * @param string $selected selected element
1118 * @param array $nothing
f8dab966 1119 * @param string $formid
a9967cf5
PS
1120 * @return string HTML fragment
1121 */
f8dab966 1122 public function single_select($url, $name, array $options, $selected='', $nothing=array(''=>'choosedots'), $formid=null) {
a9967cf5
PS
1123 if (!($url instanceof moodle_url)) {
1124 $url = new moodle_url($url);
1125 }
f8dab966 1126 $select = new single_select($url, $name, $options, $selected, $nothing, $formid);
a9967cf5
PS
1127
1128 return $this->render($select);
1129 }
1130
1131 /**
1132 * Internal implementation of single_select rendering
1133 * @param single_select $select
1134 * @return string HTML fragment
1135 */
1136 protected function render_single_select(single_select $select) {
1137 $select = clone($select);
1138 if (empty($select->formid)) {
1139 $select->formid = html_writer::random_id('single_select_f');
1140 }
1141
1142 $output = '';
1143 $params = $select->url->params();
1144 if ($select->method === 'post') {
1145 $params['sesskey'] = sesskey();
1146 }
1147 foreach ($params as $name=>$value) {
1148 $output .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>$name, 'value'=>$value));
1149 }
1150
1151 if (empty($select->attributes['id'])) {
1152 $select->attributes['id'] = html_writer::random_id('single_select');
1153 }
1154
0b2cb132
PS
1155 if ($select->disabled) {
1156 $select->attributes['disabled'] = 'disabled';
1157 }
4d10e579 1158
a9967cf5
PS
1159 if ($select->tooltip) {
1160 $select->attributes['title'] = $select->tooltip;
1161 }
1162
1163 if ($select->label) {
995f2d51 1164 $output .= html_writer::label($select->label, $select->attributes['id']);
a9967cf5
PS
1165 }
1166
1167 if ($select->helpicon instanceof help_icon) {
1168 $output .= $this->render($select->helpicon);
259c165d
PS
1169 } else if ($select->helpicon instanceof old_help_icon) {
1170 $output .= $this->render($select->helpicon);
a9967cf5
PS
1171 }
1172
1173 $output .= html_writer::select($select->options, $select->name, $select->selected, $select->nothing, $select->attributes);
1174
1175 $go = html_writer::empty_tag('input', array('type'=>'submit', 'value'=>get_string('go')));
fb0f16a7 1176 $output .= html_writer::tag('noscript', html_writer::tag('div', $go), array('style'=>'inline'));
a9967cf5
PS
1177
1178 $nothing = empty($select->nothing) ? false : key($select->nothing);
edc28287 1179 $this->page->requires->js_init_call('M.util.init_select_autosubmit', array($select->formid, $select->attributes['id'], $nothing));
a9967cf5
PS
1180
1181 // then div wrapper for xhtml strictness
26acc814 1182 $output = html_writer::tag('div', $output);
a9967cf5
PS
1183
1184 // now the form itself around it
1185 $formattributes = array('method' => $select->method,
1186 'action' => $select->url->out_omit_querystring(),
1187 'id' => $select->formid);
26acc814 1188 $output = html_writer::tag('form', $output, $formattributes);
4d10e579
PS
1189
1190 // and finally one more wrapper with class
26acc814 1191 return html_writer::tag('div', $output, array('class' => $select->class));
4d10e579
PS
1192 }
1193
1194 /**
ab08be98 1195 * Returns a form with a url select widget.
4d10e579
PS
1196 * @param array $urls list of urls - array('/course/view.php?id=1'=>'Frontpage', ....)
1197 * @param string $selected selected element
1198 * @param array $nothing
1199 * @param string $formid
1200 * @return string HTML fragment
1201 */
1202 public function url_select(array $urls, $selected, $nothing=array(''=>'choosedots'), $formid=null) {
1203 $select = new url_select($urls, $selected, $nothing, $formid);
1204 return $this->render($select);
1205 }
1206
1207 /**
ab08be98 1208 * Internal implementation of url_select rendering
4d10e579
PS
1209 * @param single_select $select
1210 * @return string HTML fragment
1211 */
1212 protected function render_url_select(url_select $select) {
c422efcf
PS
1213 global $CFG;
1214
4d10e579
PS
1215 $select = clone($select);
1216 if (empty($select->formid)) {
1217 $select->formid = html_writer::random_id('url_select_f');
1218 }
1219
1220 if (empty($select->attributes['id'])) {
1221 $select->attributes['id'] = html_writer::random_id('url_select');
1222 }
1223
1224 if ($select->disabled) {
1225 $select->attributes['disabled'] = 'disabled';
1226 }
1227
1228 if ($select->tooltip) {
1229 $select->attributes['title'] = $select->tooltip;
1230 }
1231
1232 $output = '';
1233
1234 if ($select->label) {
995f2d51 1235 $output .= html_writer::label($select->label, $select->attributes['id']);
4d10e579
PS
1236 }
1237
1238 if ($select->helpicon instanceof help_icon) {
1239 $output .= $this->render($select->helpicon);
259c165d
PS
1240 } else if ($select->helpicon instanceof old_help_icon) {
1241 $output .= $this->render($select->helpicon);
4d10e579
PS
1242 }
1243
d4dcfc6b
DM
1244 // For security reasons, the script course/jumpto.php requires URL starting with '/'. To keep
1245 // backward compatibility, we are removing heading $CFG->wwwroot from URLs here.
c422efcf
PS
1246 $urls = array();
1247 foreach ($select->urls as $k=>$v) {
d4dcfc6b
DM
1248 if (is_array($v)) {
1249 // optgroup structure
1250 foreach ($v as $optgrouptitle => $optgroupoptions) {
1251 foreach ($optgroupoptions as $optionurl => $optiontitle) {
1252 if (empty($optionurl)) {
1253 $safeoptionurl = '';
1254 } else if (strpos($optionurl, $CFG->wwwroot.'/') === 0) {
1255 // debugging('URLs passed to url_select should be in local relative form - please fix the code.', DEBUG_DEVELOPER);
1256 $safeoptionurl = str_replace($CFG->wwwroot, '', $optionurl);
1257 } else if (strpos($optionurl, '/') !== 0) {
1258 debugging("Invalid url_select urls parameter inside optgroup: url '$optionurl' is not local relative url!");
1259 continue;
1260 } else {
1261 $safeoptionurl = $optionurl;
1262 }
1263 $urls[$k][$optgrouptitle][$safeoptionurl] = $optiontitle;
1264 }
1265 }
1266 } else {
1267 // plain list structure
1268 if (empty($k)) {
1269 // nothing selected option
1270 } else if (strpos($k, $CFG->wwwroot.'/') === 0) {
1271 $k = str_replace($CFG->wwwroot, '', $k);
1272 } else if (strpos($k, '/') !== 0) {
1273 debugging("Invalid url_select urls parameter: url '$k' is not local relative url!");
1274 continue;
1275 }
1276 $urls[$k] = $v;
1277 }
1278 }
1279 $selected = $select->selected;
1280 if (!empty($selected)) {
1281 if (strpos($select->selected, $CFG->wwwroot.'/') === 0) {
1282 $selected = str_replace($CFG->wwwroot, '', $selected);
1283 } else if (strpos($selected, '/') !== 0) {
1284 debugging("Invalid value of parameter 'selected': url '$selected' is not local relative url!");
c422efcf 1285 }
c422efcf
PS
1286 }
1287
4d10e579 1288 $output .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'sesskey', 'value'=>sesskey()));
d4dcfc6b 1289 $output .= html_writer::select($urls, 'jump', $selected, $select->nothing, $select->attributes);
4d10e579
PS
1290
1291 $go = html_writer::empty_tag('input', array('type'=>'submit', 'value'=>get_string('go')));
fb0f16a7 1292 $output .= html_writer::tag('noscript', html_writer::tag('div', $go), array('style'=>'inline'));
4d10e579
PS
1293
1294 $nothing = empty($select->nothing) ? false : key($select->nothing);
1295 $output .= $this->page->requires->js_init_call('M.util.init_url_select', array($select->formid, $select->attributes['id'], $nothing));
1296
1297 // then div wrapper for xhtml strictness
26acc814 1298 $output = html_writer::tag('div', $output);
4d10e579
PS
1299
1300 // now the form itself around it
1301 $formattributes = array('method' => 'post',
1302 'action' => new moodle_url('/course/jumpto.php'),
1303 'id' => $select->formid);
26acc814 1304 $output = html_writer::tag('form', $output, $formattributes);
a9967cf5
PS
1305
1306 // and finally one more wrapper with class
26acc814 1307 return html_writer::tag('div', $output, array('class' => $select->class));
a9967cf5
PS
1308 }
1309
d9c8f425 1310 /**
1311 * Returns a string containing a link to the user documentation.
1312 * Also contains an icon by default. Shown to teachers and admin only.
1313 * @param string $path The page link after doc root and language, no leading slash.
1314 * @param string $text The text to be displayed for the link
996b1e0c 1315 * @return string
d9c8f425 1316 */
010e02b4 1317 public function doc_link($path, $text = '') {
8ae8bf8a
PS
1318 global $CFG;
1319
000c278c 1320 $icon = $this->pix_icon('docs', $text, 'moodle', array('class'=>'iconhelp'));
8ae8bf8a 1321
000c278c 1322 $url = new moodle_url(get_docs_url($path));
8ae8bf8a 1323
c80877aa 1324 $attributes = array('href'=>$url);
d9c8f425 1325 if (!empty($CFG->doctonewwindow)) {
c80877aa 1326 $attributes['id'] = $this->add_action_handler(new popup_action('click', $url));
d9c8f425 1327 }
1adaa404 1328
26acc814 1329 return html_writer::tag('a', $icon.$text, $attributes);
d9c8f425 1330 }
1331
000c278c
PS
1332 /**
1333 * Render icon
1334 * @param string $pix short pix name
1335 * @param string $alt mandatory alt attribute
eb557002 1336 * @param string $component standard compoennt name like 'moodle', 'mod_forum', etc.
000c278c
PS
1337 * @param array $attributes htm lattributes
1338 * @return string HTML fragment
1339 */
1340 public function pix_icon($pix, $alt, $component='moodle', array $attributes = null) {
1341 $icon = new pix_icon($pix, $alt, $component, $attributes);
1342 return $this->render($icon);
1343 }
1344
1345 /**
1346 * Render icon
1347 * @param pix_icon $icon
1348 * @return string HTML fragment
1349 */
ce0110bf 1350 protected function render_pix_icon(pix_icon $icon) {
000c278c
PS
1351 $attributes = $icon->attributes;
1352 $attributes['src'] = $this->pix_url($icon->pix, $icon->component);
c80877aa 1353 return html_writer::empty_tag('img', $attributes);
000c278c
PS
1354 }
1355
a09aeee4
AD
1356 /**
1357 * Produces the html that represents this rating in the UI
1358 * @param $page the page object on which this rating will appear
1359 */
1360 function render_rating(rating $rating) {
7ac928a7 1361 global $CFG, $USER;
a09aeee4
AD
1362 static $havesetupjavascript = false;
1363
63e87951
AD
1364 if( $rating->settings->aggregationmethod == RATING_AGGREGATE_NONE ){
1365 return null;//ratings are turned off
1366 }
1367
b1721f67
AD
1368 $useajax = !empty($CFG->enableajax);
1369
1370 //include required Javascript
1371 if( !$havesetupjavascript && $useajax ) {
3dcdf440 1372 $this->page->requires->js_init_call('M.core_rating.init');
a09aeee4
AD
1373 $havesetupjavascript = true;
1374 }
1375
63e87951
AD
1376 //check the item we're rating was created in the assessable time window
1377 $inassessablewindow = true;
1378 if ( $rating->settings->assesstimestart && $rating->settings->assesstimefinish ) {
55d95d90 1379 if ($rating->itemtimecreated < $rating->settings->assesstimestart || $rating->itemtimecreated > $rating->settings->assesstimefinish) {
63e87951 1380 $inassessablewindow = false;
a09aeee4 1381 }
63e87951 1382 }
a09aeee4 1383
63e87951
AD
1384 $strrate = get_string("rate", "rating");
1385 $ratinghtml = ''; //the string we'll return
1386
d251b259 1387 //permissions check - can they view the aggregate?
66c34e9c 1388 $canviewaggregate = false;
d251b259 1389
66c34e9c
AD
1390 //if its the current user's item and they have permission to view the aggregate on their own items
1391 if ( $rating->itemuserid==$USER->id && $rating->settings->permissions->view && $rating->settings->pluginpermissions->view) {
1392 $canviewaggregate = true;
1393 }
1394
1395 //if the item doesnt belong to anyone or its another user's items and they can see the aggregate on items they don't own
1396 //Note that viewany doesnt mean you can see the aggregate or ratings of your own items
1397 if ( (empty($rating->itemuserid) or $rating->itemuserid!=$USER->id) && $rating->settings->permissions->viewany && $rating->settings->pluginpermissions->viewany ) {
1398 $canviewaggregate = true;
1399 }
1400
1401 if ($canviewaggregate==true) {
d251b259
AD
1402 $aggregatelabel = '';
1403 switch ($rating->settings->aggregationmethod) {
1404 case RATING_AGGREGATE_AVERAGE :
07f05a04 1405 $aggregatelabel .= get_string("aggregateavg", "rating");
d251b259
AD
1406 break;
1407 case RATING_AGGREGATE_COUNT :
07f05a04 1408 $aggregatelabel .= get_string("aggregatecount", "rating");
d251b259
AD
1409 break;
1410 case RATING_AGGREGATE_MAXIMUM :
07f05a04 1411 $aggregatelabel .= get_string("aggregatemax", "rating");
d251b259
AD
1412 break;
1413 case RATING_AGGREGATE_MINIMUM :
07f05a04 1414 $aggregatelabel .= get_string("aggregatemin", "rating");
d251b259
AD
1415 break;
1416 case RATING_AGGREGATE_SUM :
07f05a04 1417 $aggregatelabel .= get_string("aggregatesum", "rating");
d251b259
AD
1418 break;
1419 }
c6de9cef 1420 $aggregatelabel .= get_string('labelsep', 'langconfig');
a09aeee4 1421
d251b259
AD
1422 //$scalemax = 0;//no longer displaying scale max
1423 $aggregatestr = '';
a09aeee4 1424
50e7d9da
AD
1425 //only display aggregate if aggregation method isn't COUNT
1426 if ($rating->aggregate && $rating->settings->aggregationmethod!= RATING_AGGREGATE_COUNT) {
1427 if ($rating->settings->aggregationmethod!= RATING_AGGREGATE_SUM && is_array($rating->settings->scale->scaleitems)) {
d251b259 1428 $aggregatestr .= $rating->settings->scale->scaleitems[round($rating->aggregate)];//round aggregate as we're using it as an index
63e87951 1429 }
50e7d9da 1430 else { //aggregation is SUM or the scale is numeric
d251b259 1431 $aggregatestr .= round($rating->aggregate,1);
63e87951 1432 }
d251b259 1433 } else {
42c32efd 1434 $aggregatestr = '';
d251b259
AD
1435 }
1436
771b3fbe 1437 $countstr = html_writer::start_tag('span', array('id'=>"ratingcount{$rating->itemid}"));
d251b259 1438 if ($rating->count>0) {
771b3fbe 1439 $countstr .= "({$rating->count})";
d251b259 1440 }
771b3fbe 1441 $countstr .= html_writer::end_tag('span');
63e87951 1442
d251b259
AD
1443 //$aggregatehtml = "{$ratingstr} / $scalemax ({$rating->count}) ";
1444 $aggregatehtml = "<span id='ratingaggregate{$rating->itemid}'>{$aggregatestr}</span> $countstr ";
63e87951 1445
c6de9cef 1446 $ratinghtml .= html_writer::tag('span', $aggregatelabel, array('class'=>'rating-aggregate-label'));
d251b259
AD
1447 if ($rating->settings->permissions->viewall && $rating->settings->pluginpermissions->viewall) {
1448 $url = "/rating/index.php?contextid={$rating->context->id}&itemid={$rating->itemid}&scaleid={$rating->settings->scale->id}";
1449 $nonpopuplink = new moodle_url($url);
1450 $popuplink = new moodle_url("$url&popup=1");
a09aeee4 1451
d251b259 1452 $action = new popup_action('click', $popuplink, 'ratings', array('height' => 400, 'width' => 600));
c6de9cef 1453 $ratinghtml .= $this->action_link($nonpopuplink, $aggregatehtml, $action);
d251b259 1454 } else {
c6de9cef 1455 $ratinghtml .= $aggregatehtml;
a09aeee4 1456 }
d251b259 1457 }
a09aeee4 1458
d251b259 1459 $formstart = null;
71c03ac1 1460 //if the item doesn't belong to the current user, the user has permission to rate
d251b259
AD
1461 //and we're within the assessable period
1462 if ($rating->itemuserid!=$USER->id
1463 && $rating->settings->permissions->rate
1464 && $rating->settings->pluginpermissions->rate
1465 && $inassessablewindow) {
4d2ee4c2 1466
771b3fbe
AD
1467 //start the rating form
1468 $formstart = html_writer::start_tag('form',
1469 array('id'=>"postrating{$rating->itemid}", 'class'=>'postratingform', 'method'=>'post', 'action'=>"{$CFG->wwwroot}/rating/rate.php"));
1470
1471 $formstart .= html_writer::start_tag('div', array('class'=>'ratingform'));
1472
1473 //add the hidden inputs
1474
1475 $attributes = array('type'=>'hidden', 'class'=>'ratinginput', 'name'=>'contextid', 'value'=>$rating->context->id);
1476 $formstart .= html_writer::empty_tag('input', $attributes);
1477
1478 $attributes['name'] = 'itemid';
1479 $attributes['value'] = $rating->itemid;
1480 $formstart .= html_writer::empty_tag('input', $attributes);
1481
1482 $attributes['name'] = 'scaleid';
1483 $attributes['value'] = $rating->settings->scale->id;
1484 $formstart .= html_writer::empty_tag('input', $attributes);
1485
1486 $attributes['name'] = 'returnurl';
1487 $attributes['value'] = $rating->settings->returnurl;
1488 $formstart .= html_writer::empty_tag('input', $attributes);
1489
1490 $attributes['name'] = 'rateduserid';
1491 $attributes['value'] = $rating->itemuserid;
1492 $formstart .= html_writer::empty_tag('input', $attributes);
1493
1494 $attributes['name'] = 'aggregation';
1495 $attributes['value'] = $rating->settings->aggregationmethod;
1496 $formstart .= html_writer::empty_tag('input', $attributes);
1497
3180bc2c
AD
1498 $attributes['name'] = 'sesskey';
1499 $attributes['value'] = sesskey();;
1500 $formstart .= html_writer::empty_tag('input', $attributes);
1501
d251b259
AD
1502 if (empty($ratinghtml)) {
1503 $ratinghtml .= $strrate.': ';
1504 }
63e87951 1505
d251b259 1506 $ratinghtml = $formstart.$ratinghtml;
63e87951 1507
d251b259
AD
1508 //generate an array of values for numeric scales
1509 $scalearray = $rating->settings->scale->scaleitems;
1510 if (!is_array($scalearray)) { //almost certainly a numerical scale
996b1e0c 1511 $intscalearray = intval($scalearray);//just in case they've passed "5" instead of 5
9f60f914
AD
1512 $scalearray = array();
1513 if( is_int($intscalearray) && $intscalearray>0 ) {
d251b259
AD
1514 for($i=0; $i<=$rating->settings->scale->scaleitems; $i++) {
1515 $scalearray[$i] = $i;
6c5fcef7 1516 }
a09aeee4 1517 }
d251b259 1518 }
6c5fcef7 1519
d251b259
AD
1520 $scalearray = array(RATING_UNSET_RATING => $strrate.'...') + $scalearray;
1521 $ratinghtml .= html_writer::select($scalearray, 'rating', $rating->rating, false, array('class'=>'postratingmenu ratinginput','id'=>'menurating'.$rating->itemid));
a09aeee4 1522
d251b259 1523 //output submit button
4d2ee4c2 1524
771b3fbe
AD
1525 $ratinghtml .= html_writer::start_tag('span', array('class'=>"ratingsubmit"));
1526
1527 $attributes = array('type'=>'submit', 'class'=>'postratingmenusubmit', 'id'=>'postratingsubmit'.$rating->itemid, 'value'=>s(get_string('rate', 'rating')));
1528 $ratinghtml .= html_writer::empty_tag('input', $attributes);
a09aeee4 1529
d251b259
AD
1530 if (is_array($rating->settings->scale->scaleitems)) {
1531 $ratinghtml .= $this->help_icon_scale($rating->settings->scale->courseid, $rating->settings->scale);
a09aeee4 1532 }
771b3fbe
AD
1533 $ratinghtml .= html_writer::end_tag('span');
1534 $ratinghtml .= html_writer::end_tag('div');
1535 $ratinghtml .= html_writer::end_tag('form');
a09aeee4
AD
1536 }
1537
63e87951 1538 return $ratinghtml;
a09aeee4
AD
1539 }
1540
d9c8f425 1541 /*
1542 * Centered heading with attached help button (same title text)
1543 * and optional icon attached
4bcc5118 1544 * @param string $text A heading text
53a78cef 1545 * @param string $helpidentifier The keyword that defines a help page
4bcc5118
PS
1546 * @param string $component component name
1547 * @param string|moodle_url $icon
1548 * @param string $iconalt icon alt text
d9c8f425 1549 * @return string HTML fragment
1550 */
53a78cef 1551 public function heading_with_help($text, $helpidentifier, $component='moodle', $icon='', $iconalt='') {
4bcc5118
PS
1552 $image = '';
1553 if ($icon) {
0029a917 1554 $image = $this->pix_icon($icon, $iconalt, $component, array('class'=>'icon'));
d9c8f425 1555 }
4bcc5118 1556
259c165d
PS
1557 $help = '';
1558 if ($helpidentifier) {
1559 $help = $this->help_icon($helpidentifier, $component);
1560 }
4bcc5118
PS
1561
1562 return $this->heading($image.$text.$help, 2, 'main help');
d9c8f425 1563 }
1564
1565 /**
1566 * Print a help icon.
1567 *
cb616be8 1568 * @deprecated since Moodle 2.0
4bcc5118 1569 * @param string $page The keyword that defines a help page
bf11293a 1570 * @param string $title A descriptive text for accessibility only
4bcc5118 1571 * @param string $component component name
bf11293a
PS
1572 * @param string|bool $linktext true means use $title as link text, string means link text value
1573 * @return string HTML fragment
1574 */
596509e4 1575 public function old_help_icon($helpidentifier, $title, $component = 'moodle', $linktext = '') {
cb616be8 1576 debugging('The method old_help_icon() is deprecated, please fix the code and use help_icon() method instead', DEBUG_DEVELOPER);
596509e4 1577 $icon = new old_help_icon($helpidentifier, $title, $component);
bf11293a
PS
1578 if ($linktext === true) {
1579 $icon->linktext = $title;
1580 } else if (!empty($linktext)) {
1581 $icon->linktext = $linktext;
1582 }
1583 return $this->render($icon);
1584 }
4bcc5118 1585
bf11293a
PS
1586 /**
1587 * Implementation of user image rendering.
1588 * @param help_icon $helpicon
1589 * @return string HTML fragment
d9c8f425 1590 */
596509e4 1591 protected function render_old_help_icon(old_help_icon $helpicon) {
bf11293a 1592 global $CFG;
d9c8f425 1593
bf11293a
PS
1594 // first get the help image icon
1595 $src = $this->pix_url('help');
d9c8f425 1596
bf11293a
PS
1597 if (empty($helpicon->linktext)) {
1598 $alt = $helpicon->title;
1599 } else {
1600 $alt = get_string('helpwiththis');
1601 }
1602
1603 $attributes = array('src'=>$src, 'alt'=>$alt, 'class'=>'iconhelp');
1604 $output = html_writer::empty_tag('img', $attributes);
1605
1606 // add the link text if given
1607 if (!empty($helpicon->linktext)) {
1608 // the spacing has to be done through CSS
1609 $output .= $helpicon->linktext;
d9c8f425 1610 }
1611
53a78cef
PS
1612 // now create the link around it
1613 $url = new moodle_url('/help.php', array('component' => $helpicon->component, 'identifier' => $helpicon->helpidentifier, 'lang'=>current_language()));
bf11293a
PS
1614
1615 // note: this title is displayed only if JS is disabled, otherwise the link will have the new ajax tooltip
1616 $title = get_string('helpprefix2', '', trim($helpicon->title, ". \t"));
1617
1618 $attributes = array('href'=>$url, 'title'=>$title);
1619 $id = html_writer::random_id('helpicon');
1620 $attributes['id'] = $id;
26acc814 1621 $output = html_writer::tag('a', $output, $attributes);
8af8be4a
DM
1622
1623 $this->page->requires->js_init_call('M.util.help_icon.add', array(array('id'=>$id, 'url'=>$url->out(false))));
1624
bf11293a 1625 // and finally span
26acc814 1626 return html_writer::tag('span', $output, array('class' => 'helplink'));
d9c8f425 1627 }
1628
259c165d
PS
1629 /**
1630 * Print a help icon.
1631 *
1632 * @param string $identifier The keyword that defines a help page
1633 * @param string $component component name
1634 * @param string|bool $linktext true means use $title as link text, string means link text value
1635 * @return string HTML fragment
1636 */
1637 public function help_icon($identifier, $component = 'moodle', $linktext = '') {
2cf81209 1638 $icon = new help_icon($identifier, $component);
259c165d
PS
1639 $icon->diag_strings();
1640 if ($linktext === true) {
1641 $icon->linktext = get_string($icon->identifier, $icon->component);
1642 } else if (!empty($linktext)) {
1643 $icon->linktext = $linktext;
1644 }
1645 return $this->render($icon);
1646 }
1647
1648 /**
1649 * Implementation of user image rendering.
1650 * @param help_icon $helpicon
1651 * @return string HTML fragment
1652 */
1653 protected function render_help_icon(help_icon $helpicon) {
1654 global $CFG;
1655
1656 // first get the help image icon
1657 $src = $this->pix_url('help');
1658
1659 $title = get_string($helpicon->identifier, $helpicon->component);
1660
1661 if (empty($helpicon->linktext)) {
1662 $alt = $title;
1663 } else {
1664 $alt = get_string('helpwiththis');
1665 }
1666
1667 $attributes = array('src'=>$src, 'alt'=>$alt, 'class'=>'iconhelp');
1668 $output = html_writer::empty_tag('img', $attributes);
1669
1670 // add the link text if given
1671 if (!empty($helpicon->linktext)) {
1672 // the spacing has to be done through CSS
1673 $output .= $helpicon->linktext;
1674 }
1675
1676 // now create the link around it
1677 $url = new moodle_url('/help.php', array('component' => $helpicon->component, 'identifier' => $helpicon->identifier, 'lang'=>current_language()));
1678
1679 // note: this title is displayed only if JS is disabled, otherwise the link will have the new ajax tooltip
1680 $title = get_string('helpprefix2', '', trim($title, ". \t"));
1681
1682 $attributes = array('href'=>$url, 'title'=>$title);
1683 $id = html_writer::random_id('helpicon');
1684 $attributes['id'] = $id;
259c165d
PS
1685 $output = html_writer::tag('a', $output, $attributes);
1686
2cf81209
SH
1687 $this->page->requires->js_init_call('M.util.help_icon.add', array(array('id'=>$id, 'url'=>$url->out(false))));
1688
259c165d
PS
1689 // and finally span
1690 return html_writer::tag('span', $output, array('class' => 'helplink'));
1691 }
1692
d9c8f425 1693 /**
4bcc5118 1694 * Print scale help icon.
d9c8f425 1695 *
4bcc5118
PS
1696 * @param int $courseid
1697 * @param object $scale instance
1698 * @return string HTML fragment
d9c8f425 1699 */
4bcc5118
PS
1700 public function help_icon_scale($courseid, stdClass $scale) {
1701 global $CFG;
02f64f97 1702
4bcc5118 1703 $title = get_string('helpprefix2', '', $scale->name) .' ('.get_string('newwindow').')';
02f64f97 1704
0029a917 1705 $icon = $this->pix_icon('help', get_string('scales'), 'moodle', array('class'=>'iconhelp'));
02f64f97 1706
68bf577b
AD
1707 $scaleid = abs($scale->id);
1708
1709 $link = new moodle_url('/course/scales.php', array('id' => $courseid, 'list' => true, 'scaleid' => $scaleid));
230ec401 1710 $action = new popup_action('click', $link, 'ratingscale');
02f64f97 1711
26acc814 1712 return html_writer::tag('span', $this->action_link($link, $icon, $action), array('class' => 'helplink'));
d9c8f425 1713 }
1714
1715 /**
1716 * Creates and returns a spacer image with optional line break.
1717 *
0029a917
PS
1718 * @param array $attributes
1719 * @param boo spacer
d9c8f425 1720 * @return string HTML fragment
1721 */
0029a917
PS
1722 public function spacer(array $attributes = null, $br = false) {
1723 $attributes = (array)$attributes;
1724 if (empty($attributes['width'])) {
1725 $attributes['width'] = 1;
1ba862ec 1726 }
e1a5a9cc 1727 if (empty($attributes['height'])) {
0029a917 1728 $attributes['height'] = 1;
d9c8f425 1729 }
0029a917 1730 $attributes['class'] = 'spacer';
d9c8f425 1731
0029a917 1732 $output = $this->pix_icon('spacer', '', 'moodle', $attributes);
b65bfc3e 1733
0029a917 1734 if (!empty($br)) {
1ba862ec
PS
1735 $output .= '<br />';
1736 }
d9c8f425 1737
1738 return $output;
1739 }
1740
d9c8f425 1741 /**
1742 * Print the specified user's avatar.
1743 *
5d0c95a5 1744 * User avatar may be obtained in two ways:
d9c8f425 1745 * <pre>
812dbaf7
PS
1746 * // Option 1: (shortcut for simple cases, preferred way)
1747 * // $user has come from the DB and has fields id, picture, imagealt, firstname and lastname
1748 * $OUTPUT->user_picture($user, array('popup'=>true));
1749 *
5d0c95a5
PS
1750 * // Option 2:
1751 * $userpic = new user_picture($user);
d9c8f425 1752 * // Set properties of $userpic
812dbaf7 1753 * $userpic->popup = true;
5d0c95a5 1754 * $OUTPUT->render($userpic);
d9c8f425 1755 * </pre>
1756 *
5d0c95a5 1757 * @param object Object with at least fields id, picture, imagealt, firstname, lastname
812dbaf7 1758 * If any of these are missing, the database is queried. Avoid this
d9c8f425 1759 * if at all possible, particularly for reports. It is very bad for performance.
812dbaf7
PS
1760 * @param array $options associative array with user picture options, used only if not a user_picture object,
1761 * options are:
1762 * - courseid=$this->page->course->id (course id of user profile in link)
1763 * - size=35 (size of image)
1764 * - link=true (make image clickable - the link leads to user profile)
1765 * - popup=false (open in popup)
1766 * - alttext=true (add image alt attribute)
5d0c95a5 1767 * - class = image class attribute (default 'userpicture')
d9c8f425 1768 * @return string HTML fragment
1769 */
5d0c95a5
PS
1770 public function user_picture(stdClass $user, array $options = null) {
1771 $userpicture = new user_picture($user);
1772 foreach ((array)$options as $key=>$value) {
1773 if (array_key_exists($key, $userpicture)) {
1774 $userpicture->$key = $value;
1775 }
1776 }
1777 return $this->render($userpicture);
1778 }
1779
1780 /**
1781 * Internal implementation of user image rendering.
1782 * @param user_picture $userpicture
1783 * @return string
1784 */
1785 protected function render_user_picture(user_picture $userpicture) {
1786 global $CFG, $DB;
812dbaf7 1787
5d0c95a5
PS
1788 $user = $userpicture->user;
1789
1790 if ($userpicture->alttext) {
1791 if (!empty($user->imagealt)) {
1792 $alt = $user->imagealt;
1793 } else {
1794 $alt = get_string('pictureof', '', fullname($user));
1795 }
d9c8f425 1796 } else {
97c10099 1797 $alt = '';
5d0c95a5
PS
1798 }
1799
1800 if (empty($userpicture->size)) {
1801 $file = 'f2';
1802 $size = 35;
1803 } else if ($userpicture->size === true or $userpicture->size == 1) {
1804 $file = 'f1';
1805 $size = 100;
1806 } else if ($userpicture->size >= 50) {
1807 $file = 'f1';
1808 $size = $userpicture->size;
1809 } else {
1810 $file = 'f2';
1811 $size = $userpicture->size;
d9c8f425 1812 }
1813
5d0c95a5 1814 $class = $userpicture->class;
d9c8f425 1815
edfd6a5e
PS
1816 if ($user->picture == 1) {
1817 $usercontext = get_context_instance(CONTEXT_USER, $user->id);
1818 $src = moodle_url::make_pluginfile_url($usercontext->id, 'user', 'icon', NULL, '/', $file);
1819
1820 } else if ($user->picture == 2) {
1821 //TODO: gravatar user icon support
1822
5d0c95a5
PS
1823 } else { // Print default user pictures (use theme version if available)
1824 $class .= ' defaultuserpic';
1825 $src = $this->pix_url('u/' . $file);
1826 }
d9c8f425 1827
29cf6631 1828 $attributes = array('src'=>$src, 'alt'=>$alt, 'title'=>$alt, 'class'=>$class, 'width'=>$size, 'height'=>$size);
5d0c95a5
PS
1829
1830 // get the image html output fisrt
1831 $output = html_writer::empty_tag('img', $attributes);;
1832
1833 // then wrap it in link if needed
1834 if (!$userpicture->link) {
1835 return $output;
d9c8f425 1836 }
1837
5d0c95a5
PS
1838 if (empty($userpicture->courseid)) {
1839 $courseid = $this->page->course->id;
1840 } else {
1841 $courseid = $userpicture->courseid;
1842 }
1843
03d9401e
MD
1844 if ($courseid == SITEID) {
1845 $url = new moodle_url('/user/profile.php', array('id' => $user->id));
1846 } else {
1847 $url = new moodle_url('/user/view.php', array('id' => $user->id, 'course' => $courseid));
1848 }
5d0c95a5
PS
1849
1850 $attributes = array('href'=>$url);
1851
1852 if ($userpicture->popup) {
1853 $id = html_writer::random_id('userpicture');
1854 $attributes['id'] = $id;
c80877aa 1855 $this->add_action_handler(new popup_action('click', $url), $id);
5d0c95a5
PS
1856 }
1857
26acc814 1858 return html_writer::tag('a', $output, $attributes);
d9c8f425 1859 }
b80ef420 1860
b80ef420
DC
1861 /**
1862 * Internal implementation of file tree viewer items rendering.
1863 * @param array $dir
1864 * @return string
1865 */
1866 public function htmllize_file_tree($dir) {
1867 if (empty($dir['subdirs']) and empty($dir['files'])) {
1868 return '';
1869 }
1870 $result = '<ul>';
1871 foreach ($dir['subdirs'] as $subdir) {
1872 $result .= '<li>'.s($subdir['dirname']).' '.$this->htmllize_file_tree($subdir).'</li>';
1873 }
1874 foreach ($dir['files'] as $file) {
1875 $filename = $file->get_filename();
1876 $result .= '<li><span>'.html_writer::link($file->fileurl, $filename).'</span></li>';
1877 }
1878 $result .= '</ul>';
1879
1880 return $result;
1881 }
bb496de7
DC
1882 /**
1883 * Print the file picker
1884 *
1885 * <pre>
1886 * $OUTPUT->file_picker($options);
1887 * </pre>
1888 *
1889 * @param array $options associative array with file manager options
1890 * options are:
1891 * maxbytes=>-1,
1892 * itemid=>0,
1893 * client_id=>uniqid(),
1894 * acepted_types=>'*',
1895 * return_types=>FILE_INTERNAL,
1896 * context=>$PAGE->context
1897 * @return string HTML fragment
1898 */
1899 public function file_picker($options) {
1900 $fp = new file_picker($options);
1901 return $this->render($fp);
1902 }
b80ef420
DC
1903 /**
1904 * Internal implementation of file picker rendering.
1905 * @param file_picker $fp
1906 * @return string
1907 */
bb496de7
DC
1908 public function render_file_picker(file_picker $fp) {
1909 global $CFG, $OUTPUT, $USER;
1910 $options = $fp->options;
1911 $client_id = $options->client_id;
1912 $strsaved = get_string('filesaved', 'repository');
1913 $straddfile = get_string('openpicker', 'repository');
1914 $strloading = get_string('loading', 'repository');
1915 $icon_progress = $OUTPUT->pix_icon('i/loading_small', $strloading).'';
1916
1917 $currentfile = $options->currentfile;
1918 if (empty($currentfile)) {
1919 $currentfile = get_string('nofilesattached', 'repository');
1920 }
b817205b
DC
1921 if ($options->maxbytes) {
1922 $size = $options->maxbytes;
1923 } else {
1924 $size = get_max_upload_file_size();
1925 }
513aed3c 1926 if ($size == -1) {
831399c4 1927 $maxsize = '';
513aed3c
DC
1928 } else {
1929 $maxsize = get_string('maxfilesize', 'moodle', display_size($size));
1930 }
bb496de7
DC
1931 $html = <<<EOD
1932<div class="filemanager-loading mdl-align" id='filepicker-loading-{$client_id}'>
1933$icon_progress
1934</div>
1935<div id="filepicker-wrapper-{$client_id}" class="mdl-left" style="display:none">
1936 <div>
26c137b1 1937 <input type="button" id="filepicker-button-{$client_id}" value="{$straddfile}" />
fa7f2a45 1938 <span> $maxsize </span>
bb496de7
DC
1939 </div>
1940EOD;
1941 if ($options->env != 'url') {
1942 $html .= <<<EOD
1943 <div id="file_info_{$client_id}" class="mdl-left filepicker-filelist">$currentfile</div>
1944EOD;
1945 }
1946 $html .= '</div>';
1947 return $html;
1948 }
d9c8f425 1949
1950 /**
1951 * Prints the 'Update this Modulename' button that appears on module pages.
1952 *
1953 * @param string $cmid the course_module id.
1954 * @param string $modulename the module name, eg. "forum", "quiz" or "workshop"
1955 * @return string the HTML for the button, if this user has permission to edit it, else an empty string.
1956 */
1957 public function update_module_button($cmid, $modulename) {
1958 global $CFG;
1959 if (has_capability('moodle/course:manageactivities', get_context_instance(CONTEXT_MODULE, $cmid))) {
1960 $modulename = get_string('modulename', $modulename);
1961 $string = get_string('updatethis', '', $modulename);
3ba60ee1
PS
1962 $url = new moodle_url("$CFG->wwwroot/course/mod.php", array('update' => $cmid, 'return' => true, 'sesskey' => sesskey()));
1963 return $this->single_button($url, $string);
d9c8f425 1964 } else {
1965 return '';
1966 }
1967 }
1968
1969 /**
1970 * Prints a "Turn editing on/off" button in a form.
1971 * @param moodle_url $url The URL + params to send through when clicking the button
1972 * @return string HTML the button
1973 */
1974 public function edit_button(moodle_url $url) {
3362dfdc
EL
1975
1976 $url->param('sesskey', sesskey());
1977 if ($this->page->user_is_editing()) {
1978 $url->param('edit', 'off');
1979 $editstring = get_string('turneditingoff');
d9c8f425 1980 } else {
3362dfdc
EL
1981 $url->param('edit', 'on');
1982 $editstring = get_string('turneditingon');
d9c8f425 1983 }
1984
3362dfdc 1985 return $this->single_button($url, $editstring);
d9c8f425 1986 }
1987
d9c8f425 1988 /**
1989 * Prints a simple button to close a window
1990 *
d9c8f425 1991 * @param string $text The lang string for the button's label (already output from get_string())
3ba60ee1 1992 * @return string html fragment
d9c8f425 1993 */
7a5c78e0 1994 public function close_window_button($text='') {
d9c8f425 1995 if (empty($text)) {
1996 $text = get_string('closewindow');
1997 }
a6855934
PS
1998 $button = new single_button(new moodle_url('#'), $text, 'get');
1999 $button->add_action(new component_action('click', 'close_window'));
3ba60ee1
PS
2000
2001 return $this->container($this->render($button), 'closewindow');
d9c8f425 2002 }
2003
d9c8f425 2004 /**
2005 * Output an error message. By default wraps the error message in <span class="error">.
2006 * If the error message is blank, nothing is output.
2007 * @param string $message the error message.
2008 * @return string the HTML to output.
2009 */
2010 public function error_text($message) {
2011 if (empty($message)) {
2012 return '';
2013 }
26acc814 2014 return html_writer::tag('span', $message, array('class' => 'error'));
d9c8f425 2015 }
2016
2017 /**
2018 * Do not call this function directly.
2019 *
2020 * To terminate the current script with a fatal error, call the {@link print_error}
2021 * function, or throw an exception. Doing either of those things will then call this
2022 * function to display the error, before terminating the execution.
2023 *
2024 * @param string $message The message to output
2025 * @param string $moreinfourl URL where more info can be found about the error
2026 * @param string $link Link for the Continue button
2027 * @param array $backtrace The execution backtrace
2028 * @param string $debuginfo Debugging information
d9c8f425 2029 * @return string the HTML to output.
2030 */
83267ec0 2031 public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
d9c8f425 2032
2033 $output = '';
6f8f4d83 2034 $obbuffer = '';
e57c283d 2035
d9c8f425 2036 if ($this->has_started()) {
50764d37
PS
2037 // we can not always recover properly here, we have problems with output buffering,
2038 // html tables, etc.
d9c8f425 2039 $output .= $this->opencontainers->pop_all_but_last();
50764d37 2040
d9c8f425 2041 } else {
50764d37
PS
2042 // It is really bad if library code throws exception when output buffering is on,
2043 // because the buffered text would be printed before our start of page.
2044 // NOTE: this hack might be behave unexpectedly in case output buffering is enabled in PHP.ini
2045 while (ob_get_level() > 0) {
6f8f4d83 2046 $obbuffer .= ob_get_clean();
50764d37 2047 }
6f8f4d83 2048
d9c8f425 2049 // Header not yet printed
85309744 2050 if (isset($_SERVER['SERVER_PROTOCOL'])) {
78946b9b
PS
2051 // server protocol should be always present, because this render
2052 // can not be used from command line or when outputting custom XML
85309744
PS
2053 @header($_SERVER['SERVER_PROTOCOL'] . ' 404 Not Found');
2054 }
eb5bdb35 2055 $this->page->set_context(null); // ugly hack - make sure page context is set to something, we do not want bogus warnings here
7fde1e4b 2056 $this->page->set_url('/'); // no url
191b267b 2057 //$this->page->set_pagelayout('base'); //TODO: MDL-20676 blocks on error pages are weird, unfortunately it somehow detect the pagelayout from URL :-(
dcfb9b78 2058 $this->page->set_title(get_string('error'));
8093188f 2059 $this->page->set_heading($this->page->course->fullname);
d9c8f425 2060 $output .= $this->header();
2061 }
2062
2063 $message = '<p class="errormessage">' . $message . '</p>'.
2064 '<p class="errorcode"><a href="' . $moreinfourl . '">' .
2065 get_string('moreinformation') . '</a></p>';
2066 $output .= $this->box($message, 'errorbox');
2067
6f8f4d83
PS
2068 if (debugging('', DEBUG_DEVELOPER)) {
2069 if (!empty($debuginfo)) {
c5d18164
PS
2070 $debuginfo = s($debuginfo); // removes all nasty JS
2071 $debuginfo = str_replace("\n", '<br />', $debuginfo); // keep newlines
2072 $output .= $this->notification('<strong>Debug info:</strong> '.$debuginfo, 'notifytiny');
6f8f4d83
PS
2073 }
2074 if (!empty($backtrace)) {
2075 $output .= $this->notification('<strong>Stack trace:</strong> '.format_backtrace($backtrace), 'notifytiny');
2076 }
2077 if ($obbuffer !== '' ) {
2078 $output .= $this->notification('<strong>Output buffer:</strong> '.s($obbuffer), 'notifytiny');
2079 }
d9c8f425 2080 }
2081
2082 if (!empty($link)) {
2083 $output .= $this->continue_button($link);
2084 }
2085
2086 $output .= $this->footer();
2087
2088 // Padding to encourage IE to display our error page, rather than its own.
2089 $output .= str_repeat(' ', 512);
2090
2091 return $output;
2092 }
2093
2094 /**
2095 * Output a notification (that is, a status message about something that has
2096 * just happened).
2097 *
2098 * @param string $message the message to print out
2099 * @param string $classes normally 'notifyproblem' or 'notifysuccess'.
2100 * @return string the HTML to output.
2101 */
2102 public function notification($message, $classes = 'notifyproblem') {
26acc814 2103 return html_writer::tag('div', clean_text($message), array('class' => renderer_base::prepare_classes($classes)));
d9c8f425 2104 }
2105
2106 /**
2107 * Print a continue button that goes to a particular URL.
2108 *
3ba60ee1 2109 * @param string|moodle_url $url The url the button goes to.
d9c8f425 2110 * @return string the HTML to output.
2111 */
3ba60ee1
PS
2112 public function continue_button($url) {
2113 if (!($url instanceof moodle_url)) {
2114 $url = new moodle_url($url);
d9c8f425 2115 }
3ba60ee1
PS
2116 $button = new single_button($url, get_string('continue'), 'get');
2117 $button->class = 'continuebutton';
d9c8f425 2118
3ba60ee1 2119 return $this->render($button);
d9c8f425 2120 }
2121
2122 /**
2123 * Prints a single paging bar to provide access to other pages (usually in a search)
2124 *
71c03ac1 2125 * @param int $totalcount The total number of entries available to be paged through
929d7a83
PS
2126 * @param int $page The page you are currently viewing
2127 * @param int $perpage The number of entries that should be shown per page
2128 * @param string|moodle_url $baseurl url of the current page, the $pagevar parameter is added
2129 * @param string $pagevar name of page parameter that holds the page number
d9c8f425 2130 * @return string the HTML to output.
2131 */
929d7a83
PS
2132 public function paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar = 'page') {
2133 $pb = new paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar);
2134 return $this->render($pb);
2135 }
2136
2137 /**
2138 * Internal implementation of paging bar rendering.
2139 * @param paging_bar $pagingbar
2140 * @return string
2141 */
2142 protected function render_paging_bar(paging_bar $pagingbar) {
d9c8f425 2143 $output = '';
2144 $pagingbar = clone($pagingbar);
34059565 2145 $pagingbar->prepare($this, $this->page, $this->target);
d9c8f425 2146
2147 if ($pagingbar->totalcount > $pagingbar->perpage) {
2148 $output .= get_string('page') . ':';
2149
2150 if (!empty($pagingbar->previouslink)) {
56ddb719 2151 $output .= '&#160;(' . $pagingbar->previouslink . ')&#160;';
d9c8f425 2152 }
2153
2154 if (!empty($pagingbar->firstlink)) {
56ddb719 2155 $output .= '&#160;' . $pagingbar->firstlink . '&#160;...';
d9c8f425 2156 }
2157
2158 foreach ($pagingbar->pagelinks as $link) {
56ddb719 2159 $output .= "&#160;&#160;$link";
d9c8f425 2160 }
2161
2162 if (!empty($pagingbar->lastlink)) {
56ddb719 2163 $output .= '&#160;...' . $pagingbar->lastlink . '&#160;';
d9c8f425 2164 }
2165
2166 if (!empty($pagingbar->nextlink)) {
56ddb719 2167 $output .= '&#160;&#160;(' . $pagingbar->nextlink . ')';
d9c8f425 2168 }
2169 }
2170
26acc814 2171 return html_writer::tag('div', $output, array('class' => 'paging'));
d9c8f425 2172 }
2173
d9c8f425 2174 /**
2175 * Output the place a skip link goes to.
2176 * @param string $id The target name from the corresponding $PAGE->requires->skip_link_to($target) call.
2177 * @return string the HTML to output.
2178 */
fe213365 2179 public function skip_link_target($id = null) {
26acc814 2180 return html_writer::tag('span', '', array('id' => $id));
d9c8f425 2181 }
2182
2183 /**
2184 * Outputs a heading
2185 * @param string $text The text of the heading
2186 * @param int $level The level of importance of the heading. Defaulting to 2
2187 * @param string $classes A space-separated list of CSS classes
2188 * @param string $id An optional ID
2189 * @return string the HTML to output.
2190 */
fe213365 2191 public function heading($text, $level = 2, $classes = 'main', $id = null) {
d9c8f425 2192 $level = (integer) $level;
2193 if ($level < 1 or $level > 6) {
2194 throw new coding_exception('Heading level must be an integer between 1 and 6.');
2195 }
26acc814 2196 return html_writer::tag('h' . $level, $text, array('id' => $id, 'class' => renderer_base::prepare_classes($classes)));
d9c8f425 2197 }
2198
2199 /**
2200 * Outputs a box.
2201 * @param string $contents The contents of the box
2202 * @param string $classes A space-separated list of CSS classes
2203 * @param string $id An optional ID
2204 * @return string the HTML to output.
2205 */
fe213365 2206 public function box($contents, $classes = 'generalbox', $id = null) {
d9c8f425 2207 return $this->box_start($classes, $id) . $contents . $this->box_end();
2208 }
2209
2210 /**
2211 * Outputs the opening section of a box.
2212 * @param string $classes A space-separated list of CSS classes
2213 * @param string $id An optional ID
2214 * @return string the HTML to output.
2215 */
fe213365 2216 public function box_start($classes = 'generalbox', $id = null) {
5d0c95a5
PS
2217 $this->opencontainers->push('box', html_writer::end_tag('div'));
2218 return html_writer::start_tag('div', array('id' => $id,
78946b9b 2219 'class' => 'box ' . renderer_base::prepare_classes($classes)));
d9c8f425 2220 }
2221
2222 /**
2223 * Outputs the closing section of a box.
2224 * @return string the HTML to output.
2225 */
2226 public function box_end() {
2227 return $this->opencontainers->pop('box');
2228 }
2229
2230 /**
2231 * Outputs a container.
2232 * @param string $contents The contents of the box
2233 * @param string $classes A space-separated list of CSS classes
2234 * @param string $id An optional ID
2235 * @return string the HTML to output.
2236 */
fe213365 2237 public function container($contents, $classes = null, $id = null) {
d9c8f425 2238 return $this->container_start($classes, $id) . $contents . $this->container_end();
2239 }
2240
2241 /**
2242 * Outputs the opening section of a container.
2243 * @param string $classes A space-separated list of CSS classes
2244 * @param string $id An optional ID
2245 * @return string the HTML to output.
2246 */
fe213365 2247 public function container_start($classes = null, $id = null) {
5d0c95a5
PS
2248 $this->opencontainers->push('container', html_writer::end_tag('div'));
2249 return html_writer::start_tag('div', array('id' => $id,
78946b9b 2250 'class' => renderer_base::prepare_classes($classes)));
d9c8f425 2251 }
2252
2253 /**
2254 * Outputs the closing section of a container.
2255 * @return string the HTML to output.
2256 */
2257 public function container_end() {
2258 return $this->opencontainers->pop('container');
2259 }
7d2a0492 2260
3406acde 2261 /**
7d2a0492 2262 * Make nested HTML lists out of the items
2263 *
2264 * The resulting list will look something like this:
2265 *
2266 * <pre>
2267 * <<ul>>
2268 * <<li>><div class='tree_item parent'>(item contents)</div>
2269 * <<ul>
2270 * <<li>><div class='tree_item'>(item contents)</div><</li>>
2271 * <</ul>>
2272 * <</li>>
2273 * <</ul>>
2274 * </pre>
2275 *
2276 * @param array[]tree_item $items
2277 * @param array[string]string $attrs html attributes passed to the top of
2278 * the list
2279 * @return string HTML
2280 */
2281 function tree_block_contents($items, $attrs=array()) {
2282 // exit if empty, we don't want an empty ul element
2283 if (empty($items)) {
2284 return '';
2285 }
2286 // array of nested li elements
2287 $lis = array();
2288 foreach ($items as $item) {
2289 // this applies to the li item which contains all child lists too
2290 $content = $item->content($this);
2291 $liclasses = array($item->get_css_type());
3406acde 2292 if (!$item->forceopen || (!$item->forceopen && $item->collapse) || ($item->children->count()==0 && $item->nodetype==navigation_node::NODETYPE_BRANCH)) {
7d2a0492 2293 $liclasses[] = 'collapsed';
2294 }
2295 if ($item->isactive === true) {
2296 $liclasses[] = 'current_branch';
2297 }
2298 $liattr = array('class'=>join(' ',$liclasses));
2299 // class attribute on the div item which only contains the item content
2300 $divclasses = array('tree_item');
3406acde 2301 if ($item->children->count()>0 || $item->nodetype==navigation_node::NODETYPE_BRANCH) {
7d2a0492 2302 $divclasses[] = 'branch';
2303 } else {
2304 $divclasses[] = 'leaf';
2305 }
2306 if (!empty($item->classes) && count($item->classes)>0) {
2307 $divclasses[] = join(' ', $item->classes);
2308 }
2309 $divattr = array('class'=>join(' ', $divclasses));
2310 if (!empty($item->id)) {
2311 $divattr['id'] = $item->id;
2312 }
26acc814 2313 $content = html_writer::tag('p', $content, $divattr) . $this->tree_block_contents($item->children);
7d2a0492 2314 if (!empty($item->preceedwithhr) && $item->preceedwithhr===true) {
26acc814 2315 $content = html_writer::empty_tag('hr') . $content;
7d2a0492 2316 }
26acc814 2317 $content = html_writer::tag('li', $content, $liattr);
7d2a0492 2318 $lis[] = $content;
2319 }
26acc814 2320 return html_writer::tag('ul', implode("\n", $lis), $attrs);
7d2a0492 2321 }
2322
2323 /**
2324 * Return the navbar content so that it can be echoed out by the layout
2325 * @return string XHTML navbar
2326 */
2327 public function navbar() {
3406acde
SH
2328 //return $this->page->navbar->content();
2329
2330 $items = $this->page->navbar->get_items();
2331
2332 $count = 0;
2333
2334 $htmlblocks = array();
2335 // Iterate the navarray and display each node
ffca6f4b
SH
2336 $itemcount = count($items);
2337 $separator = get_separator();
2338 for ($i=0;$i < $itemcount;$i++) {
2339 $item = $items[$i];
493a48f3 2340 $item->hideicon = true;
ffca6f4b
SH
2341 if ($i===0) {
2342 $content = html_writer::tag('li', $this->render($item));
2343 } else {
2344 $content = html_writer::tag('li', $separator.$this->render($item));
2345 }
2346 $htmlblocks[] = $content;
3406acde
SH
2347 }
2348
dcfb9b78
RW
2349 //accessibility: heading for navbar list (MDL-20446)
2350 $navbarcontent = html_writer::tag('span', get_string('pagepath'), array('class'=>'accesshide'));
2351 $navbarcontent .= html_writer::tag('ul', join('', $htmlblocks));
3406acde 2352 // XHTML
dcfb9b78 2353 return $navbarcontent;
3406acde
SH
2354 }
2355
2356 protected function render_navigation_node(navigation_node $item) {
2357 $content = $item->get_content();
2358 $title = $item->get_title();
493a48f3 2359 if ($item->icon instanceof renderable && !$item->hideicon) {
3406acde 2360 $icon = $this->render($item->icon);
48fa9484 2361 $content = $icon.$content; // use CSS for spacing of icons
3406acde
SH
2362 }
2363 if ($item->helpbutton !== null) {
2364 $content = trim($item->helpbutton).html_writer::tag('span', $content, array('class'=>'clearhelpbutton'));
2365 }
2366 if ($content === '') {
b4c458a3 2367 return '';
3406acde
SH
2368 }
2369 if ($item->action instanceof action_link) {
2370 //TODO: to be replaced with something else
2371 $link = $item->action;
2372 if ($item->hidden) {
2373 $link->add_class('dimmed');
2374 }
2375 $content = $this->output->render($link);
2376 } else if ($item->action instanceof moodle_url) {
2377 $attributes = array();
2378 if ($title !== '') {
2379 $attributes['title'] = $title;
2380 }
2381 if ($item->hidden) {
2382 $attributes['class'] = 'dimmed_text';
2383 }
2384 $content = html_writer::link($item->action, $content, $attributes);
2385
2386 } else if (is_string($item->action) || empty($item->action)) {
2387 $attributes = array();
2388 if ($title !== '') {
2389 $attributes['title'] = $title;
2390 }
2391 if ($item->hidden) {
2392 $attributes['class'] = 'dimmed_text';
2393 }
2394 $content = html_writer::tag('span', $content, $attributes);
2395 }
2396 return $content;
7d2a0492 2397 }
92e01ab7
PS
2398
2399 /**
2400 * Accessibility: Right arrow-like character is
2401 * used in the breadcrumb trail, course navigation menu
2402 * (previous/next activity), calendar, and search forum block.
2403 * If the theme does not set characters, appropriate defaults
2404 * are set automatically. Please DO NOT
2405 * use &lt; &gt; &raquo; - these are confusing for blind users.
2406 * @return string
2407 */
2408 public function rarrow() {
2409 return $this->page->theme->rarrow;
2410 }
2411
2412 /**
2413 * Accessibility: Right arrow-like character is
2414 * used in the breadcrumb trail, course navigation menu
2415 * (previous/next activity), calendar, and search forum block.
2416 * If the theme does not set characters, appropriate defaults
2417 * are set automatically. Please DO NOT
2418 * use &lt; &gt; &raquo; - these are confusing for blind users.
2419 * @return string
2420 */
2421 public function larrow() {
2422 return $this->page->theme->larrow;
2423 }
088ccb43
PS
2424
2425 /**
2426 * Returns the colours of the small MP3 player
2427 * @return string
2428 */
2429 public function filter_mediaplugin_colors() {
2430 return $this->page->theme->filter_mediaplugin_colors;
2431 }
2432
2433 /**
2434 * Returns the colours of the big MP3 player
2435 * @return string
2436 */
2437 public function resource_mp3player_colors() {
2438 return $this->page->theme->resource_mp3player_colors;
2439 }
d2dbd0c0
SH
2440
2441 /**
2442 * Returns the custom menu if one has been set
2443 *
71c03ac1 2444 * A custom menu can be configured by browsing to
d2dbd0c0
SH
2445 * Settings: Administration > Appearance > Themes > Theme settings
2446 * and then configuring the custommenu config setting as described.
4d2ee4c2 2447 *
d2dbd0c0
SH
2448 * @return string
2449 */
2450 public function custom_menu() {
12cc75ae
SH
2451 global $CFG;
2452 if (empty($CFG->custommenuitems)) {
2453 return '';
2454 }
d2dbd0c0
SH
2455 $custommenu = new custom_menu();
2456 return $this->render_custom_menu($custommenu);
2457 }
2458
2459 /**
2460 * Renders a custom menu object (located in outputcomponents.php)
2461 *
2462 * The custom menu this method produces makes use of the YUI3 menunav widget
2463 * and requires very specific html elements and classes.
2464 *
2465 * @staticvar int $menucount
2466 * @param custom_menu $menu
2467 * @return string
2468 */
2469 protected function render_custom_menu(custom_menu $menu) {
2470 static $menucount = 0;
2471 // If the menu has no children return an empty string
2472 if (!$menu->has_children()) {
2473 return '';
2474 }
2475 // Increment the menu count. This is used for ID's that get worked with
2476 // in JavaScript as is essential
2477 $menucount++;
d2dbd0c0 2478 // Initialise this custom menu
d7bd9acd 2479 $this->page->requires->js_init_call('M.core_custom_menu.init', array('custom_menu_'.$menucount));
d2dbd0c0
SH
2480 // Build the root nodes as required by YUI
2481 $content = html_writer::start_tag('div', array('id'=>'custom_menu_'.$menucount, 'class'=>'yui3-menu yui3-menu-horizontal javascript-disabled'));
2482 $content .= html_writer::start_tag('div', array('class'=>'yui3-menu-content'));
2483 $content .= html_writer::start_tag('ul');
2484 // Render each child
2485 foreach ($menu->get_children() as $item) {
2486 $content .= $this->render_custom_menu_item($item);
2487 }
2488 // Close the open tags
2489 $content .= html_writer::end_tag('ul');
2490 $content .= html_writer::end_tag('div');
2491 $content .= html_writer::end_tag('div');
2492 // Return the custom menu
2493 return $content;
2494 }
2495
2496 /**
2497 * Renders a custom menu node as part of a submenu
2498 *
2499 * The custom menu this method produces makes use of the YUI3 menunav widget
2500 * and requires very specific html elements and classes.
2501 *
2502 * @see render_custom_menu()
2503 *
2504 * @staticvar int $submenucount
2505 * @param custom_menu_item $menunode
2506 * @return string
2507 */
2508 protected function render_custom_menu_item(custom_menu_item $menunode) {
2509 // Required to ensure we get unique trackable id's
2510 static $submenucount = 0;
2511 if ($menunode->has_children()) {
2512 // If the child has menus render it as a sub menu
2513 $submenucount++;
2514 $content = html_writer::start_tag('li');
2515 if ($menunode->get_url() !== null) {
2516 $url = $menunode->get_url();
2517 } else {
2518 $url = '#cm_submenu_'.$submenucount;
2519 }
2520 $content .= html_writer::link($url, $menunode->get_text(), array('class'=>'yui3-menu-label', 'title'=>$menunode->get_title()));
2521 $content .= html_writer::start_tag('div', array('id'=>'cm_submenu_'.$submenucount, 'class'=>'yui3-menu custom_menu_submenu'));
2522 $content .= html_writer::start_tag('div', array('class'=>'yui3-menu-content'));
2523 $content .= html_writer::start_tag('ul');
2524 foreach ($menunode->get_children() as $menunode) {
2525 $content .= $this->render_custom_menu_item($menunode);
2526 }
2527 $content .= html_writer::end_tag('ul');
2528 $content .= html_writer::end_tag('div');
2529 $content .= html_writer::end_tag('div');
2530 $content .= html_writer::end_tag('li');
2531 } else {
2532 // The node doesn't have children so produce a final menuitem
2533 $content = html_writer::start_tag('li', array('class'=>'yui3-menuitem'));
2534 if ($menunode->get_url() !== null) {
2535 $url = $menunode->get_url();
2536 } else {
2537 $url = '#';
2538 }
2539 $content .= html_writer::link($url, $menunode->get_text(), array('class'=>'yui3-menuitem-content', 'title'=>$menunode->get_title()));
2540 $content .= html_writer::end_tag('li');
2541 }
2542 // Return the sub menu
2543 return $content;
2544 }
2a102b90
SH
2545
2546 /**
2547 * Renders the image_gallery component and initialises its JavaScript
2548 *
2549 * @param image_gallery $imagegallery
2550 * @return string
2551 */
2552 protected function render_image_gallery(image_gallery $imagegallery) {
78bfb562 2553 $this->page->requires->yui_module(array('gallery-lightbox','gallery-lightbox-skin'),
f21b3630 2554 'Y.Lightbox.init', null, '2010.04.08-12-35');
2a102b90
SH
2555 if (count($imagegallery->images) == 0) {
2556 return '';
2557 }
af7c1e29
SH
2558 $classes = array('image_gallery');
2559 if ($imagegallery->displayfirstimageonly) {
2560 $classes[] = 'oneimageonly';
2561 }
2562 $content = html_writer::start_tag('div', array('class'=>join(' ', $classes)));
2a102b90
SH
2563 foreach ($imagegallery->images as $image) {
2564 $content .= html_writer::tag('a', html_writer::empty_tag('img', $image->thumb), $image->link);
2565 }
2566 $content .= html_writer::end_tag('div');
2567 return $content;
2568 }
78946b9b 2569}
d9c8f425 2570
2571
2572/// RENDERERS
2573
2574/**
2575 * A renderer that generates output for command-line scripts.
2576 *
2577 * The implementation of this renderer is probably incomplete.
2578 *
2579 * @copyright 2009 Tim Hunt
2580 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2581 * @since Moodle 2.0
2582 */
56cbc53b 2583class core_renderer_cli extends core_renderer {
d9c8f425 2584 /**
2585 * Returns the page header.
2586 * @return string HTML fragment
2587 */
2588 public function header() {
d9c8f425 2589 return $this->page->heading . "\n";
2590 }
2591
2592 /**
2593 * Returns a template fragment representing a Heading.
2594 * @param string $text The text of the heading
2595 * @param int $level The level of importance of the heading
2596 * @param string $classes A space-separated list of CSS classes
2597 * @param string $id An optional ID
2598 * @return string A template fragment for a heading
2599 */
0fddc031 2600 public function heading($text, $level = 2, $classes = 'main', $id = null) {
d9c8f425 2601 $text .= "\n";
2602 switch ($level) {
2603 case 1:
2604 return '=>' . $text;
2605 case 2:
2606 return '-->' . $text;
2607 default:
2608 return $text;
2609 }
2610 }
2611
2612 /**
2613 * Returns a template fragment representing a fatal error.
2614 * @param string $message The message to output
2615 * @param string $moreinfourl URL where more info can be found about the error
2616 * @param string $link Link for the Continue button
2617 * @param array $backtrace The execution backtrace
2618 * @param string $debuginfo Debugging information
d9c8f425 2619 * @return string A template fragment for a fatal error
2620 */
83267ec0 2621 public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
d9c8f425 2622 $output = "!!! $message !!!\n";
2623
2624 if (debugging('', DEBUG_DEVELOPER)) {
2625 if (!empty($debuginfo)) {
2626 $this->notification($debuginfo, 'notifytiny');
2627 }
2628 if (!empty($backtrace)) {
2629 $this->notification('Stack trace: ' . format_backtrace($backtrace, true), 'notifytiny');
2630 }
2631 }
2632 }
2633
2634 /**
2635 * Returns a template fragment representing a notification.
2636 * @param string $message The message to include
2637 * @param string $classes A space-separated list of CSS classes
2638 * @return string A template fragment for a notification
2639 */
2640 public function notification($message, $classes = 'notifyproblem') {
2641 $message = clean_text($message);
2642 if ($classes === 'notifysuccess') {
2643 return "++ $message ++\n";
2644 }
2645 return "!! $message !!\n";
2646 }
2647}
2648
1adaa404
PS
2649
2650/**
2651 * A renderer that generates output for ajax scripts.
2652 *
2653 * This renderer prevents accidental sends back only json
2654 * encoded error messages, all other output is ignored.
2655 *
2656 * @copyright 2010 Petr Skoda
2657 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2658 * @since Moodle 2.0
2659 */
2660class core_renderer_ajax extends core_renderer {
2661 /**
2662 * Returns a template fragment representing a fatal error.
2663 * @param string $message The message to output
2664 * @param string $moreinfourl URL where more info can be found about the error
2665 * @param string $link Link for the Continue button
2666 * @param array $backtrace The execution backtrace
2667 * @param string $debuginfo Debugging information
2668 * @return string A template fragment for a fatal error
2669 */
2670 public function fatal_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
79beb849 2671 global $CFG;
eb5bdb35
PS
2672
2673 $this->page->set_context(null); // ugly hack - make sure page context is set to something, we do not want bogus warnings here
2674
1adaa404
PS
2675 $e = new stdClass();
2676 $e->error = $message;
2677 $e->stacktrace = NULL;
2678 $e->debuginfo = NULL;
6db3eee0 2679 $e->reproductionlink = NULL;
1adaa404 2680 if (!empty($CFG->debug) and $CFG->debug >= DEBUG_DEVELOPER) {
6db3eee0 2681 $e->reproductionlink = $link;
1adaa404
PS
2682 if (!empty($debuginfo)) {
2683 $e->debuginfo = $debuginfo;
2684 }
2685 if (!empty($backtrace)) {
2686 $e->stacktrace = format_backtrace($backtrace, true);
2687 }
2688 }
bce08d9a 2689 $this->header();
1adaa404
PS
2690 return json_encode($e);
2691 }
2692
2693 public function notification($message, $classes = 'notifyproblem') {
2694 }
bce08d9a 2695
1adaa404
PS
2696 public function redirect_message($encodedurl, $message, $delay, $debugdisableredirect) {
2697 }
bce08d9a 2698
1adaa404 2699 public function header() {
bce08d9a
PS
2700 // unfortunately YUI iframe upload does not support application/json
2701 if (!empty($_FILES)) {
2702 @header('Content-type: text/plain');
2703 } else {
2704 @header('Content-type: application/json');
2705 }
2706
2707 /// Headers to make it not cacheable and json
2708 @header('Cache-Control: no-store, no-cache, must-revalidate');
2709 @header('Cache-Control: post-check=0, pre-check=0', false);
2710 @header('Pragma: no-cache');
2711 @header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
2712 @header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
2713 @header('Accept-Ranges: none');
1adaa404 2714 }
bce08d9a 2715
1adaa404
PS
2716 public function footer() {
2717 }
bce08d9a 2718
0fddc031 2719 public function heading($text, $level = 2, $classes = 'main', $id = null) {
1adaa404
PS
2720 }
2721}
2722