Merge branch 'MDL-68667-master' of git://github.com/aanabit/moodle
[moodle.git] / lib / outputcomponents.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Classes representing HTML elements, used by $OUTPUT methods
19  *
20  * Please see http://docs.moodle.org/en/Developement:How_Moodle_outputs_HTML
21  * for an overview.
22  *
23  * @package core
24  * @category output
25  * @copyright 2009 Tim Hunt
26  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27  */
29 defined('MOODLE_INTERNAL') || die();
31 /**
32  * Interface marking other classes as suitable for renderer_base::render()
33  *
34  * @copyright 2010 Petr Skoda (skodak) info@skodak.org
35  * @package core
36  * @category output
37  */
38 interface renderable {
39     // intentionally empty
40 }
42 /**
43  * Interface marking other classes having the ability to export their data for use by templates.
44  *
45  * @copyright 2015 Damyon Wiese
46  * @package core
47  * @category output
48  * @since 2.9
49  */
50 interface templatable {
52     /**
53      * Function to export the renderer data in a format that is suitable for a
54      * mustache template. This means:
55      * 1. No complex types - only stdClass, array, int, string, float, bool
56      * 2. Any additional info that is required for the template is pre-calculated (e.g. capability checks).
57      *
58      * @param renderer_base $output Used to do a final render of any components that need to be rendered for export.
59      * @return stdClass|array
60      */
61     public function export_for_template(renderer_base $output);
62 }
64 /**
65  * Data structure representing a file picker.
66  *
67  * @copyright 2010 Dongsheng Cai
68  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
69  * @since Moodle 2.0
70  * @package core
71  * @category output
72  */
73 class file_picker implements renderable {
75     /**
76      * @var stdClass An object containing options for the file picker
77      */
78     public $options;
80     /**
81      * Constructs a file picker object.
82      *
83      * The following are possible options for the filepicker:
84      *    - accepted_types  (*)
85      *    - return_types    (FILE_INTERNAL)
86      *    - env             (filepicker)
87      *    - client_id       (uniqid)
88      *    - itemid          (0)
89      *    - maxbytes        (-1)
90      *    - maxfiles        (1)
91      *    - buttonname      (false)
92      *
93      * @param stdClass $options An object containing options for the file picker.
94      */
95     public function __construct(stdClass $options) {
96         global $CFG, $USER, $PAGE;
97         require_once($CFG->dirroot. '/repository/lib.php');
98         $defaults = array(
99             'accepted_types'=>'*',
100             'return_types'=>FILE_INTERNAL,
101             'env' => 'filepicker',
102             'client_id' => uniqid(),
103             'itemid' => 0,
104             'maxbytes'=>-1,
105             'maxfiles'=>1,
106             'buttonname'=>false
107         );
108         foreach ($defaults as $key=>$value) {
109             if (empty($options->$key)) {
110                 $options->$key = $value;
111             }
112         }
114         $options->currentfile = '';
115         if (!empty($options->itemid)) {
116             $fs = get_file_storage();
117             $usercontext = context_user::instance($USER->id);
118             if (empty($options->filename)) {
119                 if ($files = $fs->get_area_files($usercontext->id, 'user', 'draft', $options->itemid, 'id DESC', false)) {
120                     $file = reset($files);
121                 }
122             } else {
123                 $file = $fs->get_file($usercontext->id, 'user', 'draft', $options->itemid, $options->filepath, $options->filename);
124             }
125             if (!empty($file)) {
126                 $options->currentfile = html_writer::link(moodle_url::make_draftfile_url($file->get_itemid(), $file->get_filepath(), $file->get_filename()), $file->get_filename());
127             }
128         }
130         // initilise options, getting files in root path
131         $this->options = initialise_filepicker($options);
133         // copying other options
134         foreach ($options as $name=>$value) {
135             if (!isset($this->options->$name)) {
136                 $this->options->$name = $value;
137             }
138         }
139     }
142 /**
143  * Data structure representing a user picture.
144  *
145  * @copyright 2009 Nicolas Connault, 2010 Petr Skoda
146  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
147  * @since Modle 2.0
148  * @package core
149  * @category output
150  */
151 class user_picture implements renderable {
152     /**
153      * @var array List of mandatory fields in user record here. (do not include
154      * TEXT columns because it would break SELECT DISTINCT in MSSQL and ORACLE)
155      */
156     protected static $fields = array('id', 'picture', 'firstname', 'lastname', 'firstnamephonetic', 'lastnamephonetic',
157             'middlename', 'alternatename', 'imagealt', 'email');
159     /**
160      * @var stdClass A user object with at least fields all columns specified
161      * in $fields array constant set.
162      */
163     public $user;
165     /**
166      * @var int The course id. Used when constructing the link to the user's
167      * profile, page course id used if not specified.
168      */
169     public $courseid;
171     /**
172      * @var bool Add course profile link to image
173      */
174     public $link = true;
176     /**
177      * @var int Size in pixels. Special values are (true/1 = 100px) and
178      * (false/0 = 35px)
179      * for backward compatibility.
180      */
181     public $size = 35;
183     /**
184      * @var bool Add non-blank alt-text to the image.
185      * Default true, set to false when image alt just duplicates text in screenreaders.
186      */
187     public $alttext = true;
189     /**
190      * @var bool Whether or not to open the link in a popup window.
191      */
192     public $popup = false;
194     /**
195      * @var string Image class attribute
196      */
197     public $class = 'userpicture';
199     /**
200      * @var bool Whether to be visible to screen readers.
201      */
202     public $visibletoscreenreaders = true;
204     /**
205      * @var bool Whether to include the fullname in the user picture link.
206      */
207     public $includefullname = false;
209     /**
210      * @var mixed Include user authentication token. True indicates to generate a token for current user, and integer value
211      * indicates to generate a token for the user whose id is the value indicated.
212      */
213     public $includetoken = false;
215     /**
216      * User picture constructor.
217      *
218      * @param stdClass $user user record with at least id, picture, imagealt, firstname and lastname set.
219      *                 It is recommended to add also contextid of the user for performance reasons.
220      */
221     public function __construct(stdClass $user) {
222         global $DB;
224         if (empty($user->id)) {
225             throw new coding_exception('User id is required when printing user avatar image.');
226         }
228         // only touch the DB if we are missing data and complain loudly...
229         $needrec = false;
230         foreach (self::$fields as $field) {
231             if (!property_exists($user, $field)) {
232                 $needrec = true;
233                 debugging('Missing '.$field.' property in $user object, this is a performance problem that needs to be fixed by a developer. '
234                           .'Please use user_picture::fields() to get the full list of required fields.', DEBUG_DEVELOPER);
235                 break;
236             }
237         }
239         if ($needrec) {
240             $this->user = $DB->get_record('user', array('id'=>$user->id), self::fields(), MUST_EXIST);
241         } else {
242             $this->user = clone($user);
243         }
244     }
246     /**
247      * Returns a list of required user fields, useful when fetching required user info from db.
248      *
249      * In some cases we have to fetch the user data together with some other information,
250      * the idalias is useful there because the id would otherwise override the main
251      * id of the result record. Please note it has to be converted back to id before rendering.
252      *
253      * @param string $tableprefix name of database table prefix in query
254      * @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)
255      * @param string $idalias alias of id field
256      * @param string $fieldprefix prefix to add to all columns in their aliases, does not apply to 'id'
257      * @return string
258      */
259     public static function fields($tableprefix = '', array $extrafields = NULL, $idalias = 'id', $fieldprefix = '') {
260         if (!$tableprefix and !$extrafields and !$idalias) {
261             return implode(',', self::$fields);
262         }
263         if ($tableprefix) {
264             $tableprefix .= '.';
265         }
266         foreach (self::$fields as $field) {
267             if ($field === 'id' and $idalias and $idalias !== 'id') {
268                 $fields[$field] = "$tableprefix$field AS $idalias";
269             } else {
270                 if ($fieldprefix and $field !== 'id') {
271                     $fields[$field] = "$tableprefix$field AS $fieldprefix$field";
272                 } else {
273                     $fields[$field] = "$tableprefix$field";
274                 }
275             }
276         }
277         // add extra fields if not already there
278         if ($extrafields) {
279             foreach ($extrafields as $e) {
280                 if ($e === 'id' or isset($fields[$e])) {
281                     continue;
282                 }
283                 if ($fieldprefix) {
284                     $fields[$e] = "$tableprefix$e AS $fieldprefix$e";
285                 } else {
286                     $fields[$e] = "$tableprefix$e";
287                 }
288             }
289         }
290         return implode(',', $fields);
291     }
293     /**
294      * Extract the aliased user fields from a given record
295      *
296      * Given a record that was previously obtained using {@link self::fields()} with aliases,
297      * this method extracts user related unaliased fields.
298      *
299      * @param stdClass $record containing user picture fields
300      * @param array $extrafields extra fields included in the $record
301      * @param string $idalias alias of the id field
302      * @param string $fieldprefix prefix added to all columns in their aliases, does not apply to 'id'
303      * @return stdClass object with unaliased user fields
304      */
305     public static function unalias(stdClass $record, array $extrafields = null, $idalias = 'id', $fieldprefix = '') {
307         if (empty($idalias)) {
308             $idalias = 'id';
309         }
311         $return = new stdClass();
313         foreach (self::$fields as $field) {
314             if ($field === 'id') {
315                 if (property_exists($record, $idalias)) {
316                     $return->id = $record->{$idalias};
317                 }
318             } else {
319                 if (property_exists($record, $fieldprefix.$field)) {
320                     $return->{$field} = $record->{$fieldprefix.$field};
321                 }
322             }
323         }
324         // add extra fields if not already there
325         if ($extrafields) {
326             foreach ($extrafields as $e) {
327                 if ($e === 'id' or property_exists($return, $e)) {
328                     continue;
329                 }
330                 $return->{$e} = $record->{$fieldprefix.$e};
331             }
332         }
334         return $return;
335     }
337     /**
338      * Works out the URL for the users picture.
339      *
340      * This method is recommended as it avoids costly redirects of user pictures
341      * if requests are made for non-existent files etc.
342      *
343      * @param moodle_page $page
344      * @param renderer_base $renderer
345      * @return moodle_url
346      */
347     public function get_url(moodle_page $page, renderer_base $renderer = null) {
348         global $CFG;
350         if (is_null($renderer)) {
351             $renderer = $page->get_renderer('core');
352         }
354         // Sort out the filename and size. Size is only required for the gravatar
355         // implementation presently.
356         if (empty($this->size)) {
357             $filename = 'f2';
358             $size = 35;
359         } else if ($this->size === true or $this->size == 1) {
360             $filename = 'f1';
361             $size = 100;
362         } else if ($this->size > 100) {
363             $filename = 'f3';
364             $size = (int)$this->size;
365         } else if ($this->size >= 50) {
366             $filename = 'f1';
367             $size = (int)$this->size;
368         } else {
369             $filename = 'f2';
370             $size = (int)$this->size;
371         }
373         $defaulturl = $renderer->image_url('u/'.$filename); // default image
375         if ((!empty($CFG->forcelogin) and !isloggedin()) ||
376             (!empty($CFG->forceloginforprofileimage) && (!isloggedin() || isguestuser()))) {
377             // Protect images if login required and not logged in;
378             // also if login is required for profile images and is not logged in or guest
379             // do not use require_login() because it is expensive and not suitable here anyway.
380             return $defaulturl;
381         }
383         // First try to detect deleted users - but do not read from database for performance reasons!
384         if (!empty($this->user->deleted) or strpos($this->user->email, '@') === false) {
385             // All deleted users should have email replaced by md5 hash,
386             // all active users are expected to have valid email.
387             return $defaulturl;
388         }
390         // Did the user upload a picture?
391         if ($this->user->picture > 0) {
392             if (!empty($this->user->contextid)) {
393                 $contextid = $this->user->contextid;
394             } else {
395                 $context = context_user::instance($this->user->id, IGNORE_MISSING);
396                 if (!$context) {
397                     // This must be an incorrectly deleted user, all other users have context.
398                     return $defaulturl;
399                 }
400                 $contextid = $context->id;
401             }
403             $path = '/';
404             if (clean_param($page->theme->name, PARAM_THEME) == $page->theme->name) {
405                 // We append the theme name to the file path if we have it so that
406                 // in the circumstance that the profile picture is not available
407                 // when the user actually requests it they still get the profile
408                 // picture for the correct theme.
409                 $path .= $page->theme->name.'/';
410             }
411             // Set the image URL to the URL for the uploaded file and return.
412             $url = moodle_url::make_pluginfile_url(
413                     $contextid, 'user', 'icon', null, $path, $filename, false, $this->includetoken);
414             $url->param('rev', $this->user->picture);
415             return $url;
416         }
418         if ($this->user->picture == 0 and !empty($CFG->enablegravatar)) {
419             // Normalise the size variable to acceptable bounds
420             if ($size < 1 || $size > 512) {
421                 $size = 35;
422             }
423             // Hash the users email address
424             $md5 = md5(strtolower(trim($this->user->email)));
425             // Build a gravatar URL with what we know.
427             // Find the best default image URL we can (MDL-35669)
428             if (empty($CFG->gravatardefaulturl)) {
429                 $absoluteimagepath = $page->theme->resolve_image_location('u/'.$filename, 'core');
430                 if (strpos($absoluteimagepath, $CFG->dirroot) === 0) {
431                     $gravatardefault = $CFG->wwwroot . substr($absoluteimagepath, strlen($CFG->dirroot));
432                 } else {
433                     $gravatardefault = $CFG->wwwroot . '/pix/u/' . $filename . '.png';
434                 }
435             } else {
436                 $gravatardefault = $CFG->gravatardefaulturl;
437             }
439             // If the currently requested page is https then we'll return an
440             // https gravatar page.
441             if (is_https()) {
442                 return new moodle_url("https://secure.gravatar.com/avatar/{$md5}", array('s' => $size, 'd' => $gravatardefault));
443             } else {
444                 return new moodle_url("http://www.gravatar.com/avatar/{$md5}", array('s' => $size, 'd' => $gravatardefault));
445             }
446         }
448         return $defaulturl;
449     }
452 /**
453  * Data structure representing a help icon.
454  *
455  * @copyright 2010 Petr Skoda (info@skodak.org)
456  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
457  * @since Moodle 2.0
458  * @package core
459  * @category output
460  */
461 class help_icon implements renderable, templatable {
463     /**
464      * @var string lang pack identifier (without the "_help" suffix),
465      * both get_string($identifier, $component) and get_string($identifier.'_help', $component)
466      * must exist.
467      */
468     public $identifier;
470     /**
471      * @var string Component name, the same as in get_string()
472      */
473     public $component;
475     /**
476      * @var string Extra descriptive text next to the icon
477      */
478     public $linktext = null;
480     /**
481      * Constructor
482      *
483      * @param string $identifier string for help page title,
484      *  string with _help suffix is used for the actual help text.
485      *  string with _link suffix is used to create a link to further info (if it exists)
486      * @param string $component
487      */
488     public function __construct($identifier, $component) {
489         $this->identifier = $identifier;
490         $this->component  = $component;
491     }
493     /**
494      * Verifies that both help strings exists, shows debug warnings if not
495      */
496     public function diag_strings() {
497         $sm = get_string_manager();
498         if (!$sm->string_exists($this->identifier, $this->component)) {
499             debugging("Help title string does not exist: [$this->identifier, $this->component]");
500         }
501         if (!$sm->string_exists($this->identifier.'_help', $this->component)) {
502             debugging("Help contents string does not exist: [{$this->identifier}_help, $this->component]");
503         }
504     }
506     /**
507      * Export this data so it can be used as the context for a mustache template.
508      *
509      * @param renderer_base $output Used to do a final render of any components that need to be rendered for export.
510      * @return array
511      */
512     public function export_for_template(renderer_base $output) {
513         global $CFG;
515         $title = get_string($this->identifier, $this->component);
517         if (empty($this->linktext)) {
518             $alt = get_string('helpprefix2', '', trim($title, ". \t"));
519         } else {
520             $alt = get_string('helpwiththis');
521         }
523         $data = get_formatted_help_string($this->identifier, $this->component, false);
525         $data->alt = $alt;
526         $data->icon = (new pix_icon('help', $alt, 'core', ['class' => 'iconhelp']))->export_for_template($output);
527         $data->linktext = $this->linktext;
528         $data->title = get_string('helpprefix2', '', trim($title, ". \t"));
530         $options = [
531             'component' => $this->component,
532             'identifier' => $this->identifier,
533             'lang' => current_language()
534         ];
536         // Debugging feature lets you display string identifier and component.
537         if (isset($CFG->debugstringids) && $CFG->debugstringids && optional_param('strings', 0, PARAM_INT)) {
538             $options['strings'] = 1;
539         }
541         $data->url = (new moodle_url('/help.php', $options))->out(false);
542         $data->ltr = !right_to_left();
543         return $data;
544     }
548 /**
549  * Data structure representing an icon font.
550  *
551  * @copyright 2016 Damyon Wiese
552  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
553  * @package core
554  * @category output
555  */
556 class pix_icon_font implements templatable {
558     /**
559      * @var pix_icon $pixicon The original icon.
560      */
561     private $pixicon = null;
563     /**
564      * @var string $key The mapped key.
565      */
566     private $key;
568     /**
569      * @var bool $mapped The icon could not be mapped.
570      */
571     private $mapped;
573     /**
574      * Constructor
575      *
576      * @param pix_icon $pixicon The original icon
577      */
578     public function __construct(pix_icon $pixicon) {
579         global $PAGE;
581         $this->pixicon = $pixicon;
582         $this->mapped = false;
583         $iconsystem = \core\output\icon_system::instance();
585         $this->key = $iconsystem->remap_icon_name($pixicon->pix, $pixicon->component);
586         if (!empty($this->key)) {
587             $this->mapped = true;
588         }
589     }
591     /**
592      * Return true if this pix_icon was successfully mapped to an icon font.
593      *
594      * @return bool
595      */
596     public function is_mapped() {
597         return $this->mapped;
598     }
600     /**
601      * Export this data so it can be used as the context for a mustache template.
602      *
603      * @param renderer_base $output Used to do a final render of any components that need to be rendered for export.
604      * @return array
605      */
606     public function export_for_template(renderer_base $output) {
608         $pixdata = $this->pixicon->export_for_template($output);
610         $title = isset($this->pixicon->attributes['title']) ? $this->pixicon->attributes['title'] : '';
611         $alt = isset($this->pixicon->attributes['alt']) ? $this->pixicon->attributes['alt'] : '';
612         if (empty($title)) {
613             $title = $alt;
614         }
615         $data = array(
616             'extraclasses' => $pixdata['extraclasses'],
617             'title' => $title,
618             'alt' => $alt,
619             'key' => $this->key
620         );
622         return $data;
623     }
626 /**
627  * Data structure representing an icon subtype.
628  *
629  * @copyright 2016 Damyon Wiese
630  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
631  * @package core
632  * @category output
633  */
634 class pix_icon_fontawesome extends pix_icon_font {
638 /**
639  * Data structure representing an icon.
640  *
641  * @copyright 2010 Petr Skoda
642  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
643  * @since Moodle 2.0
644  * @package core
645  * @category output
646  */
647 class pix_icon implements renderable, templatable {
649     /**
650      * @var string The icon name
651      */
652     var $pix;
654     /**
655      * @var string The component the icon belongs to.
656      */
657     var $component;
659     /**
660      * @var array An array of attributes to use on the icon
661      */
662     var $attributes = array();
664     /**
665      * Constructor
666      *
667      * @param string $pix short icon name
668      * @param string $alt The alt text to use for the icon
669      * @param string $component component name
670      * @param array $attributes html attributes
671      */
672     public function __construct($pix, $alt, $component='moodle', array $attributes = null) {
673         global $PAGE;
675         $this->pix = $pix;
676         $this->component  = $component;
677         $this->attributes = (array)$attributes;
679         if (empty($this->attributes['class'])) {
680             $this->attributes['class'] = '';
681         }
683         // Set an additional class for big icons so that they can be styled properly.
684         if (substr($pix, 0, 2) === 'b/') {
685             $this->attributes['class'] .= ' iconsize-big';
686         }
688         // If the alt is empty, don't place it in the attributes, otherwise it will override parent alt text.
689         if (!is_null($alt)) {
690             $this->attributes['alt'] = $alt;
692             // If there is no title, set it to the attribute.
693             if (!isset($this->attributes['title'])) {
694                 $this->attributes['title'] = $this->attributes['alt'];
695             }
696         } else {
697             unset($this->attributes['alt']);
698         }
700         if (empty($this->attributes['title'])) {
701             // Remove the title attribute if empty, we probably want to use the parent node's title
702             // and some browsers might overwrite it with an empty title.
703             unset($this->attributes['title']);
704         }
706         // Hide icons from screen readers that have no alt.
707         if (empty($this->attributes['alt'])) {
708             $this->attributes['aria-hidden'] = 'true';
709         }
710     }
712     /**
713      * Export this data so it can be used as the context for a mustache template.
714      *
715      * @param renderer_base $output Used to do a final render of any components that need to be rendered for export.
716      * @return array
717      */
718     public function export_for_template(renderer_base $output) {
719         $attributes = $this->attributes;
720         $extraclasses = '';
722         foreach ($attributes as $key => $item) {
723             if ($key == 'class') {
724                 $extraclasses = $item;
725                 unset($attributes[$key]);
726                 break;
727             }
728         }
730         $attributes['src'] = $output->image_url($this->pix, $this->component)->out(false);
731         $templatecontext = array();
732         foreach ($attributes as $name => $value) {
733             $templatecontext[] = array('name' => $name, 'value' => $value);
734         }
735         $title = isset($attributes['title']) ? $attributes['title'] : '';
736         if (empty($title)) {
737             $title = isset($attributes['alt']) ? $attributes['alt'] : '';
738         }
739         $data = array(
740             'attributes' => $templatecontext,
741             'extraclasses' => $extraclasses
742         );
744         return $data;
745     }
747     /**
748      * Much simpler version of export that will produce the data required to render this pix with the
749      * pix helper in a mustache tag.
750      *
751      * @return array
752      */
753     public function export_for_pix() {
754         $title = isset($this->attributes['title']) ? $this->attributes['title'] : '';
755         if (empty($title)) {
756             $title = isset($this->attributes['alt']) ? $this->attributes['alt'] : '';
757         }
758         return [
759             'key' => $this->pix,
760             'component' => $this->component,
761             'title' => $title
762         ];
763     }
766 /**
767  * Data structure representing an activity icon.
768  *
769  * The difference is that activity icons will always render with the standard icon system (no font icons).
770  *
771  * @copyright 2017 Damyon Wiese
772  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
773  * @package core
774  */
775 class image_icon extends pix_icon {
778 /**
779  * Data structure representing an emoticon image
780  *
781  * @copyright 2010 David Mudrak
782  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
783  * @since Moodle 2.0
784  * @package core
785  * @category output
786  */
787 class pix_emoticon extends pix_icon implements renderable {
789     /**
790      * Constructor
791      * @param string $pix short icon name
792      * @param string $alt alternative text
793      * @param string $component emoticon image provider
794      * @param array $attributes explicit HTML attributes
795      */
796     public function __construct($pix, $alt, $component = 'moodle', array $attributes = array()) {
797         if (empty($attributes['class'])) {
798             $attributes['class'] = 'emoticon';
799         }
800         parent::__construct($pix, $alt, $component, $attributes);
801     }
804 /**
805  * Data structure representing a simple form with only one button.
806  *
807  * @copyright 2009 Petr Skoda
808  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
809  * @since Moodle 2.0
810  * @package core
811  * @category output
812  */
813 class single_button implements renderable {
815     /**
816      * @var moodle_url Target url
817      */
818     public $url;
820     /**
821      * @var string Button label
822      */
823     public $label;
825     /**
826      * @var string Form submit method post or get
827      */
828     public $method = 'post';
830     /**
831      * @var string Wrapping div class
832      */
833     public $class = 'singlebutton';
835     /**
836      * @var bool True if button is primary button. Used for styling.
837      */
838     public $primary = false;
840     /**
841      * @var bool True if button disabled, false if normal
842      */
843     public $disabled = false;
845     /**
846      * @var string Button tooltip
847      */
848     public $tooltip = null;
850     /**
851      * @var string Form id
852      */
853     public $formid;
855     /**
856      * @var array List of attached actions
857      */
858     public $actions = array();
860     /**
861      * @var array $params URL Params
862      */
863     public $params;
865     /**
866      * @var string Action id
867      */
868     public $actionid;
870     /**
871      * @var array
872      */
873     protected $attributes = [];
875     /**
876      * Constructor
877      * @param moodle_url $url
878      * @param string $label button text
879      * @param string $method get or post submit method
880      * @param array $attributes Attributes for the HTML button tag
881      */
882     public function __construct(moodle_url $url, $label, $method='post', $primary=false, $attributes = []) {
883         $this->url    = clone($url);
884         $this->label  = $label;
885         $this->method = $method;
886         $this->primary = $primary;
887         $this->attributes = $attributes;
888     }
890     /**
891      * Shortcut for adding a JS confirm dialog when the button is clicked.
892      * The message must be a yes/no question.
893      *
894      * @param string $confirmmessage The yes/no confirmation question. If "Yes" is clicked, the original action will occur.
895      */
896     public function add_confirm_action($confirmmessage) {
897         $this->add_action(new confirm_action($confirmmessage));
898     }
900     /**
901      * Add action to the button.
902      * @param component_action $action
903      */
904     public function add_action(component_action $action) {
905         $this->actions[] = $action;
906     }
908     /**
909      * Sets an attribute for the HTML button tag.
910      *
911      * @param  string $name  The attribute name
912      * @param  mixed  $value The value
913      * @return null
914      */
915     public function set_attribute($name, $value) {
916         $this->attributes[$name] = $value;
917     }
919     /**
920      * Export data.
921      *
922      * @param renderer_base $output Renderer.
923      * @return stdClass
924      */
925     public function export_for_template(renderer_base $output) {
926         $url = $this->method === 'get' ? $this->url->out_omit_querystring(true) : $this->url->out_omit_querystring();
928         $data = new stdClass();
929         $data->id = html_writer::random_id('single_button');
930         $data->formid = $this->formid;
931         $data->method = $this->method;
932         $data->url = $url === '' ? '#' : $url;
933         $data->label = $this->label;
934         $data->classes = $this->class;
935         $data->disabled = $this->disabled;
936         $data->tooltip = $this->tooltip;
937         $data->primary = $this->primary;
939         $data->attributes = [];
940         foreach ($this->attributes as $key => $value) {
941             $data->attributes[] = ['name' => $key, 'value' => $value];
942         }
944         // Form parameters.
945         $params = $this->url->params();
946         if ($this->method === 'post') {
947             $params['sesskey'] = sesskey();
948         }
949         $data->params = array_map(function($key) use ($params) {
950             return ['name' => $key, 'value' => $params[$key]];
951         }, array_keys($params));
953         // Button actions.
954         $actions = $this->actions;
955         $data->actions = array_map(function($action) use ($output) {
956             return $action->export_for_template($output);
957         }, $actions);
958         $data->hasactions = !empty($data->actions);
960         return $data;
961     }
965 /**
966  * Simple form with just one select field that gets submitted automatically.
967  *
968  * If JS not enabled small go button is printed too.
969  *
970  * @copyright 2009 Petr Skoda
971  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
972  * @since Moodle 2.0
973  * @package core
974  * @category output
975  */
976 class single_select implements renderable, templatable {
978     /**
979      * @var moodle_url Target url - includes hidden fields
980      */
981     var $url;
983     /**
984      * @var string Name of the select element.
985      */
986     var $name;
988     /**
989      * @var array $options associative array value=>label ex.: array(1=>'One, 2=>Two)
990      *     it is also possible to specify optgroup as complex label array ex.:
991      *         array(array('Odd'=>array(1=>'One', 3=>'Three)), array('Even'=>array(2=>'Two')))
992      *         array(1=>'One', '--1uniquekey'=>array('More'=>array(2=>'Two', 3=>'Three')))
993      */
994     var $options;
996     /**
997      * @var string Selected option
998      */
999     var $selected;
1001     /**
1002      * @var array Nothing selected
1003      */
1004     var $nothing;
1006     /**
1007      * @var array Extra select field attributes
1008      */
1009     var $attributes = array();
1011     /**
1012      * @var string Button label
1013      */
1014     var $label = '';
1016     /**
1017      * @var array Button label's attributes
1018      */
1019     var $labelattributes = array();
1021     /**
1022      * @var string Form submit method post or get
1023      */
1024     var $method = 'get';
1026     /**
1027      * @var string Wrapping div class
1028      */
1029     var $class = 'singleselect';
1031     /**
1032      * @var bool True if button disabled, false if normal
1033      */
1034     var $disabled = false;
1036     /**
1037      * @var string Button tooltip
1038      */
1039     var $tooltip = null;
1041     /**
1042      * @var string Form id
1043      */
1044     var $formid = null;
1046     /**
1047      * @var help_icon The help icon for this element.
1048      */
1049     var $helpicon = null;
1051     /**
1052      * Constructor
1053      * @param moodle_url $url form action target, includes hidden fields
1054      * @param string $name name of selection field - the changing parameter in url
1055      * @param array $options list of options
1056      * @param string $selected selected element
1057      * @param array $nothing
1058      * @param string $formid
1059      */
1060     public function __construct(moodle_url $url, $name, array $options, $selected = '', $nothing = array('' => 'choosedots'), $formid = null) {
1061         $this->url      = $url;
1062         $this->name     = $name;
1063         $this->options  = $options;
1064         $this->selected = $selected;
1065         $this->nothing  = $nothing;
1066         $this->formid   = $formid;
1067     }
1069     /**
1070      * Shortcut for adding a JS confirm dialog when the button is clicked.
1071      * The message must be a yes/no question.
1072      *
1073      * @param string $confirmmessage The yes/no confirmation question. If "Yes" is clicked, the original action will occur.
1074      */
1075     public function add_confirm_action($confirmmessage) {
1076         $this->add_action(new component_action('submit', 'M.util.show_confirm_dialog', array('message' => $confirmmessage)));
1077     }
1079     /**
1080      * Add action to the button.
1081      *
1082      * @param component_action $action
1083      */
1084     public function add_action(component_action $action) {
1085         $this->actions[] = $action;
1086     }
1088     /**
1089      * Adds help icon.
1090      *
1091      * @deprecated since Moodle 2.0
1092      */
1093     public function set_old_help_icon($helppage, $title, $component = 'moodle') {
1094         throw new coding_exception('set_old_help_icon() can not be used any more, please see set_help_icon().');
1095     }
1097     /**
1098      * Adds help icon.
1099      *
1100      * @param string $identifier The keyword that defines a help page
1101      * @param string $component
1102      */
1103     public function set_help_icon($identifier, $component = 'moodle') {
1104         $this->helpicon = new help_icon($identifier, $component);
1105     }
1107     /**
1108      * Sets select's label
1109      *
1110      * @param string $label
1111      * @param array $attributes (optional)
1112      */
1113     public function set_label($label, $attributes = array()) {
1114         $this->label = $label;
1115         $this->labelattributes = $attributes;
1117     }
1119     /**
1120      * Export data.
1121      *
1122      * @param renderer_base $output Renderer.
1123      * @return stdClass
1124      */
1125     public function export_for_template(renderer_base $output) {
1126         $attributes = $this->attributes;
1128         $data = new stdClass();
1129         $data->name = $this->name;
1130         $data->method = $this->method;
1131         $data->action = $this->method === 'get' ? $this->url->out_omit_querystring(true) : $this->url->out_omit_querystring();
1132         $data->classes = $this->class;
1133         $data->label = $this->label;
1134         $data->disabled = $this->disabled;
1135         $data->title = $this->tooltip;
1136         $data->formid = !empty($this->formid) ? $this->formid : html_writer::random_id('single_select_f');
1137         $data->id = !empty($attributes['id']) ? $attributes['id'] : html_writer::random_id('single_select');
1139         // Select element attributes.
1140         // Unset attributes that are already predefined in the template.
1141         unset($attributes['id']);
1142         unset($attributes['class']);
1143         unset($attributes['name']);
1144         unset($attributes['title']);
1145         unset($attributes['disabled']);
1147         // Map the attributes.
1148         $data->attributes = array_map(function($key) use ($attributes) {
1149             return ['name' => $key, 'value' => $attributes[$key]];
1150         }, array_keys($attributes));
1152         // Form parameters.
1153         $params = $this->url->params();
1154         if ($this->method === 'post') {
1155             $params['sesskey'] = sesskey();
1156         }
1157         $data->params = array_map(function($key) use ($params) {
1158             return ['name' => $key, 'value' => $params[$key]];
1159         }, array_keys($params));
1161         // Select options.
1162         $hasnothing = false;
1163         if (is_string($this->nothing) && $this->nothing !== '') {
1164             $nothing = ['' => $this->nothing];
1165             $hasnothing = true;
1166             $nothingkey = '';
1167         } else if (is_array($this->nothing)) {
1168             $nothingvalue = reset($this->nothing);
1169             if ($nothingvalue === 'choose' || $nothingvalue === 'choosedots') {
1170                 $nothing = [key($this->nothing) => get_string('choosedots')];
1171             } else {
1172                 $nothing = $this->nothing;
1173             }
1174             $hasnothing = true;
1175             $nothingkey = key($this->nothing);
1176         }
1177         if ($hasnothing) {
1178             $options = $nothing + $this->options;
1179         } else {
1180             $options = $this->options;
1181         }
1183         foreach ($options as $value => $name) {
1184             if (is_array($options[$value])) {
1185                 foreach ($options[$value] as $optgroupname => $optgroupvalues) {
1186                     $sublist = [];
1187                     foreach ($optgroupvalues as $optvalue => $optname) {
1188                         $option = [
1189                             'value' => $optvalue,
1190                             'name' => $optname,
1191                             'selected' => strval($this->selected) === strval($optvalue),
1192                         ];
1194                         if ($hasnothing && $nothingkey === $optvalue) {
1195                             $option['ignore'] = 'data-ignore';
1196                         }
1198                         $sublist[] = $option;
1199                     }
1200                     $data->options[] = [
1201                         'name' => $optgroupname,
1202                         'optgroup' => true,
1203                         'options' => $sublist
1204                     ];
1205                 }
1206             } else {
1207                 $option = [
1208                     'value' => $value,
1209                     'name' => $options[$value],
1210                     'selected' => strval($this->selected) === strval($value),
1211                     'optgroup' => false
1212                 ];
1214                 if ($hasnothing && $nothingkey === $value) {
1215                     $option['ignore'] = 'data-ignore';
1216                 }
1218                 $data->options[] = $option;
1219             }
1220         }
1222         // Label attributes.
1223         $data->labelattributes = [];
1224         // Unset label attributes that are already in the template.
1225         unset($this->labelattributes['for']);
1226         // Map the label attributes.
1227         foreach ($this->labelattributes as $key => $value) {
1228             $data->labelattributes[] = ['name' => $key, 'value' => $value];
1229         }
1231         // Help icon.
1232         $data->helpicon = !empty($this->helpicon) ? $this->helpicon->export_for_template($output) : false;
1234         return $data;
1235     }
1238 /**
1239  * Simple URL selection widget description.
1240  *
1241  * @copyright 2009 Petr Skoda
1242  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1243  * @since Moodle 2.0
1244  * @package core
1245  * @category output
1246  */
1247 class url_select implements renderable, templatable {
1248     /**
1249      * @var array $urls associative array value=>label ex.: array(1=>'One, 2=>Two)
1250      *     it is also possible to specify optgroup as complex label array ex.:
1251      *         array(array('Odd'=>array(1=>'One', 3=>'Three)), array('Even'=>array(2=>'Two')))
1252      *         array(1=>'One', '--1uniquekey'=>array('More'=>array(2=>'Two', 3=>'Three')))
1253      */
1254     var $urls;
1256     /**
1257      * @var string Selected option
1258      */
1259     var $selected;
1261     /**
1262      * @var array Nothing selected
1263      */
1264     var $nothing;
1266     /**
1267      * @var array Extra select field attributes
1268      */
1269     var $attributes = array();
1271     /**
1272      * @var string Button label
1273      */
1274     var $label = '';
1276     /**
1277      * @var array Button label's attributes
1278      */
1279     var $labelattributes = array();
1281     /**
1282      * @var string Wrapping div class
1283      */
1284     var $class = 'urlselect';
1286     /**
1287      * @var bool True if button disabled, false if normal
1288      */
1289     var $disabled = false;
1291     /**
1292      * @var string Button tooltip
1293      */
1294     var $tooltip = null;
1296     /**
1297      * @var string Form id
1298      */
1299     var $formid = null;
1301     /**
1302      * @var help_icon The help icon for this element.
1303      */
1304     var $helpicon = null;
1306     /**
1307      * @var string If set, makes button visible with given name for button
1308      */
1309     var $showbutton = null;
1311     /**
1312      * Constructor
1313      * @param array $urls list of options
1314      * @param string $selected selected element
1315      * @param array $nothing
1316      * @param string $formid
1317      * @param string $showbutton Set to text of button if it should be visible
1318      *   or null if it should be hidden (hidden version always has text 'go')
1319      */
1320     public function __construct(array $urls, $selected = '', $nothing = array('' => 'choosedots'), $formid = null, $showbutton = null) {
1321         $this->urls       = $urls;
1322         $this->selected   = $selected;
1323         $this->nothing    = $nothing;
1324         $this->formid     = $formid;
1325         $this->showbutton = $showbutton;
1326     }
1328     /**
1329      * Adds help icon.
1330      *
1331      * @deprecated since Moodle 2.0
1332      */
1333     public function set_old_help_icon($helppage, $title, $component = 'moodle') {
1334         throw new coding_exception('set_old_help_icon() can not be used any more, please see set_help_icon().');
1335     }
1337     /**
1338      * Adds help icon.
1339      *
1340      * @param string $identifier The keyword that defines a help page
1341      * @param string $component
1342      */
1343     public function set_help_icon($identifier, $component = 'moodle') {
1344         $this->helpicon = new help_icon($identifier, $component);
1345     }
1347     /**
1348      * Sets select's label
1349      *
1350      * @param string $label
1351      * @param array $attributes (optional)
1352      */
1353     public function set_label($label, $attributes = array()) {
1354         $this->label = $label;
1355         $this->labelattributes = $attributes;
1356     }
1358     /**
1359      * Clean a URL.
1360      *
1361      * @param string $value The URL.
1362      * @return The cleaned URL.
1363      */
1364     protected function clean_url($value) {
1365         global $CFG;
1367         if (empty($value)) {
1368             // Nothing.
1370         } else if (strpos($value, $CFG->wwwroot . '/') === 0) {
1371             $value = str_replace($CFG->wwwroot, '', $value);
1373         } else if (strpos($value, '/') !== 0) {
1374             debugging("Invalid url_select urls parameter: url '$value' is not local relative url!", DEBUG_DEVELOPER);
1375         }
1377         return $value;
1378     }
1380     /**
1381      * Flatten the options for Mustache.
1382      *
1383      * This also cleans the URLs.
1384      *
1385      * @param array $options The options.
1386      * @param array $nothing The nothing option.
1387      * @return array
1388      */
1389     protected function flatten_options($options, $nothing) {
1390         $flattened = [];
1392         foreach ($options as $value => $option) {
1393             if (is_array($option)) {
1394                 foreach ($option as $groupname => $optoptions) {
1395                     if (!isset($flattened[$groupname])) {
1396                         $flattened[$groupname] = [
1397                             'name' => $groupname,
1398                             'isgroup' => true,
1399                             'options' => []
1400                         ];
1401                     }
1402                     foreach ($optoptions as $optvalue => $optoption) {
1403                         $cleanedvalue = $this->clean_url($optvalue);
1404                         $flattened[$groupname]['options'][$cleanedvalue] = [
1405                             'name' => $optoption,
1406                             'value' => $cleanedvalue,
1407                             'selected' => $this->selected == $optvalue,
1408                         ];
1409                     }
1410                 }
1412             } else {
1413                 $cleanedvalue = $this->clean_url($value);
1414                 $flattened[$cleanedvalue] = [
1415                     'name' => $option,
1416                     'value' => $cleanedvalue,
1417                     'selected' => $this->selected == $value,
1418                 ];
1419             }
1420         }
1422         if (!empty($nothing)) {
1423             $value = key($nothing);
1424             $name = reset($nothing);
1425             $flattened = [
1426                 $value => ['name' => $name, 'value' => $value, 'selected' => $this->selected == $value]
1427             ] + $flattened;
1428         }
1430         // Make non-associative array.
1431         foreach ($flattened as $key => $value) {
1432             if (!empty($value['options'])) {
1433                 $flattened[$key]['options'] = array_values($value['options']);
1434             }
1435         }
1436         $flattened = array_values($flattened);
1438         return $flattened;
1439     }
1441     /**
1442      * Export for template.
1443      *
1444      * @param renderer_base $output Renderer.
1445      * @return stdClass
1446      */
1447     public function export_for_template(renderer_base $output) {
1448         $attributes = $this->attributes;
1450         $data = new stdClass();
1451         $data->formid = !empty($this->formid) ? $this->formid : html_writer::random_id('url_select_f');
1452         $data->classes = $this->class;
1453         $data->label = $this->label;
1454         $data->disabled = $this->disabled;
1455         $data->title = $this->tooltip;
1456         $data->id = !empty($attributes['id']) ? $attributes['id'] : html_writer::random_id('url_select');
1457         $data->sesskey = sesskey();
1458         $data->action = (new moodle_url('/course/jumpto.php'))->out(false);
1460         // Remove attributes passed as property directly.
1461         unset($attributes['class']);
1462         unset($attributes['id']);
1463         unset($attributes['name']);
1464         unset($attributes['title']);
1465         unset($attributes['disabled']);
1467         $data->showbutton = $this->showbutton;
1469         // Select options.
1470         $nothing = false;
1471         if (is_string($this->nothing) && $this->nothing !== '') {
1472             $nothing = ['' => $this->nothing];
1473         } else if (is_array($this->nothing)) {
1474             $nothingvalue = reset($this->nothing);
1475             if ($nothingvalue === 'choose' || $nothingvalue === 'choosedots') {
1476                 $nothing = [key($this->nothing) => get_string('choosedots')];
1477             } else {
1478                 $nothing = $this->nothing;
1479             }
1480         }
1481         $data->options = $this->flatten_options($this->urls, $nothing);
1483         // Label attributes.
1484         $data->labelattributes = [];
1485         // Unset label attributes that are already in the template.
1486         unset($this->labelattributes['for']);
1487         // Map the label attributes.
1488         foreach ($this->labelattributes as $key => $value) {
1489             $data->labelattributes[] = ['name' => $key, 'value' => $value];
1490         }
1492         // Help icon.
1493         $data->helpicon = !empty($this->helpicon) ? $this->helpicon->export_for_template($output) : false;
1495         // Finally all the remaining attributes.
1496         $data->attributes = [];
1497         foreach ($attributes as $key => $value) {
1498             $data->attributes[] = ['name' => $key, 'value' => $value];
1499         }
1501         return $data;
1502     }
1505 /**
1506  * Data structure describing html link with special action attached.
1507  *
1508  * @copyright 2010 Petr Skoda
1509  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1510  * @since Moodle 2.0
1511  * @package core
1512  * @category output
1513  */
1514 class action_link implements renderable {
1516     /**
1517      * @var moodle_url Href url
1518      */
1519     public $url;
1521     /**
1522      * @var string Link text HTML fragment
1523      */
1524     public $text;
1526     /**
1527      * @var array HTML attributes
1528      */
1529     public $attributes;
1531     /**
1532      * @var array List of actions attached to link
1533      */
1534     public $actions;
1536     /**
1537      * @var pix_icon Optional pix icon to render with the link
1538      */
1539     public $icon;
1541     /**
1542      * Constructor
1543      * @param moodle_url $url
1544      * @param string $text HTML fragment
1545      * @param component_action $action
1546      * @param array $attributes associative array of html link attributes + disabled
1547      * @param pix_icon $icon optional pix_icon to render with the link text
1548      */
1549     public function __construct(moodle_url $url,
1550                                 $text,
1551                                 component_action $action=null,
1552                                 array $attributes=null,
1553                                 pix_icon $icon=null) {
1554         $this->url = clone($url);
1555         $this->text = $text;
1556         $this->attributes = (array)$attributes;
1557         if ($action) {
1558             $this->add_action($action);
1559         }
1560         $this->icon = $icon;
1561     }
1563     /**
1564      * Add action to the link.
1565      *
1566      * @param component_action $action
1567      */
1568     public function add_action(component_action $action) {
1569         $this->actions[] = $action;
1570     }
1572     /**
1573      * Adds a CSS class to this action link object
1574      * @param string $class
1575      */
1576     public function add_class($class) {
1577         if (empty($this->attributes['class'])) {
1578             $this->attributes['class'] = $class;
1579         } else {
1580             $this->attributes['class'] .= ' ' . $class;
1581         }
1582     }
1584     /**
1585      * Returns true if the specified class has been added to this link.
1586      * @param string $class
1587      * @return bool
1588      */
1589     public function has_class($class) {
1590         return strpos(' ' . $this->attributes['class'] . ' ', ' ' . $class . ' ') !== false;
1591     }
1593     /**
1594      * Return the rendered HTML for the icon. Useful for rendering action links in a template.
1595      * @return string
1596      */
1597     public function get_icon_html() {
1598         global $OUTPUT;
1599         if (!$this->icon) {
1600             return '';
1601         }
1602         return $OUTPUT->render($this->icon);
1603     }
1605     /**
1606      * Export for template.
1607      *
1608      * @param renderer_base $output The renderer.
1609      * @return stdClass
1610      */
1611     public function export_for_template(renderer_base $output) {
1612         $data = new stdClass();
1613         $attributes = $this->attributes;
1615         if (empty($attributes['id'])) {
1616             $attributes['id'] = html_writer::random_id('action_link');
1617         }
1618         $data->id = $attributes['id'];
1619         unset($attributes['id']);
1621         $data->disabled = !empty($attributes['disabled']);
1622         unset($attributes['disabled']);
1624         $data->text = $this->text instanceof renderable ? $output->render($this->text) : (string) $this->text;
1625         $data->url = $this->url ? $this->url->out(false) : '';
1626         $data->icon = $this->icon ? $this->icon->export_for_pix() : null;
1627         $data->classes = isset($attributes['class']) ? $attributes['class'] : '';
1628         unset($attributes['class']);
1630         $data->attributes = array_map(function($key, $value) {
1631             return [
1632                 'name' => $key,
1633                 'value' => $value
1634             ];
1635         }, array_keys($attributes), $attributes);
1637         $data->actions = array_map(function($action) use ($output) {
1638             return $action->export_for_template($output);
1639         }, !empty($this->actions) ? $this->actions : []);
1640         $data->hasactions = !empty($this->actions);
1642         return $data;
1643     }
1646 /**
1647  * Simple html output class
1648  *
1649  * @copyright 2009 Tim Hunt, 2010 Petr Skoda
1650  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1651  * @since Moodle 2.0
1652  * @package core
1653  * @category output
1654  */
1655 class html_writer {
1657     /**
1658      * Outputs a tag with attributes and contents
1659      *
1660      * @param string $tagname The name of tag ('a', 'img', 'span' etc.)
1661      * @param string $contents What goes between the opening and closing tags
1662      * @param array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
1663      * @return string HTML fragment
1664      */
1665     public static function tag($tagname, $contents, array $attributes = null) {
1666         return self::start_tag($tagname, $attributes) . $contents . self::end_tag($tagname);
1667     }
1669     /**
1670      * Outputs an opening tag with attributes
1671      *
1672      * @param string $tagname The name of tag ('a', 'img', 'span' etc.)
1673      * @param array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
1674      * @return string HTML fragment
1675      */
1676     public static function start_tag($tagname, array $attributes = null) {
1677         return '<' . $tagname . self::attributes($attributes) . '>';
1678     }
1680     /**
1681      * Outputs a closing tag
1682      *
1683      * @param string $tagname The name of tag ('a', 'img', 'span' etc.)
1684      * @return string HTML fragment
1685      */
1686     public static function end_tag($tagname) {
1687         return '</' . $tagname . '>';
1688     }
1690     /**
1691      * Outputs an empty tag with attributes
1692      *
1693      * @param string $tagname The name of tag ('input', 'img', 'br' etc.)
1694      * @param array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
1695      * @return string HTML fragment
1696      */
1697     public static function empty_tag($tagname, array $attributes = null) {
1698         return '<' . $tagname . self::attributes($attributes) . ' />';
1699     }
1701     /**
1702      * Outputs a tag, but only if the contents are not empty
1703      *
1704      * @param string $tagname The name of tag ('a', 'img', 'span' etc.)
1705      * @param string $contents What goes between the opening and closing tags
1706      * @param array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
1707      * @return string HTML fragment
1708      */
1709     public static function nonempty_tag($tagname, $contents, array $attributes = null) {
1710         if ($contents === '' || is_null($contents)) {
1711             return '';
1712         }
1713         return self::tag($tagname, $contents, $attributes);
1714     }
1716     /**
1717      * Outputs a HTML attribute and value
1718      *
1719      * @param string $name The name of the attribute ('src', 'href', 'class' etc.)
1720      * @param string $value The value of the attribute. The value will be escaped with {@link s()}
1721      * @return string HTML fragment
1722      */
1723     public static function attribute($name, $value) {
1724         if ($value instanceof moodle_url) {
1725             return ' ' . $name . '="' . $value->out() . '"';
1726         }
1728         // special case, we do not want these in output
1729         if ($value === null) {
1730             return '';
1731         }
1733         // no sloppy trimming here!
1734         return ' ' . $name . '="' . s($value) . '"';
1735     }
1737     /**
1738      * Outputs a list of HTML attributes and values
1739      *
1740      * @param array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
1741      *       The values will be escaped with {@link s()}
1742      * @return string HTML fragment
1743      */
1744     public static function attributes(array $attributes = null) {
1745         $attributes = (array)$attributes;
1746         $output = '';
1747         foreach ($attributes as $name => $value) {
1748             $output .= self::attribute($name, $value);
1749         }
1750         return $output;
1751     }
1753     /**
1754      * Generates a simple image tag with attributes.
1755      *
1756      * @param string $src The source of image
1757      * @param string $alt The alternate text for image
1758      * @param array $attributes The tag attributes (array('height' => $max_height, 'class' => 'class1') etc.)
1759      * @return string HTML fragment
1760      */
1761     public static function img($src, $alt, array $attributes = null) {
1762         $attributes = (array)$attributes;
1763         $attributes['src'] = $src;
1764         $attributes['alt'] = $alt;
1766         return self::empty_tag('img', $attributes);
1767     }
1769     /**
1770      * Generates random html element id.
1771      *
1772      * @staticvar int $counter
1773      * @staticvar type $uniq
1774      * @param string $base A string fragment that will be included in the random ID.
1775      * @return string A unique ID
1776      */
1777     public static function random_id($base='random') {
1778         static $counter = 0;
1779         static $uniq;
1781         if (!isset($uniq)) {
1782             $uniq = uniqid();
1783         }
1785         $counter++;
1786         return $base.$uniq.$counter;
1787     }
1789     /**
1790      * Generates a simple html link
1791      *
1792      * @param string|moodle_url $url The URL
1793      * @param string $text The text
1794      * @param array $attributes HTML attributes
1795      * @return string HTML fragment
1796      */
1797     public static function link($url, $text, array $attributes = null) {
1798         $attributes = (array)$attributes;
1799         $attributes['href']  = $url;
1800         return self::tag('a', $text, $attributes);
1801     }
1803     /**
1804      * Generates a simple checkbox with optional label
1805      *
1806      * @param string $name The name of the checkbox
1807      * @param string $value The value of the checkbox
1808      * @param bool $checked Whether the checkbox is checked
1809      * @param string $label The label for the checkbox
1810      * @param array $attributes Any attributes to apply to the checkbox
1811      * @param array $labelattributes Any attributes to apply to the label, if present
1812      * @return string html fragment
1813      */
1814     public static function checkbox($name, $value, $checked = true, $label = '',
1815             array $attributes = null, array $labelattributes = null) {
1816         $attributes = (array) $attributes;
1817         $output = '';
1819         if ($label !== '' and !is_null($label)) {
1820             if (empty($attributes['id'])) {
1821                 $attributes['id'] = self::random_id('checkbox_');
1822             }
1823         }
1824         $attributes['type']    = 'checkbox';
1825         $attributes['value']   = $value;
1826         $attributes['name']    = $name;
1827         $attributes['checked'] = $checked ? 'checked' : null;
1829         $output .= self::empty_tag('input', $attributes);
1831         if ($label !== '' and !is_null($label)) {
1832             $labelattributes = (array) $labelattributes;
1833             $labelattributes['for'] = $attributes['id'];
1834             $output .= self::tag('label', $label, $labelattributes);
1835         }
1837         return $output;
1838     }
1840     /**
1841      * Generates a simple select yes/no form field
1842      *
1843      * @param string $name name of select element
1844      * @param bool $selected
1845      * @param array $attributes - html select element attributes
1846      * @return string HTML fragment
1847      */
1848     public static function select_yes_no($name, $selected=true, array $attributes = null) {
1849         $options = array('1'=>get_string('yes'), '0'=>get_string('no'));
1850         return self::select($options, $name, $selected, null, $attributes);
1851     }
1853     /**
1854      * Generates a simple select form field
1855      *
1856      * @param array $options associative array value=>label ex.:
1857      *                array(1=>'One, 2=>Two)
1858      *              it is also possible to specify optgroup as complex label array ex.:
1859      *                array(array('Odd'=>array(1=>'One', 3=>'Three)), array('Even'=>array(2=>'Two')))
1860      *                array(1=>'One', '--1uniquekey'=>array('More'=>array(2=>'Two', 3=>'Three')))
1861      * @param string $name name of select element
1862      * @param string|array $selected value or array of values depending on multiple attribute
1863      * @param array|bool $nothing add nothing selected option, or false of not added
1864      * @param array $attributes html select element attributes
1865      * @return string HTML fragment
1866      */
1867     public static function select(array $options, $name, $selected = '', $nothing = array('' => 'choosedots'), array $attributes = null) {
1868         $attributes = (array)$attributes;
1869         if (is_array($nothing)) {
1870             foreach ($nothing as $k=>$v) {
1871                 if ($v === 'choose' or $v === 'choosedots') {
1872                     $nothing[$k] = get_string('choosedots');
1873                 }
1874             }
1875             $options = $nothing + $options; // keep keys, do not override
1877         } else if (is_string($nothing) and $nothing !== '') {
1878             // BC
1879             $options = array(''=>$nothing) + $options;
1880         }
1882         // we may accept more values if multiple attribute specified
1883         $selected = (array)$selected;
1884         foreach ($selected as $k=>$v) {
1885             $selected[$k] = (string)$v;
1886         }
1888         if (!isset($attributes['id'])) {
1889             $id = 'menu'.$name;
1890             // name may contaion [], which would make an invalid id. e.g. numeric question type editing form, assignment quickgrading
1891             $id = str_replace('[', '', $id);
1892             $id = str_replace(']', '', $id);
1893             $attributes['id'] = $id;
1894         }
1896         if (!isset($attributes['class'])) {
1897             $class = 'menu'.$name;
1898             // name may contaion [], which would make an invalid class. e.g. numeric question type editing form, assignment quickgrading
1899             $class = str_replace('[', '', $class);
1900             $class = str_replace(']', '', $class);
1901             $attributes['class'] = $class;
1902         }
1903         $attributes['class'] = 'select custom-select ' . $attributes['class']; // Add 'select' selector always.
1905         $attributes['name'] = $name;
1907         if (!empty($attributes['disabled'])) {
1908             $attributes['disabled'] = 'disabled';
1909         } else {
1910             unset($attributes['disabled']);
1911         }
1913         $output = '';
1914         foreach ($options as $value=>$label) {
1915             if (is_array($label)) {
1916                 // ignore key, it just has to be unique
1917                 $output .= self::select_optgroup(key($label), current($label), $selected);
1918             } else {
1919                 $output .= self::select_option($label, $value, $selected);
1920             }
1921         }
1922         return self::tag('select', $output, $attributes);
1923     }
1925     /**
1926      * Returns HTML to display a select box option.
1927      *
1928      * @param string $label The label to display as the option.
1929      * @param string|int $value The value the option represents
1930      * @param array $selected An array of selected options
1931      * @return string HTML fragment
1932      */
1933     private static function select_option($label, $value, array $selected) {
1934         $attributes = array();
1935         $value = (string)$value;
1936         if (in_array($value, $selected, true)) {
1937             $attributes['selected'] = 'selected';
1938         }
1939         $attributes['value'] = $value;
1940         return self::tag('option', $label, $attributes);
1941     }
1943     /**
1944      * Returns HTML to display a select box option group.
1945      *
1946      * @param string $groupname The label to use for the group
1947      * @param array $options The options in the group
1948      * @param array $selected An array of selected values.
1949      * @return string HTML fragment.
1950      */
1951     private static function select_optgroup($groupname, $options, array $selected) {
1952         if (empty($options)) {
1953             return '';
1954         }
1955         $attributes = array('label'=>$groupname);
1956         $output = '';
1957         foreach ($options as $value=>$label) {
1958             $output .= self::select_option($label, $value, $selected);
1959         }
1960         return self::tag('optgroup', $output, $attributes);
1961     }
1963     /**
1964      * This is a shortcut for making an hour selector menu.
1965      *
1966      * @param string $type The type of selector (years, months, days, hours, minutes)
1967      * @param string $name fieldname
1968      * @param int $currenttime A default timestamp in GMT
1969      * @param int $step minute spacing
1970      * @param array $attributes - html select element attributes
1971      * @return HTML fragment
1972      */
1973     public static function select_time($type, $name, $currenttime = 0, $step = 5, array $attributes = null) {
1974         global $OUTPUT;
1976         if (!$currenttime) {
1977             $currenttime = time();
1978         }
1979         $calendartype = \core_calendar\type_factory::get_calendar_instance();
1980         $currentdate = $calendartype->timestamp_to_date_array($currenttime);
1981         $userdatetype = $type;
1982         $timeunits = array();
1984         switch ($type) {
1985             case 'years':
1986                 $timeunits = $calendartype->get_years();
1987                 $userdatetype = 'year';
1988                 break;
1989             case 'months':
1990                 $timeunits = $calendartype->get_months();
1991                 $userdatetype = 'month';
1992                 $currentdate['month'] = (int)$currentdate['mon'];
1993                 break;
1994             case 'days':
1995                 $timeunits = $calendartype->get_days();
1996                 $userdatetype = 'mday';
1997                 break;
1998             case 'hours':
1999                 for ($i=0; $i<=23; $i++) {
2000                     $timeunits[$i] = sprintf("%02d",$i);
2001                 }
2002                 break;
2003             case 'minutes':
2004                 if ($step != 1) {
2005                     $currentdate['minutes'] = ceil($currentdate['minutes']/$step)*$step;
2006                 }
2008                 for ($i=0; $i<=59; $i+=$step) {
2009                     $timeunits[$i] = sprintf("%02d",$i);
2010                 }
2011                 break;
2012             default:
2013                 throw new coding_exception("Time type $type is not supported by html_writer::select_time().");
2014         }
2016         $attributes = (array) $attributes;
2017         $data = (object) [
2018             'name' => $name,
2019             'id' => !empty($attributes['id']) ? $attributes['id'] : self::random_id('ts_'),
2020             'label' => get_string(substr($type, 0, -1), 'form'),
2021             'options' => array_map(function($value) use ($timeunits, $currentdate, $userdatetype) {
2022                 return [
2023                     'name' => $timeunits[$value],
2024                     'value' => $value,
2025                     'selected' => $currentdate[$userdatetype] == $value
2026                 ];
2027             }, array_keys($timeunits)),
2028         ];
2030         unset($attributes['id']);
2031         unset($attributes['name']);
2032         $data->attributes = array_map(function($name) use ($attributes) {
2033             return [
2034                 'name' => $name,
2035                 'value' => $attributes[$name]
2036             ];
2037         }, array_keys($attributes));
2039         return $OUTPUT->render_from_template('core/select_time', $data);
2040     }
2042     /**
2043      * Shortcut for quick making of lists
2044      *
2045      * Note: 'list' is a reserved keyword ;-)
2046      *
2047      * @param array $items
2048      * @param array $attributes
2049      * @param string $tag ul or ol
2050      * @return string
2051      */
2052     public static function alist(array $items, array $attributes = null, $tag = 'ul') {
2053         $output = html_writer::start_tag($tag, $attributes)."\n";
2054         foreach ($items as $item) {
2055             $output .= html_writer::tag('li', $item)."\n";
2056         }
2057         $output .= html_writer::end_tag($tag);
2058         return $output;
2059     }
2061     /**
2062      * Returns hidden input fields created from url parameters.
2063      *
2064      * @param moodle_url $url
2065      * @param array $exclude list of excluded parameters
2066      * @return string HTML fragment
2067      */
2068     public static function input_hidden_params(moodle_url $url, array $exclude = null) {
2069         $exclude = (array)$exclude;
2070         $params = $url->params();
2071         foreach ($exclude as $key) {
2072             unset($params[$key]);
2073         }
2075         $output = '';
2076         foreach ($params as $key => $value) {
2077             $attributes = array('type'=>'hidden', 'name'=>$key, 'value'=>$value);
2078             $output .= self::empty_tag('input', $attributes)."\n";
2079         }
2080         return $output;
2081     }
2083     /**
2084      * Generate a script tag containing the the specified code.
2085      *
2086      * @param string $jscode the JavaScript code
2087      * @param moodle_url|string $url optional url of the external script, $code ignored if specified
2088      * @return string HTML, the code wrapped in <script> tags.
2089      */
2090     public static function script($jscode, $url=null) {
2091         if ($jscode) {
2092             return self::tag('script', "\n//<![CDATA[\n$jscode\n//]]>\n") . "\n";
2094         } else if ($url) {
2095             return self::tag('script', '', ['src' => $url]) . "\n";
2097         } else {
2098             return '';
2099         }
2100     }
2102     /**
2103      * Renders HTML table
2104      *
2105      * This method may modify the passed instance by adding some default properties if they are not set yet.
2106      * If this is not what you want, you should make a full clone of your data before passing them to this
2107      * method. In most cases this is not an issue at all so we do not clone by default for performance
2108      * and memory consumption reasons.
2109      *
2110      * @param html_table $table data to be rendered
2111      * @return string HTML code
2112      */
2113     public static function table(html_table $table) {
2114         // prepare table data and populate missing properties with reasonable defaults
2115         if (!empty($table->align)) {
2116             foreach ($table->align as $key => $aa) {
2117                 if ($aa) {
2118                     $table->align[$key] = 'text-align:'. fix_align_rtl($aa) .';';  // Fix for RTL languages
2119                 } else {
2120                     $table->align[$key] = null;
2121                 }
2122             }
2123         }
2124         if (!empty($table->size)) {
2125             foreach ($table->size as $key => $ss) {
2126                 if ($ss) {
2127                     $table->size[$key] = 'width:'. $ss .';';
2128                 } else {
2129                     $table->size[$key] = null;
2130                 }
2131             }
2132         }
2133         if (!empty($table->wrap)) {
2134             foreach ($table->wrap as $key => $ww) {
2135                 if ($ww) {
2136                     $table->wrap[$key] = 'white-space:nowrap;';
2137                 } else {
2138                     $table->wrap[$key] = '';
2139                 }
2140             }
2141         }
2142         if (!empty($table->head)) {
2143             foreach ($table->head as $key => $val) {
2144                 if (!isset($table->align[$key])) {
2145                     $table->align[$key] = null;
2146                 }
2147                 if (!isset($table->size[$key])) {
2148                     $table->size[$key] = null;
2149                 }
2150                 if (!isset($table->wrap[$key])) {
2151                     $table->wrap[$key] = null;
2152                 }
2154             }
2155         }
2156         if (empty($table->attributes['class'])) {
2157             $table->attributes['class'] = 'generaltable';
2158         }
2159         if (!empty($table->tablealign)) {
2160             $table->attributes['class'] .= ' boxalign' . $table->tablealign;
2161         }
2163         // explicitly assigned properties override those defined via $table->attributes
2164         $table->attributes['class'] = trim($table->attributes['class']);
2165         $attributes = array_merge($table->attributes, array(
2166                 'id'            => $table->id,
2167                 'width'         => $table->width,
2168                 'summary'       => $table->summary,
2169                 'cellpadding'   => $table->cellpadding,
2170                 'cellspacing'   => $table->cellspacing,
2171             ));
2172         $output = html_writer::start_tag('table', $attributes) . "\n";
2174         $countcols = 0;
2176         // Output a caption if present.
2177         if (!empty($table->caption)) {
2178             $captionattributes = array();
2179             if ($table->captionhide) {
2180                 $captionattributes['class'] = 'accesshide';
2181             }
2182             $output .= html_writer::tag(
2183                 'caption',
2184                 $table->caption,
2185                 $captionattributes
2186             );
2187         }
2189         if (!empty($table->head)) {
2190             $countcols = count($table->head);
2192             $output .= html_writer::start_tag('thead', array()) . "\n";
2193             $output .= html_writer::start_tag('tr', array()) . "\n";
2194             $keys = array_keys($table->head);
2195             $lastkey = end($keys);
2197             foreach ($table->head as $key => $heading) {
2198                 // Convert plain string headings into html_table_cell objects
2199                 if (!($heading instanceof html_table_cell)) {
2200                     $headingtext = $heading;
2201                     $heading = new html_table_cell();
2202                     $heading->text = $headingtext;
2203                     $heading->header = true;
2204                 }
2206                 if ($heading->header !== false) {
2207                     $heading->header = true;
2208                 }
2210                 if ($heading->header && empty($heading->scope)) {
2211                     $heading->scope = 'col';
2212                 }
2214                 $heading->attributes['class'] .= ' header c' . $key;
2215                 if (isset($table->headspan[$key]) && $table->headspan[$key] > 1) {
2216                     $heading->colspan = $table->headspan[$key];
2217                     $countcols += $table->headspan[$key] - 1;
2218                 }
2220                 if ($key == $lastkey) {
2221                     $heading->attributes['class'] .= ' lastcol';
2222                 }
2223                 if (isset($table->colclasses[$key])) {
2224                     $heading->attributes['class'] .= ' ' . $table->colclasses[$key];
2225                 }
2226                 $heading->attributes['class'] = trim($heading->attributes['class']);
2227                 $attributes = array_merge($heading->attributes, array(
2228                         'style'     => $table->align[$key] . $table->size[$key] . $heading->style,
2229                         'scope'     => $heading->scope,
2230                         'colspan'   => $heading->colspan,
2231                     ));
2233                 $tagtype = 'td';
2234                 if ($heading->header === true) {
2235                     $tagtype = 'th';
2236                 }
2237                 $output .= html_writer::tag($tagtype, $heading->text, $attributes) . "\n";
2238             }
2239             $output .= html_writer::end_tag('tr') . "\n";
2240             $output .= html_writer::end_tag('thead') . "\n";
2242             if (empty($table->data)) {
2243                 // For valid XHTML strict every table must contain either a valid tr
2244                 // or a valid tbody... both of which must contain a valid td
2245                 $output .= html_writer::start_tag('tbody', array('class' => 'empty'));
2246                 $output .= html_writer::tag('tr', html_writer::tag('td', '', array('colspan'=>count($table->head))));
2247                 $output .= html_writer::end_tag('tbody');
2248             }
2249         }
2251         if (!empty($table->data)) {
2252             $keys       = array_keys($table->data);
2253             $lastrowkey = end($keys);
2254             $output .= html_writer::start_tag('tbody', array());
2256             foreach ($table->data as $key => $row) {
2257                 if (($row === 'hr') && ($countcols)) {
2258                     $output .= html_writer::tag('td', html_writer::tag('div', '', array('class' => 'tabledivider')), array('colspan' => $countcols));
2259                 } else {
2260                     // Convert array rows to html_table_rows and cell strings to html_table_cell objects
2261                     if (!($row instanceof html_table_row)) {
2262                         $newrow = new html_table_row();
2264                         foreach ($row as $cell) {
2265                             if (!($cell instanceof html_table_cell)) {
2266                                 $cell = new html_table_cell($cell);
2267                             }
2268                             $newrow->cells[] = $cell;
2269                         }
2270                         $row = $newrow;
2271                     }
2273                     if (isset($table->rowclasses[$key])) {
2274                         $row->attributes['class'] .= ' ' . $table->rowclasses[$key];
2275                     }
2277                     if ($key == $lastrowkey) {
2278                         $row->attributes['class'] .= ' lastrow';
2279                     }
2281                     // Explicitly assigned properties should override those defined in the attributes.
2282                     $row->attributes['class'] = trim($row->attributes['class']);
2283                     $trattributes = array_merge($row->attributes, array(
2284                             'id'            => $row->id,
2285                             'style'         => $row->style,
2286                         ));
2287                     $output .= html_writer::start_tag('tr', $trattributes) . "\n";
2288                     $keys2 = array_keys($row->cells);
2289                     $lastkey = end($keys2);
2291                     $gotlastkey = false; //flag for sanity checking
2292                     foreach ($row->cells as $key => $cell) {
2293                         if ($gotlastkey) {
2294                             //This should never happen. Why do we have a cell after the last cell?
2295                             mtrace("A cell with key ($key) was found after the last key ($lastkey)");
2296                         }
2298                         if (!($cell instanceof html_table_cell)) {
2299                             $mycell = new html_table_cell();
2300                             $mycell->text = $cell;
2301                             $cell = $mycell;
2302                         }
2304                         if (($cell->header === true) && empty($cell->scope)) {
2305                             $cell->scope = 'row';
2306                         }
2308                         if (isset($table->colclasses[$key])) {
2309                             $cell->attributes['class'] .= ' ' . $table->colclasses[$key];
2310                         }
2312                         $cell->attributes['class'] .= ' cell c' . $key;
2313                         if ($key == $lastkey) {
2314                             $cell->attributes['class'] .= ' lastcol';
2315                             $gotlastkey = true;
2316                         }
2317                         $tdstyle = '';
2318                         $tdstyle .= isset($table->align[$key]) ? $table->align[$key] : '';
2319                         $tdstyle .= isset($table->size[$key]) ? $table->size[$key] : '';
2320                         $tdstyle .= isset($table->wrap[$key]) ? $table->wrap[$key] : '';
2321                         $cell->attributes['class'] = trim($cell->attributes['class']);
2322                         $tdattributes = array_merge($cell->attributes, array(
2323                                 'style' => $tdstyle . $cell->style,
2324                                 'colspan' => $cell->colspan,
2325                                 'rowspan' => $cell->rowspan,
2326                                 'id' => $cell->id,
2327                                 'abbr' => $cell->abbr,
2328                                 'scope' => $cell->scope,
2329                             ));
2330                         $tagtype = 'td';
2331                         if ($cell->header === true) {
2332                             $tagtype = 'th';
2333                         }
2334                         $output .= html_writer::tag($tagtype, $cell->text, $tdattributes) . "\n";
2335                     }
2336                 }
2337                 $output .= html_writer::end_tag('tr') . "\n";
2338             }
2339             $output .= html_writer::end_tag('tbody') . "\n";
2340         }
2341         $output .= html_writer::end_tag('table') . "\n";
2343         return $output;
2344     }
2346     /**
2347      * Renders form element label
2348      *
2349      * By default, the label is suffixed with a label separator defined in the
2350      * current language pack (colon by default in the English lang pack).
2351      * Adding the colon can be explicitly disabled if needed. Label separators
2352      * are put outside the label tag itself so they are not read by
2353      * screenreaders (accessibility).
2354      *
2355      * Parameter $for explicitly associates the label with a form control. When
2356      * set, the value of this attribute must be the same as the value of
2357      * the id attribute of the form control in the same document. When null,
2358      * the label being defined is associated with the control inside the label
2359      * element.
2360      *
2361      * @param string $text content of the label tag
2362      * @param string|null $for id of the element this label is associated with, null for no association
2363      * @param bool $colonize add label separator (colon) to the label text, if it is not there yet
2364      * @param array $attributes to be inserted in the tab, for example array('accesskey' => 'a')
2365      * @return string HTML of the label element
2366      */
2367     public static function label($text, $for, $colonize = true, array $attributes=array()) {
2368         if (!is_null($for)) {
2369             $attributes = array_merge($attributes, array('for' => $for));
2370         }
2371         $text = trim($text);
2372         $label = self::tag('label', $text, $attributes);
2374         // TODO MDL-12192 $colonize disabled for now yet
2375         // if (!empty($text) and $colonize) {
2376         //     // the $text may end with the colon already, though it is bad string definition style
2377         //     $colon = get_string('labelsep', 'langconfig');
2378         //     if (!empty($colon)) {
2379         //         $trimmed = trim($colon);
2380         //         if ((substr($text, -strlen($trimmed)) == $trimmed) or (substr($text, -1) == ':')) {
2381         //             //debugging('The label text should not end with colon or other label separator,
2382         //             //           please fix the string definition.', DEBUG_DEVELOPER);
2383         //         } else {
2384         //             $label .= $colon;
2385         //         }
2386         //     }
2387         // }
2389         return $label;
2390     }
2392     /**
2393      * Combines a class parameter with other attributes. Aids in code reduction
2394      * because the class parameter is very frequently used.
2395      *
2396      * If the class attribute is specified both in the attributes and in the
2397      * class parameter, the two values are combined with a space between.
2398      *
2399      * @param string $class Optional CSS class (or classes as space-separated list)
2400      * @param array $attributes Optional other attributes as array
2401      * @return array Attributes (or null if still none)
2402      */
2403     private static function add_class($class = '', array $attributes = null) {
2404         if ($class !== '') {
2405             $classattribute = array('class' => $class);
2406             if ($attributes) {
2407                 if (array_key_exists('class', $attributes)) {
2408                     $attributes['class'] = trim($attributes['class'] . ' ' . $class);
2409                 } else {
2410                     $attributes = $classattribute + $attributes;
2411                 }
2412             } else {
2413                 $attributes = $classattribute;
2414             }
2415         }
2416         return $attributes;
2417     }
2419     /**
2420      * Creates a <div> tag. (Shortcut function.)
2421      *
2422      * @param string $content HTML content of tag
2423      * @param string $class Optional CSS class (or classes as space-separated list)
2424      * @param array $attributes Optional other attributes as array
2425      * @return string HTML code for div
2426      */
2427     public static function div($content, $class = '', array $attributes = null) {
2428         return self::tag('div', $content, self::add_class($class, $attributes));
2429     }
2431     /**
2432      * Starts a <div> tag. (Shortcut function.)
2433      *
2434      * @param string $class Optional CSS class (or classes as space-separated list)
2435      * @param array $attributes Optional other attributes as array
2436      * @return string HTML code for open div tag
2437      */
2438     public static function start_div($class = '', array $attributes = null) {
2439         return self::start_tag('div', self::add_class($class, $attributes));
2440     }
2442     /**
2443      * Ends a <div> tag. (Shortcut function.)
2444      *
2445      * @return string HTML code for close div tag
2446      */
2447     public static function end_div() {
2448         return self::end_tag('div');
2449     }
2451     /**
2452      * Creates a <span> tag. (Shortcut function.)
2453      *
2454      * @param string $content HTML content of tag
2455      * @param string $class Optional CSS class (or classes as space-separated list)
2456      * @param array $attributes Optional other attributes as array
2457      * @return string HTML code for span
2458      */
2459     public static function span($content, $class = '', array $attributes = null) {
2460         return self::tag('span', $content, self::add_class($class, $attributes));
2461     }
2463     /**
2464      * Starts a <span> tag. (Shortcut function.)
2465      *
2466      * @param string $class Optional CSS class (or classes as space-separated list)
2467      * @param array $attributes Optional other attributes as array
2468      * @return string HTML code for open span tag
2469      */
2470     public static function start_span($class = '', array $attributes = null) {
2471         return self::start_tag('span', self::add_class($class, $attributes));
2472     }
2474     /**
2475      * Ends a <span> tag. (Shortcut function.)
2476      *
2477      * @return string HTML code for close span tag
2478      */
2479     public static function end_span() {
2480         return self::end_tag('span');
2481     }
2484 /**
2485  * Simple javascript output class
2486  *
2487  * @copyright 2010 Petr Skoda
2488  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2489  * @since Moodle 2.0
2490  * @package core
2491  * @category output
2492  */
2493 class js_writer {
2495     /**
2496      * Returns javascript code calling the function
2497      *
2498      * @param string $function function name, can be complex like Y.Event.purgeElement
2499      * @param array $arguments parameters
2500      * @param int $delay execution delay in seconds
2501      * @return string JS code fragment
2502      */
2503     public static function function_call($function, array $arguments = null, $delay=0) {
2504         if ($arguments) {
2505             $arguments = array_map('json_encode', convert_to_array($arguments));
2506             $arguments = implode(', ', $arguments);
2507         } else {
2508             $arguments = '';
2509         }
2510         $js = "$function($arguments);";
2512         if ($delay) {
2513             $delay = $delay * 1000; // in miliseconds
2514             $js = "setTimeout(function() { $js }, $delay);";
2515         }
2516         return $js . "\n";
2517     }
2519     /**
2520      * Special function which adds Y as first argument of function call.
2521      *
2522      * @param string $function The function to call
2523      * @param array $extraarguments Any arguments to pass to it
2524      * @return string Some JS code
2525      */
2526     public static function function_call_with_Y($function, array $extraarguments = null) {
2527         if ($extraarguments) {
2528             $extraarguments = array_map('json_encode', convert_to_array($extraarguments));
2529             $arguments = 'Y, ' . implode(', ', $extraarguments);
2530         } else {
2531             $arguments = 'Y';
2532         }
2533         return "$function($arguments);\n";
2534     }
2536     /**
2537      * Returns JavaScript code to initialise a new object
2538      *
2539      * @param string $var If it is null then no var is assigned the new object.
2540      * @param string $class The class to initialise an object for.
2541      * @param array $arguments An array of args to pass to the init method.
2542      * @param array $requirements Any modules required for this class.
2543      * @param int $delay The delay before initialisation. 0 = no delay.
2544      * @return string Some JS code
2545      */
2546     public static function object_init($var, $class, array $arguments = null, array $requirements = null, $delay=0) {
2547         if (is_array($arguments)) {
2548             $arguments = array_map('json_encode', convert_to_array($arguments));
2549             $arguments = implode(', ', $arguments);
2550         }
2552         if ($var === null) {
2553             $js = "new $class(Y, $arguments);";
2554         } else if (strpos($var, '.')!==false) {
2555             $js = "$var = new $class(Y, $arguments);";
2556         } else {
2557             $js = "var $var = new $class(Y, $arguments);";
2558         }
2560         if ($delay) {
2561             $delay = $delay * 1000; // in miliseconds
2562             $js = "setTimeout(function() { $js }, $delay);";
2563         }
2565         if (count($requirements) > 0) {
2566             $requirements = implode("', '", $requirements);
2567             $js = "Y.use('$requirements', function(Y){ $js });";
2568         }
2569         return $js."\n";
2570     }
2572     /**
2573      * Returns code setting value to variable
2574      *
2575      * @param string $name
2576      * @param mixed $value json serialised value
2577      * @param bool $usevar add var definition, ignored for nested properties
2578      * @return string JS code fragment
2579      */
2580     public static function set_variable($name, $value, $usevar = true) {
2581         $output = '';
2583         if ($usevar) {
2584             if (strpos($name, '.')) {
2585                 $output .= '';
2586             } else {
2587                 $output .= 'var ';
2588             }
2589         }
2591         $output .= "$name = ".json_encode($value).";";
2593         return $output;
2594     }
2596     /**
2597      * Writes event handler attaching code
2598      *
2599      * @param array|string $selector standard YUI selector for elements, may be
2600      *     array or string, element id is in the form "#idvalue"
2601      * @param string $event A valid DOM event (click, mousedown, change etc.)
2602      * @param string $function The name of the function to call
2603      * @param array $arguments An optional array of argument parameters to pass to the function
2604      * @return string JS code fragment
2605      */
2606     public static function event_handler($selector, $event, $function, array $arguments = null) {
2607         $selector = json_encode($selector);
2608         $output = "Y.on('$event', $function, $selector, null";
2609         if (!empty($arguments)) {
2610             $output .= ', ' . json_encode($arguments);
2611         }
2612         return $output . ");\n";
2613     }
2616 /**
2617  * Holds all the information required to render a <table> by {@link core_renderer::table()}
2618  *
2619  * Example of usage:
2620  * $t = new html_table();
2621  * ... // set various properties of the object $t as described below
2622  * echo html_writer::table($t);
2623  *
2624  * @copyright 2009 David Mudrak <david.mudrak@gmail.com>
2625  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2626  * @since Moodle 2.0
2627  * @package core
2628  * @category output
2629  */
2630 class html_table {
2632     /**
2633      * @var string Value to use for the id attribute of the table
2634      */
2635     public $id = null;
2637     /**
2638      * @var array Attributes of HTML attributes for the <table> element
2639      */
2640     public $attributes = array();
2642     /**
2643      * @var array An array of headings. The n-th array item is used as a heading of the n-th column.
2644      * For more control over the rendering of the headers, an array of html_table_cell objects
2645      * can be passed instead of an array of strings.
2646      *
2647      * Example of usage:
2648      * $t->head = array('Student', 'Grade');
2649      */
2650     public $head;
2652     /**
2653      * @var array An array that can be used to make a heading span multiple columns.
2654      * In this example, {@link html_table:$data} is supposed to have three columns. For the first two columns,
2655      * the same heading is used. Therefore, {@link html_table::$head} should consist of two items.
2656      *
2657      * Example of usage:
2658      * $t->headspan = array(2,1);
2659      */
2660     public $headspan;
2662     /**
2663      * @var array An array of column alignments.
2664      * The value is used as CSS 'text-align' property. Therefore, possible
2665      * values are 'left', 'right', 'center' and 'justify'. Specify 'right' or 'left' from the perspective
2666      * of a left-to-right (LTR) language. For RTL, the values are flipped automatically.
2667      *
2668      * Examples of usage:
2669      * $t->align = array(null, 'right');
2670      * or
2671      * $t->align[1] = 'right';
2672      */
2673     public $align;
2675     /**
2676      * @var array The value is used as CSS 'size' property.
2677      *
2678      * Examples of usage:
2679      * $t->size = array('50%', '50%');
2680      * or
2681      * $t->size[1] = '120px';
2682      */
2683     public $size;
2685     /**
2686      * @var array An array of wrapping information.
2687      * The only possible value is 'nowrap' that sets the
2688      * CSS property 'white-space' to the value 'nowrap' in the given column.
2689      *
2690      * Example of usage:
2691      * $t->wrap = array(null, 'nowrap');
2692      */
2693     public $wrap;
2695     /**
2696      * @var array Array of arrays or html_table_row objects containing the data. Alternatively, if you have
2697      * $head specified, the string 'hr' (for horizontal ruler) can be used
2698      * instead of an array of cells data resulting in a divider rendered.
2699      *
2700      * Example of usage with array of arrays:
2701      * $row1 = array('Harry Potter', '76 %');
2702      * $row2 = array('Hermione Granger', '100 %');
2703      * $t->data = array($row1, $row2);
2704      *
2705      * Example with array of html_table_row objects: (used for more fine-grained control)
2706      * $cell1 = new html_table_cell();
2707      * $cell1->text = 'Harry Potter';
2708      * $cell1->colspan = 2;
2709      * $row1 = new html_table_row();
2710      * $row1->cells[] = $cell1;
2711      * $cell2 = new html_table_cell();
2712      * $cell2->text = 'Hermione Granger';
2713      * $cell3 = new html_table_cell();
2714      * $cell3->text = '100 %';
2715      * $row2 = new html_table_row();
2716      * $row2->cells = array($cell2, $cell3);
2717      * $t->data = array($row1, $row2);
2718      */
2719     public $data = [];
2721     /**
2722      * @deprecated since Moodle 2.0. Styling should be in the CSS.
2723      * @var string Width of the table, percentage of the page preferred.
2724      */
2725     public $width = null;
2727     /**
2728      * @deprecated since Moodle 2.0. Styling should be in the CSS.
2729      * @var string Alignment for the whole table. Can be 'right', 'left' or 'center' (default).
2730      */
2731     public $tablealign = null;
2733     /**
2734      * @deprecated since Moodle 2.0. Styling should be in the CSS.
2735      * @var int Padding on each cell, in pixels
2736      */
2737     public $cellpadding = null;
2739     /**
2740      * @var int Spacing between cells, in pixels
2741      * @deprecated since Moodle 2.0. Styling should be in the CSS.
2742      */
2743     public $cellspacing = null;
2745     /**
2746      * @var array Array of classes to add to particular rows, space-separated string.
2747      * Class 'lastrow' is added automatically for the last row in the table.
2748      *
2749      * Example of usage:
2750      * $t->rowclasses[9] = 'tenth'
2751      */
2752     public $rowclasses;
2754     /**
2755      * @var array An array of classes to add to every cell in a particular column,
2756      * space-separated string. Class 'cell' is added automatically by the renderer.
2757      * Classes 'c0' or 'c1' are added automatically for every odd or even column,
2758      * respectively. Class 'lastcol' is added automatically for all last cells
2759      * in a row.
2760      *
2761      * Example of usage:
2762      * $t->colclasses = array(null, 'grade');
2763      */
2764     public $colclasses;
2766     /**
2767      * @var string Description of the contents for screen readers.
2768      */
2769     public $summary;
2771     /**
2772      * @var string Caption for the table, typically a title.
2773      *
2774      * Example of usage:
2775      * $t->caption = "TV Guide";
2776      */
2777     public $caption;
2779     /**
2780      * @var bool Whether to hide the table's caption from sighted users.
2781      *
2782      * Example of usage:
2783      * $t->caption = "TV Guide";
2784      * $t->captionhide = true;
2785      */
2786     public $captionhide = false;
2788     /**
2789      * Constructor
2790      */
2791     public function __construct() {
2792         $this->attributes['class'] = '';
2793     }
2796 /**
2797  * Component representing a table row.
2798  *
2799  * @copyright 2009 Nicolas Connault
2800  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2801  * @since Moodle 2.0
2802  * @package core
2803  * @category output
2804  */
2805 class html_table_row {
2807     /**
2808      * @var string Value to use for the id attribute of the row.
2809      */
2810     public $id = null;
2812     /**
2813      * @var array Array of html_table_cell objects
2814      */
2815     public $cells = array();
2817     /**
2818      * @var string Value to use for the style attribute of the table row
2819      */
2820     public $style = null;
2822     /**
2823      * @var array Attributes of additional HTML attributes for the <tr> element
2824      */
2825     public $attributes = array();
2827     /**
2828      * Constructor
2829      * @param array $cells
2830      */
2831     public function __construct(array $cells=null) {
2832         $this->attributes['class'] = '';
2833         $cells = (array)$cells;
2834         foreach ($cells as $cell) {
2835             if ($cell instanceof html_table_cell) {
2836                 $this->cells[] = $cell;
2837             } else {
2838                 $this->cells[] = new html_table_cell($cell);
2839             }
2840         }
2841     }
2844 /**
2845  * Component representing a table cell.
2846  *
2847  * @copyright 2009 Nicolas Connault
2848  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2849  * @since Moodle 2.0
2850  * @package core
2851  * @category output
2852  */
2853 class html_table_cell {
2855     /**
2856      * @var string Value to use for the id attribute of the cell.
2857      */
2858     public $id = null;
2860     /**
2861      * @var string The contents of the cell.
2862      */
2863     public $text;
2865     /**
2866      * @var string Abbreviated version of the contents of the cell.
2867      */
2868     public $abbr = null;
2870     /**
2871      * @var int Number of columns this cell should span.
2872      */
2873     public $colspan = null;
2875     /**
2876      * @var int Number of rows this cell should span.
2877      */
2878     public $rowspan = null;
2880     /**
2881      * @var string Defines a way to associate header cells and data cells in a table.
2882      */
2883     public $scope = null;
2885     /**
2886      * @var bool Whether or not this cell is a header cell.
2887      */
2888     public $header = null;
2890     /**
2891      * @var string Value to use for the style attribute of the table cell
2892      */
2893     public $style = null;
2895     /**
2896      * @var array Attributes of additional HTML attributes for the <td> element
2897      */
2898     public $attributes = array();
2900     /**
2901      * Constructs a table cell
2902      *
2903      * @param string $text
2904      */
2905     public function __construct($text = null) {
2906         $this->text = $text;
2907         $this->attributes['class'] = '';
2908     }
2911 /**
2912  * Component representing a paging bar.
2913  *
2914  * @copyright 2009 Nicolas Connault
2915  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2916  * @since Moodle 2.0
2917  * @package core
2918  * @category output
2919  */
2920 class paging_bar implements renderable, templatable {
2922     /**
2923      * @var int The maximum number of pagelinks to display.
2924      */
2925     public $maxdisplay = 18;
2927     /**
2928      * @var int The total number of entries to be pages through..
2929      */
2930     public $totalcount;
2932     /**
2933      * @var int The page you are currently viewing.
2934      */
2935     public $page;
2937     /**
2938      * @var int The number of entries that should be shown per page.
2939      */
2940     public $perpage;
2942     /**
2943      * @var string|moodle_url If this  is a string then it is the url which will be appended with $pagevar,
2944      * an equals sign and the page number.
2945      * If this is a moodle_url object then the pagevar param will be replaced by
2946      * the page no, for each page.
2947      */
2948     public $baseurl;
2950     /**
2951      * @var string This is the variable name that you use for the pagenumber in your
2952      * code (ie. 'tablepage', 'blogpage', etc)
2953      */
2954     public $pagevar;
2956     /**
2957      * @var string A HTML link representing the "previous" page.
2958      */
2959     public $previouslink = null;
2961     /**
2962      * @var string A HTML link representing the "next" page.
2963      */
2964     public $nextlink = null;
2966     /**
2967      * @var string A HTML link representing the first page.
2968      */
2969     public $firstlink = null;
2971     /**
2972      * @var string A HTML link representing the last page.
2973      */
2974     public $lastlink = null;
2976     /**
2977      * @var array An array of strings. One of them is just a string: the current page
2978      */
2979     public $pagelinks = array();
2981     /**
2982      * Constructor paging_bar with only the required params.
2983      *
2984      * @param int $totalcount The total number of entries available to be paged through
2985      * @param int $page The page you are currently viewing
2986      * @param int $perpage The number of entries that should be shown per page
2987      * @param string|moodle_url $baseurl url of the current page, the $pagevar parameter is added
2988      * @param string $pagevar name of page parameter that holds the page number
2989      */
2990     public function __construct($totalcount, $page, $perpage, $baseurl, $pagevar = 'page') {
2991         $this->totalcount = $totalcount;
2992         $this->page       = $page;
2993         $this->perpage    = $perpage;
2994         $this->baseurl    = $baseurl;
2995         $this->pagevar    = $pagevar;
2996     }
2998     /**
2999      * Prepares the paging bar for output.
3000      *
3001      * This method validates the arguments set up for the paging bar and then
3002      * produces fragments of HTML to assist display later on.
3003      *
3004      * @param renderer_base $output
3005      * @param moodle_page $page
3006      * @param string $target
3007      * @throws coding_exception
3008      */
3009     public function prepare(renderer_base $output, moodle_page $page, $target) {
3010         if (!isset($this->totalcount) || is_null($this->totalcount)) {
3011             throw new coding_exception('paging_bar requires a totalcount value.');
3012         }
3013         if (!isset($this->page) || is_null($this->page)) {
3014             throw new coding_exception('paging_bar requires a page value.');
3015         }
3016         if (empty($this->perpage)) {
3017             throw new coding_exception('paging_bar requires a perpage value.');
3018         }
3019         if (empty($this->baseurl)) {
3020             throw new coding_exception('paging_bar requires a baseurl value.');
3021         }
3023         if ($this->totalcount > $this->perpage) {
3024             $pagenum = $this->page - 1;
3026             if ($this->page > 0) {
3027                 $this->previouslink = html_writer::link(new moodle_url($this->baseurl, array($this->pagevar=>$pagenum)), get_string('previous'), array('class'=>'previous'));
3028             }
3030             if ($this->perpage > 0) {
3031                 $lastpage = ceil($this->totalcount / $this->perpage);
3032             } else {
3033                 $lastpage = 1;
3034             }
3036             if ($this->page > round(($this->maxdisplay/3)*2)) {
3037                 $currpage = $this->page - round($this->maxdisplay/3);
3039                 $this->firstlink = html_writer::link(new moodle_url($this->baseurl, array($this->pagevar=>0)), '1', array('class'=>'first'));
3040             } else {
3041                 $currpage = 0;
3042             }
3044             $displaycount = $displaypage = 0;
3046             while ($displaycount < $this->maxdisplay and $currpage < $lastpage) {
3047                 $displaypage = $currpage + 1;
3049                 if ($this->page == $currpage) {
3050                     $this->pagelinks[] = html_writer::span($displaypage, 'current-page');
3051                 } else {
3052                     $pagelink = html_writer::link(new moodle_url($this->baseurl, array($this->pagevar=>$currpage)), $displaypage);
3053                     $this->pagelinks[] = $pagelink;
3054                 }
3056                 $displaycount++;
3057                 $currpage++;
3058             }
3060             if ($currpage < $lastpage) {
3061                 $lastpageactual = $lastpage - 1;
3062                 $this->lastlink = html_writer::link(new moodle_url($this->baseurl, array($this->pagevar=>$lastpageactual)), $lastpage, array('class'=>'last'));
3063             }
3065             $pagenum = $this->page + 1;
3067             if ($pagenum != $lastpage) {
3068                 $this->nextlink = html_writer::link(new moodle_url($this->baseurl, array($this->pagevar=>$pagenum)), get_string('next'), array('class'=>'next'));
3069             }
3070         }
3071     }
3073     /**
3074      * Export for template.
3075      *
3076      * @param renderer_base $output The renderer.
3077      * @return stdClass
3078      */
3079     public function export_for_template(renderer_base $output) {
3080         $data = new stdClass();
3081         $data->previous = null;
3082         $data->next = null;
3083         $data->first = null;
3084         $data->last = null;
3085         $data->label = get_string('page');
3086         $data->pages = [];
3087         $data->haspages = $this->totalcount > $this->perpage;
3088         $data->pagesize = $this->perpage;
3090         if (!$data->haspages) {
3091             return $data;
3092         }
3094         if ($this->page > 0) {
3095             $data->previous = [
3096                 'page' => $this->page,
3097                 'url' => (new moodle_url($this->baseurl, [$this->pagevar => $this->page - 1]))->out(false)
3098             ];
3099         }
3101         $currpage = 0;
3102         if ($this->page > round(($this->maxdisplay / 3) * 2)) {
3103             $currpage = $this->page - round($this->maxdisplay / 3);
3104             $data->first = [
3105                 'page' => 1,
3106                 'url' => (new moodle_url($this->baseurl, [$this->pagevar => 0]))->out(false)
3107             ];
3108         }
3110         $lastpage = 1;
3111         if ($this->perpage > 0) {
3112             $lastpage = ceil($this->totalcount / $this->perpage);
3113         }
3115         $displaycount = 0;
3116         $displaypage = 0;
3117         while ($displaycount < $this->maxdisplay and $currpage < $lastpage) {
3118             $displaypage = $currpage + 1;
3120             $iscurrent = $this->page == $currpage;
3121             $link = new moodle_url($this->baseurl, [$this->pagevar => $currpage]);
3123             $data->pages[] = [
3124                 'page' => $displaypage,
3125                 'active' => $iscurrent,
3126                 'url' => $iscurrent ? null : $link->out(false)
3127             ];
3129             $displaycount++;
3130             $currpage++;
3131         }
3133         if ($currpage < $lastpage) {
3134             $data->last = [
3135                 'page' => $lastpage,
3136                 'url' => (new moodle_url($this->baseurl, [$this->pagevar => $lastpage - 1]))->out(false)
3137             ];
3138         }
3140         if ($this->page + 1 != $lastpage) {
3141             $data->next = [
3142                 'page' => $this->page + 2,
3143                 'url' => (new moodle_url($this->baseurl, [$this->pagevar => $this->page + 1]))->out(false)
3144             ];
3145         }
3147         return $data;
3148     }
3151 /**
3152  * Component representing initials bar.
3153  *
3154  * @copyright 2017 Ilya Tregubov
3155  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3156  * @since Moodle 3.3
3157  * @package core
3158  * @category output
3159  */
3160 class initials_bar implements renderable, templatable {
3162     /**
3163      * @var string Currently selected letter.
3164      */
3165     public $current;
3167     /**
3168      * @var string Class name to add to this initial bar.
3169      */
3170     public $class;
3172     /**
3173      * @var string The name to put in front of this initial bar.
3174      */
3175     public $title;
3177     /**
3178      * @var string URL parameter name for this initial.
3179      */
3180     public $urlvar;
3182     /**
3183      * @var string URL object.
3184      */
3185     public $url;
3187     /**
3188      * @var array An array of letters in the alphabet.
3189      */
3190     public $alpha;
3192     /**
3193      * Constructor initials_bar with only the required params.
3194      *
3195      * @param string $current the currently selected letter.
3196      * @param string $class class name to add to this initial bar.
3197      * @param string $title the name to put in front of this initial bar.
3198      * @param string $urlvar URL parameter name for this initial.
3199      * @param string $url URL object.
3200      * @param array $alpha of letters in the alphabet.
3201      */
3202     public function __construct($current, $class, $title, $urlvar, $url, $alpha = null) {
3203         $this->current       = $current;
3204         $this->class    = $class;
3205         $this->title    = $title;
3206         $this->urlvar    = $urlvar;
3207         $this->url    = $url;
3208         $this->alpha    = $alpha;
3209     }
3211     /**
3212      * Export for template.
3213      *
3214      * @param renderer_base $output The renderer.
3215      * @return stdClass
3216      */
3217     public function export_for_template(renderer_base $output) {
3218         $data = new stdClass();
3220         if ($this->alpha == null) {
3221             $this->alpha = explode(',', get_string('alphabet', 'langconfig'));
3222         }
3224         if ($this->current == 'all') {
3225             $this->current = '';
3226         }
3228         // We want to find a letter grouping size which suits the language so
3229         // find the largest group size which is less than 15 chars.
3230         // The choice of 15 chars is the largest number of chars that reasonably
3231         // fits on the smallest supported screen size. By always using a max number
3232         // of groups which is a factor of 2, we always get nice wrapping, and the
3233         // last row is always the shortest.
3234         $groupsize = count($this->alpha);
3235         $groups = 1;
3236         while ($groupsize > 15) {
3237             $groups *= 2;
3238             $groupsize = ceil(count($this->alpha) / $groups);
3239         }
3241         $groupsizelimit = 0;
3242         $groupnumber = 0;
3243         foreach ($this->alpha as $letter) {
3244             if ($groupsizelimit++ > 0 && $groupsizelimit % $groupsize == 1) {
3245                 $groupnumber++;
3246             }
3247             $groupletter = new stdClass();
3248             $groupletter->name = $letter;
3249             $groupletter->url = $this->url->out(false, array($this->urlvar => $letter));
3250             if ($letter == $this->current) {
3251                 $groupletter->selected = $this->current;
3252             }
3253             if (!isset($data->group[$groupnumber])) {
3254                 $data->group[$groupnumber] = new stdClass();
3255             }
3256             $data->group[$groupnumber]->letter[] = $groupletter;
3257         }
3259         $data->class = $this->class;
3260         $data->title = $this->title;
3261         $data->url = $this->url->out(false, array($this->urlvar => ''));
3262         $data->current = $this->current;
3263         $data->all = get_string('all');
3265         return $data;
3266     }
3269 /**
3270  * This class represents how a block appears on a page.
3271  *
3272  * During output, each block instance is asked to return a block_contents object,
3273  * those are then passed to the $OUTPUT->block function for display.
3274  *
3275  * contents should probably be generated using a moodle_block_..._renderer.
3276  *
3277  * Other block-like things that need to appear on the page, for example the
3278  * add new block UI, are also represented as block_contents objects.
3279  *
3280  * @copyright 2009 Tim Hunt
3281  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3282  * @since Moodle 2.0
3283  * @package core
3284  * @category output
3285  */
3286 class block_contents {
3288     /** Used when the block cannot be collapsed **/
3289     const NOT_HIDEABLE = 0;
3291     /** Used when the block can be collapsed but currently is not **/
3292     const VISIBLE = 1;
3294     /** Used when the block has been collapsed **/
3295     const HIDDEN = 2;
3297     /**
3298      * @var int Used to set $skipid.
3299      */
3300     protected static $idcounter = 1;
3302     /**
3303      * @var int All the blocks (or things that look like blocks) printed on
3304      * a page are given a unique number that can be used to construct id="" attributes.
3305      * This is set automatically be the {@link prepare()} method.
3306      * Do not try to set it manually.
3307      */
3308     public $skipid;
3310     /**
3311      * @var int If this is the contents of a real block, this should be set
3312      * to the block_instance.id. Otherwise this should be set to 0.
3313      */
3314     public $blockinstanceid = 0;
3316     /**
3317      * @var int If this is a real block instance, and there is a corresponding
3318      * block_position.id for the block on this page, this should be set to that id.
3319      * Otherwise it should be 0.
3320      */
3321     public $blockpositionid = 0;
3323     /**
3324      * @var array An array of attribute => value pairs that are put on the outer div of this
3325      * block. {@link $id} and {@link $classes} attributes should be set separately.
3326      */
3327     public $attributes;
3329     /**
3330      * @var string The title of this block. If this came from user input, it should already
3331      * have had format_string() processing done on it. This will be output inside
3332      * <h2> tags. Please do not cause invalid XHTML.
3333      */
3334     public $title = '';
3336     /**
3337      * @var string The label to use when the block does not, or will not have a visible title.
3338      * You should never set this as well as title... it will just be ignored.
3339      */
3340     public $arialabel = '';
3342     /**
3343      * @var string HTML for the content
3344      */
3345     public $content = '';
3347     /**
3348      * @var array An alternative to $content, it you want a list of things with optional icons.
3349      */
3350     public $footer = '';
3352     /**
3353      * @var string Any small print that should appear under the block to explain
3354      * to the teacher about the block, for example 'This is a sticky block that was
3355      * added in the system context.'
3356      */
3357     public $annotation = '';
3359     /**
3360      * @var int One of the constants NOT_HIDEABLE, VISIBLE, HIDDEN. Whether
3361      * the user can toggle whether this block is visible.
3362      */
3363     public $collapsible = self::NOT_HIDEABLE;
3365     /**
3366      * Set this to true if the block is dockable.
3367      * @var bool
3368      */
3369     public $dockable = false;
3371     /**
3372      * @var array A (possibly empty) array of editing controls. Each element of
3373      * this array should be an array('url' => $url, 'icon' => $icon, 'caption' => $caption).
3374      * $icon is the icon name. Fed to $OUTPUT->image_url.
3375      */
3376     public $controls = array();
3379     /**
3380      * Create new instance of block content
3381      * @param array $attributes
3382      */
3383     public function __construct(array $attributes = null) {
3384         $this->skipid = self::$idcounter;
3385         self::$idcounter += 1;
3387         if ($attributes) {
3388             // standard block
3389             $this->attributes = $attributes;
3390         } else {
3391             // simple "fake" blocks used in some modules and "Add new block" block
3392             $this->attributes = array('class'=>'block');
3393         }
3394     }
3396     /**
3397      * Add html class to block
3398      *
3399      * @param string $class
3400      */
3401     public function add_class($class) {
3402         $this->attributes['class'] .= ' '.$class;
3403     }
3407 /**
3408  * This class represents a target for where a block can go when it is being moved.
3409  *
3410  * This needs to be rendered as a form with the given hidden from fields, and
3411  * clicking anywhere in the form should submit it. The form action should be
3412  * $PAGE->url.
3413  *
3414  * @copyright 2009 Tim Hunt
3415  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3416  * @since Moodle 2.0
3417  * @package core
3418  * @category output
3419  */
3420 class block_move_target {
3422     /**
3423      * @var moodle_url Move url
3424      */
3425     public $url;
3427     /**
3428      * Constructor
3429      * @param moodle_url $url
3430      */
3431     public function __construct(moodle_url $url) {
3432         $this->url  = $url;
3433     }
3436 /**
3437  * Custom menu item
3438  *
3439  * This class is used to represent one item within a custom menu that may or may
3440  * not have children.
3441  *
3442  * @copyright 2010 Sam Hemelryk
3443  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3444  * @since Moodle 2.0
3445  * @package core
3446  * @category output
3447  */
3448 class custom_menu_item implements renderable, templatable {
3450     /**
3451      * @var string The text to show for the item
3452      */
3453     protected $text;
3455     /**
3456      * @var moodle_url The link to give the icon if it has no children
3457      */
3458     protected $url;
3460     /**
3461      * @var string A title to apply to the item. By default the text
3462      */
3463     protected $title;
3465     /**
3466      * @var int A sort order for the item, not necessary if you order things in
3467      * the CFG var.
3468      */
3469     protected $sort;
3471     /**
3472      * @var custom_menu_item A reference to the parent for this item or NULL if
3473      * it is a top level item
3474      */
3475     protected $parent;
3477     /**
3478      * @var array A array in which to store children this item has.
3479      */
3480     protected $children = array();
3482     /**
3483      * @var int A reference to the sort var of the last child that was added
3484      */
3485     protected $lastsort = 0;
3487     /**
3488      * Constructs the new custom menu item
3489      *
3490      * @param string $text
3491      * @param moodle_url $url A moodle url to apply as the link for this item [Optional]
3492      * @param string $title A title to apply to this item [Optional]
3493      * @param int $sort A sort or to use if we need to sort differently [Optional]
3494      * @param custom_menu_item $parent A reference to the parent custom_menu_item this child
3495      *        belongs to, only if the child has a parent. [Optional]
3496      */
3497     public function __construct($text, moodle_url $url=null, $title=null, $sort = null, custom_menu_item $parent = null) {
3498         $this->text = $text;
3499         $this->url = $url;
3500         $this->title = $title;
3501         $this->sort = (int)$sort;
3502         $this->parent = $parent;
3503     }
3505     /**
3506      * Adds a custom menu item as a child of this node given its properties.
3507      *
3508      * @param string $text
3509      * @param moodle_url $url
3510      * @param string $title
3511      * @param int $sort
3512      * @return custom_menu_item
3513      */
3514     public function add($text, moodle_url $url = null, $title = null, $sort = null) {
3515         $key = count($this->children);
3516         if (empty($sort)) {
3517             $sort = $this->lastsort + 1;
3518         }
3519         $this->children[$key] = new custom_menu_item($text, $url, $title, $sort, $this);
3520         $this->lastsort = (int)$sort;
3521         return $this->children[$key];
3522     }
3524     /**
3525      * Removes a custom menu item that is a child or descendant to the current menu.
3526      *
3527      * Returns true if child was found and removed.
3528      *
3529      * @param custom_menu_item $menuitem
3530      * @return bool
3531      */
3532     public function remove_child(custom_menu_item $menuitem) {
3533         $removed = false;
3534         if (($key = array_search($menuitem, $this->children)) !== false) {
3535             unset($this->children[$key]);