MDL-55463 output: Make single select a templatable
[moodle.git] / lib / outputcomponents.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Classes representing HTML elements, used by $OUTPUT methods
19  *
20  * Please see http://docs.moodle.org/en/Developement:How_Moodle_outputs_HTML
21  * for an overview.
22  *
23  * @package core
24  * @category output
25  * @copyright 2009 Tim Hunt
26  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27  */
29 defined('MOODLE_INTERNAL') || die();
31 /**
32  * Interface marking other classes as suitable for renderer_base::render()
33  *
34  * @copyright 2010 Petr Skoda (skodak) info@skodak.org
35  * @package core
36  * @category output
37  */
38 interface renderable {
39     // intentionally empty
40 }
42 /**
43  * Interface marking other classes having the ability to export their data for use by templates.
44  *
45  * @copyright 2015 Damyon Wiese
46  * @package core
47  * @category output
48  * @since 2.9
49  */
50 interface templatable {
52     /**
53      * Function to export the renderer data in a format that is suitable for a
54      * mustache template. This means:
55      * 1. No complex types - only stdClass, array, int, string, float, bool
56      * 2. Any additional info that is required for the template is pre-calculated (e.g. capability checks).
57      *
58      * @param renderer_base $output Used to do a final render of any components that need to be rendered for export.
59      * @return stdClass|array
60      */
61     public function export_for_template(renderer_base $output);
62 }
64 /**
65  * Data structure representing a file picker.
66  *
67  * @copyright 2010 Dongsheng Cai
68  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
69  * @since Moodle 2.0
70  * @package core
71  * @category output
72  */
73 class file_picker implements renderable {
75     /**
76      * @var stdClass An object containing options for the file picker
77      */
78     public $options;
80     /**
81      * Constructs a file picker object.
82      *
83      * The following are possible options for the filepicker:
84      *    - accepted_types  (*)
85      *    - return_types    (FILE_INTERNAL)
86      *    - env             (filepicker)
87      *    - client_id       (uniqid)
88      *    - itemid          (0)
89      *    - maxbytes        (-1)
90      *    - maxfiles        (1)
91      *    - buttonname      (false)
92      *
93      * @param stdClass $options An object containing options for the file picker.
94      */
95     public function __construct(stdClass $options) {
96         global $CFG, $USER, $PAGE;
97         require_once($CFG->dirroot. '/repository/lib.php');
98         $defaults = array(
99             'accepted_types'=>'*',
100             'return_types'=>FILE_INTERNAL,
101             'env' => 'filepicker',
102             'client_id' => uniqid(),
103             'itemid' => 0,
104             'maxbytes'=>-1,
105             'maxfiles'=>1,
106             'buttonname'=>false
107         );
108         foreach ($defaults as $key=>$value) {
109             if (empty($options->$key)) {
110                 $options->$key = $value;
111             }
112         }
114         $options->currentfile = '';
115         if (!empty($options->itemid)) {
116             $fs = get_file_storage();
117             $usercontext = context_user::instance($USER->id);
118             if (empty($options->filename)) {
119                 if ($files = $fs->get_area_files($usercontext->id, 'user', 'draft', $options->itemid, 'id DESC', false)) {
120                     $file = reset($files);
121                 }
122             } else {
123                 $file = $fs->get_file($usercontext->id, 'user', 'draft', $options->itemid, $options->filepath, $options->filename);
124             }
125             if (!empty($file)) {
126                 $options->currentfile = html_writer::link(moodle_url::make_draftfile_url($file->get_itemid(), $file->get_filepath(), $file->get_filename()), $file->get_filename());
127             }
128         }
130         // initilise options, getting files in root path
131         $this->options = initialise_filepicker($options);
133         // copying other options
134         foreach ($options as $name=>$value) {
135             if (!isset($this->options->$name)) {
136                 $this->options->$name = $value;
137             }
138         }
139     }
142 /**
143  * Data structure representing a user picture.
144  *
145  * @copyright 2009 Nicolas Connault, 2010 Petr Skoda
146  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
147  * @since Modle 2.0
148  * @package core
149  * @category output
150  */
151 class user_picture implements renderable {
152     /**
153      * @var array List of mandatory fields in user record here. (do not include
154      * TEXT columns because it would break SELECT DISTINCT in MSSQL and ORACLE)
155      */
156     protected static $fields = array('id', 'picture', 'firstname', 'lastname', 'firstnamephonetic', 'lastnamephonetic',
157             'middlename', 'alternatename', 'imagealt', 'email');
159     /**
160      * @var stdClass A user object with at least fields all columns specified
161      * in $fields array constant set.
162      */
163     public $user;
165     /**
166      * @var int The course id. Used when constructing the link to the user's
167      * profile, page course id used if not specified.
168      */
169     public $courseid;
171     /**
172      * @var bool Add course profile link to image
173      */
174     public $link = true;
176     /**
177      * @var int Size in pixels. Special values are (true/1 = 100px) and
178      * (false/0 = 35px)
179      * for backward compatibility.
180      */
181     public $size = 35;
183     /**
184      * @var bool Add non-blank alt-text to the image.
185      * Default true, set to false when image alt just duplicates text in screenreaders.
186      */
187     public $alttext = true;
189     /**
190      * @var bool Whether or not to open the link in a popup window.
191      */
192     public $popup = false;
194     /**
195      * @var string Image class attribute
196      */
197     public $class = 'userpicture';
199     /**
200      * @var bool Whether to be visible to screen readers.
201      */
202     public $visibletoscreenreaders = true;
204     /**
205      * User picture constructor.
206      *
207      * @param stdClass $user user record with at least id, picture, imagealt, firstname and lastname set.
208      *                 It is recommended to add also contextid of the user for performance reasons.
209      */
210     public function __construct(stdClass $user) {
211         global $DB;
213         if (empty($user->id)) {
214             throw new coding_exception('User id is required when printing user avatar image.');
215         }
217         // only touch the DB if we are missing data and complain loudly...
218         $needrec = false;
219         foreach (self::$fields as $field) {
220             if (!array_key_exists($field, $user)) {
221                 $needrec = true;
222                 debugging('Missing '.$field.' property in $user object, this is a performance problem that needs to be fixed by a developer. '
223                           .'Please use user_picture::fields() to get the full list of required fields.', DEBUG_DEVELOPER);
224                 break;
225             }
226         }
228         if ($needrec) {
229             $this->user = $DB->get_record('user', array('id'=>$user->id), self::fields(), MUST_EXIST);
230         } else {
231             $this->user = clone($user);
232         }
233     }
235     /**
236      * Returns a list of required user fields, useful when fetching required user info from db.
237      *
238      * In some cases we have to fetch the user data together with some other information,
239      * the idalias is useful there because the id would otherwise override the main
240      * id of the result record. Please note it has to be converted back to id before rendering.
241      *
242      * @param string $tableprefix name of database table prefix in query
243      * @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)
244      * @param string $idalias alias of id field
245      * @param string $fieldprefix prefix to add to all columns in their aliases, does not apply to 'id'
246      * @return string
247      */
248     public static function fields($tableprefix = '', array $extrafields = NULL, $idalias = 'id', $fieldprefix = '') {
249         if (!$tableprefix and !$extrafields and !$idalias) {
250             return implode(',', self::$fields);
251         }
252         if ($tableprefix) {
253             $tableprefix .= '.';
254         }
255         foreach (self::$fields as $field) {
256             if ($field === 'id' and $idalias and $idalias !== 'id') {
257                 $fields[$field] = "$tableprefix$field AS $idalias";
258             } else {
259                 if ($fieldprefix and $field !== 'id') {
260                     $fields[$field] = "$tableprefix$field AS $fieldprefix$field";
261                 } else {
262                     $fields[$field] = "$tableprefix$field";
263                 }
264             }
265         }
266         // add extra fields if not already there
267         if ($extrafields) {
268             foreach ($extrafields as $e) {
269                 if ($e === 'id' or isset($fields[$e])) {
270                     continue;
271                 }
272                 if ($fieldprefix) {
273                     $fields[$e] = "$tableprefix$e AS $fieldprefix$e";
274                 } else {
275                     $fields[$e] = "$tableprefix$e";
276                 }
277             }
278         }
279         return implode(',', $fields);
280     }
282     /**
283      * Extract the aliased user fields from a given record
284      *
285      * Given a record that was previously obtained using {@link self::fields()} with aliases,
286      * this method extracts user related unaliased fields.
287      *
288      * @param stdClass $record containing user picture fields
289      * @param array $extrafields extra fields included in the $record
290      * @param string $idalias alias of the id field
291      * @param string $fieldprefix prefix added to all columns in their aliases, does not apply to 'id'
292      * @return stdClass object with unaliased user fields
293      */
294     public static function unalias(stdClass $record, array $extrafields = null, $idalias = 'id', $fieldprefix = '') {
296         if (empty($idalias)) {
297             $idalias = 'id';
298         }
300         $return = new stdClass();
302         foreach (self::$fields as $field) {
303             if ($field === 'id') {
304                 if (property_exists($record, $idalias)) {
305                     $return->id = $record->{$idalias};
306                 }
307             } else {
308                 if (property_exists($record, $fieldprefix.$field)) {
309                     $return->{$field} = $record->{$fieldprefix.$field};
310                 }
311             }
312         }
313         // add extra fields if not already there
314         if ($extrafields) {
315             foreach ($extrafields as $e) {
316                 if ($e === 'id' or property_exists($return, $e)) {
317                     continue;
318                 }
319                 $return->{$e} = $record->{$fieldprefix.$e};
320             }
321         }
323         return $return;
324     }
326     /**
327      * Works out the URL for the users picture.
328      *
329      * This method is recommended as it avoids costly redirects of user pictures
330      * if requests are made for non-existent files etc.
331      *
332      * @param moodle_page $page
333      * @param renderer_base $renderer
334      * @return moodle_url
335      */
336     public function get_url(moodle_page $page, renderer_base $renderer = null) {
337         global $CFG;
339         if (is_null($renderer)) {
340             $renderer = $page->get_renderer('core');
341         }
343         // Sort out the filename and size. Size is only required for the gravatar
344         // implementation presently.
345         if (empty($this->size)) {
346             $filename = 'f2';
347             $size = 35;
348         } else if ($this->size === true or $this->size == 1) {
349             $filename = 'f1';
350             $size = 100;
351         } else if ($this->size > 100) {
352             $filename = 'f3';
353             $size = (int)$this->size;
354         } else if ($this->size >= 50) {
355             $filename = 'f1';
356             $size = (int)$this->size;
357         } else {
358             $filename = 'f2';
359             $size = (int)$this->size;
360         }
362         $defaulturl = $renderer->pix_url('u/'.$filename); // default image
364         if ((!empty($CFG->forcelogin) and !isloggedin()) ||
365             (!empty($CFG->forceloginforprofileimage) && (!isloggedin() || isguestuser()))) {
366             // Protect images if login required and not logged in;
367             // also if login is required for profile images and is not logged in or guest
368             // do not use require_login() because it is expensive and not suitable here anyway.
369             return $defaulturl;
370         }
372         // First try to detect deleted users - but do not read from database for performance reasons!
373         if (!empty($this->user->deleted) or strpos($this->user->email, '@') === false) {
374             // All deleted users should have email replaced by md5 hash,
375             // all active users are expected to have valid email.
376             return $defaulturl;
377         }
379         // Did the user upload a picture?
380         if ($this->user->picture > 0) {
381             if (!empty($this->user->contextid)) {
382                 $contextid = $this->user->contextid;
383             } else {
384                 $context = context_user::instance($this->user->id, IGNORE_MISSING);
385                 if (!$context) {
386                     // This must be an incorrectly deleted user, all other users have context.
387                     return $defaulturl;
388                 }
389                 $contextid = $context->id;
390             }
392             $path = '/';
393             if (clean_param($page->theme->name, PARAM_THEME) == $page->theme->name) {
394                 // We append the theme name to the file path if we have it so that
395                 // in the circumstance that the profile picture is not available
396                 // when the user actually requests it they still get the profile
397                 // picture for the correct theme.
398                 $path .= $page->theme->name.'/';
399             }
400             // Set the image URL to the URL for the uploaded file and return.
401             $url = moodle_url::make_pluginfile_url($contextid, 'user', 'icon', NULL, $path, $filename);
402             $url->param('rev', $this->user->picture);
403             return $url;
404         }
406         if ($this->user->picture == 0 and !empty($CFG->enablegravatar)) {
407             // Normalise the size variable to acceptable bounds
408             if ($size < 1 || $size > 512) {
409                 $size = 35;
410             }
411             // Hash the users email address
412             $md5 = md5(strtolower(trim($this->user->email)));
413             // Build a gravatar URL with what we know.
415             // Find the best default image URL we can (MDL-35669)
416             if (empty($CFG->gravatardefaulturl)) {
417                 $absoluteimagepath = $page->theme->resolve_image_location('u/'.$filename, 'core');
418                 if (strpos($absoluteimagepath, $CFG->dirroot) === 0) {
419                     $gravatardefault = $CFG->wwwroot . substr($absoluteimagepath, strlen($CFG->dirroot));
420                 } else {
421                     $gravatardefault = $CFG->wwwroot . '/pix/u/' . $filename . '.png';
422                 }
423             } else {
424                 $gravatardefault = $CFG->gravatardefaulturl;
425             }
427             // If the currently requested page is https then we'll return an
428             // https gravatar page.
429             if (is_https()) {
430                 $gravatardefault = str_replace($CFG->wwwroot, $CFG->httpswwwroot, $gravatardefault); // Replace by secure url.
431                 return new moodle_url("https://secure.gravatar.com/avatar/{$md5}", array('s' => $size, 'd' => $gravatardefault));
432             } else {
433                 return new moodle_url("http://www.gravatar.com/avatar/{$md5}", array('s' => $size, 'd' => $gravatardefault));
434             }
435         }
437         return $defaulturl;
438     }
441 /**
442  * Data structure representing a help icon.
443  *
444  * @copyright 2010 Petr Skoda (info@skodak.org)
445  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
446  * @since Moodle 2.0
447  * @package core
448  * @category output
449  */
450 class help_icon implements renderable, templatable {
452     /**
453      * @var string lang pack identifier (without the "_help" suffix),
454      * both get_string($identifier, $component) and get_string($identifier.'_help', $component)
455      * must exist.
456      */
457     public $identifier;
459     /**
460      * @var string Component name, the same as in get_string()
461      */
462     public $component;
464     /**
465      * @var string Extra descriptive text next to the icon
466      */
467     public $linktext = null;
469     /**
470      * Constructor
471      *
472      * @param string $identifier string for help page title,
473      *  string with _help suffix is used for the actual help text.
474      *  string with _link suffix is used to create a link to further info (if it exists)
475      * @param string $component
476      */
477     public function __construct($identifier, $component) {
478         $this->identifier = $identifier;
479         $this->component  = $component;
480     }
482     /**
483      * Verifies that both help strings exists, shows debug warnings if not
484      */
485     public function diag_strings() {
486         $sm = get_string_manager();
487         if (!$sm->string_exists($this->identifier, $this->component)) {
488             debugging("Help title string does not exist: [$this->identifier, $this->component]");
489         }
490         if (!$sm->string_exists($this->identifier.'_help', $this->component)) {
491             debugging("Help contents string does not exist: [{$this->identifier}_help, $this->component]");
492         }
493     }
495     /**
496      * Export this data so it can be used as the context for a mustache template.
497      *
498      * @param renderer_base $output Used to do a final render of any components that need to be rendered for export.
499      * @return array
500      */
501     public function export_for_template(renderer_base $output) {
502         $title = get_string($this->identifier, $this->component);
504         if (empty($this->linktext)) {
505             $alt = get_string('helpprefix2', '', trim($title, ". \t"));
506         } else {
507             $alt = get_string('helpwiththis');
508         }
510         $data = get_formatted_help_string($this->identifier, $this->component, false);
511         $data->alt = $alt;
513         $data->ltr = !right_to_left();
514         return $data;
515     }
519 /**
520  * Data structure representing an icon.
521  *
522  * @copyright 2010 Petr Skoda
523  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
524  * @since Moodle 2.0
525  * @package core
526  * @category output
527  */
528 class pix_icon implements renderable, templatable {
530     /**
531      * @var string The icon name
532      */
533     var $pix;
535     /**
536      * @var string The component the icon belongs to.
537      */
538     var $component;
540     /**
541      * @var array An array of attributes to use on the icon
542      */
543     var $attributes = array();
545     /**
546      * Constructor
547      *
548      * @param string $pix short icon name
549      * @param string $alt The alt text to use for the icon
550      * @param string $component component name
551      * @param array $attributes html attributes
552      */
553     public function __construct($pix, $alt, $component='moodle', array $attributes = null) {
554         $this->pix        = $pix;
555         $this->component  = $component;
556         $this->attributes = (array)$attributes;
558         if (empty($this->attributes['class'])) {
559             $this->attributes['class'] = 'smallicon';
560         }
562         // If the alt is empty, don't place it in the attributes, otherwise it will override parent alt text.
563         if (!is_null($alt)) {
564             $this->attributes['alt'] = $alt;
566             // If there is no title, set it to the attribute.
567             if (!isset($this->attributes['title'])) {
568                 $this->attributes['title'] = $this->attributes['alt'];
569             }
570         } else {
571             unset($this->attributes['alt']);
572         }
574         if (empty($this->attributes['title'])) {
575             // Remove the title attribute if empty, we probably want to use the parent node's title
576             // and some browsers might overwrite it with an empty title.
577             unset($this->attributes['title']);
578         }
579     }
581     /**
582      * Export this data so it can be used as the context for a mustache template.
583      *
584      * @param renderer_base $output Used to do a final render of any components that need to be rendered for export.
585      * @return array
586      */
587     public function export_for_template(renderer_base $output) {
588         $attributes = $this->attributes;
589         $attributes['src'] = $output->pix_url($this->pix, $this->component);
590         $templatecontext = array();
591         foreach ($attributes as $name => $value) {
592             $templatecontext[] = array('name' => $name, 'value' => $value);
593         }
594         $data = array('attributes' => $templatecontext);
596         return $data;
597     }
600 /**
601  * Data structure representing an emoticon image
602  *
603  * @copyright 2010 David Mudrak
604  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
605  * @since Moodle 2.0
606  * @package core
607  * @category output
608  */
609 class pix_emoticon extends pix_icon implements renderable {
611     /**
612      * Constructor
613      * @param string $pix short icon name
614      * @param string $alt alternative text
615      * @param string $component emoticon image provider
616      * @param array $attributes explicit HTML attributes
617      */
618     public function __construct($pix, $alt, $component = 'moodle', array $attributes = array()) {
619         if (empty($attributes['class'])) {
620             $attributes['class'] = 'emoticon';
621         }
622         parent::__construct($pix, $alt, $component, $attributes);
623     }
626 /**
627  * Data structure representing a simple form with only one button.
628  *
629  * @copyright 2009 Petr Skoda
630  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
631  * @since Moodle 2.0
632  * @package core
633  * @category output
634  */
635 class single_button implements renderable {
637     /**
638      * @var moodle_url Target url
639      */
640     var $url;
642     /**
643      * @var string Button label
644      */
645     var $label;
647     /**
648      * @var string Form submit method post or get
649      */
650     var $method = 'post';
652     /**
653      * @var string Wrapping div class
654      */
655     var $class = 'singlebutton';
657     /**
658      * @var bool True if button disabled, false if normal
659      */
660     var $disabled = false;
662     /**
663      * @var string Button tooltip
664      */
665     var $tooltip = null;
667     /**
668      * @var string Form id
669      */
670     var $formid;
672     /**
673      * @var array List of attached actions
674      */
675     var $actions = array();
677     /**
678      * @var array $params URL Params
679      */
680     var $params;
682     /**
683      * @var string Action id
684      */
685     var $actionid;
687     /**
688      * Constructor
689      * @param moodle_url $url
690      * @param string $label button text
691      * @param string $method get or post submit method
692      */
693     public function __construct(moodle_url $url, $label, $method='post') {
694         $this->url    = clone($url);
695         $this->label  = $label;
696         $this->method = $method;
697     }
699     /**
700      * Shortcut for adding a JS confirm dialog when the button is clicked.
701      * The message must be a yes/no question.
702      *
703      * @param string $confirmmessage The yes/no confirmation question. If "Yes" is clicked, the original action will occur.
704      */
705     public function add_confirm_action($confirmmessage) {
706         $this->add_action(new confirm_action($confirmmessage));
707     }
709     /**
710      * Add action to the button.
711      * @param component_action $action
712      */
713     public function add_action(component_action $action) {
714         $this->actions[] = $action;
715     }
719 /**
720  * Simple form with just one select field that gets submitted automatically.
721  *
722  * If JS not enabled small go button is printed too.
723  *
724  * @copyright 2009 Petr Skoda
725  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
726  * @since Moodle 2.0
727  * @package core
728  * @category output
729  */
730 class single_select implements renderable, templatable {
732     /**
733      * @var moodle_url Target url - includes hidden fields
734      */
735     var $url;
737     /**
738      * @var string Name of the select element.
739      */
740     var $name;
742     /**
743      * @var array $options associative array value=>label ex.: array(1=>'One, 2=>Two)
744      *     it is also possible to specify optgroup as complex label array ex.:
745      *         array(array('Odd'=>array(1=>'One', 3=>'Three)), array('Even'=>array(2=>'Two')))
746      *         array(1=>'One', '--1uniquekey'=>array('More'=>array(2=>'Two', 3=>'Three')))
747      */
748     var $options;
750     /**
751      * @var string Selected option
752      */
753     var $selected;
755     /**
756      * @var array Nothing selected
757      */
758     var $nothing;
760     /**
761      * @var array Extra select field attributes
762      */
763     var $attributes = array();
765     /**
766      * @var string Button label
767      */
768     var $label = '';
770     /**
771      * @var array Button label's attributes
772      */
773     var $labelattributes = array();
775     /**
776      * @var string Form submit method post or get
777      */
778     var $method = 'get';
780     /**
781      * @var string Wrapping div class
782      */
783     var $class = 'singleselect';
785     /**
786      * @var bool True if button disabled, false if normal
787      */
788     var $disabled = false;
790     /**
791      * @var string Button tooltip
792      */
793     var $tooltip = null;
795     /**
796      * @var string Form id
797      */
798     var $formid = null;
800     /**
801      * @var array List of attached actions
802      */
803     var $helpicon = null;
805     /**
806      * Constructor
807      * @param moodle_url $url form action target, includes hidden fields
808      * @param string $name name of selection field - the changing parameter in url
809      * @param array $options list of options
810      * @param string $selected selected element
811      * @param array $nothing
812      * @param string $formid
813      */
814     public function __construct(moodle_url $url, $name, array $options, $selected = '', $nothing = array('' => 'choosedots'), $formid = null) {
815         $this->url      = $url;
816         $this->name     = $name;
817         $this->options  = $options;
818         $this->selected = $selected;
819         $this->nothing  = $nothing;
820         $this->formid   = $formid;
821     }
823     /**
824      * Shortcut for adding a JS confirm dialog when the button is clicked.
825      * The message must be a yes/no question.
826      *
827      * @param string $confirmmessage The yes/no confirmation question. If "Yes" is clicked, the original action will occur.
828      */
829     public function add_confirm_action($confirmmessage) {
830         $this->add_action(new component_action('submit', 'M.util.show_confirm_dialog', array('message' => $confirmmessage)));
831     }
833     /**
834      * Add action to the button.
835      *
836      * @param component_action $action
837      */
838     public function add_action(component_action $action) {
839         $this->actions[] = $action;
840     }
842     /**
843      * Adds help icon.
844      *
845      * @deprecated since Moodle 2.0
846      */
847     public function set_old_help_icon($helppage, $title, $component = 'moodle') {
848         throw new coding_exception('set_old_help_icon() can not be used any more, please see set_help_icon().');
849     }
851     /**
852      * Adds help icon.
853      *
854      * @param string $identifier The keyword that defines a help page
855      * @param string $component
856      */
857     public function set_help_icon($identifier, $component = 'moodle') {
858         $this->helpicon = new help_icon($identifier, $component);
859     }
861     /**
862      * Sets select's label
863      *
864      * @param string $label
865      * @param array $attributes (optional)
866      */
867     public function set_label($label, $attributes = array()) {
868         $this->label = $label;
869         $this->labelattributes = $attributes;
871     }
873     /**
874      * Export data.
875      *
876      * @param renderer_base $output Renderer.
877      * @return stdClass
878      */
879     public function export_for_template(renderer_base $output) {
880         $attributes = $this->attributes;
882         $data = new stdClass();
883         $data->name = $this->name;
884         $data->method = $this->method;
885         $data->action = $this->method === 'get' ? $this->url->out_omit_querystring(true) : $this->url->out_omit_querystring();
886         $data->classes = 'autosubmit ' . $this->class;
887         $data->label = $this->label;
888         $data->disabled = $this->disabled;
889         $data->title = $this->tooltip;
890         $data->id = !empty($attributes['id']) ? $attributes['id'] : html_writer::random_id('single_select');
891         unset($attributes['id']);
893         // Form parameters.
894         $params = $this->url->params();
895         if ($this->method === 'post') {
896             $params['sesskey'] = sesskey();
897         }
898         $data->params = array_map(function($key) use ($params) {
899             return ['name' => $key, 'value' => $params[$key]];
900         }, array_keys($params));
902         // Select options.
903         $hasnothing = false;
904         if (is_string($this->nothing) && $this->nothing !== '') {
905             $nothing = ['' => $this->nothing];
906             $hasnothing = true;
907         } else if (is_array($this->nothing)) {
908             $key = key($this->nothing);
909             if ($key === 'choose' || $key === 'choosedots') {
910                 $nothing = [$key => get_string('choosedots')];
911             } else {
912                 $nothing = $this->nothing;
913             }
914             $hasnothing = true;
915         }
916         if ($hasnothing) {
917             $options = $nothing + $this->options;
918         } else {
919             $options = $this->options;
920         }
921         $data->hasnothing = $hasnothing;
922         $data->nothingkey = $hasnothing ? key($nothing) : false;
924         foreach ($options as $value => $name) {
925             $data->options[] = [
926                 'value' => $value,
927                 'name' => $options[$value],
928                 'selected' => $this->selected == $value
929             ];
930         }
932         // Label attributes.
933         $data->labelattributes = [];
934         foreach ($this->labelattributes as $key => $value) {
935             $data->labelattributes = ['name' => $key, 'value' => $value];
936         }
938         // Help icon.
939         $data->helpicon = !empty($this->helpicon) ? $this->helpicon->export_for_template($output) : false;
941         return $data;
942     }
945 /**
946  * Simple URL selection widget description.
947  *
948  * @copyright 2009 Petr Skoda
949  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
950  * @since Moodle 2.0
951  * @package core
952  * @category output
953  */
954 class url_select implements renderable {
955     /**
956      * @var array $urls associative array value=>label ex.: array(1=>'One, 2=>Two)
957      *     it is also possible to specify optgroup as complex label array ex.:
958      *         array(array('Odd'=>array(1=>'One', 3=>'Three)), array('Even'=>array(2=>'Two')))
959      *         array(1=>'One', '--1uniquekey'=>array('More'=>array(2=>'Two', 3=>'Three')))
960      */
961     var $urls;
963     /**
964      * @var string Selected option
965      */
966     var $selected;
968     /**
969      * @var array Nothing selected
970      */
971     var $nothing;
973     /**
974      * @var array Extra select field attributes
975      */
976     var $attributes = array();
978     /**
979      * @var string Button label
980      */
981     var $label = '';
983     /**
984      * @var array Button label's attributes
985      */
986     var $labelattributes = array();
988     /**
989      * @var string Wrapping div class
990      */
991     var $class = 'urlselect';
993     /**
994      * @var bool True if button disabled, false if normal
995      */
996     var $disabled = false;
998     /**
999      * @var string Button tooltip
1000      */
1001     var $tooltip = null;
1003     /**
1004      * @var string Form id
1005      */
1006     var $formid = null;
1008     /**
1009      * @var array List of attached actions
1010      */
1011     var $helpicon = null;
1013     /**
1014      * @var string If set, makes button visible with given name for button
1015      */
1016     var $showbutton = null;
1018     /**
1019      * Constructor
1020      * @param array $urls list of options
1021      * @param string $selected selected element
1022      * @param array $nothing
1023      * @param string $formid
1024      * @param string $showbutton Set to text of button if it should be visible
1025      *   or null if it should be hidden (hidden version always has text 'go')
1026      */
1027     public function __construct(array $urls, $selected = '', $nothing = array('' => 'choosedots'), $formid = null, $showbutton = null) {
1028         $this->urls       = $urls;
1029         $this->selected   = $selected;
1030         $this->nothing    = $nothing;
1031         $this->formid     = $formid;
1032         $this->showbutton = $showbutton;
1033     }
1035     /**
1036      * Adds help icon.
1037      *
1038      * @deprecated since Moodle 2.0
1039      */
1040     public function set_old_help_icon($helppage, $title, $component = 'moodle') {
1041         throw new coding_exception('set_old_help_icon() can not be used any more, please see set_help_icon().');
1042     }
1044     /**
1045      * Adds help icon.
1046      *
1047      * @param string $identifier The keyword that defines a help page
1048      * @param string $component
1049      */
1050     public function set_help_icon($identifier, $component = 'moodle') {
1051         $this->helpicon = new help_icon($identifier, $component);
1052     }
1054     /**
1055      * Sets select's label
1056      *
1057      * @param string $label
1058      * @param array $attributes (optional)
1059      */
1060     public function set_label($label, $attributes = array()) {
1061         $this->label = $label;
1062         $this->labelattributes = $attributes;
1063     }
1066 /**
1067  * Data structure describing html link with special action attached.
1068  *
1069  * @copyright 2010 Petr Skoda
1070  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1071  * @since Moodle 2.0
1072  * @package core
1073  * @category output
1074  */
1075 class action_link implements renderable {
1077     /**
1078      * @var moodle_url Href url
1079      */
1080     public $url;
1082     /**
1083      * @var string Link text HTML fragment
1084      */
1085     public $text;
1087     /**
1088      * @var array HTML attributes
1089      */
1090     public $attributes;
1092     /**
1093      * @var array List of actions attached to link
1094      */
1095     public $actions;
1097     /**
1098      * @var pix_icon Optional pix icon to render with the link
1099      */
1100     public $icon;
1102     /**
1103      * Constructor
1104      * @param moodle_url $url
1105      * @param string $text HTML fragment
1106      * @param component_action $action
1107      * @param array $attributes associative array of html link attributes + disabled
1108      * @param pix_icon $icon optional pix_icon to render with the link text
1109      */
1110     public function __construct(moodle_url $url,
1111                                 $text,
1112                                 component_action $action=null,
1113                                 array $attributes=null,
1114                                 pix_icon $icon=null) {
1115         $this->url = clone($url);
1116         $this->text = $text;
1117         $this->attributes = (array)$attributes;
1118         if ($action) {
1119             $this->add_action($action);
1120         }
1121         $this->icon = $icon;
1122     }
1124     /**
1125      * Add action to the link.
1126      *
1127      * @param component_action $action
1128      */
1129     public function add_action(component_action $action) {
1130         $this->actions[] = $action;
1131     }
1133     /**
1134      * Adds a CSS class to this action link object
1135      * @param string $class
1136      */
1137     public function add_class($class) {
1138         if (empty($this->attributes['class'])) {
1139             $this->attributes['class'] = $class;
1140         } else {
1141             $this->attributes['class'] .= ' ' . $class;
1142         }
1143     }
1145     /**
1146      * Returns true if the specified class has been added to this link.
1147      * @param string $class
1148      * @return bool
1149      */
1150     public function has_class($class) {
1151         return strpos(' ' . $this->attributes['class'] . ' ', ' ' . $class . ' ') !== false;
1152     }
1154     /**
1155      * Return the rendered HTML for the icon. Useful for rendering action links in a template.
1156      * @return string
1157      */
1158     public function get_icon_html() {
1159         global $OUTPUT;
1160         if (!$this->icon) {
1161             return '';
1162         }
1163         return $OUTPUT->render($this->icon);
1164     }
1167 /**
1168  * Simple html output class
1169  *
1170  * @copyright 2009 Tim Hunt, 2010 Petr Skoda
1171  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1172  * @since Moodle 2.0
1173  * @package core
1174  * @category output
1175  */
1176 class html_writer {
1178     /**
1179      * Outputs a tag with attributes and contents
1180      *
1181      * @param string $tagname The name of tag ('a', 'img', 'span' etc.)
1182      * @param string $contents What goes between the opening and closing tags
1183      * @param array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
1184      * @return string HTML fragment
1185      */
1186     public static function tag($tagname, $contents, array $attributes = null) {
1187         return self::start_tag($tagname, $attributes) . $contents . self::end_tag($tagname);
1188     }
1190     /**
1191      * Outputs an opening tag with attributes
1192      *
1193      * @param string $tagname The name of tag ('a', 'img', 'span' etc.)
1194      * @param array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
1195      * @return string HTML fragment
1196      */
1197     public static function start_tag($tagname, array $attributes = null) {
1198         return '<' . $tagname . self::attributes($attributes) . '>';
1199     }
1201     /**
1202      * Outputs a closing tag
1203      *
1204      * @param string $tagname The name of tag ('a', 'img', 'span' etc.)
1205      * @return string HTML fragment
1206      */
1207     public static function end_tag($tagname) {
1208         return '</' . $tagname . '>';
1209     }
1211     /**
1212      * Outputs an empty tag with attributes
1213      *
1214      * @param string $tagname The name of tag ('input', 'img', 'br' etc.)
1215      * @param array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
1216      * @return string HTML fragment
1217      */
1218     public static function empty_tag($tagname, array $attributes = null) {
1219         return '<' . $tagname . self::attributes($attributes) . ' />';
1220     }
1222     /**
1223      * Outputs a tag, but only if the contents are not empty
1224      *
1225      * @param string $tagname The name of tag ('a', 'img', 'span' etc.)
1226      * @param string $contents What goes between the opening and closing tags
1227      * @param array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
1228      * @return string HTML fragment
1229      */
1230     public static function nonempty_tag($tagname, $contents, array $attributes = null) {
1231         if ($contents === '' || is_null($contents)) {
1232             return '';
1233         }
1234         return self::tag($tagname, $contents, $attributes);
1235     }
1237     /**
1238      * Outputs a HTML attribute and value
1239      *
1240      * @param string $name The name of the attribute ('src', 'href', 'class' etc.)
1241      * @param string $value The value of the attribute. The value will be escaped with {@link s()}
1242      * @return string HTML fragment
1243      */
1244     public static function attribute($name, $value) {
1245         if ($value instanceof moodle_url) {
1246             return ' ' . $name . '="' . $value->out() . '"';
1247         }
1249         // special case, we do not want these in output
1250         if ($value === null) {
1251             return '';
1252         }
1254         // no sloppy trimming here!
1255         return ' ' . $name . '="' . s($value) . '"';
1256     }
1258     /**
1259      * Outputs a list of HTML attributes and values
1260      *
1261      * @param array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
1262      *       The values will be escaped with {@link s()}
1263      * @return string HTML fragment
1264      */
1265     public static function attributes(array $attributes = null) {
1266         $attributes = (array)$attributes;
1267         $output = '';
1268         foreach ($attributes as $name => $value) {
1269             $output .= self::attribute($name, $value);
1270         }
1271         return $output;
1272     }
1274     /**
1275      * Generates a simple image tag with attributes.
1276      *
1277      * @param string $src The source of image
1278      * @param string $alt The alternate text for image
1279      * @param array $attributes The tag attributes (array('height' => $max_height, 'class' => 'class1') etc.)
1280      * @return string HTML fragment
1281      */
1282     public static function img($src, $alt, array $attributes = null) {
1283         $attributes = (array)$attributes;
1284         $attributes['src'] = $src;
1285         $attributes['alt'] = $alt;
1287         return self::empty_tag('img', $attributes);
1288     }
1290     /**
1291      * Generates random html element id.
1292      *
1293      * @staticvar int $counter
1294      * @staticvar type $uniq
1295      * @param string $base A string fragment that will be included in the random ID.
1296      * @return string A unique ID
1297      */
1298     public static function random_id($base='random') {
1299         static $counter = 0;
1300         static $uniq;
1302         if (!isset($uniq)) {
1303             $uniq = uniqid();
1304         }
1306         $counter++;
1307         return $base.$uniq.$counter;
1308     }
1310     /**
1311      * Generates a simple html link
1312      *
1313      * @param string|moodle_url $url The URL
1314      * @param string $text The text
1315      * @param array $attributes HTML attributes
1316      * @return string HTML fragment
1317      */
1318     public static function link($url, $text, array $attributes = null) {
1319         $attributes = (array)$attributes;
1320         $attributes['href']  = $url;
1321         return self::tag('a', $text, $attributes);
1322     }
1324     /**
1325      * Generates a simple checkbox with optional label
1326      *
1327      * @param string $name The name of the checkbox
1328      * @param string $value The value of the checkbox
1329      * @param bool $checked Whether the checkbox is checked
1330      * @param string $label The label for the checkbox
1331      * @param array $attributes Any attributes to apply to the checkbox
1332      * @return string html fragment
1333      */
1334     public static function checkbox($name, $value, $checked = true, $label = '', array $attributes = null) {
1335         $attributes = (array)$attributes;
1336         $output = '';
1338         if ($label !== '' and !is_null($label)) {
1339             if (empty($attributes['id'])) {
1340                 $attributes['id'] = self::random_id('checkbox_');
1341             }
1342         }
1343         $attributes['type']    = 'checkbox';
1344         $attributes['value']   = $value;
1345         $attributes['name']    = $name;
1346         $attributes['checked'] = $checked ? 'checked' : null;
1348         $output .= self::empty_tag('input', $attributes);
1350         if ($label !== '' and !is_null($label)) {
1351             $output .= self::tag('label', $label, array('for'=>$attributes['id']));
1352         }
1354         return $output;
1355     }
1357     /**
1358      * Generates a simple select yes/no form field
1359      *
1360      * @param string $name name of select element
1361      * @param bool $selected
1362      * @param array $attributes - html select element attributes
1363      * @return string HTML fragment
1364      */
1365     public static function select_yes_no($name, $selected=true, array $attributes = null) {
1366         $options = array('1'=>get_string('yes'), '0'=>get_string('no'));
1367         return self::select($options, $name, $selected, null, $attributes);
1368     }
1370     /**
1371      * Generates a simple select form field
1372      *
1373      * @param array $options associative array value=>label ex.:
1374      *                array(1=>'One, 2=>Two)
1375      *              it is also possible to specify optgroup as complex label array ex.:
1376      *                array(array('Odd'=>array(1=>'One', 3=>'Three)), array('Even'=>array(2=>'Two')))
1377      *                array(1=>'One', '--1uniquekey'=>array('More'=>array(2=>'Two', 3=>'Three')))
1378      * @param string $name name of select element
1379      * @param string|array $selected value or array of values depending on multiple attribute
1380      * @param array|bool $nothing add nothing selected option, or false of not added
1381      * @param array $attributes html select element attributes
1382      * @return string HTML fragment
1383      */
1384     public static function select(array $options, $name, $selected = '', $nothing = array('' => 'choosedots'), array $attributes = null) {
1385         $attributes = (array)$attributes;
1386         if (is_array($nothing)) {
1387             foreach ($nothing as $k=>$v) {
1388                 if ($v === 'choose' or $v === 'choosedots') {
1389                     $nothing[$k] = get_string('choosedots');
1390                 }
1391             }
1392             $options = $nothing + $options; // keep keys, do not override
1394         } else if (is_string($nothing) and $nothing !== '') {
1395             // BC
1396             $options = array(''=>$nothing) + $options;
1397         }
1399         // we may accept more values if multiple attribute specified
1400         $selected = (array)$selected;
1401         foreach ($selected as $k=>$v) {
1402             $selected[$k] = (string)$v;
1403         }
1405         if (!isset($attributes['id'])) {
1406             $id = 'menu'.$name;
1407             // name may contaion [], which would make an invalid id. e.g. numeric question type editing form, assignment quickgrading
1408             $id = str_replace('[', '', $id);
1409             $id = str_replace(']', '', $id);
1410             $attributes['id'] = $id;
1411         }
1413         if (!isset($attributes['class'])) {
1414             $class = 'menu'.$name;
1415             // name may contaion [], which would make an invalid class. e.g. numeric question type editing form, assignment quickgrading
1416             $class = str_replace('[', '', $class);
1417             $class = str_replace(']', '', $class);
1418             $attributes['class'] = $class;
1419         }
1420         $attributes['class'] = 'select ' . $attributes['class']; // Add 'select' selector always
1422         $attributes['name'] = $name;
1424         if (!empty($attributes['disabled'])) {
1425             $attributes['disabled'] = 'disabled';
1426         } else {
1427             unset($attributes['disabled']);
1428         }
1430         $output = '';
1431         foreach ($options as $value=>$label) {
1432             if (is_array($label)) {
1433                 // ignore key, it just has to be unique
1434                 $output .= self::select_optgroup(key($label), current($label), $selected);
1435             } else {
1436                 $output .= self::select_option($label, $value, $selected);
1437             }
1438         }
1439         return self::tag('select', $output, $attributes);
1440     }
1442     /**
1443      * Returns HTML to display a select box option.
1444      *
1445      * @param string $label The label to display as the option.
1446      * @param string|int $value The value the option represents
1447      * @param array $selected An array of selected options
1448      * @return string HTML fragment
1449      */
1450     private static function select_option($label, $value, array $selected) {
1451         $attributes = array();
1452         $value = (string)$value;
1453         if (in_array($value, $selected, true)) {
1454             $attributes['selected'] = 'selected';
1455         }
1456         $attributes['value'] = $value;
1457         return self::tag('option', $label, $attributes);
1458     }
1460     /**
1461      * Returns HTML to display a select box option group.
1462      *
1463      * @param string $groupname The label to use for the group
1464      * @param array $options The options in the group
1465      * @param array $selected An array of selected values.
1466      * @return string HTML fragment.
1467      */
1468     private static function select_optgroup($groupname, $options, array $selected) {
1469         if (empty($options)) {
1470             return '';
1471         }
1472         $attributes = array('label'=>$groupname);
1473         $output = '';
1474         foreach ($options as $value=>$label) {
1475             $output .= self::select_option($label, $value, $selected);
1476         }
1477         return self::tag('optgroup', $output, $attributes);
1478     }
1480     /**
1481      * This is a shortcut for making an hour selector menu.
1482      *
1483      * @param string $type The type of selector (years, months, days, hours, minutes)
1484      * @param string $name fieldname
1485      * @param int $currenttime A default timestamp in GMT
1486      * @param int $step minute spacing
1487      * @param array $attributes - html select element attributes
1488      * @return HTML fragment
1489      */
1490     public static function select_time($type, $name, $currenttime = 0, $step = 5, array $attributes = null) {
1491         if (!$currenttime) {
1492             $currenttime = time();
1493         }
1494         $calendartype = \core_calendar\type_factory::get_calendar_instance();
1495         $currentdate = $calendartype->timestamp_to_date_array($currenttime);
1496         $userdatetype = $type;
1497         $timeunits = array();
1499         switch ($type) {
1500             case 'years':
1501                 $timeunits = $calendartype->get_years();
1502                 $userdatetype = 'year';
1503                 break;
1504             case 'months':
1505                 $timeunits = $calendartype->get_months();
1506                 $userdatetype = 'month';
1507                 $currentdate['month'] = (int)$currentdate['mon'];
1508                 break;
1509             case 'days':
1510                 $timeunits = $calendartype->get_days();
1511                 $userdatetype = 'mday';
1512                 break;
1513             case 'hours':
1514                 for ($i=0; $i<=23; $i++) {
1515                     $timeunits[$i] = sprintf("%02d",$i);
1516                 }
1517                 break;
1518             case 'minutes':
1519                 if ($step != 1) {
1520                     $currentdate['minutes'] = ceil($currentdate['minutes']/$step)*$step;
1521                 }
1523                 for ($i=0; $i<=59; $i+=$step) {
1524                     $timeunits[$i] = sprintf("%02d",$i);
1525                 }
1526                 break;
1527             default:
1528                 throw new coding_exception("Time type $type is not supported by html_writer::select_time().");
1529         }
1531         if (empty($attributes['id'])) {
1532             $attributes['id'] = self::random_id('ts_');
1533         }
1534         $timerselector = self::select($timeunits, $name, $currentdate[$userdatetype], null, $attributes);
1535         $label = self::tag('label', get_string(substr($type, 0, -1), 'form'), array('for'=>$attributes['id'], 'class'=>'accesshide'));
1537         return $label.$timerselector;
1538     }
1540     /**
1541      * Shortcut for quick making of lists
1542      *
1543      * Note: 'list' is a reserved keyword ;-)
1544      *
1545      * @param array $items
1546      * @param array $attributes
1547      * @param string $tag ul or ol
1548      * @return string
1549      */
1550     public static function alist(array $items, array $attributes = null, $tag = 'ul') {
1551         $output = html_writer::start_tag($tag, $attributes)."\n";
1552         foreach ($items as $item) {
1553             $output .= html_writer::tag('li', $item)."\n";
1554         }
1555         $output .= html_writer::end_tag($tag);
1556         return $output;
1557     }
1559     /**
1560      * Returns hidden input fields created from url parameters.
1561      *
1562      * @param moodle_url $url
1563      * @param array $exclude list of excluded parameters
1564      * @return string HTML fragment
1565      */
1566     public static function input_hidden_params(moodle_url $url, array $exclude = null) {
1567         $exclude = (array)$exclude;
1568         $params = $url->params();
1569         foreach ($exclude as $key) {
1570             unset($params[$key]);
1571         }
1573         $output = '';
1574         foreach ($params as $key => $value) {
1575             $attributes = array('type'=>'hidden', 'name'=>$key, 'value'=>$value);
1576             $output .= self::empty_tag('input', $attributes)."\n";
1577         }
1578         return $output;
1579     }
1581     /**
1582      * Generate a script tag containing the the specified code.
1583      *
1584      * @param string $jscode the JavaScript code
1585      * @param moodle_url|string $url optional url of the external script, $code ignored if specified
1586      * @return string HTML, the code wrapped in <script> tags.
1587      */
1588     public static function script($jscode, $url=null) {
1589         if ($jscode) {
1590             $attributes = array('type'=>'text/javascript');
1591             return self::tag('script', "\n//<![CDATA[\n$jscode\n//]]>\n", $attributes) . "\n";
1593         } else if ($url) {
1594             $attributes = array('type'=>'text/javascript', 'src'=>$url);
1595             return self::tag('script', '', $attributes) . "\n";
1597         } else {
1598             return '';
1599         }
1600     }
1602     /**
1603      * Renders HTML table
1604      *
1605      * This method may modify the passed instance by adding some default properties if they are not set yet.
1606      * If this is not what you want, you should make a full clone of your data before passing them to this
1607      * method. In most cases this is not an issue at all so we do not clone by default for performance
1608      * and memory consumption reasons.
1609      *
1610      * @param html_table $table data to be rendered
1611      * @return string HTML code
1612      */
1613     public static function table(html_table $table) {
1614         // prepare table data and populate missing properties with reasonable defaults
1615         if (!empty($table->align)) {
1616             foreach ($table->align as $key => $aa) {
1617                 if ($aa) {
1618                     $table->align[$key] = 'text-align:'. fix_align_rtl($aa) .';';  // Fix for RTL languages
1619                 } else {
1620                     $table->align[$key] = null;
1621                 }
1622             }
1623         }
1624         if (!empty($table->size)) {
1625             foreach ($table->size as $key => $ss) {
1626                 if ($ss) {
1627                     $table->size[$key] = 'width:'. $ss .';';
1628                 } else {
1629                     $table->size[$key] = null;
1630                 }
1631             }
1632         }
1633         if (!empty($table->wrap)) {
1634             foreach ($table->wrap as $key => $ww) {
1635                 if ($ww) {
1636                     $table->wrap[$key] = 'white-space:nowrap;';
1637                 } else {
1638                     $table->wrap[$key] = '';
1639                 }
1640             }
1641         }
1642         if (!empty($table->head)) {
1643             foreach ($table->head as $key => $val) {
1644                 if (!isset($table->align[$key])) {
1645                     $table->align[$key] = null;
1646                 }
1647                 if (!isset($table->size[$key])) {
1648                     $table->size[$key] = null;
1649                 }
1650                 if (!isset($table->wrap[$key])) {
1651                     $table->wrap[$key] = null;
1652                 }
1654             }
1655         }
1656         if (empty($table->attributes['class'])) {
1657             $table->attributes['class'] = 'generaltable';
1658         }
1659         if (!empty($table->tablealign)) {
1660             $table->attributes['class'] .= ' boxalign' . $table->tablealign;
1661         }
1663         // explicitly assigned properties override those defined via $table->attributes
1664         $table->attributes['class'] = trim($table->attributes['class']);
1665         $attributes = array_merge($table->attributes, array(
1666                 'id'            => $table->id,
1667                 'width'         => $table->width,
1668                 'summary'       => $table->summary,
1669                 'cellpadding'   => $table->cellpadding,
1670                 'cellspacing'   => $table->cellspacing,
1671             ));
1672         $output = html_writer::start_tag('table', $attributes) . "\n";
1674         $countcols = 0;
1676         // Output a caption if present.
1677         if (!empty($table->caption)) {
1678             $captionattributes = array();
1679             if ($table->captionhide) {
1680                 $captionattributes['class'] = 'accesshide';
1681             }
1682             $output .= html_writer::tag(
1683                 'caption',
1684                 $table->caption,
1685                 $captionattributes
1686             );
1687         }
1689         if (!empty($table->head)) {
1690             $countcols = count($table->head);
1692             $output .= html_writer::start_tag('thead', array()) . "\n";
1693             $output .= html_writer::start_tag('tr', array()) . "\n";
1694             $keys = array_keys($table->head);
1695             $lastkey = end($keys);
1697             foreach ($table->head as $key => $heading) {
1698                 // Convert plain string headings into html_table_cell objects
1699                 if (!($heading instanceof html_table_cell)) {
1700                     $headingtext = $heading;
1701                     $heading = new html_table_cell();
1702                     $heading->text = $headingtext;
1703                     $heading->header = true;
1704                 }
1706                 if ($heading->header !== false) {
1707                     $heading->header = true;
1708                 }
1710                 if ($heading->header && empty($heading->scope)) {
1711                     $heading->scope = 'col';
1712                 }
1714                 $heading->attributes['class'] .= ' header c' . $key;
1715                 if (isset($table->headspan[$key]) && $table->headspan[$key] > 1) {
1716                     $heading->colspan = $table->headspan[$key];
1717                     $countcols += $table->headspan[$key] - 1;
1718                 }
1720                 if ($key == $lastkey) {
1721                     $heading->attributes['class'] .= ' lastcol';
1722                 }
1723                 if (isset($table->colclasses[$key])) {
1724                     $heading->attributes['class'] .= ' ' . $table->colclasses[$key];
1725                 }
1726                 $heading->attributes['class'] = trim($heading->attributes['class']);
1727                 $attributes = array_merge($heading->attributes, array(
1728                         'style'     => $table->align[$key] . $table->size[$key] . $heading->style,
1729                         'scope'     => $heading->scope,
1730                         'colspan'   => $heading->colspan,
1731                     ));
1733                 $tagtype = 'td';
1734                 if ($heading->header === true) {
1735                     $tagtype = 'th';
1736                 }
1737                 $output .= html_writer::tag($tagtype, $heading->text, $attributes) . "\n";
1738             }
1739             $output .= html_writer::end_tag('tr') . "\n";
1740             $output .= html_writer::end_tag('thead') . "\n";
1742             if (empty($table->data)) {
1743                 // For valid XHTML strict every table must contain either a valid tr
1744                 // or a valid tbody... both of which must contain a valid td
1745                 $output .= html_writer::start_tag('tbody', array('class' => 'empty'));
1746                 $output .= html_writer::tag('tr', html_writer::tag('td', '', array('colspan'=>count($table->head))));
1747                 $output .= html_writer::end_tag('tbody');
1748             }
1749         }
1751         if (!empty($table->data)) {
1752             $keys       = array_keys($table->data);
1753             $lastrowkey = end($keys);
1754             $output .= html_writer::start_tag('tbody', array());
1756             foreach ($table->data as $key => $row) {
1757                 if (($row === 'hr') && ($countcols)) {
1758                     $output .= html_writer::tag('td', html_writer::tag('div', '', array('class' => 'tabledivider')), array('colspan' => $countcols));
1759                 } else {
1760                     // Convert array rows to html_table_rows and cell strings to html_table_cell objects
1761                     if (!($row instanceof html_table_row)) {
1762                         $newrow = new html_table_row();
1764                         foreach ($row as $cell) {
1765                             if (!($cell instanceof html_table_cell)) {
1766                                 $cell = new html_table_cell($cell);
1767                             }
1768                             $newrow->cells[] = $cell;
1769                         }
1770                         $row = $newrow;
1771                     }
1773                     if (isset($table->rowclasses[$key])) {
1774                         $row->attributes['class'] .= ' ' . $table->rowclasses[$key];
1775                     }
1777                     if ($key == $lastrowkey) {
1778                         $row->attributes['class'] .= ' lastrow';
1779                     }
1781                     // Explicitly assigned properties should override those defined in the attributes.
1782                     $row->attributes['class'] = trim($row->attributes['class']);
1783                     $trattributes = array_merge($row->attributes, array(
1784                             'id'            => $row->id,
1785                             'style'         => $row->style,
1786                         ));
1787                     $output .= html_writer::start_tag('tr', $trattributes) . "\n";
1788                     $keys2 = array_keys($row->cells);
1789                     $lastkey = end($keys2);
1791                     $gotlastkey = false; //flag for sanity checking
1792                     foreach ($row->cells as $key => $cell) {
1793                         if ($gotlastkey) {
1794                             //This should never happen. Why do we have a cell after the last cell?
1795                             mtrace("A cell with key ($key) was found after the last key ($lastkey)");
1796                         }
1798                         if (!($cell instanceof html_table_cell)) {
1799                             $mycell = new html_table_cell();
1800                             $mycell->text = $cell;
1801                             $cell = $mycell;
1802                         }
1804                         if (($cell->header === true) && empty($cell->scope)) {
1805                             $cell->scope = 'row';
1806                         }
1808                         if (isset($table->colclasses[$key])) {
1809                             $cell->attributes['class'] .= ' ' . $table->colclasses[$key];
1810                         }
1812                         $cell->attributes['class'] .= ' cell c' . $key;
1813                         if ($key == $lastkey) {
1814                             $cell->attributes['class'] .= ' lastcol';
1815                             $gotlastkey = true;
1816                         }
1817                         $tdstyle = '';
1818                         $tdstyle .= isset($table->align[$key]) ? $table->align[$key] : '';
1819                         $tdstyle .= isset($table->size[$key]) ? $table->size[$key] : '';
1820                         $tdstyle .= isset($table->wrap[$key]) ? $table->wrap[$key] : '';
1821                         $cell->attributes['class'] = trim($cell->attributes['class']);
1822                         $tdattributes = array_merge($cell->attributes, array(
1823                                 'style' => $tdstyle . $cell->style,
1824                                 'colspan' => $cell->colspan,
1825                                 'rowspan' => $cell->rowspan,
1826                                 'id' => $cell->id,
1827                                 'abbr' => $cell->abbr,
1828                                 'scope' => $cell->scope,
1829                             ));
1830                         $tagtype = 'td';
1831                         if ($cell->header === true) {
1832                             $tagtype = 'th';
1833                         }
1834                         $output .= html_writer::tag($tagtype, $cell->text, $tdattributes) . "\n";
1835                     }
1836                 }
1837                 $output .= html_writer::end_tag('tr') . "\n";
1838             }
1839             $output .= html_writer::end_tag('tbody') . "\n";
1840         }
1841         $output .= html_writer::end_tag('table') . "\n";
1843         return $output;
1844     }
1846     /**
1847      * Renders form element label
1848      *
1849      * By default, the label is suffixed with a label separator defined in the
1850      * current language pack (colon by default in the English lang pack).
1851      * Adding the colon can be explicitly disabled if needed. Label separators
1852      * are put outside the label tag itself so they are not read by
1853      * screenreaders (accessibility).
1854      *
1855      * Parameter $for explicitly associates the label with a form control. When
1856      * set, the value of this attribute must be the same as the value of
1857      * the id attribute of the form control in the same document. When null,
1858      * the label being defined is associated with the control inside the label
1859      * element.
1860      *
1861      * @param string $text content of the label tag
1862      * @param string|null $for id of the element this label is associated with, null for no association
1863      * @param bool $colonize add label separator (colon) to the label text, if it is not there yet
1864      * @param array $attributes to be inserted in the tab, for example array('accesskey' => 'a')
1865      * @return string HTML of the label element
1866      */
1867     public static function label($text, $for, $colonize = true, array $attributes=array()) {
1868         if (!is_null($for)) {
1869             $attributes = array_merge($attributes, array('for' => $for));
1870         }
1871         $text = trim($text);
1872         $label = self::tag('label', $text, $attributes);
1874         // TODO MDL-12192 $colonize disabled for now yet
1875         // if (!empty($text) and $colonize) {
1876         //     // the $text may end with the colon already, though it is bad string definition style
1877         //     $colon = get_string('labelsep', 'langconfig');
1878         //     if (!empty($colon)) {
1879         //         $trimmed = trim($colon);
1880         //         if ((substr($text, -strlen($trimmed)) == $trimmed) or (substr($text, -1) == ':')) {
1881         //             //debugging('The label text should not end with colon or other label separator,
1882         //             //           please fix the string definition.', DEBUG_DEVELOPER);
1883         //         } else {
1884         //             $label .= $colon;
1885         //         }
1886         //     }
1887         // }
1889         return $label;
1890     }
1892     /**
1893      * Combines a class parameter with other attributes. Aids in code reduction
1894      * because the class parameter is very frequently used.
1895      *
1896      * If the class attribute is specified both in the attributes and in the
1897      * class parameter, the two values are combined with a space between.
1898      *
1899      * @param string $class Optional CSS class (or classes as space-separated list)
1900      * @param array $attributes Optional other attributes as array
1901      * @return array Attributes (or null if still none)
1902      */
1903     private static function add_class($class = '', array $attributes = null) {
1904         if ($class !== '') {
1905             $classattribute = array('class' => $class);
1906             if ($attributes) {
1907                 if (array_key_exists('class', $attributes)) {
1908                     $attributes['class'] = trim($attributes['class'] . ' ' . $class);
1909                 } else {
1910                     $attributes = $classattribute + $attributes;
1911                 }
1912             } else {
1913                 $attributes = $classattribute;
1914             }
1915         }
1916         return $attributes;
1917     }
1919     /**
1920      * Creates a <div> tag. (Shortcut function.)
1921      *
1922      * @param string $content HTML content of tag
1923      * @param string $class Optional CSS class (or classes as space-separated list)
1924      * @param array $attributes Optional other attributes as array
1925      * @return string HTML code for div
1926      */
1927     public static function div($content, $class = '', array $attributes = null) {
1928         return self::tag('div', $content, self::add_class($class, $attributes));
1929     }
1931     /**
1932      * Starts a <div> tag. (Shortcut function.)
1933      *
1934      * @param string $class Optional CSS class (or classes as space-separated list)
1935      * @param array $attributes Optional other attributes as array
1936      * @return string HTML code for open div tag
1937      */
1938     public static function start_div($class = '', array $attributes = null) {
1939         return self::start_tag('div', self::add_class($class, $attributes));
1940     }
1942     /**
1943      * Ends a <div> tag. (Shortcut function.)
1944      *
1945      * @return string HTML code for close div tag
1946      */
1947     public static function end_div() {
1948         return self::end_tag('div');
1949     }
1951     /**
1952      * Creates a <span> tag. (Shortcut function.)
1953      *
1954      * @param string $content HTML content of tag
1955      * @param string $class Optional CSS class (or classes as space-separated list)
1956      * @param array $attributes Optional other attributes as array
1957      * @return string HTML code for span
1958      */
1959     public static function span($content, $class = '', array $attributes = null) {
1960         return self::tag('span', $content, self::add_class($class, $attributes));
1961     }
1963     /**
1964      * Starts a <span> tag. (Shortcut function.)
1965      *
1966      * @param string $class Optional CSS class (or classes as space-separated list)
1967      * @param array $attributes Optional other attributes as array
1968      * @return string HTML code for open span tag
1969      */
1970     public static function start_span($class = '', array $attributes = null) {
1971         return self::start_tag('span', self::add_class($class, $attributes));
1972     }
1974     /**
1975      * Ends a <span> tag. (Shortcut function.)
1976      *
1977      * @return string HTML code for close span tag
1978      */
1979     public static function end_span() {
1980         return self::end_tag('span');
1981     }
1984 /**
1985  * Simple javascript output class
1986  *
1987  * @copyright 2010 Petr Skoda
1988  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1989  * @since Moodle 2.0
1990  * @package core
1991  * @category output
1992  */
1993 class js_writer {
1995     /**
1996      * Returns javascript code calling the function
1997      *
1998      * @param string $function function name, can be complex like Y.Event.purgeElement
1999      * @param array $arguments parameters
2000      * @param int $delay execution delay in seconds
2001      * @return string JS code fragment
2002      */
2003     public static function function_call($function, array $arguments = null, $delay=0) {
2004         if ($arguments) {
2005             $arguments = array_map('json_encode', convert_to_array($arguments));
2006             $arguments = implode(', ', $arguments);
2007         } else {
2008             $arguments = '';
2009         }
2010         $js = "$function($arguments);";
2012         if ($delay) {
2013             $delay = $delay * 1000; // in miliseconds
2014             $js = "setTimeout(function() { $js }, $delay);";
2015         }
2016         return $js . "\n";
2017     }
2019     /**
2020      * Special function which adds Y as first argument of function call.
2021      *
2022      * @param string $function The function to call
2023      * @param array $extraarguments Any arguments to pass to it
2024      * @return string Some JS code
2025      */
2026     public static function function_call_with_Y($function, array $extraarguments = null) {
2027         if ($extraarguments) {
2028             $extraarguments = array_map('json_encode', convert_to_array($extraarguments));
2029             $arguments = 'Y, ' . implode(', ', $extraarguments);
2030         } else {
2031             $arguments = 'Y';
2032         }
2033         return "$function($arguments);\n";
2034     }
2036     /**
2037      * Returns JavaScript code to initialise a new object
2038      *
2039      * @param string $var If it is null then no var is assigned the new object.
2040      * @param string $class The class to initialise an object for.
2041      * @param array $arguments An array of args to pass to the init method.
2042      * @param array $requirements Any modules required for this class.
2043      * @param int $delay The delay before initialisation. 0 = no delay.
2044      * @return string Some JS code
2045      */
2046     public static function object_init($var, $class, array $arguments = null, array $requirements = null, $delay=0) {
2047         if (is_array($arguments)) {
2048             $arguments = array_map('json_encode', convert_to_array($arguments));
2049             $arguments = implode(', ', $arguments);
2050         }
2052         if ($var === null) {
2053             $js = "new $class(Y, $arguments);";
2054         } else if (strpos($var, '.')!==false) {
2055             $js = "$var = new $class(Y, $arguments);";
2056         } else {
2057             $js = "var $var = new $class(Y, $arguments);";
2058         }
2060         if ($delay) {
2061             $delay = $delay * 1000; // in miliseconds
2062             $js = "setTimeout(function() { $js }, $delay);";
2063         }
2065         if (count($requirements) > 0) {
2066             $requirements = implode("', '", $requirements);
2067             $js = "Y.use('$requirements', function(Y){ $js });";
2068         }
2069         return $js."\n";
2070     }
2072     /**
2073      * Returns code setting value to variable
2074      *
2075      * @param string $name
2076      * @param mixed $value json serialised value
2077      * @param bool $usevar add var definition, ignored for nested properties
2078      * @return string JS code fragment
2079      */
2080     public static function set_variable($name, $value, $usevar = true) {
2081         $output = '';
2083         if ($usevar) {
2084             if (strpos($name, '.')) {
2085                 $output .= '';
2086             } else {
2087                 $output .= 'var ';
2088             }
2089         }
2091         $output .= "$name = ".json_encode($value).";";
2093         return $output;
2094     }
2096     /**
2097      * Writes event handler attaching code
2098      *
2099      * @param array|string $selector standard YUI selector for elements, may be
2100      *     array or string, element id is in the form "#idvalue"
2101      * @param string $event A valid DOM event (click, mousedown, change etc.)
2102      * @param string $function The name of the function to call
2103      * @param array $arguments An optional array of argument parameters to pass to the function
2104      * @return string JS code fragment
2105      */
2106     public static function event_handler($selector, $event, $function, array $arguments = null) {
2107         $selector = json_encode($selector);
2108         $output = "Y.on('$event', $function, $selector, null";
2109         if (!empty($arguments)) {
2110             $output .= ', ' . json_encode($arguments);
2111         }
2112         return $output . ");\n";
2113     }
2116 /**
2117  * Holds all the information required to render a <table> by {@link core_renderer::table()}
2118  *
2119  * Example of usage:
2120  * $t = new html_table();
2121  * ... // set various properties of the object $t as described below
2122  * echo html_writer::table($t);
2123  *
2124  * @copyright 2009 David Mudrak <david.mudrak@gmail.com>
2125  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2126  * @since Moodle 2.0
2127  * @package core
2128  * @category output
2129  */
2130 class html_table {
2132     /**
2133      * @var string Value to use for the id attribute of the table
2134      */
2135     public $id = null;
2137     /**
2138      * @var array Attributes of HTML attributes for the <table> element
2139      */
2140     public $attributes = array();
2142     /**
2143      * @var array An array of headings. The n-th array item is used as a heading of the n-th column.
2144      * For more control over the rendering of the headers, an array of html_table_cell objects
2145      * can be passed instead of an array of strings.
2146      *
2147      * Example of usage:
2148      * $t->head = array('Student', 'Grade');
2149      */
2150     public $head;
2152     /**
2153      * @var array An array that can be used to make a heading span multiple columns.
2154      * In this example, {@link html_table:$data} is supposed to have three columns. For the first two columns,
2155      * the same heading is used. Therefore, {@link html_table::$head} should consist of two items.
2156      *
2157      * Example of usage:
2158      * $t->headspan = array(2,1);
2159      */
2160     public $headspan;
2162     /**
2163      * @var array An array of column alignments.
2164      * The value is used as CSS 'text-align' property. Therefore, possible
2165      * values are 'left', 'right', 'center' and 'justify'. Specify 'right' or 'left' from the perspective
2166      * of a left-to-right (LTR) language. For RTL, the values are flipped automatically.
2167      *
2168      * Examples of usage:
2169      * $t->align = array(null, 'right');
2170      * or
2171      * $t->align[1] = 'right';
2172      */
2173     public $align;
2175     /**
2176      * @var array The value is used as CSS 'size' property.
2177      *
2178      * Examples of usage:
2179      * $t->size = array('50%', '50%');
2180      * or
2181      * $t->size[1] = '120px';
2182      */
2183     public $size;
2185     /**
2186      * @var array An array of wrapping information.
2187      * The only possible value is 'nowrap' that sets the
2188      * CSS property 'white-space' to the value 'nowrap' in the given column.
2189      *
2190      * Example of usage:
2191      * $t->wrap = array(null, 'nowrap');
2192      */
2193     public $wrap;
2195     /**
2196      * @var array Array of arrays or html_table_row objects containing the data. Alternatively, if you have
2197      * $head specified, the string 'hr' (for horizontal ruler) can be used
2198      * instead of an array of cells data resulting in a divider rendered.
2199      *
2200      * Example of usage with array of arrays:
2201      * $row1 = array('Harry Potter', '76 %');
2202      * $row2 = array('Hermione Granger', '100 %');
2203      * $t->data = array($row1, $row2);
2204      *
2205      * Example with array of html_table_row objects: (used for more fine-grained control)
2206      * $cell1 = new html_table_cell();
2207      * $cell1->text = 'Harry Potter';
2208      * $cell1->colspan = 2;
2209      * $row1 = new html_table_row();
2210      * $row1->cells[] = $cell1;
2211      * $cell2 = new html_table_cell();
2212      * $cell2->text = 'Hermione Granger';
2213      * $cell3 = new html_table_cell();
2214      * $cell3->text = '100 %';
2215      * $row2 = new html_table_row();
2216      * $row2->cells = array($cell2, $cell3);
2217      * $t->data = array($row1, $row2);
2218      */
2219     public $data;
2221     /**
2222      * @deprecated since Moodle 2.0. Styling should be in the CSS.
2223      * @var string Width of the table, percentage of the page preferred.
2224      */
2225     public $width = null;
2227     /**
2228      * @deprecated since Moodle 2.0. Styling should be in the CSS.
2229      * @var string Alignment for the whole table. Can be 'right', 'left' or 'center' (default).
2230      */
2231     public $tablealign = null;
2233     /**
2234      * @deprecated since Moodle 2.0. Styling should be in the CSS.
2235      * @var int Padding on each cell, in pixels
2236      */
2237     public $cellpadding = null;
2239     /**
2240      * @var int Spacing between cells, in pixels
2241      * @deprecated since Moodle 2.0. Styling should be in the CSS.
2242      */
2243     public $cellspacing = null;
2245     /**
2246      * @var array Array of classes to add to particular rows, space-separated string.
2247      * Class 'lastrow' is added automatically for the last row in the table.
2248      *
2249      * Example of usage:
2250      * $t->rowclasses[9] = 'tenth'
2251      */
2252     public $rowclasses;
2254     /**
2255      * @var array An array of classes to add to every cell in a particular column,
2256      * space-separated string. Class 'cell' is added automatically by the renderer.
2257      * Classes 'c0' or 'c1' are added automatically for every odd or even column,
2258      * respectively. Class 'lastcol' is added automatically for all last cells
2259      * in a row.
2260      *
2261      * Example of usage:
2262      * $t->colclasses = array(null, 'grade');
2263      */
2264     public $colclasses;
2266     /**
2267      * @var string Description of the contents for screen readers.
2268      */
2269     public $summary;
2271     /**
2272      * @var string Caption for the table, typically a title.
2273      *
2274      * Example of usage:
2275      * $t->caption = "TV Guide";
2276      */
2277     public $caption;
2279     /**
2280      * @var bool Whether to hide the table's caption from sighted users.
2281      *
2282      * Example of usage:
2283      * $t->caption = "TV Guide";
2284      * $t->captionhide = true;
2285      */
2286     public $captionhide = false;
2288     /**
2289      * Constructor
2290      */
2291     public function __construct() {
2292         $this->attributes['class'] = '';
2293     }
2296 /**
2297  * Component representing a table row.
2298  *
2299  * @copyright 2009 Nicolas Connault
2300  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2301  * @since Moodle 2.0
2302  * @package core
2303  * @category output
2304  */
2305 class html_table_row {
2307     /**
2308      * @var string Value to use for the id attribute of the row.
2309      */
2310     public $id = null;
2312     /**
2313      * @var array Array of html_table_cell objects
2314      */
2315     public $cells = array();
2317     /**
2318      * @var string Value to use for the style attribute of the table row
2319      */
2320     public $style = null;
2322     /**
2323      * @var array Attributes of additional HTML attributes for the <tr> element
2324      */
2325     public $attributes = array();
2327     /**
2328      * Constructor
2329      * @param array $cells
2330      */
2331     public function __construct(array $cells=null) {
2332         $this->attributes['class'] = '';
2333         $cells = (array)$cells;
2334         foreach ($cells as $cell) {
2335             if ($cell instanceof html_table_cell) {
2336                 $this->cells[] = $cell;
2337             } else {
2338                 $this->cells[] = new html_table_cell($cell);
2339             }
2340         }
2341     }
2344 /**
2345  * Component representing a table cell.
2346  *
2347  * @copyright 2009 Nicolas Connault
2348  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2349  * @since Moodle 2.0
2350  * @package core
2351  * @category output
2352  */
2353 class html_table_cell {
2355     /**
2356      * @var string Value to use for the id attribute of the cell.
2357      */
2358     public $id = null;
2360     /**
2361      * @var string The contents of the cell.
2362      */
2363     public $text;
2365     /**
2366      * @var string Abbreviated version of the contents of the cell.
2367      */
2368     public $abbr = null;
2370     /**
2371      * @var int Number of columns this cell should span.
2372      */
2373     public $colspan = null;
2375     /**
2376      * @var int Number of rows this cell should span.
2377      */
2378     public $rowspan = null;
2380     /**
2381      * @var string Defines a way to associate header cells and data cells in a table.
2382      */
2383     public $scope = null;
2385     /**
2386      * @var bool Whether or not this cell is a header cell.
2387      */
2388     public $header = null;
2390     /**
2391      * @var string Value to use for the style attribute of the table cell
2392      */
2393     public $style = null;
2395     /**
2396      * @var array Attributes of additional HTML attributes for the <td> element
2397      */
2398     public $attributes = array();
2400     /**
2401      * Constructs a table cell
2402      *
2403      * @param string $text
2404      */
2405     public function __construct($text = null) {
2406         $this->text = $text;
2407         $this->attributes['class'] = '';
2408     }
2411 /**
2412  * Component representing a paging bar.
2413  *
2414  * @copyright 2009 Nicolas Connault
2415  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2416  * @since Moodle 2.0
2417  * @package core
2418  * @category output
2419  */
2420 class paging_bar implements renderable {
2422     /**
2423      * @var int The maximum number of pagelinks to display.
2424      */
2425     public $maxdisplay = 18;
2427     /**
2428      * @var int The total number of entries to be pages through..
2429      */
2430     public $totalcount;
2432     /**
2433      * @var int The page you are currently viewing.
2434      */
2435     public $page;
2437     /**
2438      * @var int The number of entries that should be shown per page.
2439      */
2440     public $perpage;
2442     /**
2443      * @var string|moodle_url If this  is a string then it is the url which will be appended with $pagevar,
2444      * an equals sign and the page number.
2445      * If this is a moodle_url object then the pagevar param will be replaced by
2446      * the page no, for each page.
2447      */
2448     public $baseurl;
2450     /**
2451      * @var string This is the variable name that you use for the pagenumber in your
2452      * code (ie. 'tablepage', 'blogpage', etc)
2453      */
2454     public $pagevar;
2456     /**
2457      * @var string A HTML link representing the "previous" page.
2458      */
2459     public $previouslink = null;
2461     /**
2462      * @var string A HTML link representing the "next" page.
2463      */
2464     public $nextlink = null;
2466     /**
2467      * @var string A HTML link representing the first page.
2468      */
2469     public $firstlink = null;
2471     /**
2472      * @var string A HTML link representing the last page.
2473      */
2474     public $lastlink = null;
2476     /**
2477      * @var array An array of strings. One of them is just a string: the current page
2478      */
2479     public $pagelinks = array();
2481     /**
2482      * Constructor paging_bar with only the required params.
2483      *
2484      * @param int $totalcount The total number of entries available to be paged through
2485      * @param int $page The page you are currently viewing
2486      * @param int $perpage The number of entries that should be shown per page
2487      * @param string|moodle_url $baseurl url of the current page, the $pagevar parameter is added
2488      * @param string $pagevar name of page parameter that holds the page number
2489      */
2490     public function __construct($totalcount, $page, $perpage, $baseurl, $pagevar = 'page') {
2491         $this->totalcount = $totalcount;
2492         $this->page       = $page;
2493         $this->perpage    = $perpage;
2494         $this->baseurl    = $baseurl;
2495         $this->pagevar    = $pagevar;
2496     }
2498     /**
2499      * Prepares the paging bar for output.
2500      *
2501      * This method validates the arguments set up for the paging bar and then
2502      * produces fragments of HTML to assist display later on.
2503      *
2504      * @param renderer_base $output
2505      * @param moodle_page $page
2506      * @param string $target
2507      * @throws coding_exception
2508      */
2509     public function prepare(renderer_base $output, moodle_page $page, $target) {
2510         if (!isset($this->totalcount) || is_null($this->totalcount)) {
2511             throw new coding_exception('paging_bar requires a totalcount value.');
2512         }
2513         if (!isset($this->page) || is_null($this->page)) {
2514             throw new coding_exception('paging_bar requires a page value.');
2515         }
2516         if (empty($this->perpage)) {
2517             throw new coding_exception('paging_bar requires a perpage value.');
2518         }
2519         if (empty($this->baseurl)) {
2520             throw new coding_exception('paging_bar requires a baseurl value.');
2521         }
2523         if ($this->totalcount > $this->perpage) {
2524             $pagenum = $this->page - 1;
2526             if ($this->page > 0) {
2527                 $this->previouslink = html_writer::link(new moodle_url($this->baseurl, array($this->pagevar=>$pagenum)), get_string('previous'), array('class'=>'previous'));
2528             }
2530             if ($this->perpage > 0) {
2531                 $lastpage = ceil($this->totalcount / $this->perpage);
2532             } else {
2533                 $lastpage = 1;
2534             }
2536             if ($this->page > round(($this->maxdisplay/3)*2)) {
2537                 $currpage = $this->page - round($this->maxdisplay/3);
2539                 $this->firstlink = html_writer::link(new moodle_url($this->baseurl, array($this->pagevar=>0)), '1', array('class'=>'first'));
2540             } else {
2541                 $currpage = 0;
2542             }
2544             $displaycount = $displaypage = 0;
2546             while ($displaycount < $this->maxdisplay and $currpage < $lastpage) {
2547                 $displaypage = $currpage + 1;
2549                 if ($this->page == $currpage) {
2550                     $this->pagelinks[] = html_writer::span($displaypage, 'current-page');
2551                 } else {
2552                     $pagelink = html_writer::link(new moodle_url($this->baseurl, array($this->pagevar=>$currpage)), $displaypage);
2553                     $this->pagelinks[] = $pagelink;
2554                 }
2556                 $displaycount++;
2557                 $currpage++;
2558             }
2560             if ($currpage < $lastpage) {
2561                 $lastpageactual = $lastpage - 1;
2562                 $this->lastlink = html_writer::link(new moodle_url($this->baseurl, array($this->pagevar=>$lastpageactual)), $lastpage, array('class'=>'last'));
2563             }
2565             $pagenum = $this->page + 1;
2567             if ($pagenum != $lastpage) {
2568                 $this->nextlink = html_writer::link(new moodle_url($this->baseurl, array($this->pagevar=>$pagenum)), get_string('next'), array('class'=>'next'));
2569             }
2570         }
2571     }
2574 /**
2575  * This class represents how a block appears on a page.
2576  *
2577  * During output, each block instance is asked to return a block_contents object,
2578  * those are then passed to the $OUTPUT->block function for display.
2579  *
2580  * contents should probably be generated using a moodle_block_..._renderer.
2581  *
2582  * Other block-like things that need to appear on the page, for example the
2583  * add new block UI, are also represented as block_contents objects.
2584  *
2585  * @copyright 2009 Tim Hunt
2586  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2587  * @since Moodle 2.0
2588  * @package core
2589  * @category output
2590  */
2591 class block_contents {
2593     /** Used when the block cannot be collapsed **/
2594     const NOT_HIDEABLE = 0;
2596     /** Used when the block can be collapsed but currently is not **/
2597     const VISIBLE = 1;
2599     /** Used when the block has been collapsed **/
2600     const HIDDEN = 2;
2602     /**
2603      * @var int Used to set $skipid.
2604      */
2605     protected static $idcounter = 1;
2607     /**
2608      * @var int All the blocks (or things that look like blocks) printed on
2609      * a page are given a unique number that can be used to construct id="" attributes.
2610      * This is set automatically be the {@link prepare()} method.
2611      * Do not try to set it manually.
2612      */
2613     public $skipid;
2615     /**
2616      * @var int If this is the contents of a real block, this should be set
2617      * to the block_instance.id. Otherwise this should be set to 0.
2618      */
2619     public $blockinstanceid = 0;
2621     /**
2622      * @var int If this is a real block instance, and there is a corresponding
2623      * block_position.id for the block on this page, this should be set to that id.
2624      * Otherwise it should be 0.
2625      */
2626     public $blockpositionid = 0;
2628     /**
2629      * @var array An array of attribute => value pairs that are put on the outer div of this
2630      * block. {@link $id} and {@link $classes} attributes should be set separately.
2631      */
2632     public $attributes;
2634     /**
2635      * @var string The title of this block. If this came from user input, it should already
2636      * have had format_string() processing done on it. This will be output inside
2637      * <h2> tags. Please do not cause invalid XHTML.
2638      */
2639     public $title = '';
2641     /**
2642      * @var string The label to use when the block does not, or will not have a visible title.
2643      * You should never set this as well as title... it will just be ignored.
2644      */
2645     public $arialabel = '';
2647     /**
2648      * @var string HTML for the content
2649      */
2650     public $content = '';
2652     /**
2653      * @var array An alternative to $content, it you want a list of things with optional icons.
2654      */
2655     public $footer = '';
2657     /**
2658      * @var string Any small print that should appear under the block to explain
2659      * to the teacher about the block, for example 'This is a sticky block that was
2660      * added in the system context.'
2661      */
2662     public $annotation = '';
2664     /**
2665      * @var int One of the constants NOT_HIDEABLE, VISIBLE, HIDDEN. Whether
2666      * the user can toggle whether this block is visible.
2667      */
2668     public $collapsible = self::NOT_HIDEABLE;
2670     /**
2671      * Set this to true if the block is dockable.
2672      * @var bool
2673      */
2674     public $dockable = false;
2676     /**
2677      * @var array A (possibly empty) array of editing controls. Each element of
2678      * this array should be an array('url' => $url, 'icon' => $icon, 'caption' => $caption).
2679      * $icon is the icon name. Fed to $OUTPUT->pix_url.
2680      */
2681     public $controls = array();
2684     /**
2685      * Create new instance of block content
2686      * @param array $attributes
2687      */
2688     public function __construct(array $attributes = null) {
2689         $this->skipid = self::$idcounter;
2690         self::$idcounter += 1;
2692         if ($attributes) {
2693             // standard block
2694             $this->attributes = $attributes;
2695         } else {
2696             // simple "fake" blocks used in some modules and "Add new block" block
2697             $this->attributes = array('class'=>'block');
2698         }
2699     }
2701     /**
2702      * Add html class to block
2703      *
2704      * @param string $class
2705      */
2706     public function add_class($class) {
2707         $this->attributes['class'] .= ' '.$class;
2708     }
2712 /**
2713  * This class represents a target for where a block can go when it is being moved.
2714  *
2715  * This needs to be rendered as a form with the given hidden from fields, and
2716  * clicking anywhere in the form should submit it. The form action should be
2717  * $PAGE->url.
2718  *
2719  * @copyright 2009 Tim Hunt
2720  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2721  * @since Moodle 2.0
2722  * @package core
2723  * @category output
2724  */
2725 class block_move_target {
2727     /**
2728      * @var moodle_url Move url
2729      */
2730     public $url;
2732     /**
2733      * Constructor
2734      * @param moodle_url $url
2735      */
2736     public function __construct(moodle_url $url) {
2737         $this->url  = $url;
2738     }
2741 /**
2742  * Custom menu item
2743  *
2744  * This class is used to represent one item within a custom menu that may or may
2745  * not have children.
2746  *
2747  * @copyright 2010 Sam Hemelryk
2748  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2749  * @since Moodle 2.0
2750  * @package core
2751  * @category output
2752  */
2753 class custom_menu_item implements renderable, templatable {
2755     /**
2756      * @var string The text to show for the item
2757      */
2758     protected $text;
2760     /**
2761      * @var moodle_url The link to give the icon if it has no children
2762      */
2763     protected $url;
2765     /**
2766      * @var string A title to apply to the item. By default the text
2767      */
2768     protected $title;
2770     /**
2771      * @var int A sort order for the item, not necessary if you order things in
2772      * the CFG var.
2773      */
2774     protected $sort;
2776     /**
2777      * @var custom_menu_item A reference to the parent for this item or NULL if
2778      * it is a top level item
2779      */
2780     protected $parent;
2782     /**
2783      * @var array A array in which to store children this item has.
2784      */
2785     protected $children = array();
2787     /**
2788      * @var int A reference to the sort var of the last child that was added
2789      */
2790     protected $lastsort = 0;
2792     /**
2793      * Constructs the new custom menu item
2794      *
2795      * @param string $text
2796      * @param moodle_url $url A moodle url to apply as the link for this item [Optional]
2797      * @param string $title A title to apply to this item [Optional]
2798      * @param int $sort A sort or to use if we need to sort differently [Optional]
2799      * @param custom_menu_item $parent A reference to the parent custom_menu_item this child
2800      *        belongs to, only if the child has a parent. [Optional]
2801      */
2802     public function __construct($text, moodle_url $url=null, $title=null, $sort = null, custom_menu_item $parent = null) {
2803         $this->text = $text;
2804         $this->url = $url;
2805         $this->title = $title;
2806         $this->sort = (int)$sort;
2807         $this->parent = $parent;
2808     }
2810     /**
2811      * Adds a custom menu item as a child of this node given its properties.
2812      *
2813      * @param string $text
2814      * @param moodle_url $url
2815      * @param string $title
2816      * @param int $sort
2817      * @return custom_menu_item
2818      */
2819     public function add($text, moodle_url $url = null, $title = null, $sort = null) {
2820         $key = count($this->children);
2821         if (empty($sort)) {
2822             $sort = $this->lastsort + 1;
2823         }
2824         $this->children[$key] = new custom_menu_item($text, $url, $title, $sort, $this);
2825         $this->lastsort = (int)$sort;
2826         return $this->children[$key];
2827     }
2829     /**
2830      * Removes a custom menu item that is a child or descendant to the current menu.
2831      *
2832      * Returns true if child was found and removed.
2833      *
2834      * @param custom_menu_item $menuitem
2835      * @return bool
2836      */
2837     public function remove_child(custom_menu_item $menuitem) {
2838         $removed = false;
2839         if (($key = array_search($menuitem, $this->children)) !== false) {
2840             unset($this->children[$key]);
2841             $this->children = array_values($this->children);
2842             $removed = true;
2843         } else {
2844             foreach ($this->children as $child) {
2845                 if ($removed = $child->remove_child($menuitem)) {
2846                     break;
2847                 }
2848             }
2849         }
2850         return $removed;
2851     }
2853     /**
2854      * Returns the text for this item
2855      * @return string
2856      */
2857     public function get_text() {
2858         return $this->text;
2859     }
2861     /**
2862      * Returns the url for this item
2863      * @return moodle_url
2864      */
2865     public function get_url() {
2866         return $this->url;
2867     }
2869     /**
2870      * Returns the title for this item
2871      * @return string
2872      */
2873     public function get_title() {
2874         return $this->title;
2875     }
2877     /**
2878      * Sorts and returns the children for this item
2879      * @return array
2880      */
2881     public function get_children() {
2882         $this->sort();
2883         return $this->children;
2884     }
2886     /**
2887      * Gets the sort order for this child
2888      * @return int
2889      */
2890     public function get_sort_order() {
2891         return $this->sort;
2892     }
2894     /**
2895      * Gets the parent this child belong to
2896      * @return custom_menu_item
2897      */
2898     public function get_parent() {
2899         return $this->parent;
2900     }
2902     /**
2903      * Sorts the children this item has
2904      */
2905     public function sort() {
2906         usort($this->children, array('custom_menu','sort_custom_menu_items'));
2907     }
2909     /**
2910      * Returns true if this item has any children
2911      * @return bool
2912      */
2913     public function has_children() {
2914         return (count($this->children) > 0);
2915     }
2917     /**
2918      * Sets the text for the node
2919      * @param string $text
2920      */
2921     public function set_text($text) {
2922         $this->text = (string)$text;
2923     }
2925     /**
2926      * Sets the title for the node
2927      * @param string $title
2928      */
2929     public function set_title($title) {
2930         $this->title = (string)$title;
2931     }
2933     /**
2934      * Sets the url for the node
2935      * @param moodle_url $url
2936      */
2937     public function set_url(moodle_url $url) {
2938         $this->url = $url;
2939     }
2941     /**
2942      * Export this data so it can be used as the context for a mustache template.
2943      *
2944      * @param renderer_base $output Used to do a final render of any components that need to be rendered for export.
2945      * @return array
2946      */
2947     public function export_for_template(renderer_base $output) {
2948         global $CFG;
2950         require_once($CFG->libdir . '/externallib.php');
2952         $syscontext = context_system::instance();
2954         $context = new stdClass();
2955         $context->text = external_format_string($this->text, $syscontext->id);
2956         $context->url = $this->url ? $this->url->out() : null;
2957         $context->title = external_format_string($this->title, $syscontext->id);
2958         $context->sort = $this->sort;
2959         $context->children = array();
2960         if (preg_match("/^#+$/", $this->text)) {
2961             $context->divider = true;
2962         }
2963         $context->haschildren = !empty($this->children) && (count($this->children) > 0);
2964         foreach ($this->children as $child) {
2965             $child = $child->export_for_template($output);
2966             array_push($context->children, $child);
2967         }
2969         return $context;
2970     }
2973 /**
2974  * Custom menu class
2975  *
2976  * This class is used to operate a custom menu that can be rendered for the page.
2977  * The custom menu is built using $CFG->custommenuitems and is a structured collection
2978  * of custom_menu_item nodes that can be rendered by the core renderer.
2979  *
2980  * To configure the custom menu:
2981  *     Settings: Administration > Appearance > Themes > Theme settings
2982  *
2983  * @copyright 2010 Sam Hemelryk
2984  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2985  * @since Moodle 2.0
2986  * @package core
2987  * @category output
2988  */
2989 class custom_menu extends custom_menu_item {
2991     /**
2992      * @var string The language we should render for, null disables multilang support.
2993      */
2994     protected $currentlanguage = null;
2996     /**
2997      * Creates the custom menu
2998      *
2999      * @param string $definition the menu items definition in syntax required by {@link convert_text_to_menu_nodes()}
3000      * @param string $currentlanguage the current language code, null disables multilang support
3001      */
3002     public function __construct($definition = '', $currentlanguage = null) {
3003         $this->currentlanguage = $currentlanguage;
3004         parent::__construct('root'); // create virtual root element of the menu
3005         if (!empty($definition)) {
3006             $this->override_children(self::convert_text_to_menu_nodes($definition, $currentlanguage));
3007         }
3008     }
3010     /**
3011      * Overrides the children of this custom menu. Useful when getting children
3012      * from $CFG->custommenuitems
3013      *
3014      * @param array $children
3015      */
3016     public function override_children(array $children) {
3017         $this->children = array();
3018         foreach ($children as $child) {
3019             if ($child instanceof custom_menu_item) {
3020                 $this->children[] = $child;
3021             }
3022         }
3023     }
3025     /**
3026      * Converts a string into a structured array of custom_menu_items which can
3027      * then be added to a custom menu.
3028      *
3029      * Structure:
3030      *     text|url|title|langs
3031      * The number of hyphens at the start determines the depth of the item. The
3032      * languages are optional, comma separated list of languages the line is for.
3033      *
3034      * Example structure:
3035      *     First level first item|http://www.moodle.com/
3036      *     -Second level first item|http://www.moodle.com/partners/
3037      *     -Second level second item|http://www.moodle.com/hq/
3038      *     --Third level first item|http://www.moodle.com/jobs/
3039      *     -Second level third item|http://www.moodle.com/development/
3040      *     First level second item|http://www.moodle.com/feedback/
3041      *     First level third item
3042      *     English only|http://moodle.com|English only item|en
3043      *     German only|http://moodle.de|Deutsch|de,de_du,de_kids
3044      *
3045      *
3046      * @static
3047      * @param string $text the menu items definition
3048      * @param string $language the language code, null disables multilang support
3049      * @return array
3050      */
3051     public static function convert_text_to_menu_nodes($text, $language = null) {
3052         $root = new custom_menu();
3053         $lastitem = $root;
3054         $lastdepth = 0;
3055         $hiddenitems = array();
3056         $lines = explode("\n", $text);
3057         foreach ($lines as $linenumber => $line) {
3058             $line = trim($line);
3059             if (strlen($line) == 0) {
3060                 continue;
3061             }
3062             // Parse item settings.
3063             $itemtext = null;
3064             $itemurl = null;
3065             $itemtitle = null;
3066             $itemvisible = true;
3067             $settings = explode('|', $line);
3068             foreach ($settings as $i => $setting) {
3069                 $setting = trim($setting);
3070                 if (!empty($setting)) {
3071                     switch ($i) {
3072                         case 0:
3073                             $itemtext = ltrim($setting, '-');
3074                             $itemtitle = $itemtext;
3075                             break;
3076                         case 1:
3077                             try {
3078                                 $itemurl = new moodle_url($setting);
3079                             } catch (moodle_exception $exception) {
3080                                 // We're not actually worried about this, we don't want to mess up the display
3081                                 // just for a wrongly entered URL.
3082                                 $itemurl = null;
3083                             }
3084                             break;
3085                         case 2:
3086                             $itemtitle = $setting;
3087                             break;
3088                         case 3:
3089                             if (!empty($language)) {
3090                                 $itemlanguages = array_map('trim', explode(',', $setting));
3091                                 $itemvisible &= in_array($language, $itemlanguages);
3092                             }
3093                             break;
3094                     }
3095                 }
3096             }
3097             // Get depth of new item.
3098             preg_match('/^(\-*)/', $line, $match);
3099             $itemdepth = strlen($match[1]) + 1;
3100             // Find parent item for new item.
3101             while (($lastdepth - $itemdepth) >= 0) {
3102                 $lastitem = $lastitem->get_parent();
3103                 $lastdepth--;
3104             }
3105             $lastitem = $lastitem->add($itemtext, $itemurl, $itemtitle, $linenumber + 1);
3106             $lastdepth++;
3107             if (!$itemvisible) {
3108                 $hiddenitems[] = $lastitem;
3109             }
3110         }
3111         foreach ($hiddenitems as $item) {
3112             $item->parent->remove_child($item);
3113         }
3114         return $root->get_children();
3115     }
3117     /**
3118      * Sorts two custom menu items
3119      *
3120      * This function is designed to be used with the usort method
3121      *     usort($this->children, array('custom_menu','sort_custom_menu_items'));
3122      *
3123      * @static
3124      * @param custom_menu_item $itema
3125      * @param custom_menu_item $itemb
3126      * @return int
3127      */
3128     public static function sort_custom_menu_items(custom_menu_item $itema, custom_menu_item $itemb) {
3129         $itema = $itema->get_sort_order();
3130         $itemb = $itemb->get_sort_order();
3131         if ($itema == $itemb) {
3132             return 0;
3133         }
3134         return ($itema > $itemb) ? +1 : -1;
3135     }
3138 /**
3139  * Stores one tab
3140  *
3141  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3142  * @package core
3143  */
3144 class tabobject implements renderable, templatable {
3145     /** @var string unique id of the tab in this tree, it is used to find selected and/or inactive tabs */
3146     var $id;
3147     /** @var moodle_url|string link */
3148     var $link;
3149     /** @var string text on the tab */
3150     var $text;
3151     /** @var string title under the link, by defaul equals to text */
3152     var $title;
3153     /** @var bool whether to display a link under the tab name when it's selected */
3154     var $linkedwhenselected = false;
3155     /** @var bool whether the tab is inactive */
3156     var $inactive = false;
3157     /** @var bool indicates that this tab's child is selected */
3158     var $activated = false;
3159     /** @var bool indicates that this tab is selected */
3160     var $selected = false;
3161     /** @var array stores children tabobjects */
3162     var $subtree = array();
3163     /** @var int level of tab in the tree, 0 for root (instance of tabtree), 1 for the first row of tabs */
3164     var $level = 1;
3166     /**
3167      * Constructor
3168      *
3169      * @param string $id unique id of the tab in this tree, it is used to find selected and/or inactive tabs
3170      * @param string|moodle_url $link
3171      * @param string $text text on the tab
3172      * @param string $title title under the link, by defaul equals to text
3173      * @param bool $linkedwhenselected whether to display a link under the tab name when it's selected
3174      */
3175     public function __construct($id, $link = null, $text = '', $title = '', $linkedwhenselected = false) {
3176         $this->id = $id;
3177         $this->link = $link;
3178         $this->text = $text;
3179         $this->title = $title ? $title : $text;
3180         $this->linkedwhenselected = $linkedwhenselected;
3181     }
3183     /**
3184      * Travels through tree and finds the tab to mark as selected, all parents are automatically marked as activated
3185      *
3186      * @param string $selected the id of the selected tab (whatever row it's on),
3187      *    if null marks all tabs as unselected
3188      * @return bool whether this tab is selected or contains selected tab in its subtree
3189      */
3190     protected function set_selected($selected) {
3191         if ((string)$selected === (string)$this->id) {
3192             $this->selected = true;
3193             // This tab is selected. No need to travel through subtree.
3194             return true;
3195         }
3196         foreach ($this->subtree as $subitem) {
3197             if ($subitem->set_selected($selected)) {
3198                 // This tab has child that is selected. Mark it as activated. No need to check other children.
3199                 $this->activated = true;
3200                 return true;
3201             }
3202         }
3203         return false;
3204     }
3206     /**
3207      * Travels through tree and finds a tab with specified id
3208      *
3209      * @param string $id
3210      * @return tabtree|null
3211      */
3212     public function find($id) {
3213         if ((string)$this->id === (string)$id) {
3214             return $this;
3215         }
3216         foreach ($this->subtree as $tab) {
3217             if ($obj = $tab->find($id)) {
3218                 return $obj;
3219             }
3220         }
3221         return null;
3222     }
3224     /**
3225      * Allows to mark each tab's level in the tree before rendering.
3226      *
3227      * @param int $level
3228      */
3229     protected function set_level($level) {
3230         $this->level = $level;
3231         foreach ($this->subtree as $tab) {
3232             $tab->set_level($level + 1);
3233         }
3234     }
3236     /**
3237      * Export for template.
3238      *
3239      * @param renderer_base $output Renderer.
3240      * @return object
3241      */
3242     public function export_for_template(renderer_base $output) {
3243         if ($this->inactive || ($this->selected && !$this->linkedwhenselected) || $this->activated) {
3244             $link = null;
3245         } else {
3246             $link = $this->link;
3247         }
3248         $active = $this->activated || $this->selected;
3250         return (object) [
3251             'id' => $this->id,
3252             'link' => is_object($link) ? $link->out(false) : $link,
3253             'text' => $this->text,
3254             'title' => $this->title,
3255             'inactive' => !$active && $this->inactive,
3256             'active' => $active,
3257             'level' => $this->level,
3258         ];
3259     }
3263 /**
3264  * Renderable for the main page header.
3265  *
3266  * @package core
3267  * @category output
3268  * @since 2.9
3269  * @copyright 2015 Adrian Greeve <adrian@moodle.com>
3270  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3271  */
3272 class context_header implements renderable {
3274     /**
3275      * @var string $heading Main heading.
3276      */
3277     public $heading;
3278     /**
3279      * @var int $headinglevel Main heading 'h' tag level.
3280      */
3281     public $headinglevel;
3282     /**
3283      * @var string|null $imagedata HTML code for the picture in the page header.
3284      */
3285     public $imagedata;
3286     /**
3287      * @var array $additionalbuttons Additional buttons for the header e.g. Messaging button for the user header.
3288      *      array elements - title => alternate text for the image, or if no image is available the button text.
3289      *                       url => Link for the button to head to. Should be a moodle_url.
3290      *                       image => location to the image, or name of the image in /pix/t/{image name}.
3291      *                       linkattributes => additional attributes for the <a href> element.
3292      *                       page => page object. Don't include if the image is an external image.
3293      */
3294     public $additionalbuttons;
3296     /**
3297      * Constructor.
3298      *
3299      * @param string $heading Main heading data.
3300      * @param int $headinglevel Main heading 'h' tag level.
3301      * @param string|null $imagedata HTML code for the picture in the page header.
3302      * @param string $additionalbuttons Buttons for the header e.g. Messaging button for the user header.
3303      */
3304     public function __construct($heading = null, $headinglevel = 1, $imagedata = null, $additionalbuttons = null) {
3306         $this->heading = $heading;
3307         $this->headinglevel = $headinglevel;
3308         $this->imagedata = $imagedata;
3309         $this->additionalbuttons = $additionalbuttons;
3310         // If we have buttons then format them.
3311         if (isset($this->additionalbuttons)) {
3312             $this->format_button_images();
3313         }
3314     }
3316     /**
3317      * Adds an array element for a formatted image.
3318      */
3319     protected function format_button_images() {
3321         foreach ($this->additionalbuttons as $buttontype => $button) {
3322             $page = $button['page'];
3323             // If no image is provided then just use the title.
3324             if (!isset($button['image'])) {
3325                 $this->additionalbuttons[$buttontype]['formattedimage'] = $button['title'];
3326             } else {
3327                 // Check to see if this is an internal Moodle icon.
3328                 $internalimage = $page->theme->resolve_image_location('t/' . $button['image'], 'moodle');
3329                 if ($internalimage) {
3330                     $this->additionalbuttons[$buttontype]['formattedimage'] = 't/' . $button['image'];
3331                 } else {
3332                     // Treat as an external image.
3333                     $this->additionalbuttons[$buttontype]['formattedimage'] = $button['image'];
3334                 }
3335             }
3336             // Add the bootstrap 'btn' class for formatting.
3337             $this->additionalbuttons[$buttontype]['linkattributes'] = array_merge($button['linkattributes'],
3338                     array('class' => 'btn'));
3339         }
3340     }
3343 /**
3344  * Stores tabs list
3345  *
3346  * Example how to print a single line tabs:
3347  * $rows = array(
3348  *    new tabobject(...),
3349  *    new tabobject(...)
3350  * );
3351  * echo $OUTPUT->tabtree($rows, $selectedid);
3352  *
3353  * Multiple row tabs may not look good on some devices but if you want to use them
3354  * you can specify ->subtree for the active tabobject.
3355  *
3356  * @copyright 2013 Marina Glancy
3357  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3358  * @since Moodle 2.5
3359  * @package core
3360  * @category output
3361  */
3362 class tabtree extends tabobject {
3363     /**
3364      * Constuctor
3365      *
3366      * It is highly recommended to call constructor when list of tabs is already
3367      * populated, this way you ensure that selected and inactive tabs are located
3368      * and attribute level is set correctly.
3369      *
3370      * @param array $tabs array of tabs, each of them may have it's own ->subtree
3371      * @param string|null $selected which tab to mark as selected, all parent tabs will
3372      *     automatically be marked as activated
3373      * @param array|string|null $inactive list of ids of inactive tabs, regardless of
3374      *     their level. Note that you can as weel specify tabobject::$inactive for separate instances
3375      */
3376     public function __construct($tabs, $selected = null, $inactive = null) {
3377         $this->subtree = $tabs;
3378         if ($selected !== null) {
3379             $this->set_selected($selected);
3380         }
3381         if ($inactive !== null) {
3382             if (is_array($inactive)) {
3383                 foreach ($inactive as $id) {
3384                     if ($tab = $this->find($id)) {
3385                         $tab->inactive = true;
3386                     }
3387                 }
3388             } else if ($tab = $this->find($inactive)) {
3389                 $tab->inactive = true;
3390             }
3391         }
3392         $this->set_level(0);
3393     }
3395     /**
3396      * Export for template.
3397      *
3398      * @param renderer_base $output Renderer.
3399      * @return object
3400      */
3401     public function export_for_template(renderer_base $output) {
3402         $tabs = [];
3403         $secondrow = false;
3405         foreach ($this->subtree as $tab) {
3406             $tabs[] = $tab->export_for_template($output);
3407             if (!empty($tab->subtree) && ($tab->level == 0 || $tab->selected || $tab->activated)) {
3408                 $secondrow = new tabtree($tab->subtree);
3409             }
3410         }
3412         return (object) [
3413             'tabs' => $tabs,
3414             'secondrow' => $secondrow ? $secondrow->export_for_template($output) : false
3415         ];
3416     }
3419 /**
3420  * An action menu.
3421  *
3422  * This action menu component takes a series of primary and secondary actions.
3423  * The primary actions are displayed permanently and the secondary attributes are displayed within a drop
3424  * down menu.
3425  *
3426  * @package core
3427  * @category output
3428  * @copyright 2013 Sam Hemelryk
3429  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3430  */
3431 class action_menu implements renderable {
3433     /**
3434      * Top right alignment.
3435      */
3436     const TL = 1;
3438     /**
3439      * Top right alignment.
3440      */
3441     const TR = 2;
3443     /**
3444      * Top right alignment.
3445      */
3446     const BL = 3;
3448     /**
3449      * Top right alignment.
3450      */
3451     const BR = 4;
3453     /**
3454      * The instance number. This is unique to this instance of the action menu.
3455      * @var int
3456      */
3457     protected $instance = 0;
3459     /**
3460      * An array of primary actions. Please use {@link action_menu::add_primary_action()} to add actions.
3461      * @var array
3462      */
3463     protected $primaryactions = array();
3465     /**
3466      * An array of secondary actions. Please use {@link action_menu::add_secondary_action()} to add actions.
3467      * @var array
3468      */
3469     protected $secondaryactions = array();
3471     /**
3472      * An array of attributes added to the container of the action menu.
3473      * Initialised with defaults during construction.
3474      * @var array
3475      */
3476     public $attributes = array();
3477     /**
3478      * An array of attributes added to the container of the primary actions.
3479      * Initialised with defaults during construction.
3480      * @var array
3481      */
3482     public $attributesprimary = array();
3483     /**
3484      * An array of attributes added to the container of the secondary actions.
3485      * Initialised with defaults during construction.
3486      * @var array
3487      */
3488     public $attributessecondary = array();
3490     /**
3491      * The string to use next to the icon for the action icon relating to the secondary (dropdown) menu.
3492      * @var array
3493      */
3494     public $actiontext = null;
3496     /**
3497      * An icon to use for the toggling the secondary menu (dropdown).
3498      * @var actionicon
3499      */
3500     public $actionicon;
3502     /**
3503      * Any text to use for the toggling the secondary menu (dropdown).
3504      * @var menutrigger
3505      */
3506     public $menutrigger = '';
3508     /**
3509      * Place the action menu before all other actions.
3510      * @var prioritise
3511      */
3512     public $prioritise = false;
3514     /**
3515      * Constructs the action menu with the given items.
3516      *
3517      * @param array $actions An array of actions.
3518      */
3519     public function __construct(array $actions = array()) {
3520         static $initialised = 0;
3521         $this->instance = $initialised;
3522         $initialised++;
3524         $this->attributes = array(
3525             'id' => 'action-menu-'.$this->instance,
3526             'class' => 'moodle-actionmenu',
3527             'data-enhance' => 'moodle-core-actionmenu'
3528         );
3529         $this->attributesprimary = array(
3530             'id' => 'action-menu-'.$this->instance.'-menubar',
3531             'class' => 'menubar',
3532             'role' => 'menubar'
3533         );
3534         $this->attributessecondary = array(
3535             'id' => 'action-menu-'.$this->instance.'-menu',
3536             'class' => 'menu',
3537             'data-rel' => 'menu-content',
3538             'aria-labelledby' => 'action-menu-toggle-'.$this->instance,
3539             'role' => 'menu'
3540         );
3541         $this->set_alignment(self::TR, self::BR);
3542         for