lib/outputcomponents.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 representing HTML elements, used by $OUTPUT methods
  20  *
  21  * Please see http://docs.moodle.org/en/Developement:How_Moodle_outputs_HTML
  22  * for an overview.
  23  *
  24  * @package    core
  25  * @subpackage lib
  26  * @copyright  2009 Tim Hunt
  27  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  28  */
  29
  30 defined('MOODLE_INTERNAL') || die();
  31
  32 /**
  33  * Interface marking other classes as suitable for renderer_base::render()
  34  * @author 2010 Petr Skoda (skodak) info@skodak.org
  35  */
  36 interface renderable {
  37     // intentionally empty
  38 }
  39
  40 /**
  41  * Data structure representing a file picker.
  42  *
  43  * @copyright 2010 Dongsheng Cai
  44  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  45  * @since     Moodle 2.0
  46  */
  47 class file_picker implements renderable {
  48     public $options;
  49     public function __construct(stdClass $options) {
  50         global $CFG, $USER, $PAGE;
  51         require_once($CFG->dirroot. '/repository/lib.php');
  52         $defaults = array(
  53             'accepted_types'=>'*',
  54             'return_types'=>FILE_INTERNAL,
  55             'env' => 'filepicker',
  56             'client_id' => uniqid(),
  57             'itemid' => 0,
  58             'maxbytes'=>-1,
  59             'maxfiles'=>1,
  60             'buttonname'=>false
  61         );
  62         foreach ($defaults as $key=>$value) {
  63             if (empty($options->$key)) {
  64                 $options->$key = $value;
  65             }
  66         }
  67
  68         $options->currentfile = '';
  69         if (!empty($options->itemid)) {
  70             $fs = get_file_storage();
  71             $usercontext = get_context_instance(CONTEXT_USER, $USER->id);
  72             if (empty($options->filename)) {
  73                 if ($files = $fs->get_area_files($usercontext->id, 'user', 'draft', $options->itemid, 'id DESC', false)) {
  74                     $file = reset($files);
  75                 }
  76             } else {
  77                 $file = $fs->get_file($usercontext->id, 'user', 'draft', $options->itemid, $options->filepath, $options->filename);
  78             }
  79             if (!empty($file)) {
  80                 $options->currentfile = html_writer::link(moodle_url::make_draftfile_url($file->get_itemid(), $file->get_filepath(), $file->get_filename()), $file->get_filename());
  81             }
  82         }
  83
  84         // initilise options, getting files in root path
  85         $this->options = initialise_filepicker($options);
  86
  87         // copying other options
  88         foreach ($options as $name=>$value) {
  89             if (!isset($this->options->$name)) {
  90                 $this->options->$name = $value;
  91             }
  92         }
  93     }
  94 }
  95
  96 /**
  97  * Data structure representing a user picture.
  98  *
  99  * @copyright 2009 Nicolas Connault, 2010 Petr Skoda
 100  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 101  * @since     Moodle 2.0
 102  */
 103 class user_picture implements renderable {
 104     /**
 105      * @var array List of mandatory fields in user record here. (do not include TEXT columns because it would break SELECT DISTINCT in MSSQL and ORACLE)
 106      */
 107     protected static $fields = array('id', 'picture', 'firstname', 'lastname', 'imagealt', 'email');
 108
 109     /**
 110      * @var object $user A user object with at least fields all columns specified in $fields array constant set.
 111      */
 112     public $user;
 113     /**
 114      * @var int $courseid The course id. Used when constructing the link to the user's profile,
 115      * page course id used if not specified.
 116      */
 117     public $courseid;
 118     /**
 119      * @var bool $link add course profile link to image
 120      */
 121     public $link = true;
 122     /**
 123      * @var int $size Size in pixels. Special values are (true/1 = 100px) and (false/0 = 35px) for backward compatibility
 124      */
 125     public $size = 35;
 126     /**
 127      * @var boolean $alttext add non-blank alt-text to the image.
 128      * Default true, set to false when image alt just duplicates text in screenreaders.
 129      */
 130     public $alttext = true;
 131     /**
 132      * @var boolean $popup Whether or not to open the link in a popup window.
 133      */
 134     public $popup = false;
 135     /**
 136      * @var string Image class attribute
 137      */
 138     public $class = 'userpicture';
 139
 140     /**
 141      * User picture constructor.
 142      *
 143      * @param object $user user record with at least id, picture, imagealt, firstname and lastname set.
 144      * @param array $options such as link, size, link, ...
 145      */
 146     public function __construct(stdClass $user) {
 147         global $DB;
 148
 149         if (empty($user->id)) {
 150             throw new coding_exception('User id is required when printing user avatar image.');
 151         }
 152
 153         // only touch the DB if we are missing data and complain loudly...
 154         $needrec = false;
 155         foreach (self::$fields as $field) {
 156             if (!array_key_exists($field, $user)) {
 157                 $needrec = true;
 158                 debugging('Missing '.$field.' property in $user object, this is a performance problem that needs to be fixed by a developer. '
 159                           .'Please use user_picture::fields() to get the full list of required fields.', DEBUG_DEVELOPER);
 160                 break;
 161             }
 162         }
 163
 164         if ($needrec) {
 165             $this->user = $DB->get_record('user', array('id'=>$user->id), self::fields(), MUST_EXIST);
 166         } else {
 167             $this->user = clone($user);
 168         }
 169     }
 170
 171     /**
 172      * Returns a list of required user fields, useful when fetching required user info from db.
 173      *
 174      * In some cases we have to fetch the user data together with some other information,
 175      * the idalias is useful there because the id would otherwise override the main
 176      * id of the result record. Please note it has to be converted back to id before rendering.
 177      *
 178      * @param string $tableprefix name of database table prefix in query
 179      * @param array $extrafields extra fields to be included in result (do not include TEXT columns because it would break SELECT DISTINCT in MSSQL and ORACLE)
 180      * @param string $idalias alias of id field
 181      * @param string $fieldprefix prefix to add to all columns in their aliases, does not apply to 'id'
 182      * @return string
 183      */
 184     public static function fields($tableprefix = '', array $extrafields = NULL, $idalias = 'id', $fieldprefix = '') {
 185         if (!$tableprefix and !$extrafields and !$idalias) {
 186             return implode(',', self::$fields);
 187         }
 188         if ($tableprefix) {
 189             $tableprefix .= '.';
 190         }
 191         $fields = array();
 192         foreach (self::$fields as $field) {
 193             if ($field === 'id' and $idalias and $idalias !== 'id') {
 194                 $fields[$field] = "$tableprefix$field AS $idalias";
 195             } else {
 196                 if ($fieldprefix and $field !== 'id') {
 197                     $fields[$field] = "$tableprefix$field AS $fieldprefix$field";
 198                 } else {
 199                     $fields[$field] = "$tableprefix$field";
 200                 }
 201             }
 202         }
 203         // add extra fields if not already there
 204         if ($extrafields) {
 205             foreach ($extrafields as $e) {
 206                 if ($e === 'id' or isset($fields[$e])) {
 207                     continue;
 208                 }
 209                 if ($fieldprefix) {
 210                     $fields[$e] = "$tableprefix$e AS $fieldprefix$e";
 211                 } else {
 212                     $fields[$e] = "$tableprefix$e";
 213                 }
 214             }
 215         }
 216         return implode(',', $fields);
 217     }
 218
 219     /**
 220      * Extract the aliased user fields from a given record
 221      *
 222      * Given a record that was previously obtained using {@link self::fields()} with aliases,
 223      * this method extracts user related unaliased fields.
 224      *
 225      * @param stdClass $record containing user picture fields
 226      * @param array $extrafields extra fields included in the $record
 227      * @param string $idalias alias of the id field
 228      * @param string $fieldprefix prefix added to all columns in their aliases, does not apply to 'id'
 229      * @return stdClass object with unaliased user fields
 230      */
 231     public static function unalias(stdClass $record, array $extrafields=null, $idalias='id', $fieldprefix='') {
 232
 233         if (empty($idalias)) {
 234             $idalias = 'id';
 235         }
 236
 237         $return = new stdClass();
 238
 239         foreach (self::$fields as $field) {
 240             if ($field === 'id') {
 241                 if (property_exists($record, $idalias)) {
 242                     $return->id = $record->{$idalias};
 243                 }
 244             } else {
 245                 if (property_exists($record, $fieldprefix.$field)) {
 246                     $return->{$field} = $record->{$fieldprefix.$field};
 247                 }
 248             }
 249         }
 250         // add extra fields if not already there
 251         if ($extrafields) {
 252             foreach ($extrafields as $e) {
 253                 if ($e === 'id' or property_exists($return, $e)) {
 254                     continue;
 255                 }
 256                 $return->{$e} = $record->{$fieldprefix.$e};
 257             }
 258         }
 259
 260         return $return;
 261     }
 262
 263     /**
 264      * Works out the URL for the users picture.
 265      *
 266      * This method is recommended as it avoids costly redirects of user pictures
 267      * if requests are made for non-existent files etc.
 268      *
 269      * @param renderer_base $renderer
 270      * @return moodle_url
 271      */
 272     public function get_url(moodle_page $page, renderer_base $renderer = null) {
 273         global $CFG;
 274
 275         if (is_null($renderer)) {
 276             $renderer = $page->get_renderer('core');
 277         }
 278
 279         if ((!empty($CFG->forcelogin) and !isloggedin()) ||
 280                 (!empty($CFG->forceloginforprofileimage) && (!isloggedin() || isguestuser()))) {
 281             // protect images if login required and not logged in;
 282             // also if login is required for profile images and is not logged in or guest
 283             // do not use require_login() because it is expensive and not suitable here anyway
 284             return $renderer->pix_url('u/f1');
 285         }
 286
 287         // Sort out the filename and size. Size is only required for the gravatar
 288         // implementation presently.
 289         if (empty($this->size)) {
 290             $filename = 'f2';
 291             $size = 35;
 292         } else if ($this->size === true or $this->size == 1) {
 293             $filename = 'f1';
 294             $size = 100;
 295         } else if ($this->size >= 50) {
 296             $filename = 'f1';
 297             $size = (int)$this->size;
 298         } else {
 299             $filename = 'f2';
 300             $size = (int)$this->size;
 301         }
 302
 303         if ($this->user->picture == 1) {
 304             // The user has uploaded their own profile pic. In this case we will
 305             // check that a profile pic file does actually exist
 306             $fs = get_file_storage();
 307             $context = get_context_instance(CONTEXT_USER, $this->user->id);
 308             if (!$fs->file_exists($context->id, 'user', 'icon', 0, '/', $filename.'/.png')) {
 309                 if (!$fs->file_exists($context->id, 'user', 'icon', 0, '/', $filename.'/.jpg')) {
 310                     return $renderer->pix_url('u/'.$filename);
 311                 }
 312             }
 313             $path = '/';
 314             if (clean_param($page->theme->name, PARAM_THEME) == $page->theme->name) {
 315                 // We append the theme name to the file path if we have it so that
 316                 // in the circumstance that the profile picture is not available
 317                 // when the user actually requests it they still get the profile
 318                 // picture for the correct theme.
 319                 $path .= $page->theme->name.'/';
 320             }
 321             return moodle_url::make_pluginfile_url($context->id, 'user', 'icon', NULL, $path, $filename);
 322
 323         } else if ($this->user->picture == 2) {
 324             // This is just VERY basic support for gravatar to give the actual
 325             // implementor a headstart in what to do.
 326             if ($size < 1 || $size > 500) {
 327                 $size = 35;
 328             }
 329             $md5 = md5(strtolower(trim($this->user->email)));
 330             $default = urlencode($this->pix_url('u/'.$filename)->out(false));
 331             return "http://www.gravatar.com/avatar/{$md5}?s={$size}&d={$default}";
 332         }
 333
 334         return $renderer->pix_url('u/'.$filename);
 335     }
 336 }
 337
 338 /**
 339  * Data structure representing a help icon.
 340  *
 341  * @copyright 2009 Nicolas Connault, 2010 Petr Skoda
 342  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 343  * @since     Moodle 2.0
 344  */
 345 class old_help_icon implements renderable {
 346     /**
 347      * @var string $helpidentifier lang pack identifier
 348      */
 349     public $helpidentifier;
 350     /**
 351      * @var string $title A descriptive text for title tooltip
 352      */
 353     public $title = null;
 354     /**
 355      * @var string $component Component name, the same as in get_string()
 356      */
 357     public $component = 'moodle';
 358     /**
 359      * @var string $linktext Extra descriptive text next to the icon
 360      */
 361     public $linktext = null;
 362
 363     /**
 364      * Constructor: sets up the other components in case they are needed
 365      * @param string $helpidentifier  The keyword that defines a help page
 366      * @param string $title A descriptive text for accessibility only
 367      * @param string $component
 368      * @param bool $linktext add extra text to icon
 369      * @return void
 370      */
 371     public function __construct($helpidentifier, $title, $component = 'moodle') {
 372         if (empty($title)) {
 373             throw new coding_exception('A help_icon object requires a $text parameter');
 374         }
 375         if (empty($helpidentifier)) {
 376             throw new coding_exception('A help_icon object requires a $helpidentifier parameter');
 377         }
 378
 379         $this->helpidentifier  = $helpidentifier;
 380         $this->title           = $title;
 381         $this->component       = $component;
 382     }
 383 }
 384
 385 /**
 386  * Data structure representing a help icon.
 387  *
 388  * @copyright 2010 Petr Skoda (info@skodak.org)
 389  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 390  * @since     Moodle 2.0
 391  */
 392 class help_icon implements renderable {
 393     /**
 394      * @var string $identifier lang pack identifier (without the "_help" suffix),
 395      *    both get_string($identifier, $component) and get_string($identifier.'_help', $component)
 396      *    must exist.
 397      */
 398     public $identifier;
 399     /**
 400      * @var string $component Component name, the same as in get_string()
 401      */
 402     public $component;
 403     /**
 404      * @var string $linktext Extra descriptive text next to the icon
 405      */
 406     public $linktext = null;
 407
 408     /**
 409      * Constructor
 410      * @param string $identifier  string for help page title,
 411      *  string with _help suffix is used for the actual help text.
 412      *  string with _link suffix is used to create a link to further info (if it exists)
 413      * @param string $component
 414      */
 415     public function __construct($identifier, $component) {
 416         $this->identifier = $identifier;
 417         $this->component  = $component;
 418     }
 419
 420     /**
 421      * Verifies that both help strings exists, shows debug warnings if not
 422      */
 423     public function diag_strings() {
 424         $sm = get_string_manager();
 425         if (!$sm->string_exists($this->identifier, $this->component)) {
 426             debugging("Help title string does not exist: [$this->identifier, $this->component]");
 427         }
 428         if (!$sm->string_exists($this->identifier.'_help', $this->component)) {
 429             debugging("Help contents string does not exist: [{$this->identifier}_help, $this->component]");
 430         }
 431     }
 432 }
 433
 434
 435 /**
 436  * Data structure representing an icon.
 437  *
 438  * @copyright 2010 Petr Skoda
 439  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 440  * @since     Moodle 2.0
 441  */
 442 class pix_icon implements renderable {
 443     var $pix;
 444     var $component;
 445     var $attributes = array();
 446
 447     /**
 448      * Constructor
 449      * @param string $pix short icon name
 450      * @param string $component component name
 451      * @param array $attributes html attributes
 452      */
 453     public function __construct($pix, $alt, $component='moodle', array $attributes = null) {
 454         $this->pix        = $pix;
 455         $this->component  = $component;
 456         $this->attributes = (array)$attributes;
 457
 458         $this->attributes['alt'] = $alt;
 459         if (empty($this->attributes['class'])) {
 460             $this->attributes['class'] = 'smallicon';
 461         }
 462         if (!isset($this->attributes['title'])) {
 463             $this->attributes['title'] = $this->attributes['alt'];
 464         }
 465     }
 466 }
 467
 468 /**
 469  * Data structure representing an emoticon image
 470  *
 471  * @since     Moodle 2.0
 472  */
 473 class pix_emoticon extends pix_icon implements renderable {
 474
 475     /**
 476      * Constructor
 477      * @param string $pix short icon name
 478      * @param string $alt alternative text
 479      * @param string $component emoticon image provider
 480      * @param array $attributes explicit HTML attributes
 481      */
 482     public function __construct($pix, $alt, $component = 'moodle', array $attributes = array()) {
 483         if (empty($attributes['class'])) {
 484             $attributes['class'] = 'emoticon';
 485         }
 486         parent::__construct($pix, $alt, $component, $attributes);
 487     }
 488 }
 489
 490 /**
 491  * Data structure representing a simple form with only one button.
 492  *
 493  * @copyright 2009 Petr Skoda
 494  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 495  * @since     Moodle 2.0
 496  */
 497 class single_button implements renderable {
 498     /**
 499      * Target url
 500      * @var moodle_url
 501      */
 502     var $url;
 503     /**
 504      * Button label
 505      * @var string
 506      */
 507     var $label;
 508     /**
 509      * Form submit method
 510      * @var string post or get
 511      */
 512     var $method = 'post';
 513     /**
 514      * Wrapping div class
 515      * @var string
 516      * */
 517     var $class = 'singlebutton';
 518     /**
 519      * True if button disabled, false if normal
 520      * @var boolean
 521      */
 522     var $disabled = false;
 523     /**
 524      * Button tooltip
 525      * @var string
 526      */
 527     var $tooltip = null;
 528     /**
 529      * Form id
 530      * @var string
 531      */
 532     var $formid;
 533     /**
 534      * List of attached actions
 535      * @var array of component_action
 536      */
 537     var $actions = array();
 538
 539     /**
 540      * Constructor
 541      * @param string|moodle_url $url
 542      * @param string $label button text
 543      * @param string $method get or post submit method
 544      */
 545     public function __construct(moodle_url $url, $label, $method='post') {
 546         $this->url    = clone($url);
 547         $this->label  = $label;
 548         $this->method = $method;
 549     }
 550
 551     /**
 552      * Shortcut for adding a JS confirm dialog when the button is clicked.
 553      * The message must be a yes/no question.
 554      * @param string $message The yes/no confirmation question. If "Yes" is clicked, the original action will occur.
 555      * @return void
 556      */
 557     public function add_confirm_action($confirmmessage) {
 558         $this->add_action(new confirm_action($confirmmessage));
 559     }
 560
 561     /**
 562      * Add action to the button.
 563      * @param component_action $action
 564      * @return void
 565      */
 566     public function add_action(component_action $action) {
 567         $this->actions[] = $action;
 568     }
 569 }
 570
 571
 572 /**
 573  * Simple form with just one select field that gets submitted automatically.
 574  * If JS not enabled small go button is printed too.
 575  *
 576  * @copyright 2009 Petr Skoda
 577  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 578  * @since     Moodle 2.0
 579  */
 580 class single_select implements renderable {
 581     /**
 582      * Target url - includes hidden fields
 583      * @var moodle_url
 584      */
 585     var $url;
 586     /**
 587      * Name of the select element.
 588      * @var string
 589      */
 590     var $name;
 591     /**
 592      * @var array $options associative array value=>label ex.:
 593      *              array(1=>'One, 2=>Two)
 594      *              it is also possible to specify optgroup as complex label array ex.:
 595      *                array(array('Odd'=>array(1=>'One', 3=>'Three)), array('Even'=>array(2=>'Two')))
 596      *                array(1=>'One', '--1uniquekey'=>array('More'=>array(2=>'Two', 3=>'Three')))
 597      */
 598     var $options;
 599     /**
 600      * Selected option
 601      * @var string
 602      */
 603     var $selected;
 604     /**
 605      * Nothing selected
 606      * @var array
 607      */
 608     var $nothing;
 609     /**
 610      * Extra select field attributes
 611      * @var array
 612      */
 613     var $attributes = array();
 614     /**
 615      * Button label
 616      * @var string
 617      */
 618     var $label = '';
 619     /**
 620      * Form submit method
 621      * @var string post or get
 622      */
 623     var $method = 'get';
 624     /**
 625      * Wrapping div class
 626      * @var string
 627      * */
 628     var $class = 'singleselect';
 629     /**
 630      * True if button disabled, false if normal
 631      * @var boolean
 632      */
 633     var $disabled = false;
 634     /**
 635      * Button tooltip
 636      * @var string
 637      */
 638     var $tooltip = null;
 639     /**
 640      * Form id
 641      * @var string
 642      */
 643     var $formid = null;
 644     /**
 645      * List of attached actions
 646      * @var array of component_action
 647      */
 648     var $helpicon = null;
 649     /**
 650      * Constructor
 651      * @param moodle_url $url form action target, includes hidden fields
 652      * @param string $name name of selection field - the changing parameter in url
 653      * @param array $options list of options
 654      * @param string $selected selected element
 655      * @param array $nothing
 656      * @param string $formid
 657      */
 658     public function __construct(moodle_url $url, $name, array $options, $selected='', $nothing=array(''=>'choosedots'), $formid=null) {
 659         $this->url      = $url;
 660         $this->name     = $name;
 661         $this->options  = $options;
 662         $this->selected = $selected;
 663         $this->nothing  = $nothing;
 664         $this->formid   = $formid;
 665     }
 666
 667     /**
 668      * Shortcut for adding a JS confirm dialog when the button is clicked.
 669      * The message must be a yes/no question.
 670      * @param string $message The yes/no confirmation question. If "Yes" is clicked, the original action will occur.
 671      * @return void
 672      */
 673     public function add_confirm_action($confirmmessage) {
 674         $this->add_action(new component_action('submit', 'M.util.show_confirm_dialog', array('message' => $confirmmessage)));
 675     }
 676
 677     /**
 678      * Add action to the button.
 679      * @param component_action $action
 680      * @return void
 681      */
 682     public function add_action(component_action $action) {
 683         $this->actions[] = $action;
 684     }
 685
 686     /**
 687      * Adds help icon.
 688      * @param string $page  The keyword that defines a help page
 689      * @param string $title A descriptive text for accessibility only
 690      * @param string $component
 691      * @param bool $linktext add extra text to icon
 692      * @return void
 693      */
 694     public function set_old_help_icon($helppage, $title, $component = 'moodle') {
 695         $this->helpicon = new old_help_icon($helppage, $title, $component);
 696     }
 697
 698     /**
 699      * Adds help icon.
 700      * @param string $identifier The keyword that defines a help page
 701      * @param string $component
 702      * @param bool $linktext add extra text to icon
 703      * @return void
 704      */
 705     public function set_help_icon($identifier, $component = 'moodle') {
 706         $this->helpicon = new help_icon($identifier, $component);
 707     }
 708
 709     /**
 710      * Sets select's label
 711      * @param string $label
 712      * @return void
 713      */
 714     public function set_label($label) {
 715         $this->label = $label;
 716     }
 717 }
 718
 719
 720 /**
 721  * Simple URL selection widget description.
 722  * @copyright 2009 Petr Skoda
 723  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 724  * @since     Moodle 2.0
 725  */
 726 class url_select implements renderable {
 727     /**
 728      * @var array $urls associative array value=>label ex.:
 729      *              array(1=>'One, 2=>Two)
 730      *              it is also possible to specify optgroup as complex label array ex.:
 731      *                array(array('Odd'=>array(1=>'One', 3=>'Three)), array('Even'=>array(2=>'Two')))
 732      *                array(1=>'One', '--1uniquekey'=>array('More'=>array(2=>'Two', 3=>'Three')))
 733      */
 734     var $urls;
 735     /**
 736      * Selected option
 737      * @var string
 738      */
 739     var $selected;
 740     /**
 741      * Nothing selected
 742      * @var array
 743      */
 744     var $nothing;
 745     /**
 746      * Extra select field attributes
 747      * @var array
 748      */
 749     var $attributes = array();
 750     /**
 751      * Button label
 752      * @var string
 753      */
 754     var $label = '';
 755     /**
 756      * Wrapping div class
 757      * @var string
 758      * */
 759     var $class = 'urlselect';
 760     /**
 761      * True if button disabled, false if normal
 762      * @var boolean
 763      */
 764     var $disabled = false;
 765     /**
 766      * Button tooltip
 767      * @var string
 768      */
 769     var $tooltip = null;
 770     /**
 771      * Form id
 772      * @var string
 773      */
 774     var $formid = null;
 775     /**
 776      * List of attached actions
 777      * @var array of component_action
 778      */
 779     var $helpicon = null;
 780     /**
 781      * @var string If set, makes button visible with given name for button
 782      */
 783     var $showbutton = null;
 784     /**
 785      * Constructor
 786      * @param array $urls list of options
 787      * @param string $selected selected element
 788      * @param array $nothing
 789      * @param string $formid
 790      * @param string $showbutton Set to text of button if it should be visible
 791      *   or null if it should be hidden (hidden version always has text 'go')
 792      */
 793     public function __construct(array $urls, $selected='', $nothing=array(''=>'choosedots'),
 794             $formid=null, $showbutton=null) {
 795         $this->urls       = $urls;
 796         $this->selected   = $selected;
 797         $this->nothing    = $nothing;
 798         $this->formid     = $formid;
 799         $this->showbutton = $showbutton;
 800     }
 801
 802     /**
 803      * Adds help icon.
 804      * @param string $page  The keyword that defines a help page
 805      * @param string $title A descriptive text for accessibility only
 806      * @param string $component
 807      * @param bool $linktext add extra text to icon
 808      * @return void
 809      */
 810     public function set_old_help_icon($helppage, $title, $component = 'moodle') {
 811         $this->helpicon = new old_help_icon($helppage, $title, $component);
 812     }
 813
 814     /**
 815      * Adds help icon.
 816      * @param string $identifier The keyword that defines a help page
 817      * @param string $component
 818      * @param bool $linktext add extra text to icon
 819      * @return void
 820      */
 821     public function set_help_icon($identifier, $component = 'moodle') {
 822         $this->helpicon = new help_icon($identifier, $component);
 823     }
 824
 825     /**
 826      * Sets select's label
 827      * @param string $label
 828      * @return void
 829      */
 830     public function set_label($label) {
 831         $this->label = $label;
 832     }
 833 }
 834
 835
 836 /**
 837  * Data structure describing html link with special action attached.
 838  * @copyright 2010 Petr Skoda
 839  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 840  * @since     Moodle 2.0
 841  */
 842 class action_link implements renderable {
 843     /**
 844      * Href url
 845      * @var moodle_url
 846      */
 847     var $url;
 848     /**
 849      * Link text
 850      * @var string HTML fragment
 851      */
 852     var $text;
 853     /**
 854      * HTML attributes
 855      * @var array
 856      */
 857     var $attributes;
 858     /**
 859      * List of actions attached to link
 860      * @var array of component_action
 861      */
 862     var $actions;
 863
 864     /**
 865      * Constructor
 866      * @param string|moodle_url $url
 867      * @param string $text HTML fragment
 868      * @param component_action $action
 869      * @param array $attributes associative array of html link attributes + disabled
 870      */
 871     public function __construct(moodle_url $url, $text, component_action $action=null, array $attributes=null) {
 872         $this->url       = clone($url);
 873         $this->text      = $text;
 874         $this->attributes = (array)$attributes;
 875         if ($action) {
 876             $this->add_action($action);
 877         }
 878     }
 879
 880     /**
 881      * Add action to the link.
 882      * @param component_action $action
 883      * @return void
 884      */
 885     public function add_action(component_action $action) {
 886         $this->actions[] = $action;
 887     }
 888
 889     public function add_class($class) {
 890         if (empty($this->attributes['class'])) {
 891             $this->attributes['class'] = $class;
 892         } else {
 893             $this->attributes['class'] .= ' ' . $class;
 894         }
 895     }
 896 }
 897
 898 // ==== HTML writer and helper classes, will be probably moved elsewhere ======
 899
 900 /**
 901  * Simple html output class
 902  * @copyright 2009 Tim Hunt, 2010 Petr Skoda
 903  */
 904 class html_writer {
 905     /**
 906      * Outputs a tag with attributes and contents
 907      * @param string $tagname The name of tag ('a', 'img', 'span' etc.)
 908      * @param string $contents What goes between the opening and closing tags
 909      * @param array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
 910      * @return string HTML fragment
 911      */
 912     public static function tag($tagname, $contents, array $attributes = null) {
 913         return self::start_tag($tagname, $attributes) . $contents . self::end_tag($tagname);
 914     }
 915
 916     /**
 917      * Outputs an opening tag with attributes
 918      * @param string $tagname The name of tag ('a', 'img', 'span' etc.)
 919      * @param array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
 920      * @return string HTML fragment
 921      */
 922     public static function start_tag($tagname, array $attributes = null) {
 923         return '<' . $tagname . self::attributes($attributes) . '>';
 924     }
 925
 926     /**
 927      * Outputs a closing tag
 928      * @param string $tagname The name of tag ('a', 'img', 'span' etc.)
 929      * @return string HTML fragment
 930      */
 931     public static function end_tag($tagname) {
 932         return '</' . $tagname . '>';
 933     }
 934
 935     /**
 936      * Outputs an empty tag with attributes
 937      * @param string $tagname The name of tag ('input', 'img', 'br' etc.)
 938      * @param array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
 939      * @return string HTML fragment
 940      */
 941     public static function empty_tag($tagname, array $attributes = null) {
 942         return '<' . $tagname . self::attributes($attributes) . ' />';
 943     }
 944
 945     /**
 946      * Outputs a tag, but only if the contents are not empty
 947      * @param string $tagname The name of tag ('a', 'img', 'span' etc.)
 948      * @param string $contents What goes between the opening and closing tags
 949      * @param array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
 950      * @return string HTML fragment
 951      */
 952     public static function nonempty_tag($tagname, $contents, array $attributes = null) {
 953         if ($contents === '' || is_null($contents)) {
 954             return '';
 955         }
 956         return self::tag($tagname, $contents, $attributes);
 957     }
 958
 959     /**
 960      * Outputs a HTML attribute and value
 961      * @param string $name The name of the attribute ('src', 'href', 'class' etc.)
 962      * @param string $value The value of the attribute. The value will be escaped with {@link s()}
 963      * @return string HTML fragment
 964      */
 965     public static function attribute($name, $value) {
 966         if (is_array($value)) {
 967             debugging("Passed an array for the HTML attribute $name", DEBUG_DEVELOPER);
 968         }
 969         if ($value instanceof moodle_url) {
 970             return ' ' . $name . '="' . $value->out() . '"';
 971         }
 972
 973         // special case, we do not want these in output
 974         if ($value === null) {
 975             return '';
 976         }
 977
 978         // no sloppy trimming here!
 979         return ' ' . $name . '="' . s($value) . '"';
 980     }
 981
 982     /**
 983      * Outputs a list of HTML attributes and values
 984      * @param array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
 985      *       The values will be escaped with {@link s()}
 986      * @return string HTML fragment
 987      */
 988     public static function attributes(array $attributes = null) {
 989         $attributes = (array)$attributes;
 990         $output = '';
 991         foreach ($attributes as $name => $value) {
 992             $output .= self::attribute($name, $value);
 993         }
 994         return $output;
 995     }
 996
 997     /**
 998      * Generates random html element id.
 999      * @param string $base
1000      * @return string
1001      */
1002     public static function random_id($base='random') {
1003         return uniqid($base);
1004     }
1005
1006     /**
1007      * Generates a simple html link
1008      * @param string|moodle_url $url
1009      * @param string $text link txt
1010      * @param array $attributes extra html attributes
1011      * @return string HTML fragment
1012      */
1013     public static function link($url, $text, array $attributes = null) {
1014         $attributes = (array)$attributes;
1015         $attributes['href']  = $url;
1016         return self::tag('a', $text, $attributes);
1017     }
1018
1019     /**
1020      * generates a simple checkbox with optional label
1021      * @param string $name
1022      * @param string $value
1023      * @param bool $checked
1024      * @param string $label
1025      * @param array $attributes
1026      * @return string html fragment
1027      */
1028     public static function checkbox($name, $value, $checked = true, $label = '', array $attributes = null) {
1029         $attributes = (array)$attributes;
1030         $output = '';
1031
1032         if ($label !== '' and !is_null($label)) {
1033             if (empty($attributes['id'])) {
1034                 $attributes['id'] = self::random_id('checkbox_');
1035             }
1036         }
1037         $attributes['type']    = 'checkbox';
1038         $attributes['value']   = $value;
1039         $attributes['name']    = $name;
1040         $attributes['checked'] = $checked ? 'checked' : null;
1041
1042         $output .= self::empty_tag('input', $attributes);
1043
1044         if ($label !== '' and !is_null($label)) {
1045             $output .= self::tag('label', $label, array('for'=>$attributes['id']));
1046         }
1047
1048         return $output;
1049     }
1050
1051     /**
1052      * Generates a simple select yes/no form field
1053      * @param string $name name of select element
1054      * @param bool $selected
1055      * @param array $attributes - html select element attributes
1056      * @return string HRML fragment
1057      */
1058     public static function select_yes_no($name, $selected=true, array $attributes = null) {
1059         $options = array('1'=>get_string('yes'), '0'=>get_string('no'));
1060         return self::select($options, $name, $selected, null, $attributes);
1061     }
1062
1063     /**
1064      * Generates a simple select form field
1065      * @param array $options associative array value=>label ex.:
1066      *                array(1=>'One, 2=>Two)
1067      *              it is also possible to specify optgroup as complex label array ex.:
1068      *                array(array('Odd'=>array(1=>'One', 3=>'Three)), array('Even'=>array(2=>'Two')))
1069      *                array(1=>'One', '--1uniquekey'=>array('More'=>array(2=>'Two', 3=>'Three')))
1070      * @param string $name name of select element
1071      * @param string|array $selected value or array of values depending on multiple attribute
1072      * @param array|bool $nothing, add nothing selected option, or false of not added
1073      * @param array $attributes - html select element attributes
1074      * @return string HTML fragment
1075      */
1076     public static function select(array $options, $name, $selected = '', $nothing = array(''=>'choosedots'), array $attributes = null) {
1077         $attributes = (array)$attributes;
1078         if (is_array($nothing)) {
1079             foreach ($nothing as $k=>$v) {
1080                 if ($v === 'choose' or $v === 'choosedots') {
1081                     $nothing[$k] = get_string('choosedots');
1082                 }
1083             }
1084             $options = $nothing + $options; // keep keys, do not override
1085
1086         } else if (is_string($nothing) and $nothing !== '') {
1087             // BC
1088             $options = array(''=>$nothing) + $options;
1089         }
1090
1091         // we may accept more values if multiple attribute specified
1092         $selected = (array)$selected;
1093         foreach ($selected as $k=>$v) {
1094             $selected[$k] = (string)$v;
1095         }
1096
1097         if (!isset($attributes['id'])) {
1098             $id = 'menu'.$name;
1099             // name may contaion [], which would make an invalid id. e.g. numeric question type editing form, assignment quickgrading
1100             $id = str_replace('[', '', $id);
1101             $id = str_replace(']', '', $id);
1102             $attributes['id'] = $id;
1103         }
1104
1105         if (!isset($attributes['class'])) {
1106             $class = 'menu'.$name;
1107             // name may contaion [], which would make an invalid class. e.g. numeric question type editing form, assignment quickgrading
1108             $class = str_replace('[', '', $class);
1109             $class = str_replace(']', '', $class);
1110             $attributes['class'] = $class;
1111         }
1112         $attributes['class'] = 'select ' . $attributes['class']; /// Add 'select' selector always
1113
1114         $attributes['name'] = $name;
1115
1116         if (!empty($attributes['disabled'])) {
1117             $attributes['disabled'] = 'disabled';
1118         } else {
1119             unset($attributes['disabled']);
1120         }
1121
1122         $output = '';
1123         foreach ($options as $value=>$label) {
1124             if (is_array($label)) {
1125                 // ignore key, it just has to be unique
1126                 $output .= self::select_optgroup(key($label), current($label), $selected);
1127             } else {
1128                 $output .= self::select_option($label, $value, $selected);
1129             }
1130         }
1131         return self::tag('select', $output, $attributes);
1132     }
1133
1134     private static function select_option($label, $value, array $selected) {
1135         $attributes = array();
1136         $value = (string)$value;
1137         if (in_array($value, $selected, true)) {
1138             $attributes['selected'] = 'selected';
1139         }
1140         $attributes['value'] = $value;
1141         return self::tag('option', $label, $attributes);
1142     }
1143
1144     private static function select_optgroup($groupname, $options, array $selected) {
1145         if (empty($options)) {
1146             return '';
1147         }
1148         $attributes = array('label'=>$groupname);
1149         $output = '';
1150         foreach ($options as $value=>$label) {
1151             $output .= self::select_option($label, $value, $selected);
1152         }
1153         return self::tag('optgroup', $output, $attributes);
1154     }
1155
1156     /**
1157      * This is a shortcut for making an hour selector menu.
1158      * @param string $type The type of selector (years, months, days, hours, minutes)
1159      * @param string $name fieldname
1160      * @param int $currenttime A default timestamp in GMT
1161      * @param int $step minute spacing
1162      * @param array $attributes - html select element attributes
1163      * @return HTML fragment
1164      */
1165     public static function select_time($type, $name, $currenttime=0, $step=5, array $attributes=null) {
1166         if (!$currenttime) {
1167             $currenttime = time();
1168         }
1169         $currentdate = usergetdate($currenttime);
1170         $userdatetype = $type;
1171         $timeunits = array();
1172
1173         switch ($type) {
1174             case 'years':
1175                 for ($i=1970; $i<=2020; $i++) {
1176                     $timeunits[$i] = $i;
1177                 }
1178                 $userdatetype = 'year';
1179                 break;
1180             case 'months':
1181                 for ($i=1; $i<=12; $i++) {
1182                     $timeunits[$i] = userdate(gmmktime(12,0,0,$i,15,2000), "%B");
1183                 }
1184                 $userdatetype = 'month';
1185                 $currentdate['month'] = (int)$currentdate['mon'];
1186                 break;
1187             case 'days':
1188                 for ($i=1; $i<=31; $i++) {
1189                     $timeunits[$i] = $i;
1190                 }
1191                 $userdatetype = 'mday';
1192                 break;
1193             case 'hours':
1194                 for ($i=0; $i<=23; $i++) {
1195                     $timeunits[$i] = sprintf("%02d",$i);
1196                 }
1197                 break;
1198             case 'minutes':
1199                 if ($step != 1) {
1200                     $currentdate['minutes'] = ceil($currentdate['minutes']/$step)*$step;
1201                 }
1202
1203                 for ($i=0; $i<=59; $i+=$step) {
1204                     $timeunits[$i] = sprintf("%02d",$i);
1205                 }
1206                 break;
1207             default:
1208                 throw new coding_exception("Time type $type is not supported by html_writer::select_time().");
1209         }
1210
1211         if (empty($attributes['id'])) {
1212             $attributes['id'] = self::random_id('ts_');
1213         }
1214         $timerselector = self::select($timeunits, $name, $currentdate[$userdatetype], null, array('id'=>$attributes['id']));
1215         $label = self::tag('label', get_string(substr($type, 0, -1), 'form'), array('for'=>$attributes['id'], 'class'=>'accesshide'));
1216
1217         return $label.$timerselector;
1218     }
1219
1220     /**
1221      * Shortcut for quick making of lists
1222      * @param array $items
1223      * @param string $tag ul or ol
1224      * @param array $attributes
1225      * @return string
1226      */
1227     public static function alist(array $items, array $attributes = null, $tag = 'ul') {
1228         //note: 'list' is a reserved keyword ;-)
1229
1230         $output = '';
1231
1232         foreach ($items as $item) {
1233             $output .= html_writer::start_tag('li') . "\n";
1234             $output .= $item . "\n";
1235             $output .= html_writer::end_tag('li') . "\n";
1236         }
1237
1238         return html_writer::tag($tag, $output, $attributes);
1239     }
1240
1241     /**
1242      * Returns hidden input fields created from url parameters.
1243      * @param moodle_url $url
1244      * @param array $exclude list of excluded parameters
1245      * @return string HTML fragment
1246      */
1247     public static function input_hidden_params(moodle_url $url, array $exclude = null) {
1248         $exclude = (array)$exclude;
1249         $params = $url->params();
1250         foreach ($exclude as $key) {
1251             unset($params[$key]);
1252         }
1253
1254         $output = '';
1255         foreach ($params as $key => $value) {
1256             $attributes = array('type'=>'hidden', 'name'=>$key, 'value'=>$value);
1257             $output .= self::empty_tag('input', $attributes)."\n";
1258         }
1259         return $output;
1260     }
1261
1262     /**
1263      * Generate a script tag containing the the specified code.
1264      *
1265      * @param string $js the JavaScript code
1266          * @param moodle_url|string optional url of the external script, $code ignored if specified
1267      * @return string HTML, the code wrapped in <script> tags.
1268      */
1269     public static function script($jscode, $url=null) {
1270         if ($jscode) {
1271             $attributes = array('type'=>'text/javascript');
1272             return self::tag('script', "\n//<![CDATA[\n$jscode\n//]]>\n", $attributes) . "\n";
1273
1274         } else if ($url) {
1275             $attributes = array('type'=>'text/javascript', 'src'=>$url);
1276             return self::tag('script', '', $attributes) . "\n";
1277
1278         } else {
1279             return '';
1280         }
1281     }
1282
1283     /**
1284      * Renders HTML table
1285      *
1286      * This method may modify the passed instance by adding some default properties if they are not set yet.
1287      * If this is not what you want, you should make a full clone of your data before passing them to this
1288      * method. In most cases this is not an issue at all so we do not clone by default for performance
1289      * and memory consumption reasons.
1290      *
1291      * @param html_table $table data to be rendered
1292      * @return string HTML code
1293      */
1294     public static function table(html_table $table) {
1295         // prepare table data and populate missing properties with reasonable defaults
1296         if (!empty($table->align)) {
1297             foreach ($table->align as $key => $aa) {
1298                 if ($aa) {
1299                     $table->align[$key] = 'text-align:'. fix_align_rtl($aa) .';';  // Fix for RTL languages
1300                 } else {
1301                     $table->align[$key] = null;
1302                 }
1303             }
1304         }
1305         if (!empty($table->size)) {
1306             foreach ($table->size as $key => $ss) {
1307                 if ($ss) {
1308                     $table->size[$key] = 'width:'. $ss .';';
1309                 } else {
1310                     $table->size[$key] = null;
1311                 }
1312             }
1313         }
1314         if (!empty($table->wrap)) {
1315             foreach ($table->wrap as $key => $ww) {
1316                 if ($ww) {
1317                     $table->wrap[$key] = 'white-space:nowrap;';
1318                 } else {
1319                     $table->wrap[$key] = '';
1320                 }
1321             }
1322         }
1323         if (!empty($table->head)) {
1324             foreach ($table->head as $key => $val) {
1325                 if (!isset($table->align[$key])) {
1326                     $table->align[$key] = null;
1327                 }
1328                 if (!isset($table->size[$key])) {
1329                     $table->size[$key] = null;
1330                 }
1331                 if (!isset($table->wrap[$key])) {
1332                     $table->wrap[$key] = null;
1333                 }
1334
1335             }
1336         }
1337         if (empty($table->attributes['class'])) {
1338             $table->attributes['class'] = 'generaltable';
1339         }
1340         if (!empty($table->tablealign)) {
1341             $table->attributes['class'] .= ' boxalign' . $table->tablealign;
1342         }
1343
1344         // explicitly assigned properties override those defined via $table->attributes
1345         $table->attributes['class'] = trim($table->attributes['class']);
1346         $attributes = array_merge($table->attributes, array(
1347                 'id'            => $table->id,
1348                 'width'         => $table->width,
1349                 'summary'       => $table->summary,
1350                 'cellpadding'   => $table->cellpadding,
1351                 'cellspacing'   => $table->cellspacing,
1352             ));
1353         $output = html_writer::start_tag('table', $attributes) . "\n";
1354
1355         $countcols = 0;
1356
1357         if (!empty($table->head)) {
1358             $countcols = count($table->head);
1359
1360             $output .= html_writer::start_tag('thead', array()) . "\n";
1361             $output .= html_writer::start_tag('tr', array()) . "\n";
1362             $keys = array_keys($table->head);
1363             $lastkey = end($keys);
1364
1365             foreach ($table->head as $key => $heading) {
1366                 // Convert plain string headings into html_table_cell objects
1367                 if (!($heading instanceof html_table_cell)) {
1368                     $headingtext = $heading;
1369                     $heading = new html_table_cell();
1370                     $heading->text = $headingtext;
1371                     $heading->header = true;
1372                 }
1373
1374                 if ($heading->header !== false) {
1375                     $heading->header = true;
1376                 }
1377
1378                 if ($heading->header && empty($heading->scope)) {
1379                     $heading->scope = 'col';
1380                 }
1381
1382                 $heading->attributes['class'] .= ' header c' . $key;
1383                 if (isset($table->headspan[$key]) && $table->headspan[$key] > 1) {
1384                     $heading->colspan = $table->headspan[$key];
1385                     $countcols += $table->headspan[$key] - 1;
1386                 }
1387
1388                 if ($key == $lastkey) {
1389                     $heading->attributes['class'] .= ' lastcol';
1390                 }
1391                 if (isset($table->colclasses[$key])) {
1392                     $heading->attributes['class'] .= ' ' . $table->colclasses[$key];
1393                 }
1394                 $heading->attributes['class'] = trim($heading->attributes['class']);
1395                 $attributes = array_merge($heading->attributes, array(
1396                         'style'     => $table->align[$key] . $table->size[$key] . $heading->style,
1397                         'scope'     => $heading->scope,
1398                         'colspan'   => $heading->colspan,
1399                     ));
1400
1401                 $tagtype = 'td';
1402                 if ($heading->header === true) {
1403                     $tagtype = 'th';
1404                 }
1405                 $output .= html_writer::tag($tagtype, $heading->text, $attributes) . "\n";
1406             }
1407             $output .= html_writer::end_tag('tr') . "\n";
1408             $output .= html_writer::end_tag('thead') . "\n";
1409
1410             if (empty($table->data)) {
1411                 // For valid XHTML strict every table must contain either a valid tr
1412                 // or a valid tbody... both of which must contain a valid td
1413                 $output .= html_writer::start_tag('tbody', array('class' => 'empty'));
1414                 $output .= html_writer::tag('tr', html_writer::tag('td', '', array('colspan'=>count($table->head))));
1415                 $output .= html_writer::end_tag('tbody');
1416             }
1417         }
1418
1419         if (!empty($table->data)) {
1420             $oddeven    = 1;
1421             $keys       = array_keys($table->data);
1422             $lastrowkey = end($keys);
1423             $output .= html_writer::start_tag('tbody', array());
1424
1425             foreach ($table->data as $key => $row) {
1426                 if (($row === 'hr') && ($countcols)) {
1427                     $output .= html_writer::tag('td', html_writer::tag('div', '', array('class' => 'tabledivider')), array('colspan' => $countcols));
1428                 } else {
1429                     // Convert array rows to html_table_rows and cell strings to html_table_cell objects
1430                     if (!($row instanceof html_table_row)) {
1431                         $newrow = new html_table_row();
1432
1433                         foreach ($row as $item) {
1434                             $cell = new html_table_cell();
1435                             $cell->text = $item;
1436                             $newrow->cells[] = $cell;
1437                         }
1438                         $row = $newrow;
1439                     }
1440
1441                     $oddeven = $oddeven ? 0 : 1;
1442                     if (isset($table->rowclasses[$key])) {
1443                         $row->attributes['class'] .= ' ' . $table->rowclasses[$key];
1444                     }
1445
1446                     $row->attributes['class'] .= ' r' . $oddeven;
1447                     if ($key == $lastrowkey) {
1448                         $row->attributes['class'] .= ' lastrow';
1449                     }
1450
1451                     $output .= html_writer::start_tag('tr', array('class' => trim($row->attributes['class']), 'style' => $row->style, 'id' => $row->id)) . "\n";
1452                     $keys2 = array_keys($row->cells);
1453                     $lastkey = end($keys2);
1454
1455                     $gotlastkey = false; //flag for sanity checking
1456                     foreach ($row->cells as $key => $cell) {
1457                         if ($gotlastkey) {
1458                             //This should never happen. Why do we have a cell after the last cell?
1459                             mtrace("A cell with key ($key) was found after the last key ($lastkey)");
1460                         }
1461
1462                         if (!($cell instanceof html_table_cell)) {
1463                             $mycell = new html_table_cell();
1464                             $mycell->text = $cell;
1465                             $cell = $mycell;
1466                         }
1467
1468                         if (($cell->header === true) && empty($cell->scope)) {
1469                             $cell->scope = 'row';
1470                         }
1471
1472                         if (isset($table->colclasses[$key])) {
1473                             $cell->attributes['class'] .= ' ' . $table->colclasses[$key];
1474                         }
1475
1476                         $cell->attributes['class'] .= ' cell c' . $key;
1477                         if ($key == $lastkey) {
1478                             $cell->attributes['class'] .= ' lastcol';
1479                             $gotlastkey = true;
1480                         }
1481                         $tdstyle = '';
1482                         $tdstyle .= isset($table->align[$key]) ? $table->align[$key] : '';
1483                         $tdstyle .= isset($table->size[$key]) ? $table->size[$key] : '';
1484                         $tdstyle .= isset($table->wrap[$key]) ? $table->wrap[$key] : '';
1485                         $cell->attributes['class'] = trim($cell->attributes['class']);
1486                         $tdattributes = array_merge($cell->attributes, array(
1487                                 'style' => $tdstyle . $cell->style,
1488                                 'colspan' => $cell->colspan,
1489                                 'rowspan' => $cell->rowspan,
1490                                 'id' => $cell->id,
1491                                 'abbr' => $cell->abbr,
1492                                 'scope' => $cell->scope,
1493                             ));
1494                         $tagtype = 'td';
1495                         if ($cell->header === true) {
1496                             $tagtype = 'th';
1497                         }
1498                         $output .= html_writer::tag($tagtype, $cell->text, $tdattributes) . "\n";
1499                     }
1500                 }
1501                 $output .= html_writer::end_tag('tr') . "\n";
1502             }
1503             $output .= html_writer::end_tag('tbody') . "\n";
1504         }
1505         $output .= html_writer::end_tag('table') . "\n";
1506
1507         return $output;
1508     }
1509
1510     /**
1511      * Renders form element label
1512      *
1513      * By default, the label is suffixed with a label separator defined in the
1514      * current language pack (colon by default in the English lang pack).
1515      * Adding the colon can be explicitly disabled if needed. Label separators
1516      * are put outside the label tag itself so they are not read by
1517      * screenreaders (accessibility).
1518      *
1519      * Parameter $for explicitly associates the label with a form control. When
1520      * set, the value of this attribute must be the same as the value of
1521      * the id attribute of the form control in the same document. When null,
1522      * the label being defined is associated with the control inside the label
1523      * element.
1524      *
1525      * @param string $text content of the label tag
1526      * @param string|null $for id of the element this label is associated with, null for no association
1527      * @param bool $colonize add label separator (colon) to the label text, if it is not there yet
1528      * @param array $attributes to be inserted in the tab, for example array('accesskey' => 'a')
1529      * @return string HTML of the label element
1530      */
1531     public static function label($text, $for, $colonize=true, array $attributes=array()) {
1532         if (!is_null($for)) {
1533             $attributes = array_merge($attributes, array('for' => $for));
1534         }
1535         $text = trim($text);
1536         $label = self::tag('label', $text, $attributes);
1537
1538         /*
1539         // TODO $colonize disabled for now yet - see MDL-12192 for details
1540         if (!empty($text) and $colonize) {
1541             // the $text may end with the colon already, though it is bad string definition style
1542             $colon = get_string('labelsep', 'langconfig');
1543             if (!empty($colon)) {
1544                 $trimmed = trim($colon);
1545                 if ((substr($text, -strlen($trimmed)) == $trimmed) or (substr($text, -1) == ':')) {
1546                     //debugging('The label text should not end with colon or other label separator,
1547                     //           please fix the string definition.', DEBUG_DEVELOPER);
1548                 } else {
1549                     $label .= $colon;
1550                 }
1551             }
1552         }
1553         */
1554
1555         return $label;
1556     }
1557 }
1558
1559 // ==== JS writer and helper classes, will be probably moved elsewhere ======
1560
1561 /**
1562  * Simple javascript output class
1563  * @copyright 2010 Petr Skoda
1564  */
1565 class js_writer {
1566     /**
1567      * Returns javascript code calling the function
1568      * @param string $function function name, can be complex like Y.Event.purgeElement
1569      * @param array $arguments parameters
1570      * @param int $delay execution delay in seconds
1571      * @return string JS code fragment
1572      */
1573     public static function function_call($function, array $arguments = null, $delay=0) {
1574         if ($arguments) {
1575             $arguments = array_map('json_encode', $arguments);
1576             $arguments = implode(', ', $arguments);
1577         } else {
1578             $arguments = '';
1579         }
1580         $js = "$function($arguments);";
1581
1582         if ($delay) {
1583             $delay = $delay * 1000; // in miliseconds
1584             $js = "setTimeout(function() { $js }, $delay);";
1585         }
1586         return $js . "\n";
1587     }
1588
1589     /**
1590      * Special function which adds Y as first argument of fucntion call.
1591      * @param string $function
1592      * @param array $extraarguments
1593      * @return string
1594      */
1595     public static function function_call_with_Y($function, array $extraarguments = null) {
1596         if ($extraarguments) {
1597             $extraarguments = array_map('json_encode', $extraarguments);
1598             $arguments = 'Y, ' . implode(', ', $extraarguments);
1599         } else {
1600             $arguments = 'Y';
1601         }
1602         return "$function($arguments);\n";
1603     }
1604
1605     /**
1606      * Returns JavaScript code to initialise a new object
1607      * @param string|null $var If it is null then no var is assigned the new object
1608      * @param string $class
1609      * @param array $arguments
1610      * @param array $requirements
1611      * @param int $delay
1612      * @return string
1613      */
1614     public static function object_init($var, $class, array $arguments = null, array $requirements = null, $delay=0) {
1615         if (is_array($arguments)) {
1616             $arguments = array_map('json_encode', $arguments);
1617             $arguments = implode(', ', $arguments);
1618         }
1619
1620         if ($var === null) {
1621             $js = "new $class(Y, $arguments);";
1622         } else if (strpos($var, '.')!==false) {
1623             $js = "$var = new $class(Y, $arguments);";
1624         } else {
1625             $js = "var $var = new $class(Y, $arguments);";
1626         }
1627
1628         if ($delay) {
1629             $delay = $delay * 1000; // in miliseconds
1630             $js = "setTimeout(function() { $js }, $delay);";
1631         }
1632
1633         if (count($requirements) > 0) {
1634             $requirements = implode("', '", $requirements);
1635             $js = "Y.use('$requirements', function(Y){ $js });";
1636         }
1637         return $js."\n";
1638     }
1639
1640     /**
1641      * Returns code setting value to variable
1642      * @param string $name
1643      * @param mixed $value json serialised value
1644      * @param bool $usevar add var definition, ignored for nested properties
1645      * @return string JS code fragment
1646      */
1647     public static function set_variable($name, $value, $usevar=true) {
1648         $output = '';
1649
1650         if ($usevar) {
1651             if (strpos($name, '.')) {
1652                 $output .= '';
1653             } else {
1654                 $output .= 'var ';
1655             }
1656         }
1657
1658         $output .= "$name = ".json_encode($value).";";
1659
1660         return $output;
1661     }
1662
1663     /**
1664      * Writes event handler attaching code
1665      * @param mixed $selector standard YUI selector for elements, may be array or string, element id is in the form "#idvalue"
1666      * @param string $event A valid DOM event (click, mousedown, change etc.)
1667      * @param string $function The name of the function to call
1668      * @param array  $arguments An optional array of argument parameters to pass to the function
1669      * @return string JS code fragment
1670      */
1671     public static function event_handler($selector, $event, $function, array $arguments = null) {
1672         $selector = json_encode($selector);
1673         $output = "Y.on('$event', $function, $selector, null";
1674         if (!empty($arguments)) {
1675             $output .= ', ' . json_encode($arguments);
1676         }
1677         return $output . ");\n";
1678     }
1679 }
1680
1681 /**
1682  * Holds all the information required to render a <table> by {@see core_renderer::table()}
1683  *
1684  * Example of usage:
1685  * $t = new html_table();
1686  * ... // set various properties of the object $t as described below
1687  * echo html_writer::table($t);
1688  *
1689  * @copyright 2009 David Mudrak <david.mudrak@gmail.com>
1690  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1691  * @since     Moodle 2.0
1692  */
1693 class html_table {
1694     /**
1695      * @var string value to use for the id attribute of the table
1696      */
1697     public $id = null;
1698     /**
1699      * @var array attributes of HTML attributes for the <table> element
1700      */
1701     public $attributes = array();
1702     /**
1703      * For more control over the rendering of the headers, an array of html_table_cell objects
1704      * can be passed instead of an array of strings.
1705      * @var array of headings. The n-th array item is used as a heading of the n-th column.
1706      *
1707      * Example of usage:
1708      * $t->head = array('Student', 'Grade');
1709      */
1710     public $head;
1711     /**
1712      * @var array can be used to make a heading span multiple columns
1713      *
1714      * Example of usage:
1715      * $t->headspan = array(2,1);
1716      *
1717      * In this example, {@see html_table:$data} is supposed to have three columns. For the first two columns,
1718      * the same heading is used. Therefore, {@see html_table::$head} should consist of two items.
1719      */
1720     public $headspan;
1721     /**
1722      * @var array of column alignments. The value is used as CSS 'text-align' property. Therefore, possible
1723      * values are 'left', 'right', 'center' and 'justify'. Specify 'right' or 'left' from the perspective
1724      * of a left-to-right (LTR) language. For RTL, the values are flipped automatically.
1725      *
1726      * Examples of usage:
1727      * $t->align = array(null, 'right');
1728      * or
1729      * $t->align[1] = 'right';
1730      *
1731      */
1732     public $align;
1733     /**
1734      * @var array of column sizes. The value is used as CSS 'size' property.
1735      *
1736      * Examples of usage:
1737      * $t->size = array('50%', '50%');
1738      * or
1739      * $t->size[1] = '120px';
1740      */
1741     public $size;
1742     /**
1743      * @var array of wrapping information. The only possible value is 'nowrap' that sets the
1744      * CSS property 'white-space' to the value 'nowrap' in the given column.
1745      *
1746      * Example of usage:
1747      * $t->wrap = array(null, 'nowrap');
1748      */
1749     public $wrap;
1750     /**
1751      * @var array of arrays or html_table_row objects containing the data. Alternatively, if you have
1752      * $head specified, the string 'hr' (for horizontal ruler) can be used
1753      * instead of an array of cells data resulting in a divider rendered.
1754      *
1755      * Example of usage with array of arrays:
1756      * $row1 = array('Harry Potter', '76 %');
1757      * $row2 = array('Hermione Granger', '100 %');
1758      * $t->data = array($row1, $row2);
1759      *
1760      * Example with array of html_table_row objects: (used for more fine-grained control)
1761      * $cell1 = new html_table_cell();
1762      * $cell1->text = 'Harry Potter';
1763      * $cell1->colspan = 2;
1764      * $row1 = new html_table_row();
1765      * $row1->cells[] = $cell1;
1766      * $cell2 = new html_table_cell();
1767      * $cell2->text = 'Hermione Granger';
1768      * $cell3 = new html_table_cell();
1769      * $cell3->text = '100 %';
1770      * $row2 = new html_table_row();
1771      * $row2->cells = array($cell2, $cell3);
1772      * $t->data = array($row1, $row2);
1773      */
1774     public $data;
1775     /**
1776      * @var string width of the table, percentage of the page preferred. Defaults to 80%
1777      * @deprecated since Moodle 2.0. Styling should be in the CSS.
1778      */
1779     public $width = null;
1780     /**
1781      * @var string alignment the whole table. Can be 'right', 'left' or 'center' (default).
1782      * @deprecated since Moodle 2.0. Styling should be in the CSS.
1783      */
1784     public $tablealign = null;
1785     /**
1786      * @var int padding on each cell, in pixels
1787      * @deprecated since Moodle 2.0. Styling should be in the CSS.
1788      */
1789     public $cellpadding = null;
1790     /**
1791      * @var int spacing between cells, in pixels
1792      * @deprecated since Moodle 2.0. Styling should be in the CSS.
1793      */
1794     public $cellspacing = null;
1795     /**
1796      * @var array classes to add to particular rows, space-separated string.
1797      * Classes 'r0' or 'r1' are added automatically for every odd or even row,
1798      * respectively. Class 'lastrow' is added automatically for the last row
1799      * in the table.
1800      *
1801      * Example of usage:
1802      * $t->rowclasses[9] = 'tenth'
1803      */
1804     public $rowclasses;
1805     /**
1806      * @var array classes to add to every cell in a particular column,
1807      * space-separated string. Class 'cell' is added automatically by the renderer.
1808      * Classes 'c0' or 'c1' are added automatically for every odd or even column,
1809      * respectively. Class 'lastcol' is added automatically for all last cells
1810      * in a row.
1811      *
1812      * Example of usage:
1813      * $t->colclasses = array(null, 'grade');
1814      */
1815     public $colclasses;
1816     /**
1817      * @var string description of the contents for screen readers.
1818      */
1819     public $summary;
1820
1821     /**
1822      * Constructor
1823      */
1824     public function __construct() {
1825         $this->attributes['class'] = '';
1826     }
1827 }
1828
1829
1830 /**
1831  * Component representing a table row.
1832  *
1833  * @copyright 2009 Nicolas Connault
1834  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1835  * @since     Moodle 2.0
1836  */
1837 class html_table_row {
1838     /**
1839      * @var string value to use for the id attribute of the row
1840      */
1841     public $id = null;
1842     /**
1843      * @var array $cells Array of html_table_cell objects
1844      */
1845     public $cells = array();
1846     /**
1847      * @var string $style value to use for the style attribute of the table row
1848      */
1849     public $style = null;
1850     /**
1851      * @var array attributes of additional HTML attributes for the <tr> element
1852      */
1853     public $attributes = array();
1854
1855     /**
1856      * Constructor
1857      * @param array $cells
1858      */
1859     public function __construct(array $cells=null) {
1860         $this->attributes['class'] = '';
1861         $cells = (array)$cells;
1862         foreach ($cells as $cell) {
1863             if ($cell instanceof html_table_cell) {
1864                 $this->cells[] = $cell;
1865             } else {
1866                 $this->cells[] = new html_table_cell($cell);
1867             }
1868         }
1869     }
1870 }
1871
1872
1873 /**
1874  * Component representing a table cell.
1875  *
1876  * @copyright 2009 Nicolas Connault
1877  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1878  * @since     Moodle 2.0
1879  */
1880 class html_table_cell {
1881     /**
1882      * @var string value to use for the id attribute of the cell
1883      */
1884     public $id = null;
1885     /**
1886      * @var string $text The contents of the cell
1887      */
1888     public $text;
1889     /**
1890      * @var string $abbr Abbreviated version of the contents of the cell
1891      */
1892     public $abbr = null;
1893     /**
1894      * @var int $colspan Number of columns this cell should span
1895      */
1896     public $colspan = null;
1897     /**
1898      * @var int $rowspan Number of rows this cell should span
1899      */
1900     public $rowspan = null;
1901     /**
1902      * @var string $scope Defines a way to associate header cells and data cells in a table
1903      */
1904     public $scope = null;
1905     /**
1906      * @var boolean $header Whether or not this cell is a header cell
1907      */
1908     public $header = null;
1909     /**
1910      * @var string $style value to use for the style attribute of the table cell
1911      */
1912     public $style = null;
1913     /**
1914      * @var array attributes of additional HTML attributes for the <td> element
1915      */
1916     public $attributes = array();
1917
1918     public function __construct($text = null) {
1919         $this->text = $text;
1920         $this->attributes['class'] = '';
1921     }
1922 }
1923
1924
1925 /// Complex components aggregating simpler components
1926
1927
1928 /**
1929  * Component representing a paging bar.
1930  *
1931  * @copyright 2009 Nicolas Connault
1932  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1933  * @since     Moodle 2.0
1934  */
1935 class paging_bar implements renderable {
1936     /**
1937      * @var int $maxdisplay The maximum number of pagelinks to display
1938      */
1939     public $maxdisplay = 18;
1940     /**
1941      * @var int $totalcount post or get
1942      */
1943     public $totalcount;
1944     /**
1945      * @var int $page The page you are currently viewing
1946      */
1947     public $page;
1948     /**
1949      * @var int $perpage The number of entries that should be shown per page
1950      */
1951     public $perpage;
1952     /**
1953      * @var string $baseurl If this  is a string then it is the url which will be appended with $pagevar, an equals sign and the page number.
1954      *      If this is a moodle_url object then the pagevar param will be replaced by the page no, for each page.
1955      */
1956     public $baseurl;
1957     /**
1958      * @var string $pagevar This is the variable name that you use for the page number in your code (ie. 'tablepage', 'blogpage', etc)
1959      */
1960     public $pagevar;
1961     /**
1962      * @var string $previouslink A HTML link representing the "previous" page
1963      */
1964     public $previouslink = null;
1965     /**
1966      * @var tring $nextlink A HTML link representing the "next" page
1967      */
1968     public $nextlink = null;
1969     /**
1970      * @var tring $firstlink A HTML link representing the first page
1971      */
1972     public $firstlink = null;
1973     /**
1974      * @var tring $lastlink A HTML link representing the last page
1975      */
1976     public $lastlink = null;
1977     /**
1978      * @var array $pagelinks An array of strings. One of them is just a string: the current page
1979      */
1980     public $pagelinks = array();
1981
1982     /**
1983      * Constructor paging_bar with only the required params.
1984      *
1985      * @param int $totalcount The total number of entries available to be paged through
1986      * @param int $page The page you are currently viewing
1987      * @param int $perpage The number of entries that should be shown per page
1988      * @param string|moodle_url $baseurl url of the current page, the $pagevar parameter is added
1989      * @param string $pagevar name of page parameter that holds the page number
1990      */
1991     public function __construct($totalcount, $page, $perpage, $baseurl, $pagevar = 'page') {
1992         $this->totalcount = $totalcount;
1993         $this->page       = $page;
1994         $this->perpage    = $perpage;
1995         $this->baseurl    = $baseurl;
1996         $this->pagevar    = $pagevar;
1997     }
1998
1999     /**
2000      * @return void
2001      */
2002     public function prepare(renderer_base $output, moodle_page $page, $target) {
2003         if (!isset($this->totalcount) || is_null($this->totalcount)) {
2004             throw new coding_exception('paging_bar requires a totalcount value.');
2005         }
2006         if (!isset($this->page) || is_null($this->page)) {
2007             throw new coding_exception('paging_bar requires a page value.');
2008         }
2009         if (empty($this->perpage)) {
2010             throw new coding_exception('paging_bar requires a perpage value.');
2011         }
2012         if (empty($this->baseurl)) {
2013             throw new coding_exception('paging_bar requires a baseurl value.');
2014         }
2015
2016         if ($this->totalcount > $this->perpage) {
2017             $pagenum = $this->page - 1;
2018
2019             if ($this->page > 0) {
2020                 $this->previouslink = html_writer::link(new moodle_url($this->baseurl, array($this->pagevar=>$pagenum)), get_string('previous'), array('class'=>'previous'));
2021             }
2022
2023             if ($this->perpage > 0) {
2024                 $lastpage = ceil($this->totalcount / $this->perpage);
2025             } else {
2026                 $lastpage = 1;
2027             }
2028
2029             if ($this->page > 15) {
2030                 $startpage = $this->page - 10;
2031
2032                 $this->firstlink = html_writer::link(new moodle_url($this->baseurl, array($this->pagevar=>0)), '1', array('class'=>'first'));
2033             } else {
2034                 $startpage = 0;
2035             }
2036
2037             $currpage = $startpage;
2038             $displaycount = $displaypage = 0;
2039
2040             while ($displaycount < $this->maxdisplay and $currpage < $lastpage) {
2041                 $displaypage = $currpage + 1;
2042
2043                 if ($this->page == $currpage) {
2044                     $this->pagelinks[] = $displaypage;
2045                 } else {
2046                     $pagelink = html_writer::link(new moodle_url($this->baseurl, array($this->pagevar=>$currpage)), $displaypage);
2047                     $this->pagelinks[] = $pagelink;
2048                 }
2049
2050                 $displaycount++;
2051                 $currpage++;
2052             }
2053
2054             if ($currpage < $lastpage) {
2055                 $lastpageactual = $lastpage - 1;
2056                 $this->lastlink = html_writer::link(new moodle_url($this->baseurl, array($this->pagevar=>$lastpageactual)), $lastpage, array('class'=>'last'));
2057             }
2058
2059             $pagenum = $this->page + 1;
2060
2061             if ($pagenum != $displaypage) {
2062                 $this->nextlink = html_writer::link(new moodle_url($this->baseurl, array($this->pagevar=>$pagenum)), get_string('next'), array('class'=>'next'));
2063             }
2064         }
2065     }
2066 }
2067
2068
2069 /**
2070  * This class represents how a block appears on a page.
2071  *
2072  * During output, each block instance is asked to return a block_contents object,
2073  * those are then passed to the $OUTPUT->block function for display.
2074  *
2075  * {@link $contents} should probably be generated using a moodle_block_..._renderer.
2076  *
2077  * Other block-like things that need to appear on the page, for example the
2078  * add new block UI, are also represented as block_contents objects.
2079  *
2080  * @copyright 2009 Tim Hunt
2081  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2082  * @since     Moodle 2.0
2083  */
2084 class block_contents {
2085     /** @var int used to set $skipid. */
2086     protected static $idcounter = 1;
2087
2088     const NOT_HIDEABLE = 0;
2089     const VISIBLE = 1;
2090     const HIDDEN = 2;
2091
2092     /**
2093      * @var integer $skipid All the blocks (or things that look like blocks)
2094      * printed on a page are given a unique number that can be used to construct
2095      * id="" attributes. This is set automatically be the {@link prepare()} method.
2096      * Do not try to set it manually.
2097      */
2098     public $skipid;
2099
2100     /**
2101      * @var integer If this is the contents of a real block, this should be set to
2102      * the block_instance.id. Otherwise this should be set to 0.
2103      */
2104     public $blockinstanceid = 0;
2105
2106     /**
2107      * @var integer if this is a real block instance, and there is a corresponding
2108      * block_position.id for the block on this page, this should be set to that id.
2109      * Otherwise it should be 0.
2110      */
2111     public $blockpositionid = 0;
2112
2113     /**
2114      * @param array $attributes an array of attribute => value pairs that are put on the
2115      * outer div of this block. {@link $id} and {@link $classes} attributes should be set separately.
2116      */
2117     public $attributes;
2118
2119     /**
2120      * @param string $title The title of this block. If this came from user input,
2121      * it should already have had format_string() processing done on it. This will
2122      * be output inside <h2> tags. Please do not cause invalid XHTML.
2123      */
2124     public $title = '';
2125
2126     /**
2127      * @param string $content HTML for the content
2128      */
2129     public $content = '';
2130
2131     /**
2132      * @param array $list an alternative to $content, it you want a list of things with optional icons.
2133      */
2134     public $footer = '';
2135
2136     /**
2137      * Any small print that should appear under the block to explain to the
2138      * teacher about the block, for example 'This is a sticky block that was
2139      * added in the system context.'
2140      * @var string
2141      */
2142     public $annotation = '';
2143
2144     /**
2145      * @var integer one of the constants NOT_HIDEABLE, VISIBLE, HIDDEN. Whether
2146      * the user can toggle whether this block is visible.
2147      */
2148     public $collapsible = self::NOT_HIDEABLE;
2149
2150     /**
2151      * A (possibly empty) array of editing controls. Each element of this array
2152      * should be an array('url' => $url, 'icon' => $icon, 'caption' => $caption).
2153      * $icon is the icon name. Fed to $OUTPUT->pix_url.
2154      * @var array
2155      */
2156     public $controls = array();
2157
2158
2159     /**
2160      * Create new instance of block content
2161      * @param array $attributes
2162      */
2163     public function __construct(array $attributes=null) {
2164         $this->skipid = self::$idcounter;
2165         self::$idcounter += 1;
2166
2167         if ($attributes) {
2168             // standard block
2169             $this->attributes = $attributes;
2170         } else {
2171             // simple "fake" blocks used in some modules and "Add new block" block
2172             $this->attributes = array('class'=>'block');
2173         }
2174     }
2175
2176     /**
2177      * Add html class to block
2178      * @param string $class
2179      * @return void
2180      */
2181     public function add_class($class) {
2182         $this->attributes['class'] .= ' '.$class;
2183     }
2184 }
2185
2186
2187 /**
2188  * This class represents a target for where a block can go when it is being moved.
2189  *
2190  * This needs to be rendered as a form with the given hidden from fields, and
2191  * clicking anywhere in the form should submit it. The form action should be
2192  * $PAGE->url.
2193  *
2194  * @copyright 2009 Tim Hunt
2195  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2196  * @since     Moodle 2.0
2197  */
2198 class block_move_target {
2199     /**
2200      * Move url
2201      * @var moodle_url
2202      */
2203     public $url;
2204     /**
2205      * label
2206      * @var string
2207      */
2208     public $text;
2209
2210     /**
2211      * Constructor
2212      * @param string $text
2213      * @param moodle_url $url
2214      */
2215     public function __construct($text, moodle_url $url) {
2216         $this->text = $text;
2217         $this->url  = $url;
2218     }
2219 }
2220
2221 /**
2222  * Custom menu item
2223  *
2224  * This class is used to represent one item within a custom menu that may or may
2225  * not have children.
2226  *
2227  * @copyright 2010 Sam Hemelryk
2228  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2229  * @since     Moodle 2.0
2230  */
2231 class custom_menu_item implements renderable {
2232     /**
2233      * The text to show for the item
2234      * @var string
2235      */
2236     protected $text;
2237     /**
2238      * The link to give the icon if it has no children
2239      * @var moodle_url
2240      */
2241     protected $url;
2242     /**
2243      * A title to apply to the item. By default the text
2244      * @var string
2245      */
2246     protected $title;
2247     /**
2248      * A sort order for the item, not necessary if you order things in the CFG var
2249      * @var int
2250      */
2251     protected $sort;
2252     /**
2253      * A reference to the parent for this item or NULL if it is a top level item
2254      * @var custom_menu_item
2255      */
2256     protected $parent;
2257     /**
2258      * A array in which to store children this item has.
2259      * @var array
2260      */
2261     protected $children = array();
2262     /**
2263      * A reference to the sort var of the last child that was added
2264      * @var int
2265      */
2266     protected $lastsort = 0;
2267     /**
2268      * Constructs the new custom menu item
2269      *
2270      * @param string $text
2271      * @param moodle_url $url A moodle url to apply as the link for this item [Optional]
2272      * @param string $title A title to apply to this item [Optional]
2273      * @param int $sort A sort or to use if we need to sort differently [Optional]
2274      * @param custom_menu_item $parent A reference to the parent custom_menu_item this child
2275      *        belongs to, only if the child has a parent. [Optional]
2276      */
2277     public function __construct($text, moodle_url $url=null, $title=null, $sort = null, custom_menu_item $parent=null) {
2278         $this->text = $text;
2279         $this->url = $url;
2280         $this->title = $title;
2281         $this->sort = (int)$sort;
2282         $this->parent = $parent;
2283     }
2284
2285     /**
2286      * Adds a custom menu item as a child of this node given its properties.
2287      *
2288      * @param string $text
2289      * @param moodle_url $url
2290      * @param string $title
2291      * @param int $sort
2292      * @return custom_menu_item
2293      */
2294     public function add($text, moodle_url $url=null, $title=null, $sort = null) {
2295         $key = count($this->children);
2296         if (empty($sort)) {
2297             $sort = $this->lastsort + 1;
2298         }
2299         $this->children[$key] = new custom_menu_item($text, $url, $title, $sort, $this);
2300         $this->lastsort = (int)$sort;
2301         return $this->children[$key];
2302     }
2303     /**
2304      * Returns the text for this item
2305      * @return string
2306      */
2307     public function get_text() {
2308         return $this->text;
2309     }
2310     /**
2311      * Returns the url for this item
2312      * @return moodle_url
2313      */
2314     public function get_url() {
2315         return $this->url;
2316     }
2317     /**
2318      * Returns the title for this item
2319      * @return string
2320      */
2321     public function get_title() {
2322         return $this->title;
2323     }
2324     /**
2325      * Sorts and returns the children for this item
2326      * @return array
2327      */
2328     public function get_children() {
2329         $this->sort();
2330         return $this->children;
2331     }
2332     /**
2333      * Gets the sort order for this child
2334      * @return int
2335      */
2336     public function get_sort_order() {
2337         return $this->sort;
2338     }
2339     /**
2340      * Gets the parent this child belong to
2341      * @return custom_menu_item
2342      */
2343     public function get_parent() {
2344         return $this->parent;
2345     }
2346     /**
2347      * Sorts the children this item has
2348      */
2349     public function sort() {
2350         usort($this->children, array('custom_menu','sort_custom_menu_items'));
2351     }
2352     /**
2353      * Returns true if this item has any children
2354      * @return bool
2355      */
2356     public function has_children() {
2357         return (count($this->children) > 0);
2358     }
2359
2360     /**
2361      * Sets the text for the node
2362      * @param string $text
2363      */
2364     public function set_text($text) {
2365         $this->text = (string)$text;
2366     }
2367
2368     /**
2369      * Sets the title for the node
2370      * @param string $title
2371      */
2372     public function set_title($title) {
2373         $this->title = (string)$title;
2374     }
2375
2376     /**
2377      * Sets the url for the node
2378      * @param moodle_url $url
2379      */
2380     public function set_url(moodle_url $url) {
2381         $this->url = $url;
2382     }
2383 }
2384
2385 /**
2386  * Custom menu class
2387  *
2388  * This class is used to operate a custom menu that can be rendered for the page.
2389  * The custom menu is built using $CFG->custommenuitems and is a structured collection
2390  * of custom_menu_item nodes that can be rendered by the core renderer.
2391  *
2392  * To configure the custom menu:
2393  *     Settings: Administration > Appearance > Themes > Theme settings
2394  *
2395  * @copyright 2010 Sam Hemelryk
2396  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2397  * @since     Moodle 2.0
2398  */
2399 class custom_menu extends custom_menu_item {
2400
2401     /** @var string the language we should render for, null disables multilang support */
2402     protected $currentlanguage = null;
2403
2404     /**
2405      * Creates the custom menu
2406      *
2407      * @param string $definition the menu items definition in syntax required by {@link convert_text_to_menu_nodes()}
2408      * @param string $language the current language code, null disables multilang support
2409      */
2410     public function __construct($definition = '', $currentlanguage = null) {
2411
2412         $this->currentlanguage = $currentlanguage;
2413         parent::__construct('root'); // create virtual root element of the menu
2414         if (!empty($definition)) {
2415             $this->override_children(self::convert_text_to_menu_nodes($definition, $currentlanguage));
2416         }
2417     }
2418
2419     /**
2420      * Overrides the children of this custom menu. Useful when getting children
2421      * from $CFG->custommenuitems
2422      */
2423     public function override_children(array $children) {
2424         $this->children = array();
2425         foreach ($children as $child) {
2426             if ($child instanceof custom_menu_item) {
2427                 $this->children[] = $child;
2428             }
2429         }
2430     }
2431
2432     /**
2433      * Converts a string into a structured array of custom_menu_items which can
2434      * then be added to a custom menu.
2435      *
2436      * Structure:
2437      *     text|url|title|langs
2438      * The number of hyphens at the start determines the depth of the item. The
2439      * languages are optional, comma separated list of languages the line is for.
2440      *
2441      * Example structure:
2442      *     First level first item|http://www.moodle.com/
2443      *     -Second level first item|http://www.moodle.com/partners/
2444      *     -Second level second item|http://www.moodle.com/hq/
2445      *     --Third level first item|http://www.moodle.com/jobs/
2446      *     -Second level third item|http://www.moodle.com/development/
2447      *     First level second item|http://www.moodle.com/feedback/
2448      *     First level third item
2449      *     English only|http://moodle.com|English only item|en
2450      *     German only|http://moodle.de|Deutsch|de,de_du,de_kids
2451      *
2452      *
2453      * @static
2454      * @param string $text the menu items definition
2455      * @param string $language the language code, null disables multilang support
2456      * @return array
2457      */
2458     public static function convert_text_to_menu_nodes($text, $language = null) {
2459         $lines = explode("\n", $text);
2460         $children = array();
2461         $lastchild = null;
2462         $lastdepth = null;
2463         $lastsort = 0;
2464         foreach ($lines as $line) {
2465             $line = trim($line);
2466             $bits = explode('|', $line, 4);    // name|url|title|langs
2467             if (!array_key_exists(0, $bits) or empty($bits[0])) {
2468                 // Every item must have a name to be valid
2469                 continue;
2470             } else {
2471                 $bits[0] = ltrim($bits[0],'-');
2472             }
2473             if (!array_key_exists(1, $bits) or empty($bits[1])) {
2474                 // Set the url to null
2475                 $bits[1] = null;
2476             } else {
2477                 // Make sure the url is a moodle url
2478                 $bits[1] = new moodle_url(trim($bits[1]));
2479             }
2480             if (!array_key_exists(2, $bits) or empty($bits[2])) {
2481                 // Set the title to null seeing as there isn't one
2482                 $bits[2] = $bits[0];
2483             }
2484             if (!array_key_exists(3, $bits) or empty($bits[3])) {
2485                 // The item is valid for all languages
2486                 $itemlangs = null;
2487             } else {
2488                 $itemlangs = array_map('trim', explode(',', $bits[3]));
2489             }
2490             if (!empty($language) and !empty($itemlangs)) {
2491                 // check that the item is intended for the current language
2492                 if (!in_array($language, $itemlangs)) {
2493                     continue;
2494                 }
2495             }
2496             // Set an incremental sort order to keep it simple.
2497             $lastsort++;
2498             if (preg_match('/^(\-*)/', $line, $match) && $lastchild != null && $lastdepth !== null) {
2499                 $depth = strlen($match[1]);
2500                 if ($depth < $lastdepth) {
2501                     $difference = $lastdepth - $depth;
2502                     if ($lastdepth > 1 && $lastdepth != $difference) {
2503                         $tempchild = $lastchild->get_parent();
2504                         for ($i =0; $i < $difference; $i++) {
2505                             $tempchild = $tempchild->get_parent();
2506                         }
2507                         $lastchild = $tempchild->add($bits[0], $bits[1], $bits[2], $lastsort);
2508                     } else {
2509                         $depth = 0;
2510                         $lastchild = new custom_menu_item($bits[0], $bits[1], $bits[2], $lastsort);
2511                         $children[] = $lastchild;
2512                     }
2513                 } else if ($depth > $lastdepth) {
2514                     $depth = $lastdepth + 1;
2515                     $lastchild = $lastchild->add($bits[0], $bits[1], $bits[2], $lastsort);
2516                 } else {
2517                     if ($depth == 0) {
2518                         $lastchild = new custom_menu_item($bits[0], $bits[1], $bits[2], $lastsort);
2519                         $children[] = $lastchild;
2520                     } else {
2521                         $lastchild = $lastchild->get_parent()->add($bits[0], $bits[1], $bits[2], $lastsort);
2522                     }
2523                 }
2524             } else {
2525                 $depth = 0;
2526                 $lastchild = new custom_menu_item($bits[0], $bits[1], $bits[2], $lastsort);
2527                 $children[] = $lastchild;
2528             }
2529             $lastdepth = $depth;
2530         }
2531         return $children;
2532     }
2533
2534     /**
2535      * Sorts two custom menu items
2536      *
2537      * This function is designed to be used with the usort method
2538      *     usort($this->children, array('custom_menu','sort_custom_menu_items'));
2539      *
2540      * @param custom_menu_item $itema
2541      * @param custom_menu_item $itemb
2542      * @return int
2543      */
2544     public static function sort_custom_menu_items(custom_menu_item $itema, custom_menu_item $itemb) {
2545         $itema = $itema->get_sort_order();
2546         $itemb = $itemb->get_sort_order();
2547         if ($itema == $itemb) {
2548             return 0;
2549         }
2550         return ($itema > $itemb) ? +1 : -1;
2551     }
2552 }