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