lib/outputrenderers.php

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