Merge branch 'wip-MDL-49028-master' of git://github.com/abgreeve/moodle
[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 {
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     }
497 /**
498  * Data structure representing an icon.
499  *
500  * @copyright 2010 Petr Skoda
501  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
502  * @since Moodle 2.0
503  * @package core
504  * @category output
505  */
506 class pix_icon implements renderable, templatable {
508     /**
509      * @var string The icon name
510      */
511     var $pix;
513     /**
514      * @var string The component the icon belongs to.
515      */
516     var $component;
518     /**
519      * @var array An array of attributes to use on the icon
520      */
521     var $attributes = array();
523     /**
524      * Constructor
525      *
526      * @param string $pix short icon name
527      * @param string $alt The alt text to use for the icon
528      * @param string $component component name
529      * @param array $attributes html attributes
530      */
531     public function __construct($pix, $alt, $component='moodle', array $attributes = null) {
532         $this->pix        = $pix;
533         $this->component  = $component;
534         $this->attributes = (array)$attributes;
536         $this->attributes['alt'] = $alt;
537         if (empty($this->attributes['class'])) {
538             $this->attributes['class'] = 'smallicon';
539         }
540         if (!isset($this->attributes['title'])) {
541             $this->attributes['title'] = $this->attributes['alt'];
542         } else if (empty($this->attributes['title'])) {
543             // Remove the title attribute if empty, we probably want to use the parent node's title
544             // and some browsers might overwrite it with an empty title.
545             unset($this->attributes['title']);
546         }
547     }
549     /**
550      * Export this data so it can be used as the context for a mustache template.
551      *
552      * @param renderer_base $output Used to do a final render of any components that need to be rendered for export.
553      * @return array
554      */
555     public function export_for_template(renderer_base $output) {
556         $attributes = $this->attributes;
557         $attributes['src'] = $output->pix_url($this->pix, $this->component);
558         $templatecontext = array();
559         foreach ($attributes as $name => $value) {
560             $templatecontext[] = array('name' => $name, 'value' => $value);
561         }
562         $data = array('attributes' => $templatecontext);
564         return $data;
565     }
568 /**
569  * Data structure representing an emoticon image
570  *
571  * @copyright 2010 David Mudrak
572  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
573  * @since Moodle 2.0
574  * @package core
575  * @category output
576  */
577 class pix_emoticon extends pix_icon implements renderable {
579     /**
580      * Constructor
581      * @param string $pix short icon name
582      * @param string $alt alternative text
583      * @param string $component emoticon image provider
584      * @param array $attributes explicit HTML attributes
585      */
586     public function __construct($pix, $alt, $component = 'moodle', array $attributes = array()) {
587         if (empty($attributes['class'])) {
588             $attributes['class'] = 'emoticon';
589         }
590         parent::__construct($pix, $alt, $component, $attributes);
591     }
594 /**
595  * Data structure representing a simple form with only one button.
596  *
597  * @copyright 2009 Petr Skoda
598  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
599  * @since Moodle 2.0
600  * @package core
601  * @category output
602  */
603 class single_button implements renderable {
605     /**
606      * @var moodle_url Target url
607      */
608     var $url;
610     /**
611      * @var string Button label
612      */
613     var $label;
615     /**
616      * @var string Form submit method post or get
617      */
618     var $method = 'post';
620     /**
621      * @var string Wrapping div class
622      */
623     var $class = 'singlebutton';
625     /**
626      * @var bool True if button disabled, false if normal
627      */
628     var $disabled = false;
630     /**
631      * @var string Button tooltip
632      */
633     var $tooltip = null;
635     /**
636      * @var string Form id
637      */
638     var $formid;
640     /**
641      * @var array List of attached actions
642      */
643     var $actions = array();
645     /**
646      * @var array $params URL Params
647      */
648     var $params;
650     /**
651      * @var string Action id
652      */
653     var $actionid;
655     /**
656      * Constructor
657      * @param moodle_url $url
658      * @param string $label button text
659      * @param string $method get or post submit method
660      */
661     public function __construct(moodle_url $url, $label, $method='post') {
662         $this->url    = clone($url);
663         $this->label  = $label;
664         $this->method = $method;
665     }
667     /**
668      * Shortcut for adding a JS confirm dialog when the button is clicked.
669      * The message must be a yes/no question.
670      *
671      * @param string $confirmmessage The yes/no confirmation question. If "Yes" is clicked, the original action will occur.
672      */
673     public function add_confirm_action($confirmmessage) {
674         $this->add_action(new confirm_action($confirmmessage));
675     }
677     /**
678      * Add action to the button.
679      * @param component_action $action
680      */
681     public function add_action(component_action $action) {
682         $this->actions[] = $action;
683     }
687 /**
688  * Simple form with just one select field that gets submitted automatically.
689  *
690  * If JS not enabled small go button is printed too.
691  *
692  * @copyright 2009 Petr Skoda
693  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
694  * @since Moodle 2.0
695  * @package core
696  * @category output
697  */
698 class single_select implements renderable {
700     /**
701      * @var moodle_url Target url - includes hidden fields
702      */
703     var $url;
705     /**
706      * @var string Name of the select element.
707      */
708     var $name;
710     /**
711      * @var array $options associative array value=>label ex.: array(1=>'One, 2=>Two)
712      *     it is also possible to specify optgroup as complex label array ex.:
713      *         array(array('Odd'=>array(1=>'One', 3=>'Three)), array('Even'=>array(2=>'Two')))
714      *         array(1=>'One', '--1uniquekey'=>array('More'=>array(2=>'Two', 3=>'Three')))
715      */
716     var $options;
718     /**
719      * @var string Selected option
720      */
721     var $selected;
723     /**
724      * @var array Nothing selected
725      */
726     var $nothing;
728     /**
729      * @var array Extra select field attributes
730      */
731     var $attributes = array();
733     /**
734      * @var string Button label
735      */
736     var $label = '';
738     /**
739      * @var array Button label's attributes
740      */
741     var $labelattributes = array();
743     /**
744      * @var string Form submit method post or get
745      */
746     var $method = 'get';
748     /**
749      * @var string Wrapping div class
750      */
751     var $class = 'singleselect';
753     /**
754      * @var bool True if button disabled, false if normal
755      */
756     var $disabled = false;
758     /**
759      * @var string Button tooltip
760      */
761     var $tooltip = null;
763     /**
764      * @var string Form id
765      */
766     var $formid = null;
768     /**
769      * @var array List of attached actions
770      */
771     var $helpicon = null;
773     /**
774      * Constructor
775      * @param moodle_url $url form action target, includes hidden fields
776      * @param string $name name of selection field - the changing parameter in url
777      * @param array $options list of options
778      * @param string $selected selected element
779      * @param array $nothing
780      * @param string $formid
781      */
782     public function __construct(moodle_url $url, $name, array $options, $selected = '', $nothing = array('' => 'choosedots'), $formid = null) {
783         $this->url      = $url;
784         $this->name     = $name;
785         $this->options  = $options;
786         $this->selected = $selected;
787         $this->nothing  = $nothing;
788         $this->formid   = $formid;
789     }
791     /**
792      * Shortcut for adding a JS confirm dialog when the button is clicked.
793      * The message must be a yes/no question.
794      *
795      * @param string $confirmmessage The yes/no confirmation question. If "Yes" is clicked, the original action will occur.
796      */
797     public function add_confirm_action($confirmmessage) {
798         $this->add_action(new component_action('submit', 'M.util.show_confirm_dialog', array('message' => $confirmmessage)));
799     }
801     /**
802      * Add action to the button.
803      *
804      * @param component_action $action
805      */
806     public function add_action(component_action $action) {
807         $this->actions[] = $action;
808     }
810     /**
811      * Adds help icon.
812      *
813      * @deprecated since Moodle 2.0
814      */
815     public function set_old_help_icon($helppage, $title, $component = 'moodle') {
816         throw new coding_exception('set_old_help_icon() can not be used any more, please see set_help_icon().');
817     }
819     /**
820      * Adds help icon.
821      *
822      * @param string $identifier The keyword that defines a help page
823      * @param string $component
824      */
825     public function set_help_icon($identifier, $component = 'moodle') {
826         $this->helpicon = new help_icon($identifier, $component);
827     }
829     /**
830      * Sets select's label
831      *
832      * @param string $label
833      * @param array $attributes (optional)
834      */
835     public function set_label($label, $attributes = array()) {
836         $this->label = $label;
837         $this->labelattributes = $attributes;
839     }
842 /**
843  * Simple URL selection widget description.
844  *
845  * @copyright 2009 Petr Skoda
846  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
847  * @since Moodle 2.0
848  * @package core
849  * @category output
850  */
851 class url_select implements renderable {
852     /**
853      * @var array $urls associative array value=>label ex.: array(1=>'One, 2=>Two)
854      *     it is also possible to specify optgroup as complex label array ex.:
855      *         array(array('Odd'=>array(1=>'One', 3=>'Three)), array('Even'=>array(2=>'Two')))
856      *         array(1=>'One', '--1uniquekey'=>array('More'=>array(2=>'Two', 3=>'Three')))
857      */
858     var $urls;
860     /**
861      * @var string Selected option
862      */
863     var $selected;
865     /**
866      * @var array Nothing selected
867      */
868     var $nothing;
870     /**
871      * @var array Extra select field attributes
872      */
873     var $attributes = array();
875     /**
876      * @var string Button label
877      */
878     var $label = '';
880     /**
881      * @var array Button label's attributes
882      */
883     var $labelattributes = array();
885     /**
886      * @var string Wrapping div class
887      */
888     var $class = 'urlselect';
890     /**
891      * @var bool True if button disabled, false if normal
892      */
893     var $disabled = false;
895     /**
896      * @var string Button tooltip
897      */
898     var $tooltip = null;
900     /**
901      * @var string Form id
902      */
903     var $formid = null;
905     /**
906      * @var array List of attached actions
907      */
908     var $helpicon = null;
910     /**
911      * @var string If set, makes button visible with given name for button
912      */
913     var $showbutton = null;
915     /**
916      * Constructor
917      * @param array $urls list of options
918      * @param string $selected selected element
919      * @param array $nothing
920      * @param string $formid
921      * @param string $showbutton Set to text of button if it should be visible
922      *   or null if it should be hidden (hidden version always has text 'go')
923      */
924     public function __construct(array $urls, $selected = '', $nothing = array('' => 'choosedots'), $formid = null, $showbutton = null) {
925         $this->urls       = $urls;
926         $this->selected   = $selected;
927         $this->nothing    = $nothing;
928         $this->formid     = $formid;
929         $this->showbutton = $showbutton;
930     }
932     /**
933      * Adds help icon.
934      *
935      * @deprecated since Moodle 2.0
936      */
937     public function set_old_help_icon($helppage, $title, $component = 'moodle') {
938         throw new coding_exception('set_old_help_icon() can not be used any more, please see set_help_icon().');
939     }
941     /**
942      * Adds help icon.
943      *
944      * @param string $identifier The keyword that defines a help page
945      * @param string $component
946      */
947     public function set_help_icon($identifier, $component = 'moodle') {
948         $this->helpicon = new help_icon($identifier, $component);
949     }
951     /**
952      * Sets select's label
953      *
954      * @param string $label
955      * @param array $attributes (optional)
956      */
957     public function set_label($label, $attributes = array()) {
958         $this->label = $label;
959         $this->labelattributes = $attributes;
960     }
963 /**
964  * Data structure describing html link with special action attached.
965  *
966  * @copyright 2010 Petr Skoda
967  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
968  * @since Moodle 2.0
969  * @package core
970  * @category output
971  */
972 class action_link implements renderable {
974     /**
975      * @var moodle_url Href url
976      */
977     public $url;
979     /**
980      * @var string Link text HTML fragment
981      */
982     public $text;
984     /**
985      * @var array HTML attributes
986      */
987     public $attributes;
989     /**
990      * @var array List of actions attached to link
991      */
992     public $actions;
994     /**
995      * @var pix_icon Optional pix icon to render with the link
996      */
997     public $icon;
999     /**
1000      * Constructor
1001      * @param moodle_url $url
1002      * @param string $text HTML fragment
1003      * @param component_action $action
1004      * @param array $attributes associative array of html link attributes + disabled
1005      * @param pix_icon $icon optional pix_icon to render with the link text
1006      */
1007     public function __construct(moodle_url $url,
1008                                 $text,
1009                                 component_action $action=null,
1010                                 array $attributes=null,
1011                                 pix_icon $icon=null) {
1012         $this->url = clone($url);
1013         $this->text = $text;
1014         $this->attributes = (array)$attributes;
1015         if ($action) {
1016             $this->add_action($action);
1017         }
1018         $this->icon = $icon;
1019     }
1021     /**
1022      * Add action to the link.
1023      *
1024      * @param component_action $action
1025      */
1026     public function add_action(component_action $action) {
1027         $this->actions[] = $action;
1028     }
1030     /**
1031      * Adds a CSS class to this action link object
1032      * @param string $class
1033      */
1034     public function add_class($class) {
1035         if (empty($this->attributes['class'])) {
1036             $this->attributes['class'] = $class;
1037         } else {
1038             $this->attributes['class'] .= ' ' . $class;
1039         }
1040     }
1042     /**
1043      * Returns true if the specified class has been added to this link.
1044      * @param string $class
1045      * @return bool
1046      */
1047     public function has_class($class) {
1048         return strpos(' ' . $this->attributes['class'] . ' ', ' ' . $class . ' ') !== false;
1049     }
1052 /**
1053  * Simple html output class
1054  *
1055  * @copyright 2009 Tim Hunt, 2010 Petr Skoda
1056  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1057  * @since Moodle 2.0
1058  * @package core
1059  * @category output
1060  */
1061 class html_writer {
1063     /**
1064      * Outputs a tag with attributes and contents
1065      *
1066      * @param string $tagname The name of tag ('a', 'img', 'span' etc.)
1067      * @param string $contents What goes between the opening and closing tags
1068      * @param array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
1069      * @return string HTML fragment
1070      */
1071     public static function tag($tagname, $contents, array $attributes = null) {
1072         return self::start_tag($tagname, $attributes) . $contents . self::end_tag($tagname);
1073     }
1075     /**
1076      * Outputs an opening tag with attributes
1077      *
1078      * @param string $tagname The name of tag ('a', 'img', 'span' etc.)
1079      * @param array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
1080      * @return string HTML fragment
1081      */
1082     public static function start_tag($tagname, array $attributes = null) {
1083         return '<' . $tagname . self::attributes($attributes) . '>';
1084     }
1086     /**
1087      * Outputs a closing tag
1088      *
1089      * @param string $tagname The name of tag ('a', 'img', 'span' etc.)
1090      * @return string HTML fragment
1091      */
1092     public static function end_tag($tagname) {
1093         return '</' . $tagname . '>';
1094     }
1096     /**
1097      * Outputs an empty tag with attributes
1098      *
1099      * @param string $tagname The name of tag ('input', 'img', 'br' etc.)
1100      * @param array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
1101      * @return string HTML fragment
1102      */
1103     public static function empty_tag($tagname, array $attributes = null) {
1104         return '<' . $tagname . self::attributes($attributes) . ' />';
1105     }
1107     /**
1108      * Outputs a tag, but only if the contents are not empty
1109      *
1110      * @param string $tagname The name of tag ('a', 'img', 'span' etc.)
1111      * @param string $contents What goes between the opening and closing tags
1112      * @param array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
1113      * @return string HTML fragment
1114      */
1115     public static function nonempty_tag($tagname, $contents, array $attributes = null) {
1116         if ($contents === '' || is_null($contents)) {
1117             return '';
1118         }
1119         return self::tag($tagname, $contents, $attributes);
1120     }
1122     /**
1123      * Outputs a HTML attribute and value
1124      *
1125      * @param string $name The name of the attribute ('src', 'href', 'class' etc.)
1126      * @param string $value The value of the attribute. The value will be escaped with {@link s()}
1127      * @return string HTML fragment
1128      */
1129     public static function attribute($name, $value) {
1130         if ($value instanceof moodle_url) {
1131             return ' ' . $name . '="' . $value->out() . '"';
1132         }
1134         // special case, we do not want these in output
1135         if ($value === null) {
1136             return '';
1137         }
1139         // no sloppy trimming here!
1140         return ' ' . $name . '="' . s($value) . '"';
1141     }
1143     /**
1144      * Outputs a list of HTML attributes and values
1145      *
1146      * @param array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
1147      *       The values will be escaped with {@link s()}
1148      * @return string HTML fragment
1149      */
1150     public static function attributes(array $attributes = null) {
1151         $attributes = (array)$attributes;
1152         $output = '';
1153         foreach ($attributes as $name => $value) {
1154             $output .= self::attribute($name, $value);
1155         }
1156         return $output;
1157     }
1159     /**
1160      * Generates a simple image tag with attributes.
1161      *
1162      * @param string $src The source of image
1163      * @param string $alt The alternate text for image
1164      * @param array $attributes The tag attributes (array('height' => $max_height, 'class' => 'class1') etc.)
1165      * @return string HTML fragment
1166      */
1167     public static function img($src, $alt, array $attributes = null) {
1168         $attributes = (array)$attributes;
1169         $attributes['src'] = $src;
1170         $attributes['alt'] = $alt;
1172         return self::empty_tag('img', $attributes);
1173     }
1175     /**
1176      * Generates random html element id.
1177      *
1178      * @staticvar int $counter
1179      * @staticvar type $uniq
1180      * @param string $base A string fragment that will be included in the random ID.
1181      * @return string A unique ID
1182      */
1183     public static function random_id($base='random') {
1184         static $counter = 0;
1185         static $uniq;
1187         if (!isset($uniq)) {
1188             $uniq = uniqid();
1189         }
1191         $counter++;
1192         return $base.$uniq.$counter;
1193     }
1195     /**
1196      * Generates a simple html link
1197      *
1198      * @param string|moodle_url $url The URL
1199      * @param string $text The text
1200      * @param array $attributes HTML attributes
1201      * @return string HTML fragment
1202      */
1203     public static function link($url, $text, array $attributes = null) {
1204         $attributes = (array)$attributes;
1205         $attributes['href']  = $url;
1206         return self::tag('a', $text, $attributes);
1207     }
1209     /**
1210      * Generates a simple checkbox with optional label
1211      *
1212      * @param string $name The name of the checkbox
1213      * @param string $value The value of the checkbox
1214      * @param bool $checked Whether the checkbox is checked
1215      * @param string $label The label for the checkbox
1216      * @param array $attributes Any attributes to apply to the checkbox
1217      * @return string html fragment
1218      */
1219     public static function checkbox($name, $value, $checked = true, $label = '', array $attributes = null) {
1220         $attributes = (array)$attributes;
1221         $output = '';
1223         if ($label !== '' and !is_null($label)) {
1224             if (empty($attributes['id'])) {
1225                 $attributes['id'] = self::random_id('checkbox_');
1226             }
1227         }
1228         $attributes['type']    = 'checkbox';
1229         $attributes['value']   = $value;
1230         $attributes['name']    = $name;
1231         $attributes['checked'] = $checked ? 'checked' : null;
1233         $output .= self::empty_tag('input', $attributes);
1235         if ($label !== '' and !is_null($label)) {
1236             $output .= self::tag('label', $label, array('for'=>$attributes['id']));
1237         }
1239         return $output;
1240     }
1242     /**
1243      * Generates a simple select yes/no form field
1244      *
1245      * @param string $name name of select element
1246      * @param bool $selected
1247      * @param array $attributes - html select element attributes
1248      * @return string HTML fragment
1249      */
1250     public static function select_yes_no($name, $selected=true, array $attributes = null) {
1251         $options = array('1'=>get_string('yes'), '0'=>get_string('no'));
1252         return self::select($options, $name, $selected, null, $attributes);
1253     }
1255     /**
1256      * Generates a simple select form field
1257      *
1258      * @param array $options associative array value=>label ex.:
1259      *                array(1=>'One, 2=>Two)
1260      *              it is also possible to specify optgroup as complex label array ex.:
1261      *                array(array('Odd'=>array(1=>'One', 3=>'Three)), array('Even'=>array(2=>'Two')))
1262      *                array(1=>'One', '--1uniquekey'=>array('More'=>array(2=>'Two', 3=>'Three')))
1263      * @param string $name name of select element
1264      * @param string|array $selected value or array of values depending on multiple attribute
1265      * @param array|bool $nothing add nothing selected option, or false of not added
1266      * @param array $attributes html select element attributes
1267      * @return string HTML fragment
1268      */
1269     public static function select(array $options, $name, $selected = '', $nothing = array('' => 'choosedots'), array $attributes = null) {
1270         $attributes = (array)$attributes;
1271         if (is_array($nothing)) {
1272             foreach ($nothing as $k=>$v) {
1273                 if ($v === 'choose' or $v === 'choosedots') {
1274                     $nothing[$k] = get_string('choosedots');
1275                 }
1276             }
1277             $options = $nothing + $options; // keep keys, do not override
1279         } else if (is_string($nothing) and $nothing !== '') {
1280             // BC
1281             $options = array(''=>$nothing) + $options;
1282         }
1284         // we may accept more values if multiple attribute specified
1285         $selected = (array)$selected;
1286         foreach ($selected as $k=>$v) {
1287             $selected[$k] = (string)$v;
1288         }
1290         if (!isset($attributes['id'])) {
1291             $id = 'menu'.$name;
1292             // name may contaion [], which would make an invalid id. e.g. numeric question type editing form, assignment quickgrading
1293             $id = str_replace('[', '', $id);
1294             $id = str_replace(']', '', $id);
1295             $attributes['id'] = $id;
1296         }
1298         if (!isset($attributes['class'])) {
1299             $class = 'menu'.$name;
1300             // name may contaion [], which would make an invalid class. e.g. numeric question type editing form, assignment quickgrading
1301             $class = str_replace('[', '', $class);
1302             $class = str_replace(']', '', $class);
1303             $attributes['class'] = $class;
1304         }
1305         $attributes['class'] = 'select ' . $attributes['class']; // Add 'select' selector always
1307         $attributes['name'] = $name;
1309         if (!empty($attributes['disabled'])) {
1310             $attributes['disabled'] = 'disabled';
1311         } else {
1312             unset($attributes['disabled']);
1313         }
1315         $output = '';
1316         foreach ($options as $value=>$label) {
1317             if (is_array($label)) {
1318                 // ignore key, it just has to be unique
1319                 $output .= self::select_optgroup(key($label), current($label), $selected);
1320             } else {
1321                 $output .= self::select_option($label, $value, $selected);
1322             }
1323         }
1324         return self::tag('select', $output, $attributes);
1325     }
1327     /**
1328      * Returns HTML to display a select box option.
1329      *
1330      * @param string $label The label to display as the option.
1331      * @param string|int $value The value the option represents
1332      * @param array $selected An array of selected options
1333      * @return string HTML fragment
1334      */
1335     private static function select_option($label, $value, array $selected) {
1336         $attributes = array();
1337         $value = (string)$value;
1338         if (in_array($value, $selected, true)) {
1339             $attributes['selected'] = 'selected';
1340         }
1341         $attributes['value'] = $value;
1342         return self::tag('option', $label, $attributes);
1343     }
1345     /**
1346      * Returns HTML to display a select box option group.
1347      *
1348      * @param string $groupname The label to use for the group
1349      * @param array $options The options in the group
1350      * @param array $selected An array of selected values.
1351      * @return string HTML fragment.
1352      */
1353     private static function select_optgroup($groupname, $options, array $selected) {
1354         if (empty($options)) {
1355             return '';
1356         }
1357         $attributes = array('label'=>$groupname);
1358         $output = '';
1359         foreach ($options as $value=>$label) {
1360             $output .= self::select_option($label, $value, $selected);
1361         }
1362         return self::tag('optgroup', $output, $attributes);
1363     }
1365     /**
1366      * This is a shortcut for making an hour selector menu.
1367      *
1368      * @param string $type The type of selector (years, months, days, hours, minutes)
1369      * @param string $name fieldname
1370      * @param int $currenttime A default timestamp in GMT
1371      * @param int $step minute spacing
1372      * @param array $attributes - html select element attributes
1373      * @return HTML fragment
1374      */
1375     public static function select_time($type, $name, $currenttime = 0, $step = 5, array $attributes = null) {
1376         if (!$currenttime) {
1377             $currenttime = time();
1378         }
1379         $currentdate = usergetdate($currenttime);
1380         $userdatetype = $type;
1381         $timeunits = array();
1383         switch ($type) {
1384             case 'years':
1385                 for ($i=1970; $i<=2020; $i++) {
1386                     $timeunits[$i] = $i;
1387                 }
1388                 $userdatetype = 'year';
1389                 break;
1390             case 'months':
1391                 for ($i=1; $i<=12; $i++) {
1392                     $timeunits[$i] = userdate(gmmktime(12,0,0,$i,15,2000), "%B");
1393                 }
1394                 $userdatetype = 'month';
1395                 $currentdate['month'] = (int)$currentdate['mon'];
1396                 break;
1397             case 'days':
1398                 for ($i=1; $i<=31; $i++) {
1399                     $timeunits[$i] = $i;
1400                 }
1401                 $userdatetype = 'mday';
1402                 break;
1403             case 'hours':
1404                 for ($i=0; $i<=23; $i++) {
1405                     $timeunits[$i] = sprintf("%02d",$i);
1406                 }
1407                 break;
1408             case 'minutes':
1409                 if ($step != 1) {
1410                     $currentdate['minutes'] = ceil($currentdate['minutes']/$step)*$step;
1411                 }
1413                 for ($i=0; $i<=59; $i+=$step) {
1414                     $timeunits[$i] = sprintf("%02d",$i);
1415                 }
1416                 break;
1417             default:
1418                 throw new coding_exception("Time type $type is not supported by html_writer::select_time().");
1419         }
1421         if (empty($attributes['id'])) {
1422             $attributes['id'] = self::random_id('ts_');
1423         }
1424         $timerselector = self::select($timeunits, $name, $currentdate[$userdatetype], null, $attributes);
1425         $label = self::tag('label', get_string(substr($type, 0, -1), 'form'), array('for'=>$attributes['id'], 'class'=>'accesshide'));
1427         return $label.$timerselector;
1428     }
1430     /**
1431      * Shortcut for quick making of lists
1432      *
1433      * Note: 'list' is a reserved keyword ;-)
1434      *
1435      * @param array $items
1436      * @param array $attributes
1437      * @param string $tag ul or ol
1438      * @return string
1439      */
1440     public static function alist(array $items, array $attributes = null, $tag = 'ul') {
1441         $output = html_writer::start_tag($tag, $attributes)."\n";
1442         foreach ($items as $item) {
1443             $output .= html_writer::tag('li', $item)."\n";
1444         }
1445         $output .= html_writer::end_tag($tag);
1446         return $output;
1447     }
1449     /**
1450      * Returns hidden input fields created from url parameters.
1451      *
1452      * @param moodle_url $url
1453      * @param array $exclude list of excluded parameters
1454      * @return string HTML fragment
1455      */
1456     public static function input_hidden_params(moodle_url $url, array $exclude = null) {
1457         $exclude = (array)$exclude;
1458         $params = $url->params();
1459         foreach ($exclude as $key) {
1460             unset($params[$key]);
1461         }
1463         $output = '';
1464         foreach ($params as $key => $value) {
1465             $attributes = array('type'=>'hidden', 'name'=>$key, 'value'=>$value);
1466             $output .= self::empty_tag('input', $attributes)."\n";
1467         }
1468         return $output;
1469     }
1471     /**
1472      * Generate a script tag containing the the specified code.
1473      *
1474      * @param string $jscode the JavaScript code
1475      * @param moodle_url|string $url optional url of the external script, $code ignored if specified
1476      * @return string HTML, the code wrapped in <script> tags.
1477      */
1478     public static function script($jscode, $url=null) {
1479         if ($jscode) {
1480             $attributes = array('type'=>'text/javascript');
1481             return self::tag('script', "\n//<![CDATA[\n$jscode\n//]]>\n", $attributes) . "\n";
1483         } else if ($url) {
1484             $attributes = array('type'=>'text/javascript', 'src'=>$url);
1485             return self::tag('script', '', $attributes) . "\n";
1487         } else {
1488             return '';
1489         }
1490     }
1492     /**
1493      * Renders HTML table
1494      *
1495      * This method may modify the passed instance by adding some default properties if they are not set yet.
1496      * If this is not what you want, you should make a full clone of your data before passing them to this
1497      * method. In most cases this is not an issue at all so we do not clone by default for performance
1498      * and memory consumption reasons.
1499      *
1500      * @param html_table $table data to be rendered
1501      * @return string HTML code
1502      */
1503     public static function table(html_table $table) {
1504         // prepare table data and populate missing properties with reasonable defaults
1505         if (!empty($table->align)) {
1506             foreach ($table->align as $key => $aa) {
1507                 if ($aa) {
1508                     $table->align[$key] = 'text-align:'. fix_align_rtl($aa) .';';  // Fix for RTL languages
1509                 } else {
1510                     $table->align[$key] = null;
1511                 }
1512             }
1513         }
1514         if (!empty($table->size)) {
1515             foreach ($table->size as $key => $ss) {
1516                 if ($ss) {
1517                     $table->size[$key] = 'width:'. $ss .';';
1518                 } else {
1519                     $table->size[$key] = null;
1520                 }
1521             }
1522         }
1523         if (!empty($table->wrap)) {
1524             foreach ($table->wrap as $key => $ww) {
1525                 if ($ww) {
1526                     $table->wrap[$key] = 'white-space:nowrap;';
1527                 } else {
1528                     $table->wrap[$key] = '';
1529                 }
1530             }
1531         }
1532         if (!empty($table->head)) {
1533             foreach ($table->head as $key => $val) {
1534                 if (!isset($table->align[$key])) {
1535                     $table->align[$key] = null;
1536                 }
1537                 if (!isset($table->size[$key])) {
1538                     $table->size[$key] = null;
1539                 }
1540                 if (!isset($table->wrap[$key])) {
1541                     $table->wrap[$key] = null;
1542                 }
1544             }
1545         }
1546         if (empty($table->attributes['class'])) {
1547             $table->attributes['class'] = 'generaltable';
1548         }
1549         if (!empty($table->tablealign)) {
1550             $table->attributes['class'] .= ' boxalign' . $table->tablealign;
1551         }
1553         // explicitly assigned properties override those defined via $table->attributes
1554         $table->attributes['class'] = trim($table->attributes['class']);
1555         $attributes = array_merge($table->attributes, array(
1556                 'id'            => $table->id,
1557                 'width'         => $table->width,
1558                 'summary'       => $table->summary,
1559                 'cellpadding'   => $table->cellpadding,
1560                 'cellspacing'   => $table->cellspacing,
1561             ));
1562         $output = html_writer::start_tag('table', $attributes) . "\n";
1564         $countcols = 0;
1566         // Output a caption if present.
1567         if (!empty($table->caption)) {
1568             $captionattributes = array();
1569             if ($table->captionhide) {
1570                 $captionattributes['class'] = 'accesshide';
1571             }
1572             $output .= html_writer::tag(
1573                 'caption',
1574                 $table->caption,
1575                 $captionattributes
1576             );
1577         }
1579         if (!empty($table->head)) {
1580             $countcols = count($table->head);
1582             $output .= html_writer::start_tag('thead', array()) . "\n";
1583             $output .= html_writer::start_tag('tr', array()) . "\n";
1584             $keys = array_keys($table->head);
1585             $lastkey = end($keys);
1587             foreach ($table->head as $key => $heading) {
1588                 // Convert plain string headings into html_table_cell objects
1589                 if (!($heading instanceof html_table_cell)) {
1590                     $headingtext = $heading;
1591                     $heading = new html_table_cell();
1592                     $heading->text = $headingtext;
1593                     $heading->header = true;
1594                 }
1596                 if ($heading->header !== false) {
1597                     $heading->header = true;
1598                 }
1600                 if ($heading->header && empty($heading->scope)) {
1601                     $heading->scope = 'col';
1602                 }
1604                 $heading->attributes['class'] .= ' header c' . $key;
1605                 if (isset($table->headspan[$key]) && $table->headspan[$key] > 1) {
1606                     $heading->colspan = $table->headspan[$key];
1607                     $countcols += $table->headspan[$key] - 1;
1608                 }
1610                 if ($key == $lastkey) {
1611                     $heading->attributes['class'] .= ' lastcol';
1612                 }
1613                 if (isset($table->colclasses[$key])) {
1614                     $heading->attributes['class'] .= ' ' . $table->colclasses[$key];
1615                 }
1616                 $heading->attributes['class'] = trim($heading->attributes['class']);
1617                 $attributes = array_merge($heading->attributes, array(
1618                         'style'     => $table->align[$key] . $table->size[$key] . $heading->style,
1619                         'scope'     => $heading->scope,
1620                         'colspan'   => $heading->colspan,
1621                     ));
1623                 $tagtype = 'td';
1624                 if ($heading->header === true) {
1625                     $tagtype = 'th';
1626                 }
1627                 $output .= html_writer::tag($tagtype, $heading->text, $attributes) . "\n";
1628             }
1629             $output .= html_writer::end_tag('tr') . "\n";
1630             $output .= html_writer::end_tag('thead') . "\n";
1632             if (empty($table->data)) {
1633                 // For valid XHTML strict every table must contain either a valid tr
1634                 // or a valid tbody... both of which must contain a valid td
1635                 $output .= html_writer::start_tag('tbody', array('class' => 'empty'));
1636                 $output .= html_writer::tag('tr', html_writer::tag('td', '', array('colspan'=>count($table->head))));
1637                 $output .= html_writer::end_tag('tbody');
1638             }
1639         }
1641         if (!empty($table->data)) {
1642             $keys       = array_keys($table->data);
1643             $lastrowkey = end($keys);
1644             $output .= html_writer::start_tag('tbody', array());
1646             foreach ($table->data as $key => $row) {
1647                 if (($row === 'hr') && ($countcols)) {
1648                     $output .= html_writer::tag('td', html_writer::tag('div', '', array('class' => 'tabledivider')), array('colspan' => $countcols));
1649                 } else {
1650                     // Convert array rows to html_table_rows and cell strings to html_table_cell objects
1651                     if (!($row instanceof html_table_row)) {
1652                         $newrow = new html_table_row();
1654                         foreach ($row as $cell) {
1655                             if (!($cell instanceof html_table_cell)) {
1656                                 $cell = new html_table_cell($cell);
1657                             }
1658                             $newrow->cells[] = $cell;
1659                         }
1660                         $row = $newrow;
1661                     }
1663                     if (isset($table->rowclasses[$key])) {
1664                         $row->attributes['class'] .= ' ' . $table->rowclasses[$key];
1665                     }
1667                     if ($key == $lastrowkey) {
1668                         $row->attributes['class'] .= ' lastrow';
1669                     }
1671                     // Explicitly assigned properties should override those defined in the attributes.
1672                     $row->attributes['class'] = trim($row->attributes['class']);
1673                     $trattributes = array_merge($row->attributes, array(
1674                             'id'            => $row->id,
1675                             'style'         => $row->style,
1676                         ));
1677                     $output .= html_writer::start_tag('tr', $trattributes) . "\n";
1678                     $keys2 = array_keys($row->cells);
1679                     $lastkey = end($keys2);
1681                     $gotlastkey = false; //flag for sanity checking
1682                     foreach ($row->cells as $key => $cell) {
1683                         if ($gotlastkey) {
1684                             //This should never happen. Why do we have a cell after the last cell?
1685                             mtrace("A cell with key ($key) was found after the last key ($lastkey)");
1686                         }
1688                         if (!($cell instanceof html_table_cell)) {
1689                             $mycell = new html_table_cell();
1690                             $mycell->text = $cell;
1691                             $cell = $mycell;
1692                         }
1694                         if (($cell->header === true) && empty($cell->scope)) {
1695                             $cell->scope = 'row';
1696                         }
1698                         if (isset($table->colclasses[$key])) {
1699                             $cell->attributes['class'] .= ' ' . $table->colclasses[$key];
1700                         }
1702                         $cell->attributes['class'] .= ' cell c' . $key;
1703                         if ($key == $lastkey) {
1704                             $cell->attributes['class'] .= ' lastcol';
1705                             $gotlastkey = true;
1706                         }
1707                         $tdstyle = '';
1708                         $tdstyle .= isset($table->align[$key]) ? $table->align[$key] : '';
1709                         $tdstyle .= isset($table->size[$key]) ? $table->size[$key] : '';
1710                         $tdstyle .= isset($table->wrap[$key]) ? $table->wrap[$key] : '';
1711                         $cell->attributes['class'] = trim($cell->attributes['class']);
1712                         $tdattributes = array_merge($cell->attributes, array(
1713                                 'style' => $tdstyle . $cell->style,
1714                                 'colspan' => $cell->colspan,
1715                                 'rowspan' => $cell->rowspan,
1716                                 'id' => $cell->id,
1717                                 'abbr' => $cell->abbr,
1718                                 'scope' => $cell->scope,
1719                             ));
1720                         $tagtype = 'td';
1721                         if ($cell->header === true) {
1722                             $tagtype = 'th';
1723                         }
1724                         $output .= html_writer::tag($tagtype, $cell->text, $tdattributes) . "\n";
1725                     }
1726                 }
1727                 $output .= html_writer::end_tag('tr') . "\n";
1728             }
1729             $output .= html_writer::end_tag('tbody') . "\n";
1730         }
1731         $output .= html_writer::end_tag('table') . "\n";
1733         return $output;
1734     }
1736     /**
1737      * Renders form element label
1738      *
1739      * By default, the label is suffixed with a label separator defined in the
1740      * current language pack (colon by default in the English lang pack).
1741      * Adding the colon can be explicitly disabled if needed. Label separators
1742      * are put outside the label tag itself so they are not read by
1743      * screenreaders (accessibility).
1744      *
1745      * Parameter $for explicitly associates the label with a form control. When
1746      * set, the value of this attribute must be the same as the value of
1747      * the id attribute of the form control in the same document. When null,
1748      * the label being defined is associated with the control inside the label
1749      * element.
1750      *
1751      * @param string $text content of the label tag
1752      * @param string|null $for id of the element this label is associated with, null for no association
1753      * @param bool $colonize add label separator (colon) to the label text, if it is not there yet
1754      * @param array $attributes to be inserted in the tab, for example array('accesskey' => 'a')
1755      * @return string HTML of the label element
1756      */
1757     public static function label($text, $for, $colonize = true, array $attributes=array()) {
1758         if (!is_null($for)) {
1759             $attributes = array_merge($attributes, array('for' => $for));
1760         }
1761         $text = trim($text);
1762         $label = self::tag('label', $text, $attributes);
1764         // TODO MDL-12192 $colonize disabled for now yet
1765         // if (!empty($text) and $colonize) {
1766         //     // the $text may end with the colon already, though it is bad string definition style
1767         //     $colon = get_string('labelsep', 'langconfig');
1768         //     if (!empty($colon)) {
1769         //         $trimmed = trim($colon);
1770         //         if ((substr($text, -strlen($trimmed)) == $trimmed) or (substr($text, -1) == ':')) {
1771         //             //debugging('The label text should not end with colon or other label separator,
1772         //             //           please fix the string definition.', DEBUG_DEVELOPER);
1773         //         } else {
1774         //             $label .= $colon;
1775         //         }
1776         //     }
1777         // }
1779         return $label;
1780     }
1782     /**
1783      * Combines a class parameter with other attributes. Aids in code reduction
1784      * because the class parameter is very frequently used.
1785      *
1786      * If the class attribute is specified both in the attributes and in the
1787      * class parameter, the two values are combined with a space between.
1788      *
1789      * @param string $class Optional CSS class (or classes as space-separated list)
1790      * @param array $attributes Optional other attributes as array
1791      * @return array Attributes (or null if still none)
1792      */
1793     private static function add_class($class = '', array $attributes = null) {
1794         if ($class !== '') {
1795             $classattribute = array('class' => $class);
1796             if ($attributes) {
1797                 if (array_key_exists('class', $attributes)) {
1798                     $attributes['class'] = trim($attributes['class'] . ' ' . $class);
1799                 } else {
1800                     $attributes = $classattribute + $attributes;
1801                 }
1802             } else {
1803                 $attributes = $classattribute;
1804             }
1805         }
1806         return $attributes;
1807     }
1809     /**
1810      * Creates a <div> tag. (Shortcut function.)
1811      *
1812      * @param string $content HTML content of tag
1813      * @param string $class Optional CSS class (or classes as space-separated list)
1814      * @param array $attributes Optional other attributes as array
1815      * @return string HTML code for div
1816      */
1817     public static function div($content, $class = '', array $attributes = null) {
1818         return self::tag('div', $content, self::add_class($class, $attributes));
1819     }
1821     /**
1822      * Starts a <div> tag. (Shortcut function.)
1823      *
1824      * @param string $class Optional CSS class (or classes as space-separated list)
1825      * @param array $attributes Optional other attributes as array
1826      * @return string HTML code for open div tag
1827      */
1828     public static function start_div($class = '', array $attributes = null) {
1829         return self::start_tag('div', self::add_class($class, $attributes));
1830     }
1832     /**
1833      * Ends a <div> tag. (Shortcut function.)
1834      *
1835      * @return string HTML code for close div tag
1836      */
1837     public static function end_div() {
1838         return self::end_tag('div');
1839     }
1841     /**
1842      * Creates a <span> tag. (Shortcut function.)
1843      *
1844      * @param string $content HTML content of tag
1845      * @param string $class Optional CSS class (or classes as space-separated list)
1846      * @param array $attributes Optional other attributes as array
1847      * @return string HTML code for span
1848      */
1849     public static function span($content, $class = '', array $attributes = null) {
1850         return self::tag('span', $content, self::add_class($class, $attributes));
1851     }
1853     /**
1854      * Starts a <span> tag. (Shortcut function.)
1855      *
1856      * @param string $class Optional CSS class (or classes as space-separated list)
1857      * @param array $attributes Optional other attributes as array
1858      * @return string HTML code for open span tag
1859      */
1860     public static function start_span($class = '', array $attributes = null) {
1861         return self::start_tag('span', self::add_class($class, $attributes));
1862     }
1864     /**
1865      * Ends a <span> tag. (Shortcut function.)
1866      *
1867      * @return string HTML code for close span tag
1868      */
1869     public static function end_span() {
1870         return self::end_tag('span');
1871     }
1874 /**
1875  * Simple javascript output class
1876  *
1877  * @copyright 2010 Petr Skoda
1878  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1879  * @since Moodle 2.0
1880  * @package core
1881  * @category output
1882  */
1883 class js_writer {
1885     /**
1886      * Returns javascript code calling the function
1887      *
1888      * @param string $function function name, can be complex like Y.Event.purgeElement
1889      * @param array $arguments parameters
1890      * @param int $delay execution delay in seconds
1891      * @return string JS code fragment
1892      */
1893     public static function function_call($function, array $arguments = null, $delay=0) {
1894         if ($arguments) {
1895             $arguments = array_map('json_encode', convert_to_array($arguments));
1896             $arguments = implode(', ', $arguments);
1897         } else {
1898             $arguments = '';
1899         }
1900         $js = "$function($arguments);";
1902         if ($delay) {
1903             $delay = $delay * 1000; // in miliseconds
1904             $js = "setTimeout(function() { $js }, $delay);";
1905         }
1906         return $js . "\n";
1907     }
1909     /**
1910      * Special function which adds Y as first argument of function call.
1911      *
1912      * @param string $function The function to call
1913      * @param array $extraarguments Any arguments to pass to it
1914      * @return string Some JS code
1915      */
1916     public static function function_call_with_Y($function, array $extraarguments = null) {
1917         if ($extraarguments) {
1918             $extraarguments = array_map('json_encode', convert_to_array($extraarguments));
1919             $arguments = 'Y, ' . implode(', ', $extraarguments);
1920         } else {
1921             $arguments = 'Y';
1922         }
1923         return "$function($arguments);\n";
1924     }
1926     /**
1927      * Returns JavaScript code to initialise a new object
1928      *
1929      * @param string $var If it is null then no var is assigned the new object.
1930      * @param string $class The class to initialise an object for.
1931      * @param array $arguments An array of args to pass to the init method.
1932      * @param array $requirements Any modules required for this class.
1933      * @param int $delay The delay before initialisation. 0 = no delay.
1934      * @return string Some JS code
1935      */
1936     public static function object_init($var, $class, array $arguments = null, array $requirements = null, $delay=0) {
1937         if (is_array($arguments)) {
1938             $arguments = array_map('json_encode', convert_to_array($arguments));
1939             $arguments = implode(', ', $arguments);
1940         }
1942         if ($var === null) {
1943             $js = "new $class(Y, $arguments);";
1944         } else if (strpos($var, '.')!==false) {
1945             $js = "$var = new $class(Y, $arguments);";
1946         } else {
1947             $js = "var $var = new $class(Y, $arguments);";
1948         }
1950         if ($delay) {
1951             $delay = $delay * 1000; // in miliseconds
1952             $js = "setTimeout(function() { $js }, $delay);";
1953         }
1955         if (count($requirements) > 0) {
1956             $requirements = implode("', '", $requirements);
1957             $js = "Y.use('$requirements', function(Y){ $js });";
1958         }
1959         return $js."\n";
1960     }
1962     /**
1963      * Returns code setting value to variable
1964      *
1965      * @param string $name
1966      * @param mixed $value json serialised value
1967      * @param bool $usevar add var definition, ignored for nested properties
1968      * @return string JS code fragment
1969      */
1970     public static function set_variable($name, $value, $usevar = true) {
1971         $output = '';
1973         if ($usevar) {
1974             if (strpos($name, '.')) {
1975                 $output .= '';
1976             } else {
1977                 $output .= 'var ';
1978             }
1979         }
1981         $output .= "$name = ".json_encode($value).";";
1983         return $output;
1984     }
1986     /**
1987      * Writes event handler attaching code
1988      *
1989      * @param array|string $selector standard YUI selector for elements, may be
1990      *     array or string, element id is in the form "#idvalue"
1991      * @param string $event A valid DOM event (click, mousedown, change etc.)
1992      * @param string $function The name of the function to call
1993      * @param array $arguments An optional array of argument parameters to pass to the function
1994      * @return string JS code fragment
1995      */
1996     public static function event_handler($selector, $event, $function, array $arguments = null) {
1997         $selector = json_encode($selector);
1998         $output = "Y.on('$event', $function, $selector, null";
1999         if (!empty($arguments)) {
2000             $output .= ', ' . json_encode($arguments);
2001         }
2002         return $output . ");\n";
2003     }
2006 /**
2007  * Holds all the information required to render a <table> by {@link core_renderer::table()}
2008  *
2009  * Example of usage:
2010  * $t = new html_table();
2011  * ... // set various properties of the object $t as described below
2012  * echo html_writer::table($t);
2013  *
2014  * @copyright 2009 David Mudrak <david.mudrak@gmail.com>
2015  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2016  * @since Moodle 2.0
2017  * @package core
2018  * @category output
2019  */
2020 class html_table {
2022     /**
2023      * @var string Value to use for the id attribute of the table
2024      */
2025     public $id = null;
2027     /**
2028      * @var array Attributes of HTML attributes for the <table> element
2029      */
2030     public $attributes = array();
2032     /**
2033      * @var array An array of headings. The n-th array item is used as a heading of the n-th column.
2034      * For more control over the rendering of the headers, an array of html_table_cell objects
2035      * can be passed instead of an array of strings.
2036      *
2037      * Example of usage:
2038      * $t->head = array('Student', 'Grade');
2039      */
2040     public $head;
2042     /**
2043      * @var array An array that can be used to make a heading span multiple columns.
2044      * In this example, {@link html_table:$data} is supposed to have three columns. For the first two columns,
2045      * the same heading is used. Therefore, {@link html_table::$head} should consist of two items.
2046      *
2047      * Example of usage:
2048      * $t->headspan = array(2,1);
2049      */
2050     public $headspan;
2052     /**
2053      * @var array An array of column alignments.
2054      * The value is used as CSS 'text-align' property. Therefore, possible
2055      * values are 'left', 'right', 'center' and 'justify'. Specify 'right' or 'left' from the perspective
2056      * of a left-to-right (LTR) language. For RTL, the values are flipped automatically.
2057      *
2058      * Examples of usage:
2059      * $t->align = array(null, 'right');
2060      * or
2061      * $t->align[1] = 'right';
2062      */
2063     public $align;
2065     /**
2066      * @var array The value is used as CSS 'size' property.
2067      *
2068      * Examples of usage:
2069      * $t->size = array('50%', '50%');
2070      * or
2071      * $t->size[1] = '120px';
2072      */
2073     public $size;
2075     /**
2076      * @var array An array of wrapping information.
2077      * The only possible value is 'nowrap' that sets the
2078      * CSS property 'white-space' to the value 'nowrap' in the given column.
2079      *
2080      * Example of usage:
2081      * $t->wrap = array(null, 'nowrap');
2082      */
2083     public $wrap;
2085     /**
2086      * @var array Array of arrays or html_table_row objects containing the data. Alternatively, if you have
2087      * $head specified, the string 'hr' (for horizontal ruler) can be used
2088      * instead of an array of cells data resulting in a divider rendered.
2089      *
2090      * Example of usage with array of arrays:
2091      * $row1 = array('Harry Potter', '76 %');
2092      * $row2 = array('Hermione Granger', '100 %');
2093      * $t->data = array($row1, $row2);
2094      *
2095      * Example with array of html_table_row objects: (used for more fine-grained control)
2096      * $cell1 = new html_table_cell();
2097      * $cell1->text = 'Harry Potter';
2098      * $cell1->colspan = 2;
2099      * $row1 = new html_table_row();
2100      * $row1->cells[] = $cell1;
2101      * $cell2 = new html_table_cell();
2102      * $cell2->text = 'Hermione Granger';
2103      * $cell3 = new html_table_cell();
2104      * $cell3->text = '100 %';
2105      * $row2 = new html_table_row();
2106      * $row2->cells = array($cell2, $cell3);
2107      * $t->data = array($row1, $row2);
2108      */
2109     public $data;
2111     /**
2112      * @deprecated since Moodle 2.0. Styling should be in the CSS.
2113      * @var string Width of the table, percentage of the page preferred.
2114      */
2115     public $width = null;
2117     /**
2118      * @deprecated since Moodle 2.0. Styling should be in the CSS.
2119      * @var string Alignment for the whole table. Can be 'right', 'left' or 'center' (default).
2120      */
2121     public $tablealign = null;
2123     /**
2124      * @deprecated since Moodle 2.0. Styling should be in the CSS.
2125      * @var int Padding on each cell, in pixels
2126      */
2127     public $cellpadding = null;
2129     /**
2130      * @var int Spacing between cells, in pixels
2131      * @deprecated since Moodle 2.0. Styling should be in the CSS.
2132      */
2133     public $cellspacing = null;
2135     /**
2136      * @var array Array of classes to add to particular rows, space-separated string.
2137      * Class 'lastrow' is added automatically for the last row in the table.
2138      *
2139      * Example of usage:
2140      * $t->rowclasses[9] = 'tenth'
2141      */
2142     public $rowclasses;
2144     /**
2145      * @var array An array of classes to add to every cell in a particular column,
2146      * space-separated string. Class 'cell' is added automatically by the renderer.
2147      * Classes 'c0' or 'c1' are added automatically for every odd or even column,
2148      * respectively. Class 'lastcol' is added automatically for all last cells
2149      * in a row.
2150      *
2151      * Example of usage:
2152      * $t->colclasses = array(null, 'grade');
2153      */
2154     public $colclasses;
2156     /**
2157      * @var string Description of the contents for screen readers.
2158      */
2159     public $summary;
2161     /**
2162      * @var string Caption for the table, typically a title.
2163      *
2164      * Example of usage:
2165      * $t->caption = "TV Guide";
2166      */
2167     public $caption;
2169     /**
2170      * @var bool Whether to hide the table's caption from sighted users.
2171      *
2172      * Example of usage:
2173      * $t->caption = "TV Guide";
2174      * $t->captionhide = true;
2175      */
2176     public $captionhide = false;
2178     /**
2179      * Constructor
2180      */
2181     public function __construct() {
2182         $this->attributes['class'] = '';
2183     }
2186 /**
2187  * Component representing a table row.
2188  *
2189  * @copyright 2009 Nicolas Connault
2190  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2191  * @since Moodle 2.0
2192  * @package core
2193  * @category output
2194  */
2195 class html_table_row {
2197     /**
2198      * @var string Value to use for the id attribute of the row.
2199      */
2200     public $id = null;
2202     /**
2203      * @var array Array of html_table_cell objects
2204      */
2205     public $cells = array();
2207     /**
2208      * @var string Value to use for the style attribute of the table row
2209      */
2210     public $style = null;
2212     /**
2213      * @var array Attributes of additional HTML attributes for the <tr> element
2214      */
2215     public $attributes = array();
2217     /**
2218      * Constructor
2219      * @param array $cells
2220      */
2221     public function __construct(array $cells=null) {
2222         $this->attributes['class'] = '';
2223         $cells = (array)$cells;
2224         foreach ($cells as $cell) {
2225             if ($cell instanceof html_table_cell) {
2226                 $this->cells[] = $cell;
2227             } else {
2228                 $this->cells[] = new html_table_cell($cell);
2229             }
2230         }
2231     }
2234 /**
2235  * Component representing a table cell.
2236  *
2237  * @copyright 2009 Nicolas Connault
2238  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2239  * @since Moodle 2.0
2240  * @package core
2241  * @category output
2242  */
2243 class html_table_cell {
2245     /**
2246      * @var string Value to use for the id attribute of the cell.
2247      */
2248     public $id = null;
2250     /**
2251      * @var string The contents of the cell.
2252      */
2253     public $text;
2255     /**
2256      * @var string Abbreviated version of the contents of the cell.
2257      */
2258     public $abbr = null;
2260     /**
2261      * @var int Number of columns this cell should span.
2262      */
2263     public $colspan = null;
2265     /**
2266      * @var int Number of rows this cell should span.
2267      */
2268     public $rowspan = null;
2270     /**
2271      * @var string Defines a way to associate header cells and data cells in a table.
2272      */
2273     public $scope = null;
2275     /**
2276      * @var bool Whether or not this cell is a header cell.
2277      */
2278     public $header = null;
2280     /**
2281      * @var string Value to use for the style attribute of the table cell
2282      */
2283     public $style = null;
2285     /**
2286      * @var array Attributes of additional HTML attributes for the <td> element
2287      */
2288     public $attributes = array();
2290     /**
2291      * Constructs a table cell
2292      *
2293      * @param string $text
2294      */
2295     public function __construct($text = null) {
2296         $this->text = $text;
2297         $this->attributes['class'] = '';
2298     }
2301 /**
2302  * Component representing a paging bar.
2303  *
2304  * @copyright 2009 Nicolas Connault
2305  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2306  * @since Moodle 2.0
2307  * @package core
2308  * @category output
2309  */
2310 class paging_bar implements renderable {
2312     /**
2313      * @var int The maximum number of pagelinks to display.
2314      */
2315     public $maxdisplay = 18;
2317     /**
2318      * @var int The total number of entries to be pages through..
2319      */
2320     public $totalcount;
2322     /**
2323      * @var int The page you are currently viewing.
2324      */
2325     public $page;
2327     /**
2328      * @var int The number of entries that should be shown per page.
2329      */
2330     public $perpage;
2332     /**
2333      * @var string|moodle_url If this  is a string then it is the url which will be appended with $pagevar,
2334      * an equals sign and the page number.
2335      * If this is a moodle_url object then the pagevar param will be replaced by
2336      * the page no, for each page.
2337      */
2338     public $baseurl;
2340     /**
2341      * @var string This is the variable name that you use for the pagenumber in your
2342      * code (ie. 'tablepage', 'blogpage', etc)
2343      */
2344     public $pagevar;
2346     /**
2347      * @var string A HTML link representing the "previous" page.
2348      */
2349     public $previouslink = null;
2351     /**
2352      * @var string A HTML link representing the "next" page.
2353      */
2354     public $nextlink = null;
2356     /**
2357      * @var string A HTML link representing the first page.
2358      */
2359     public $firstlink = null;
2361     /**
2362      * @var string A HTML link representing the last page.
2363      */
2364     public $lastlink = null;
2366     /**
2367      * @var array An array of strings. One of them is just a string: the current page
2368      */
2369     public $pagelinks = array();
2371     /**
2372      * Constructor paging_bar with only the required params.
2373      *
2374      * @param int $totalcount The total number of entries available to be paged through
2375      * @param int $page The page you are currently viewing
2376      * @param int $perpage The number of entries that should be shown per page
2377      * @param string|moodle_url $baseurl url of the current page, the $pagevar parameter is added
2378      * @param string $pagevar name of page parameter that holds the page number
2379      */
2380     public function __construct($totalcount, $page, $perpage, $baseurl, $pagevar = 'page') {
2381         $this->totalcount = $totalcount;
2382         $this->page       = $page;
2383         $this->perpage    = $perpage;
2384         $this->baseurl    = $baseurl;
2385         $this->pagevar    = $pagevar;
2386     }
2388     /**
2389      * Prepares the paging bar for output.
2390      *
2391      * This method validates the arguments set up for the paging bar and then
2392      * produces fragments of HTML to assist display later on.
2393      *
2394      * @param renderer_base $output
2395      * @param moodle_page $page
2396      * @param string $target
2397      * @throws coding_exception
2398      */
2399     public function prepare(renderer_base $output, moodle_page $page, $target) {
2400         if (!isset($this->totalcount) || is_null($this->totalcount)) {
2401             throw new coding_exception('paging_bar requires a totalcount value.');
2402         }
2403         if (!isset($this->page) || is_null($this->page)) {
2404             throw new coding_exception('paging_bar requires a page value.');
2405         }
2406         if (empty($this->perpage)) {
2407             throw new coding_exception('paging_bar requires a perpage value.');
2408         }
2409         if (empty($this->baseurl)) {
2410             throw new coding_exception('paging_bar requires a baseurl value.');
2411         }
2413         if ($this->totalcount > $this->perpage) {
2414             $pagenum = $this->page - 1;
2416             if ($this->page > 0) {
2417                 $this->previouslink = html_writer::link(new moodle_url($this->baseurl, array($this->pagevar=>$pagenum)), get_string('previous'), array('class'=>'previous'));
2418             }
2420             if ($this->perpage > 0) {
2421                 $lastpage = ceil($this->totalcount / $this->perpage);
2422             } else {
2423                 $lastpage = 1;
2424             }
2426             if ($this->page > round(($this->maxdisplay/3)*2)) {
2427                 $currpage = $this->page - round($this->maxdisplay/3);
2429                 $this->firstlink = html_writer::link(new moodle_url($this->baseurl, array($this->pagevar=>0)), '1', array('class'=>'first'));
2430             } else {
2431                 $currpage = 0;
2432             }
2434             $displaycount = $displaypage = 0;
2436             while ($displaycount < $this->maxdisplay and $currpage < $lastpage) {
2437                 $displaypage = $currpage + 1;
2439                 if ($this->page == $currpage) {
2440                     $this->pagelinks[] = html_writer::span($displaypage, 'current-page');
2441                 } else {
2442                     $pagelink = html_writer::link(new moodle_url($this->baseurl, array($this->pagevar=>$currpage)), $displaypage);
2443                     $this->pagelinks[] = $pagelink;
2444                 }
2446                 $displaycount++;
2447                 $currpage++;
2448             }
2450             if ($currpage < $lastpage) {
2451                 $lastpageactual = $lastpage - 1;
2452                 $this->lastlink = html_writer::link(new moodle_url($this->baseurl, array($this->pagevar=>$lastpageactual)), $lastpage, array('class'=>'last'));
2453             }
2455             $pagenum = $this->page + 1;
2457             if ($pagenum != $displaypage) {
2458                 $this->nextlink = html_writer::link(new moodle_url($this->baseurl, array($this->pagevar=>$pagenum)), get_string('next'), array('class'=>'next'));
2459             }
2460         }
2461     }
2464 /**
2465  * This class represents how a block appears on a page.
2466  *
2467  * During output, each block instance is asked to return a block_contents object,
2468  * those are then passed to the $OUTPUT->block function for display.
2469  *
2470  * contents should probably be generated using a moodle_block_..._renderer.
2471  *
2472  * Other block-like things that need to appear on the page, for example the
2473  * add new block UI, are also represented as block_contents objects.
2474  *
2475  * @copyright 2009 Tim Hunt
2476  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2477  * @since Moodle 2.0
2478  * @package core
2479  * @category output
2480  */
2481 class block_contents {
2483     /** Used when the block cannot be collapsed **/
2484     const NOT_HIDEABLE = 0;
2486     /** Used when the block can be collapsed but currently is not **/
2487     const VISIBLE = 1;
2489     /** Used when the block has been collapsed **/
2490     const HIDDEN = 2;
2492     /**
2493      * @var int Used to set $skipid.
2494      */
2495     protected static $idcounter = 1;
2497     /**
2498      * @var int All the blocks (or things that look like blocks) printed on
2499      * a page are given a unique number that can be used to construct id="" attributes.
2500      * This is set automatically be the {@link prepare()} method.
2501      * Do not try to set it manually.
2502      */
2503     public $skipid;
2505     /**
2506      * @var int If this is the contents of a real block, this should be set
2507      * to the block_instance.id. Otherwise this should be set to 0.
2508      */
2509     public $blockinstanceid = 0;
2511     /**
2512      * @var int If this is a real block instance, and there is a corresponding
2513      * block_position.id for the block on this page, this should be set to that id.
2514      * Otherwise it should be 0.
2515      */
2516     public $blockpositionid = 0;
2518     /**
2519      * @var array An array of attribute => value pairs that are put on the outer div of this
2520      * block. {@link $id} and {@link $classes} attributes should be set separately.
2521      */
2522     public $attributes;
2524     /**
2525      * @var string The title of this block. If this came from user input, it should already
2526      * have had format_string() processing done on it. This will be output inside
2527      * <h2> tags. Please do not cause invalid XHTML.
2528      */
2529     public $title = '';
2531     /**
2532      * @var string The label to use when the block does not, or will not have a visible title.
2533      * You should never set this as well as title... it will just be ignored.
2534      */
2535     public $arialabel = '';
2537     /**
2538      * @var string HTML for the content
2539      */
2540     public $content = '';
2542     /**
2543      * @var array An alternative to $content, it you want a list of things with optional icons.
2544      */
2545     public $footer = '';
2547     /**
2548      * @var string Any small print that should appear under the block to explain
2549      * to the teacher about the block, for example 'This is a sticky block that was
2550      * added in the system context.'
2551      */
2552     public $annotation = '';
2554     /**
2555      * @var int One of the constants NOT_HIDEABLE, VISIBLE, HIDDEN. Whether
2556      * the user can toggle whether this block is visible.
2557      */
2558     public $collapsible = self::NOT_HIDEABLE;
2560     /**
2561      * Set this to true if the block is dockable.
2562      * @var bool
2563      */
2564     public $dockable = false;
2566     /**
2567      * @var array A (possibly empty) array of editing controls. Each element of
2568      * this array should be an array('url' => $url, 'icon' => $icon, 'caption' => $caption).
2569      * $icon is the icon name. Fed to $OUTPUT->pix_url.
2570      */
2571     public $controls = array();
2574     /**
2575      * Create new instance of block content
2576      * @param array $attributes
2577      */
2578     public function __construct(array $attributes = null) {
2579         $this->skipid = self::$idcounter;
2580         self::$idcounter += 1;
2582         if ($attributes) {
2583             // standard block
2584             $this->attributes = $attributes;
2585         } else {
2586             // simple "fake" blocks used in some modules and "Add new block" block
2587             $this->attributes = array('class'=>'block');
2588         }
2589     }
2591     /**
2592      * Add html class to block
2593      *
2594      * @param string $class
2595      */
2596     public function add_class($class) {
2597         $this->attributes['class'] .= ' '.$class;
2598     }
2602 /**
2603  * This class represents a target for where a block can go when it is being moved.
2604  *
2605  * This needs to be rendered as a form with the given hidden from fields, and
2606  * clicking anywhere in the form should submit it. The form action should be
2607  * $PAGE->url.
2608  *
2609  * @copyright 2009 Tim Hunt
2610  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2611  * @since Moodle 2.0
2612  * @package core
2613  * @category output
2614  */
2615 class block_move_target {
2617     /**
2618      * @var moodle_url Move url
2619      */
2620     public $url;
2622     /**
2623      * Constructor
2624      * @param moodle_url $url
2625      */
2626     public function __construct(moodle_url $url) {
2627         $this->url  = $url;
2628     }
2631 /**
2632  * Custom menu item
2633  *
2634  * This class is used to represent one item within a custom menu that may or may
2635  * not have children.
2636  *
2637  * @copyright 2010 Sam Hemelryk
2638  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2639  * @since Moodle 2.0
2640  * @package core
2641  * @category output
2642  */
2643 class custom_menu_item implements renderable {
2645     /**
2646      * @var string The text to show for the item
2647      */
2648     protected $text;
2650     /**
2651      * @var moodle_url The link to give the icon if it has no children
2652      */
2653     protected $url;
2655     /**
2656      * @var string A title to apply to the item. By default the text
2657      */
2658     protected $title;
2660     /**
2661      * @var int A sort order for the item, not necessary if you order things in
2662      * the CFG var.
2663      */
2664     protected $sort;
2666     /**
2667      * @var custom_menu_item A reference to the parent for this item or NULL if
2668      * it is a top level item
2669      */
2670     protected $parent;
2672     /**
2673      * @var array A array in which to store children this item has.
2674      */
2675     protected $children = array();
2677     /**
2678      * @var int A reference to the sort var of the last child that was added
2679      */
2680     protected $lastsort = 0;
2682     /**
2683      * Constructs the new custom menu item
2684      *
2685      * @param string $text
2686      * @param moodle_url $url A moodle url to apply as the link for this item [Optional]
2687      * @param string $title A title to apply to this item [Optional]
2688      * @param int $sort A sort or to use if we need to sort differently [Optional]
2689      * @param custom_menu_item $parent A reference to the parent custom_menu_item this child
2690      *        belongs to, only if the child has a parent. [Optional]
2691      */
2692     public function __construct($text, moodle_url $url=null, $title=null, $sort = null, custom_menu_item $parent = null) {
2693         $this->text = $text;
2694         $this->url = $url;
2695         $this->title = $title;
2696         $this->sort = (int)$sort;
2697         $this->parent = $parent;
2698     }
2700     /**
2701      * Adds a custom menu item as a child of this node given its properties.
2702      *
2703      * @param string $text
2704      * @param moodle_url $url
2705      * @param string $title
2706      * @param int $sort
2707      * @return custom_menu_item
2708      */
2709     public function add($text, moodle_url $url = null, $title = null, $sort = null) {
2710         $key = count($this->children);
2711         if (empty($sort)) {
2712             $sort = $this->lastsort + 1;
2713         }
2714         $this->children[$key] = new custom_menu_item($text, $url, $title, $sort, $this);
2715         $this->lastsort = (int)$sort;
2716         return $this->children[$key];
2717     }
2719     /**
2720      * Removes a custom menu item that is a child or descendant to the current menu.
2721      *
2722      * Returns true if child was found and removed.
2723      *
2724      * @param custom_menu_item $menuitem
2725      * @return bool
2726      */
2727     public function remove_child(custom_menu_item $menuitem) {
2728         $removed = false;
2729         if (($key = array_search($menuitem, $this->children)) !== false) {
2730             unset($this->children[$key]);
2731             $this->children = array_values($this->children);
2732             $removed = true;
2733         } else {
2734             foreach ($this->children as $child) {
2735                 if ($removed = $child->remove_child($menuitem)) {
2736                     break;
2737                 }
2738             }
2739         }
2740         return $removed;
2741     }
2743     /**
2744      * Returns the text for this item
2745      * @return string
2746      */
2747     public function get_text() {
2748         return $this->text;
2749     }
2751     /**
2752      * Returns the url for this item
2753      * @return moodle_url
2754      */
2755     public function get_url() {
2756         return $this->url;
2757     }
2759     /**
2760      * Returns the title for this item
2761      * @return string
2762      */
2763     public function get_title() {
2764         return $this->title;
2765     }
2767     /**
2768      * Sorts and returns the children for this item
2769      * @return array
2770      */
2771     public function get_children() {
2772         $this->sort();
2773         return $this->children;
2774     }
2776     /**
2777      * Gets the sort order for this child
2778      * @return int
2779      */
2780     public function get_sort_order() {
2781         return $this->sort;
2782     }
2784     /**
2785      * Gets the parent this child belong to
2786      * @return custom_menu_item
2787      */
2788     public function get_parent() {
2789         return $this->parent;
2790     }
2792     /**
2793      * Sorts the children this item has
2794      */
2795     public function sort() {
2796         usort($this->children, array('custom_menu','sort_custom_menu_items'));
2797     }
2799     /**
2800      * Returns true if this item has any children
2801      * @return bool
2802      */
2803     public function has_children() {
2804         return (count($this->children) > 0);
2805     }
2807     /**
2808      * Sets the text for the node
2809      * @param string $text
2810      */
2811     public function set_text($text) {
2812         $this->text = (string)$text;
2813     }
2815     /**
2816      * Sets the title for the node
2817      * @param string $title
2818      */
2819     public function set_title($title) {
2820         $this->title = (string)$title;
2821     }
2823     /**
2824      * Sets the url for the node
2825      * @param moodle_url $url
2826      */
2827     public function set_url(moodle_url $url) {
2828         $this->url = $url;
2829     }
2832 /**
2833  * Custom menu class
2834  *
2835  * This class is used to operate a custom menu that can be rendered for the page.
2836  * The custom menu is built using $CFG->custommenuitems and is a structured collection
2837  * of custom_menu_item nodes that can be rendered by the core renderer.
2838  *
2839  * To configure the custom menu:
2840  *     Settings: Administration > Appearance > Themes > Theme settings
2841  *
2842  * @copyright 2010 Sam Hemelryk
2843  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2844  * @since Moodle 2.0
2845  * @package core
2846  * @category output
2847  */
2848 class custom_menu extends custom_menu_item {
2850     /**
2851      * @var string The language we should render for, null disables multilang support.
2852      */
2853     protected $currentlanguage = null;
2855     /**
2856      * Creates the custom menu
2857      *
2858      * @param string $definition the menu items definition in syntax required by {@link convert_text_to_menu_nodes()}
2859      * @param string $currentlanguage the current language code, null disables multilang support
2860      */
2861     public function __construct($definition = '', $currentlanguage = null) {
2862         $this->currentlanguage = $currentlanguage;
2863         parent::__construct('root'); // create virtual root element of the menu
2864         if (!empty($definition)) {
2865             $this->override_children(self::convert_text_to_menu_nodes($definition, $currentlanguage));
2866         }
2867     }
2869     /**
2870      * Overrides the children of this custom menu. Useful when getting children
2871      * from $CFG->custommenuitems
2872      *
2873      * @param array $children
2874      */
2875     public function override_children(array $children) {
2876         $this->children = array();
2877         foreach ($children as $child) {
2878             if ($child instanceof custom_menu_item) {
2879                 $this->children[] = $child;
2880             }
2881         }
2882     }
2884     /**
2885      * Converts a string into a structured array of custom_menu_items which can
2886      * then be added to a custom menu.
2887      *
2888      * Structure:
2889      *     text|url|title|langs
2890      * The number of hyphens at the start determines the depth of the item. The
2891      * languages are optional, comma separated list of languages the line is for.
2892      *
2893      * Example structure:
2894      *     First level first item|http://www.moodle.com/
2895      *     -Second level first item|http://www.moodle.com/partners/
2896      *     -Second level second item|http://www.moodle.com/hq/
2897      *     --Third level first item|http://www.moodle.com/jobs/
2898      *     -Second level third item|http://www.moodle.com/development/
2899      *     First level second item|http://www.moodle.com/feedback/
2900      *     First level third item
2901      *     English only|http://moodle.com|English only item|en
2902      *     German only|http://moodle.de|Deutsch|de,de_du,de_kids
2903      *
2904      *
2905      * @static
2906      * @param string $text the menu items definition
2907      * @param string $language the language code, null disables multilang support
2908      * @return array
2909      */
2910     public static function convert_text_to_menu_nodes($text, $language = null) {
2911         $root = new custom_menu();
2912         $lastitem = $root;
2913         $lastdepth = 0;
2914         $hiddenitems = array();
2915         $lines = explode("\n", $text);
2916         foreach ($lines as $linenumber => $line) {
2917             $line = trim($line);
2918             if (strlen($line) == 0) {
2919                 continue;
2920             }
2921             // Parse item settings.
2922             $itemtext = null;
2923             $itemurl = null;
2924             $itemtitle = null;
2925             $itemvisible = true;
2926             $settings = explode('|', $line);
2927             foreach ($settings as $i => $setting) {
2928                 $setting = trim($setting);
2929                 if (!empty($setting)) {
2930                     switch ($i) {
2931                         case 0:
2932                             $itemtext = ltrim($setting, '-');
2933                             $itemtitle = $itemtext;
2934                             break;
2935                         case 1:
2936                             try {
2937                                 $itemurl = new moodle_url($setting);
2938                             } catch (moodle_exception $exception) {
2939                                 // We're not actually worried about this, we don't want to mess up the display
2940                                 // just for a wrongly entered URL.
2941                                 $itemurl = null;
2942                             }
2943                             break;
2944                         case 2:
2945                             $itemtitle = $setting;
2946                             break;
2947                         case 3:
2948                             if (!empty($language)) {
2949                                 $itemlanguages = array_map('trim', explode(',', $setting));
2950                                 $itemvisible &= in_array($language, $itemlanguages);
2951                             }
2952                             break;
2953                     }
2954                 }
2955             }
2956             // Get depth of new item.
2957             preg_match('/^(\-*)/', $line, $match);
2958             $itemdepth = strlen($match[1]) + 1;
2959             // Find parent item for new item.
2960             while (($lastdepth - $itemdepth) >= 0) {
2961                 $lastitem = $lastitem->get_parent();
2962                 $lastdepth--;
2963             }
2964             $lastitem = $lastitem->add($itemtext, $itemurl, $itemtitle, $linenumber + 1);
2965             $lastdepth++;
2966             if (!$itemvisible) {
2967                 $hiddenitems[] = $lastitem;
2968             }
2969         }
2970         foreach ($hiddenitems as $item) {
2971             $item->parent->remove_child($item);
2972         }
2973         return $root->get_children();
2974     }
2976     /**
2977      * Sorts two custom menu items
2978      *
2979      * This function is designed to be used with the usort method
2980      *     usort($this->children, array('custom_menu','sort_custom_menu_items'));
2981      *
2982      * @static
2983      * @param custom_menu_item $itema
2984      * @param custom_menu_item $itemb
2985      * @return int
2986      */
2987     public static function sort_custom_menu_items(custom_menu_item $itema, custom_menu_item $itemb) {
2988         $itema = $itema->get_sort_order();
2989         $itemb = $itemb->get_sort_order();
2990         if ($itema == $itemb) {
2991             return 0;
2992         }
2993         return ($itema > $itemb) ? +1 : -1;
2994     }
2997 /**
2998  * Stores one tab
2999  *
3000  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3001  * @package core
3002  */
3003 class tabobject implements renderable {
3004     /** @var string unique id of the tab in this tree, it is used to find selected and/or inactive tabs */
3005     var $id;
3006     /** @var moodle_url|string link */
3007     var $link;
3008     /** @var string text on the tab */
3009     var $text;
3010     /** @var string title under the link, by defaul equals to text */
3011     var $title;
3012     /** @var bool whether to display a link under the tab name when it's selected */
3013     var $linkedwhenselected = false;
3014     /** @var bool whether the tab is inactive */
3015     var $inactive = false;
3016     /** @var bool indicates that this tab's child is selected */
3017     var $activated = false;
3018     /** @var bool indicates that this tab is selected */
3019     var $selected = false;
3020     /** @var array stores children tabobjects */
3021     var $subtree = array();
3022     /** @var int level of tab in the tree, 0 for root (instance of tabtree), 1 for the first row of tabs */
3023     var $level = 1;
3025     /**
3026      * Constructor
3027      *
3028      * @param string $id unique id of the tab in this tree, it is used to find selected and/or inactive tabs
3029      * @param string|moodle_url $link
3030      * @param string $text text on the tab
3031      * @param string $title title under the link, by defaul equals to text
3032      * @param bool $linkedwhenselected whether to display a link under the tab name when it's selected
3033      */
3034     public function __construct($id, $link = null, $text = '', $title = '', $linkedwhenselected = false) {
3035         $this->id = $id;
3036         $this->link = $link;
3037         $this->text = $text;
3038         $this->title = $title ? $title : $text;
3039         $this->linkedwhenselected = $linkedwhenselected;
3040     }
3042     /**
3043      * Travels through tree and finds the tab to mark as selected, all parents are automatically marked as activated
3044      *
3045      * @param string $selected the id of the selected tab (whatever row it's on),
3046      *    if null marks all tabs as unselected
3047      * @return bool whether this tab is selected or contains selected tab in its subtree
3048      */
3049     protected function set_selected($selected) {
3050         if ((string)$selected === (string)$this->id) {
3051             $this->selected = true;
3052             // This tab is selected. No need to travel through subtree.
3053             return true;
3054         }
3055         foreach ($this->subtree as $subitem) {
3056             if ($subitem->set_selected($selected)) {
3057                 // This tab has child that is selected. Mark it as activated. No need to check other children.
3058                 $this->activated = true;
3059                 return true;
3060             }
3061         }
3062         return false;
3063     }
3065     /**
3066      * Travels through tree and finds a tab with specified id
3067      *
3068      * @param string $id
3069      * @return tabtree|null
3070      */
3071     public function find($id) {
3072         if ((string)$this->id === (string)$id) {
3073             return $this;
3074         }
3075         foreach ($this->subtree as $tab) {
3076             if ($obj = $tab->find($id)) {
3077                 return $obj;
3078             }
3079         }
3080         return null;
3081     }
3083     /**
3084      * Allows to mark each tab's level in the tree before rendering.
3085      *
3086      * @param int $level
3087      */
3088     protected function set_level($level) {
3089         $this->level = $level;
3090         foreach ($this->subtree as $tab) {
3091             $tab->set_level($level + 1);
3092         }
3093     }
3096 /**
3097  * Renderable for the main page header.
3098  *
3099  * @package core
3100  * @category output
3101  * @since 2.9
3102  * @copyright 2015 Adrian Greeve <adrian@moodle.com>
3103  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3104  */
3105 class context_header implements renderable {
3107     /**
3108      * @var string $heading Main heading.
3109      */
3110     public $heading;
3111     /**
3112      * @var int $headinglevel Main heading 'h' tag level.
3113      */
3114     public $headinglevel;
3115     /**
3116      * @var string|null $imagedata HTML code for the picture in the page header.
3117      */
3118     public $imagedata;
3119     /**
3120      * @var array $additionalbuttons Additional buttons for the header e.g. Messaging button for the user header.
3121      *      array elements - title => alternate text for the image, or if no image is available the button text.
3122      *                       url => Link for the button to head to. Should be a moodle_url.
3123      *                       image => location to the image, or name of the image in /pix/t/{image name}.
3124      *                       linkattributes => additional attributes for the <a href> element.
3125      *                       page => page object. Don't include if the image is an external image.
3126      */
3127     public $additionalbuttons;
3129     /**
3130      * Constructor.
3131      *
3132      * @param string $heading Main heading data.
3133      * @param int $headinglevel Main heading 'h' tag level.
3134      * @param string|null $imagedata HTML code for the picture in the page header.
3135      * @param string $additionalbuttons Buttons for the header e.g. Messaging button for the user header.
3136      */
3137     public function __construct($heading = null, $headinglevel = 1, $imagedata = null, $additionalbuttons = null) {
3139         $this->heading = $heading;
3140         $this->headinglevel = $headinglevel;
3141         $this->imagedata = $imagedata;
3142         $this->additionalbuttons = $additionalbuttons;
3143         // If we have buttons then format them.
3144         if (isset($this->additionalbuttons)) {
3145             $this->format_button_images();
3146         }
3147     }
3149     /**
3150      * Adds an array element for a formatted image.
3151      */
3152     protected function format_button_images() {
3154         foreach ($this->additionalbuttons as $buttontype => $button) {
3155             $page = $button['page'];
3156             // If no image is provided then just use the title.
3157             if (!isset($button['image'])) {
3158                 $this->additionalbuttons[$buttontype]['formattedimage'] = $button['title'];
3159             } else {
3160                 // Check to see if this is an internal Moodle icon.
3161                 $internalimage = $page->theme->resolve_image_location('t/' . $button['image'], 'moodle');
3162                 if ($internalimage) {
3163                     $this->additionalbuttons[$buttontype]['formattedimage'] = 't/' . $button['image'];
3164                 } else {
3165                     // Treat as an external image.
3166                     $this->additionalbuttons[$buttontype]['formattedimage'] = $button['image'];
3167                 }
3168             }
3169             // Add the bootstrap 'btn' class for formatting.
3170             $this->additionalbuttons[$buttontype]['linkattributes'] = array_merge($button['linkattributes'],
3171                     array('class' => 'btn'));
3172         }
3173     }
3176 /**
3177  * Stores tabs list
3178  *
3179  * Example how to print a single line tabs:
3180  * $rows = array(
3181  *    new tabobject(...),
3182  *    new tabobject(...)
3183  * );
3184  * echo $OUTPUT->tabtree($rows, $selectedid);
3185  *
3186  * Multiple row tabs may not look good on some devices but if you want to use them
3187  * you can specify ->subtree for the active tabobject.
3188  *
3189  * @copyright 2013 Marina Glancy
3190  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3191  * @since Moodle 2.5
3192  * @package core
3193  * @category output
3194  */
3195 class tabtree extends tabobject {
3196     /**
3197      * Constuctor
3198      *
3199      * It is highly recommended to call constructor when list of tabs is already
3200      * populated, this way you ensure that selected and inactive tabs are located
3201      * and attribute level is set correctly.
3202      *
3203      * @param array $tabs array of tabs, each of them may have it's own ->subtree
3204      * @param string|null $selected which tab to mark as selected, all parent tabs will
3205      *     automatically be marked as activated
3206      * @param array|string|null $inactive list of ids of inactive tabs, regardless of
3207      *     their level. Note that you can as weel specify tabobject::$inactive for separate instances
3208      */
3209     public function __construct($tabs, $selected = null, $inactive = null) {
3210         $this->subtree = $tabs;
3211         if ($selected !== null) {
3212             $this->set_selected($selected);
3213         }
3214         if ($inactive !== null) {
3215             if (is_array($inactive)) {
3216                 foreach ($inactive as $id) {
3217                     if ($tab = $this->find($id)) {
3218                         $tab->inactive = true;
3219                     }
3220                 }
3221             } else if ($tab = $this->find($inactive)) {
3222                 $tab->inactive = true;
3223             }
3224         }
3225         $this->set_level(0);
3226     }
3229 /**
3230  * An action menu.
3231  *
3232  * This action menu component takes a series of primary and secondary actions.
3233  * The primary actions are displayed permanently and the secondary attributes are displayed within a drop
3234  * down menu.
3235  *
3236  * @package core
3237  * @category output
3238  * @copyright 2013 Sam Hemelryk
3239  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3240  */
3241 class action_menu implements renderable {
3243     /**
3244      * Top right alignment.
3245      */
3246     const TL = 1;
3248     /**
3249      * Top right alignment.
3250      */
3251     const TR = 2;
3253     /**
3254      * Top right alignment.
3255      */
3256     const BL = 3;
3258     /**
3259      * Top right alignment.
3260      */
3261     const BR = 4;
3263     /**
3264      * The instance number. This is unique to this instance of the action menu.
3265      * @var int
3266      */
3267     protected $instance = 0;
3269     /**
3270      * An array of primary actions. Please use {@link action_menu::add_primary_action()} to add actions.
3271      * @var array
3272      */
3273     protected $primaryactions = array();
3275     /**
3276      * An array of secondary actions. Please use {@link action_menu::add_secondary_action()} to add actions.
3277      * @var array
3278      */
3279     protected $secondaryactions = array();
3281     /**
3282      * An array of attributes added to the container of the action menu.
3283      * Initialised with defaults during construction.
3284      * @var array
3285      */
3286     public $attributes = array();
3287     /**
3288      * An array of attributes added to the container of the primary actions.
3289      * Initialised with defaults during construction.
3290      * @var array
3291      */
3292     public $attributesprimary = array();
3293     /**
3294      * An array of attributes added to the container of the secondary actions.
3295      * Initialised with defaults during construction.
3296      * @var array
3297      */
3298     public $attributessecondary = array();
3300     /**
3301      * The string to use next to the icon for the action icon relating to the secondary (dropdown) menu.
3302      * @var array
3303      */
3304     public $actiontext = null;
3306     /**
3307      * An icon to use for the toggling the secondary menu (dropdown).
3308      * @var actionicon
3309      */
3310     public $actionicon;
3312     /**
3313      * Any text to use for the toggling the secondary menu (dropdown).
3314      * @var menutrigger
3315      */
3316     public $menutrigger = '';
3318     /**
3319      * Place the action menu before all other actions.
3320      * @var prioritise
3321      */
3322     public $prioritise = false;
3324     /**
3325      * Constructs the action menu with the given items.
3326      *
3327      * @param array $actions An array of actions.
3328      */
3329     public function __construct(array $actions = array()) {
3330         static $initialised = 0;
3331         $this->instance = $initialised;
3332         $initialised++;
3334         $this->attributes = array(
3335             'id' => 'action-menu-'.$this->instance,
3336             'class' => 'moodle-actionmenu',
3337             'data-enhance' => 'moodle-core-actionmenu'
3338         );
3339         $this->attributesprimary = array(
3340             'id' => 'action-menu-'.$this->instance.'-menubar',
3341             'class' => 'menubar',
3342             'role' => 'menubar'
3343         );
3344         $this->attributessecondary = array(
3345             'id' => 'action-menu-'.$this->instance.'-menu',
3346             'class' => 'menu',
3347             'data-rel' => 'menu-content',
3348             'aria-labelledby' => 'action-menu-toggle-'.$this->instance,
3349             'role' => 'menu'
3350         );
3351         $this->set_alignment(self::TR, self::BR);
3352         foreach ($actions as $action) {
3353             $this->add($action);
3354         }
3355     }
3357     public function set_menu_trigger($trigger) {
3358         $this->menutrigger = $trigger;
3359     }
3361     /**
3362      * Initialises JS required fore the action menu.
3363      * The JS is only required once as it manages all action menu's on the page.
3364      *
3365      * @param moodle_page $page
3366      */
3367     public function initialise_js(moodle_page $page) {
3368         static $initialised = false;
3369         if (!$initialised) {
3370             $page->requires->yui_module('moodle-core-actionmenu', 'M.core.actionmenu.init');
3371             $initialised = true;
3372         }
3373     }
3375     /**
3376      * Adds an action to this action menu.
3377      *
3378      * @param action_menu_link|pix_icon|string $action
3379      */
3380     public function add($action) {
3381         if ($action instanceof action_link) {
3382             if ($action->primary) {
3383                 $this->add_primary_action($action);
3384             } else {
3385                 $this->add_secondary_action($action);
3386             }
3387         } else if ($action instanceof pix_icon) {
3388             $this->add_primary_action($action);
3389         } else {
3390             $this->add_secondary_action($action);
3391         }
3392     }
3394     /**
3395      * Adds a primary action to the action menu.
3396      *
3397      * @param action_menu_link|action_link|pix_icon|string $action
3398      */
3399     public function add_primary_action($action) {
3400         if ($action instanceof action_link || $action instanceof pix_icon) {
3401             $action->attributes['role'] = 'menuitem';
3402             if ($action instanceof action_menu_link) {
3403                 $action->actionmenu = $this;
3404             }
3405         }
3406         $this->primaryactions[] = $action;
3407     }
3409     /**
3410      * Adds a secondary action to the action menu.
3411      *
3412      * @param action_link|pix_icon|string $action
3413      */
3414     public function add_secondary_action($action) {
3415         if ($action instanceof action_link || $action instanceof pix_icon) {
3416             $action->attributes['role'] = 'menuitem';
3417             if ($action instanceof action_menu_link) {
3418                 $action->actionmenu = $this;
3419             }
3420         }
3421         $this->secondaryactions[] = $action;
3422     }
3424     /**
3425      * Returns the primary actions ready to be rendered.
3426      *
3427      * @param core_renderer $output The renderer to use for getting icons.
3428      * @return array
3429      */
3430     public function get_primary_actions(core_renderer $output = null) {
3431         global $OUTPUT;
3432         if ($output === null) {
3433             $output = $OUTPUT;
3434         }
3435         $pixicon = $this->actionicon;
3436         $linkclasses = array('toggle-display');
3438         $title = '';
3439         if (!empty($this->menutrigger)) {
3440             $pixicon = '<b class="caret"></b>';
3441             $linkclasses[] = 'textmenu';
3442         } else {
3443             $title = new lang_string('actions', 'moodle');
3444             $this->actionicon = new pix_icon(
3445                 't/edit_menu',
3446                 '',
3447                 'moodle',
3448                 array('class' => 'iconsmall actionmenu', 'title' => '')
3449             );
3450             $pixicon = $this->actionicon;
3451         }
3452         if ($pixicon instanceof renderable) {
3453             $pixicon = $output->render($pixicon);
3454             if ($pixicon instanceof pix_icon && isset($pixicon->attributes['alt'])) {
3455                 $title = $pixicon->attributes['alt'];
3456             }
3457         }
3458         $string = '';
3459         if ($this->actiontext) {
3460             $string = $this->actiontext;
3461         }
3462         $actions = $this->primaryactions;
3463         $attributes = array(
3464             'class' => implode(' ', $linkclasses),
3465             'title' => $title,
3466             'id' => 'action-menu-toggle-'.$this->instance,
3467             'role' => 'menuitem'
3468         );
3469         $link = html_writer::link('#', $string . $this->menutrigger . $pixicon, $attributes);
3470         if ($this->prioritise) {
3471             array_unshift($actions, $link);
3472         } else {
3473             $actions[] = $link;
3474         }
3475         return $actions;
3476     }
3478     /**
3479      * Returns the secondary actions ready to be rendered.
3480      * @return array
3481      */
3482     public function get_secondary_actions() {
3483         return $this->secondaryactions;
3484     }
3486     /**
3487      * Sets the selector that should be used to find the owning node of this menu.
3488      * @param string $selector A CSS/YUI selector to identify the owner of the menu.
3489      */
3490     public function set_owner_selector($selector) {
3491         $this->attributes['data-owner'] = $selector;
3492     }
3494     /**
3495      * Sets the alignment of the dialogue in relation to button used to toggle it.
3496      *
3497      * @param int $dialogue One of action_menu::TL, action_menu::TR, action_menu::BL, action_menu::BR.
3498      * @param int $button One of action_menu::TL, action_menu::TR, action_menu::BL, action_menu::BR.
3499      */
3500     public function set_alignment($dialogue, $button) {
3501         if (isset($this->attributessecondary['data-align'])) {
3502             // We've already got one set, lets remove the old class so as to avoid troubles.
3503             $class = $this->attributessecondary['class'];
3504             $search = 'align-'.$this->attributessecondary['data-align'];
3505             $this->attributessecondary['class'] = str_replace($search, '', $class);
3506         }
3507         $align = $this->get_align_string($dialogue) . '-' . $this->get_align_string($button);
3508         $this->attributessecondary['data-align'] = $align;
3509         $this->attributessecondary['class'] .= ' align-'.$align;
3510     }
3512     /**
3513      * Returns a string to describe the alignment.
3514      *
3515      * @param int $align One of action_menu::TL, action_menu::TR, action_menu::BL, action_menu::BR.
3516      * @return string
3517      */
3518     protected function get_align_string($align) {
3519         switch ($align) {
3520             case self::TL :
3521                 return 'tl';
3522             case self::TR :
3523                 return 'tr';
3524             case self::BL :
3525                 return 'bl';
3526             case self::BR :
3527                 return 'br';
3528             default :
3529                 return 'tl';
3530         }
3531     }
3533     /**
3534      * Sets a constraint for the dialogue.
3535      *
3536      * The constraint is applied when the dialogue is shown and limits the display of the dialogue to within the
3537      * element the constraint identifies.
3538      *
3539      * @param string $ancestorselector A snippet of CSS used to identify the ancestor to contrain the dialogue to.
3540      */