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