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