2 // This file is part of Moodle - http://moodle.org/
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.
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.
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/>.
18 * Classes representing HTML elements, used by $OUTPUT methods
20 * Please see http://docs.moodle.org/en/Developement:How_Moodle_outputs_HTML
25 * @copyright 2009 Tim Hunt
26 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
29 defined('MOODLE_INTERNAL') ||
die();
32 * Interface marking other classes as suitable for renderer_base::render()
34 * @copyright 2010 Petr Skoda (skodak) info@skodak.org
38 interface renderable
{
39 // intentionally empty
43 * Interface marking other classes having the ability to export their data for use by templates.
45 * @copyright 2015 Damyon Wiese
50 interface templatable
{
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).
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
61 public function export_for_template(renderer_base
$output);
65 * Data structure representing a file picker.
67 * @copyright 2010 Dongsheng Cai
68 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
73 class file_picker
implements renderable
{
76 * @var stdClass An object containing options for the file picker
81 * Constructs a file picker object.
83 * The following are possible options for the filepicker:
84 * - accepted_types (*)
85 * - return_types (FILE_INTERNAL)
87 * - client_id (uniqid)
91 * - buttonname (false)
93 * @param stdClass $options An object containing options for the file picker.
95 public function __construct(stdClass
$options) {
96 global $CFG, $USER, $PAGE;
97 require_once($CFG->dirroot
. '/repository/lib.php');
99 'accepted_types'=>'*',
100 'return_types'=>FILE_INTERNAL
,
101 'env' => 'filepicker',
102 'client_id' => uniqid(),
108 foreach ($defaults as $key=>$value) {
109 if (empty($options->$key)) {
110 $options->$key = $value;
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);
123 $file = $fs->get_file($usercontext->id
, 'user', 'draft', $options->itemid
, $options->filepath
, $options->filename
);
126 $options->currentfile
= html_writer
::link(moodle_url
::make_draftfile_url($file->get_itemid(), $file->get_filepath(), $file->get_filename()), $file->get_filename());
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;
143 * Data structure representing a user picture.
145 * @copyright 2009 Nicolas Connault, 2010 Petr Skoda
146 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
151 class user_picture
implements renderable
{
153 * @var stdClass A user object with at least fields all columns specified
154 * in $fields array constant set.
159 * @var int The course id. Used when constructing the link to the user's
160 * profile, page course id used if not specified.
165 * @var bool Add course profile link to image
170 * @var int Size in pixels. Special values are (true/1 = 100px) and
172 * for backward compatibility.
177 * @var bool Add non-blank alt-text to the image.
178 * Default true, set to false when image alt just duplicates text in screenreaders.
180 public $alttext = true;
183 * @var bool Whether or not to open the link in a popup window.
185 public $popup = false;
188 * @var string Image class attribute
190 public $class = 'userpicture';
193 * @var bool Whether to be visible to screen readers.
195 public $visibletoscreenreaders = true;
198 * @var bool Whether to include the fullname in the user picture link.
200 public $includefullname = false;
203 * @var mixed Include user authentication token. True indicates to generate a token for current user, and integer value
204 * indicates to generate a token for the user whose id is the value indicated.
206 public $includetoken = false;
209 * User picture constructor.
211 * @param stdClass $user user record with at least id, picture, imagealt, firstname and lastname set.
212 * It is recommended to add also contextid of the user for performance reasons.
214 public function __construct(stdClass
$user) {
217 if (empty($user->id
)) {
218 throw new coding_exception('User id is required when printing user avatar image.');
221 // only touch the DB if we are missing data and complain loudly...
223 foreach (\core_user\fields
::get_picture_fields() as $field) {
224 if (!property_exists($user, $field)) {
226 debugging('Missing '.$field.' property in $user object, this is a performance problem that needs to be fixed by a developer. '
227 .'Please use the \core_user\fields API to get the full list of required fields.', DEBUG_DEVELOPER
);
233 $this->user
= $DB->get_record('user', array('id' => $user->id
),
234 implode(',', \core_user\fields
::get_picture_fields()), MUST_EXIST
);
236 $this->user
= clone($user);
241 * Returns a list of required user fields, useful when fetching required user info from db.
243 * In some cases we have to fetch the user data together with some other information,
244 * the idalias is useful there because the id would otherwise override the main
245 * id of the result record. Please note it has to be converted back to id before rendering.
247 * @param string $tableprefix name of database table prefix in query
248 * @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)
249 * @param string $idalias alias of id field
250 * @param string $fieldprefix prefix to add to all columns in their aliases, does not apply to 'id'
252 * @deprecated since Moodle 3.11 MDL-45242
253 * @see \core_user\fields
255 public static function fields($tableprefix = '', array $extrafields = NULL, $idalias = 'id', $fieldprefix = '') {
256 debugging('user_picture::fields() is deprecated. Please use the \core_user\fields API instead.', DEBUG_DEVELOPER
);
257 $userfields = \core_user\fields
::for_userpic();
259 $userfields->including(...$extrafields);
261 $selects = $userfields->get_sql($tableprefix, false, $fieldprefix, $idalias, false)->selects
;
262 if ($tableprefix === '') {
263 // If no table alias is specified, don't add {user}. in front of fields.
264 $selects = str_replace('{user}.', '', $selects);
266 // Maintain legacy behaviour where the field list was done with 'implode' and no spaces.
267 $selects = str_replace(', ', ',', $selects);
272 * Extract the aliased user fields from a given record
274 * Given a record that was previously obtained using {@link self::fields()} with aliases,
275 * this method extracts user related unaliased fields.
277 * @param stdClass $record containing user picture fields
278 * @param array $extrafields extra fields included in the $record
279 * @param string $idalias alias of the id field
280 * @param string $fieldprefix prefix added to all columns in their aliases, does not apply to 'id'
281 * @return stdClass object with unaliased user fields
283 public static function unalias(stdClass
$record, array $extrafields = null, $idalias = 'id', $fieldprefix = '') {
285 if (empty($idalias)) {
289 $return = new stdClass();
291 foreach (\core_user\fields
::get_picture_fields() as $field) {
292 if ($field === 'id') {
293 if (property_exists($record, $idalias)) {
294 $return->id
= $record->{$idalias};
297 if (property_exists($record, $fieldprefix.$field)) {
298 $return->{$field} = $record->{$fieldprefix.$field};
302 // add extra fields if not already there
304 foreach ($extrafields as $e) {
305 if ($e === 'id' or property_exists($return, $e)) {
308 $return->{$e} = $record->{$fieldprefix.$e};
316 * Works out the URL for the users picture.
318 * This method is recommended as it avoids costly redirects of user pictures
319 * if requests are made for non-existent files etc.
321 * @param moodle_page $page
322 * @param renderer_base $renderer
325 public function get_url(moodle_page
$page, renderer_base
$renderer = null) {
328 if (is_null($renderer)) {
329 $renderer = $page->get_renderer('core');
332 // Sort out the filename and size. Size is only required for the gravatar
333 // implementation presently.
334 if (empty($this->size
)) {
337 } else if ($this->size
=== true or $this->size
== 1) {
340 } else if ($this->size
> 100) {
342 $size = (int)$this->size
;
343 } else if ($this->size
>= 50) {
345 $size = (int)$this->size
;
348 $size = (int)$this->size
;
351 $defaulturl = $renderer->image_url('u/'.$filename); // default image
353 if ((!empty($CFG->forcelogin
) and !isloggedin()) ||
354 (!empty($CFG->forceloginforprofileimage
) && (!isloggedin() ||
isguestuser()))) {
355 // Protect images if login required and not logged in;
356 // also if login is required for profile images and is not logged in or guest
357 // do not use require_login() because it is expensive and not suitable here anyway.
361 // First try to detect deleted users - but do not read from database for performance reasons!
362 if (!empty($this->user
->deleted
) or strpos($this->user
->email
, '@') === false) {
363 // All deleted users should have email replaced by md5 hash,
364 // all active users are expected to have valid email.
368 // Did the user upload a picture?
369 if ($this->user
->picture
> 0) {
370 if (!empty($this->user
->contextid
)) {
371 $contextid = $this->user
->contextid
;
373 $context = context_user
::instance($this->user
->id
, IGNORE_MISSING
);
375 // This must be an incorrectly deleted user, all other users have context.
378 $contextid = $context->id
;
382 if (clean_param($page->theme
->name
, PARAM_THEME
) == $page->theme
->name
) {
383 // We append the theme name to the file path if we have it so that
384 // in the circumstance that the profile picture is not available
385 // when the user actually requests it they still get the profile
386 // picture for the correct theme.
387 $path .= $page->theme
->name
.'/';
389 // Set the image URL to the URL for the uploaded file and return.
390 $url = moodle_url
::make_pluginfile_url(
391 $contextid, 'user', 'icon', null, $path, $filename, false, $this->includetoken
);
392 $url->param('rev', $this->user
->picture
);
396 if ($this->user
->picture
== 0 and !empty($CFG->enablegravatar
)) {
397 // Normalise the size variable to acceptable bounds
398 if ($size < 1 ||
$size > 512) {
401 // Hash the users email address
402 $md5 = md5(strtolower(trim($this->user
->email
)));
403 // Build a gravatar URL with what we know.
405 // Find the best default image URL we can (MDL-35669)
406 if (empty($CFG->gravatardefaulturl
)) {
407 $absoluteimagepath = $page->theme
->resolve_image_location('u/'.$filename, 'core');
408 if (strpos($absoluteimagepath, $CFG->dirroot
) === 0) {
409 $gravatardefault = $CFG->wwwroot
. substr($absoluteimagepath, strlen($CFG->dirroot
));
411 $gravatardefault = $CFG->wwwroot
. '/pix/u/' . $filename . '.png';
414 $gravatardefault = $CFG->gravatardefaulturl
;
417 // If the currently requested page is https then we'll return an
418 // https gravatar page.
420 return new moodle_url("https://secure.gravatar.com/avatar/{$md5}", array('s' => $size, 'd' => $gravatardefault));
422 return new moodle_url("http://www.gravatar.com/avatar/{$md5}", array('s' => $size, 'd' => $gravatardefault));
431 * Data structure representing a help icon.
433 * @copyright 2010 Petr Skoda (info@skodak.org)
434 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
439 class help_icon
implements renderable
, templatable
{
442 * @var string lang pack identifier (without the "_help" suffix),
443 * both get_string($identifier, $component) and get_string($identifier.'_help', $component)
449 * @var string Component name, the same as in get_string()
454 * @var string Extra descriptive text next to the icon
456 public $linktext = null;
461 * @param string $identifier string for help page title,
462 * string with _help suffix is used for the actual help text.
463 * string with _link suffix is used to create a link to further info (if it exists)
464 * @param string $component
466 public function __construct($identifier, $component) {
467 $this->identifier
= $identifier;
468 $this->component
= $component;
472 * Verifies that both help strings exists, shows debug warnings if not
474 public function diag_strings() {
475 $sm = get_string_manager();
476 if (!$sm->string_exists($this->identifier
, $this->component
)) {
477 debugging("Help title string does not exist: [$this->identifier, $this->component]");
479 if (!$sm->string_exists($this->identifier
.'_help', $this->component
)) {
480 debugging("Help contents string does not exist: [{$this->identifier}_help, $this->component]");
485 * Export this data so it can be used as the context for a mustache template.
487 * @param renderer_base $output Used to do a final render of any components that need to be rendered for export.
490 public function export_for_template(renderer_base
$output) {
493 $title = get_string($this->identifier
, $this->component
);
495 if (empty($this->linktext
)) {
496 $alt = get_string('helpprefix2', '', trim($title, ". \t"));
498 $alt = get_string('helpwiththis');
501 $data = get_formatted_help_string($this->identifier
, $this->component
, false);
504 $data->icon
= (new pix_icon('help', $alt, 'core', ['class' => 'iconhelp']))->export_for_template($output);
505 $data->linktext
= $this->linktext
;
506 $data->title
= get_string('helpprefix2', '', trim($title, ". \t"));
509 'component' => $this->component
,
510 'identifier' => $this->identifier
,
511 'lang' => current_language()
514 // Debugging feature lets you display string identifier and component.
515 if (isset($CFG->debugstringids
) && $CFG->debugstringids
&& optional_param('strings', 0, PARAM_INT
)) {
516 $options['strings'] = 1;
519 $data->url
= (new moodle_url('/help.php', $options))->out(false);
520 $data->ltr
= !right_to_left();
527 * Data structure representing an icon font.
529 * @copyright 2016 Damyon Wiese
530 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
534 class pix_icon_font
implements templatable
{
537 * @var pix_icon $pixicon The original icon.
539 private $pixicon = null;
542 * @var string $key The mapped key.
547 * @var bool $mapped The icon could not be mapped.
554 * @param pix_icon $pixicon The original icon
556 public function __construct(pix_icon
$pixicon) {
559 $this->pixicon
= $pixicon;
560 $this->mapped
= false;
561 $iconsystem = \core\output\icon_system
::instance();
563 $this->key
= $iconsystem->remap_icon_name($pixicon->pix
, $pixicon->component
);
564 if (!empty($this->key
)) {
565 $this->mapped
= true;
570 * Return true if this pix_icon was successfully mapped to an icon font.
574 public function is_mapped() {
575 return $this->mapped
;
579 * Export this data so it can be used as the context for a mustache template.
581 * @param renderer_base $output Used to do a final render of any components that need to be rendered for export.
584 public function export_for_template(renderer_base
$output) {
586 $pixdata = $this->pixicon
->export_for_template($output);
588 $title = isset($this->pixicon
->attributes
['title']) ?
$this->pixicon
->attributes
['title'] : '';
589 $alt = isset($this->pixicon
->attributes
['alt']) ?
$this->pixicon
->attributes
['alt'] : '';
594 'extraclasses' => $pixdata['extraclasses'],
605 * Data structure representing an icon subtype.
607 * @copyright 2016 Damyon Wiese
608 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
612 class pix_icon_fontawesome
extends pix_icon_font
{
617 * Data structure representing an icon.
619 * @copyright 2010 Petr Skoda
620 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
625 class pix_icon
implements renderable
, templatable
{
628 * @var string The icon name
633 * @var string The component the icon belongs to.
638 * @var array An array of attributes to use on the icon
640 var $attributes = array();
645 * @param string $pix short icon name
646 * @param string $alt The alt text to use for the icon
647 * @param string $component component name
648 * @param array $attributes html attributes
650 public function __construct($pix, $alt, $component='moodle', array $attributes = null) {
654 $this->component
= $component;
655 $this->attributes
= (array)$attributes;
657 if (empty($this->attributes
['class'])) {
658 $this->attributes
['class'] = '';
661 // Set an additional class for big icons so that they can be styled properly.
662 if (substr($pix, 0, 2) === 'b/') {
663 $this->attributes
['class'] .= ' iconsize-big';
666 // If the alt is empty, don't place it in the attributes, otherwise it will override parent alt text.
667 if (!is_null($alt)) {
668 $this->attributes
['alt'] = $alt;
670 // If there is no title, set it to the attribute.
671 if (!isset($this->attributes
['title'])) {
672 $this->attributes
['title'] = $this->attributes
['alt'];
675 unset($this->attributes
['alt']);
678 if (empty($this->attributes
['title'])) {
679 // Remove the title attribute if empty, we probably want to use the parent node's title
680 // and some browsers might overwrite it with an empty title.
681 unset($this->attributes
['title']);
684 // Hide icons from screen readers that have no alt.
685 if (empty($this->attributes
['alt'])) {
686 $this->attributes
['aria-hidden'] = 'true';
691 * Export this data so it can be used as the context for a mustache template.
693 * @param renderer_base $output Used to do a final render of any components that need to be rendered for export.
696 public function export_for_template(renderer_base
$output) {
697 $attributes = $this->attributes
;
700 foreach ($attributes as $key => $item) {
701 if ($key == 'class') {
702 $extraclasses = $item;
703 unset($attributes[$key]);
708 $attributes['src'] = $output->image_url($this->pix
, $this->component
)->out(false);
709 $templatecontext = array();
710 foreach ($attributes as $name => $value) {
711 $templatecontext[] = array('name' => $name, 'value' => $value);
713 $title = isset($attributes['title']) ?
$attributes['title'] : '';
715 $title = isset($attributes['alt']) ?
$attributes['alt'] : '';
718 'attributes' => $templatecontext,
719 'extraclasses' => $extraclasses
726 * Much simpler version of export that will produce the data required to render this pix with the
727 * pix helper in a mustache tag.
731 public function export_for_pix() {
732 $title = isset($this->attributes
['title']) ?
$this->attributes
['title'] : '';
734 $title = isset($this->attributes
['alt']) ?
$this->attributes
['alt'] : '';
738 'component' => $this->component
,
739 'title' => (string) $title,
745 * Data structure representing an activity icon.
747 * The difference is that activity icons will always render with the standard icon system (no font icons).
749 * @copyright 2017 Damyon Wiese
750 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
753 class image_icon
extends pix_icon
{
757 * Data structure representing an emoticon image
759 * @copyright 2010 David Mudrak
760 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
765 class pix_emoticon
extends pix_icon
implements renderable
{
769 * @param string $pix short icon name
770 * @param string $alt alternative text
771 * @param string $component emoticon image provider
772 * @param array $attributes explicit HTML attributes
774 public function __construct($pix, $alt, $component = 'moodle', array $attributes = array()) {
775 if (empty($attributes['class'])) {
776 $attributes['class'] = 'emoticon';
778 parent
::__construct($pix, $alt, $component, $attributes);
783 * Data structure representing a simple form with only one button.
785 * @copyright 2009 Petr Skoda
786 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
791 class single_button
implements renderable
{
794 * @var moodle_url Target url
799 * @var string Button label
804 * @var string Form submit method post or get
806 public $method = 'post';
809 * @var string Wrapping div class
811 public $class = 'singlebutton';
814 * @var bool True if button is primary button. Used for styling.
816 public $primary = false;
819 * @var bool True if button disabled, false if normal
821 public $disabled = false;
824 * @var string Button tooltip
826 public $tooltip = null;
829 * @var string Form id
834 * @var array List of attached actions
836 public $actions = array();
839 * @var array $params URL Params
844 * @var string Action id
851 protected $attributes = [];
855 * @param moodle_url $url
856 * @param string $label button text
857 * @param string $method get or post submit method
858 * @param bool $primary whether this is a primary button, used for styling
859 * @param array $attributes Attributes for the HTML button tag
861 public function __construct(moodle_url
$url, $label, $method='post', $primary=false, $attributes = []) {
862 $this->url
= clone($url);
863 $this->label
= $label;
864 $this->method
= $method;
865 $this->primary
= $primary;
866 $this->attributes
= $attributes;
870 * Shortcut for adding a JS confirm dialog when the button is clicked.
871 * The message must be a yes/no question.
873 * @param string $confirmmessage The yes/no confirmation question. If "Yes" is clicked, the original action will occur.
875 public function add_confirm_action($confirmmessage) {
876 $this->add_action(new confirm_action($confirmmessage));
880 * Add action to the button.
881 * @param component_action $action
883 public function add_action(component_action
$action) {
884 $this->actions
[] = $action;
888 * Sets an attribute for the HTML button tag.
890 * @param string $name The attribute name
891 * @param mixed $value The value
894 public function set_attribute($name, $value) {
895 $this->attributes
[$name] = $value;
901 * @param renderer_base $output Renderer.
904 public function export_for_template(renderer_base
$output) {
905 $url = $this->method
=== 'get' ?
$this->url
->out_omit_querystring(true) : $this->url
->out_omit_querystring();
907 $data = new stdClass();
908 $data->id
= html_writer
::random_id('single_button');
909 $data->formid
= $this->formid
;
910 $data->method
= $this->method
;
911 $data->url
= $url === '' ?
'#' : $url;
912 $data->label
= $this->label
;
913 $data->classes
= $this->class;
914 $data->disabled
= $this->disabled
;
915 $data->tooltip
= $this->tooltip
;
916 $data->primary
= $this->primary
;
918 $data->attributes
= [];
919 foreach ($this->attributes
as $key => $value) {
920 $data->attributes
[] = ['name' => $key, 'value' => $value];
924 $params = $this->url
->params();
925 if ($this->method
=== 'post') {
926 $params['sesskey'] = sesskey();
928 $data->params
= array_map(function($key) use ($params) {
929 return ['name' => $key, 'value' => $params[$key]];
930 }, array_keys($params));
933 $actions = $this->actions
;
934 $data->actions
= array_map(function($action) use ($output) {
935 return $action->export_for_template($output);
937 $data->hasactions
= !empty($data->actions
);
945 * Simple form with just one select field that gets submitted automatically.
947 * If JS not enabled small go button is printed too.
949 * @copyright 2009 Petr Skoda
950 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
955 class single_select
implements renderable
, templatable
{
958 * @var moodle_url Target url - includes hidden fields
963 * @var string Name of the select element.
968 * @var array $options associative array value=>label ex.: array(1=>'One, 2=>Two)
969 * it is also possible to specify optgroup as complex label array ex.:
970 * array(array('Odd'=>array(1=>'One', 3=>'Three)), array('Even'=>array(2=>'Two')))
971 * array(1=>'One', '--1uniquekey'=>array('More'=>array(2=>'Two', 3=>'Three')))
976 * @var string Selected option
981 * @var array Nothing selected
986 * @var array Extra select field attributes
988 var $attributes = array();
991 * @var string Button label
996 * @var array Button label's attributes
998 var $labelattributes = array();
1001 * @var string Form submit method post or get
1003 var $method = 'get';
1006 * @var string Wrapping div class
1008 var $class = 'singleselect';
1011 * @var bool True if button disabled, false if normal
1013 var $disabled = false;
1016 * @var string Button tooltip
1018 var $tooltip = null;
1021 * @var string Form id
1026 * @var help_icon The help icon for this element.
1028 var $helpicon = null;
1032 * @param moodle_url $url form action target, includes hidden fields
1033 * @param string $name name of selection field - the changing parameter in url
1034 * @param array $options list of options
1035 * @param string $selected selected element
1036 * @param array $nothing
1037 * @param string $formid
1039 public function __construct(moodle_url
$url, $name, array $options, $selected = '', $nothing = array('' => 'choosedots'), $formid = null) {
1041 $this->name
= $name;
1042 $this->options
= $options;
1043 $this->selected
= $selected;
1044 $this->nothing
= $nothing;
1045 $this->formid
= $formid;
1049 * Shortcut for adding a JS confirm dialog when the button is clicked.
1050 * The message must be a yes/no question.
1052 * @param string $confirmmessage The yes/no confirmation question. If "Yes" is clicked, the original action will occur.
1054 public function add_confirm_action($confirmmessage) {
1055 $this->add_action(new component_action('submit', 'M.util.show_confirm_dialog', array('message' => $confirmmessage)));
1059 * Add action to the button.
1061 * @param component_action $action
1063 public function add_action(component_action
$action) {
1064 $this->actions
[] = $action;
1070 * @deprecated since Moodle 2.0
1072 public function set_old_help_icon($helppage, $title, $component = 'moodle') {
1073 throw new coding_exception('set_old_help_icon() can not be used any more, please see set_help_icon().');
1079 * @param string $identifier The keyword that defines a help page
1080 * @param string $component
1082 public function set_help_icon($identifier, $component = 'moodle') {
1083 $this->helpicon
= new help_icon($identifier, $component);
1087 * Sets select's label
1089 * @param string $label
1090 * @param array $attributes (optional)
1092 public function set_label($label, $attributes = array()) {
1093 $this->label
= $label;
1094 $this->labelattributes
= $attributes;
1101 * @param renderer_base $output Renderer.
1104 public function export_for_template(renderer_base
$output) {
1105 $attributes = $this->attributes
;
1107 $data = new stdClass();
1108 $data->name
= $this->name
;
1109 $data->method
= $this->method
;
1110 $data->action
= $this->method
=== 'get' ?
$this->url
->out_omit_querystring(true) : $this->url
->out_omit_querystring();
1111 $data->classes
= $this->class;
1112 $data->label
= $this->label
;
1113 $data->disabled
= $this->disabled
;
1114 $data->title
= $this->tooltip
;
1115 $data->formid
= !empty($this->formid
) ?
$this->formid
: html_writer
::random_id('single_select_f');
1116 $data->id
= !empty($attributes['id']) ?
$attributes['id'] : html_writer
::random_id('single_select');
1118 // Select element attributes.
1119 // Unset attributes that are already predefined in the template.
1120 unset($attributes['id']);
1121 unset($attributes['class']);
1122 unset($attributes['name']);
1123 unset($attributes['title']);
1124 unset($attributes['disabled']);
1126 // Map the attributes.
1127 $data->attributes
= array_map(function($key) use ($attributes) {
1128 return ['name' => $key, 'value' => $attributes[$key]];
1129 }, array_keys($attributes));
1132 $params = $this->url
->params();
1133 if ($this->method
=== 'post') {
1134 $params['sesskey'] = sesskey();
1136 $data->params
= array_map(function($key) use ($params) {
1137 return ['name' => $key, 'value' => $params[$key]];
1138 }, array_keys($params));
1141 $hasnothing = false;
1142 if (is_string($this->nothing
) && $this->nothing
!== '') {
1143 $nothing = ['' => $this->nothing
];
1146 } else if (is_array($this->nothing
)) {
1147 $nothingvalue = reset($this->nothing
);
1148 if ($nothingvalue === 'choose' ||
$nothingvalue === 'choosedots') {
1149 $nothing = [key($this->nothing
) => get_string('choosedots')];
1151 $nothing = $this->nothing
;
1154 $nothingkey = key($this->nothing
);
1157 $options = $nothing +
$this->options
;
1159 $options = $this->options
;
1162 foreach ($options as $value => $name) {
1163 if (is_array($options[$value])) {
1164 foreach ($options[$value] as $optgroupname => $optgroupvalues) {
1166 foreach ($optgroupvalues as $optvalue => $optname) {
1168 'value' => $optvalue,
1170 'selected' => strval($this->selected
) === strval($optvalue),
1173 if ($hasnothing && $nothingkey === $optvalue) {
1174 $option['ignore'] = 'data-ignore';
1177 $sublist[] = $option;
1179 $data->options
[] = [
1180 'name' => $optgroupname,
1182 'options' => $sublist
1188 'name' => $options[$value],
1189 'selected' => strval($this->selected
) === strval($value),
1193 if ($hasnothing && $nothingkey === $value) {
1194 $option['ignore'] = 'data-ignore';
1197 $data->options
[] = $option;
1201 // Label attributes.
1202 $data->labelattributes
= [];
1203 // Unset label attributes that are already in the template.
1204 unset($this->labelattributes
['for']);
1205 // Map the label attributes.
1206 foreach ($this->labelattributes
as $key => $value) {
1207 $data->labelattributes
[] = ['name' => $key, 'value' => $value];
1211 $data->helpicon
= !empty($this->helpicon
) ?
$this->helpicon
->export_for_template($output) : false;
1218 * Simple URL selection widget description.
1220 * @copyright 2009 Petr Skoda
1221 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1226 class url_select
implements renderable
, templatable
{
1228 * @var array $urls associative array value=>label ex.: array(1=>'One, 2=>Two)
1229 * it is also possible to specify optgroup as complex label array ex.:
1230 * array(array('Odd'=>array(1=>'One', 3=>'Three)), array('Even'=>array(2=>'Two')))
1231 * array(1=>'One', '--1uniquekey'=>array('More'=>array(2=>'Two', 3=>'Three')))
1236 * @var string Selected option
1241 * @var array Nothing selected
1246 * @var array Extra select field attributes
1248 var $attributes = array();
1251 * @var string Button label
1256 * @var array Button label's attributes
1258 var $labelattributes = array();
1261 * @var string Wrapping div class
1263 var $class = 'urlselect';
1266 * @var bool True if button disabled, false if normal
1268 var $disabled = false;
1271 * @var string Button tooltip
1273 var $tooltip = null;
1276 * @var string Form id
1281 * @var help_icon The help icon for this element.
1283 var $helpicon = null;
1286 * @var string If set, makes button visible with given name for button
1288 var $showbutton = null;
1292 * @param array $urls list of options
1293 * @param string $selected selected element
1294 * @param array $nothing
1295 * @param string $formid
1296 * @param string $showbutton Set to text of button if it should be visible
1297 * or null if it should be hidden (hidden version always has text 'go')
1299 public function __construct(array $urls, $selected = '', $nothing = array('' => 'choosedots'), $formid = null, $showbutton = null) {
1300 $this->urls
= $urls;
1301 $this->selected
= $selected;
1302 $this->nothing
= $nothing;
1303 $this->formid
= $formid;
1304 $this->showbutton
= $showbutton;
1310 * @deprecated since Moodle 2.0
1312 public function set_old_help_icon($helppage, $title, $component = 'moodle') {
1313 throw new coding_exception('set_old_help_icon() can not be used any more, please see set_help_icon().');
1319 * @param string $identifier The keyword that defines a help page
1320 * @param string $component
1322 public function set_help_icon($identifier, $component = 'moodle') {
1323 $this->helpicon
= new help_icon($identifier, $component);
1327 * Sets select's label
1329 * @param string $label
1330 * @param array $attributes (optional)
1332 public function set_label($label, $attributes = array()) {
1333 $this->label
= $label;
1334 $this->labelattributes
= $attributes;
1340 * @param string $value The URL.
1341 * @return The cleaned URL.
1343 protected function clean_url($value) {
1346 if (empty($value)) {
1349 } else if (strpos($value, $CFG->wwwroot
. '/') === 0) {
1350 $value = str_replace($CFG->wwwroot
, '', $value);
1352 } else if (strpos($value, '/') !== 0) {
1353 debugging("Invalid url_select urls parameter: url '$value' is not local relative url!", DEBUG_DEVELOPER
);
1360 * Flatten the options for Mustache.
1362 * This also cleans the URLs.
1364 * @param array $options The options.
1365 * @param array $nothing The nothing option.
1368 protected function flatten_options($options, $nothing) {
1371 foreach ($options as $value => $option) {
1372 if (is_array($option)) {
1373 foreach ($option as $groupname => $optoptions) {
1374 if (!isset($flattened[$groupname])) {
1375 $flattened[$groupname] = [
1376 'name' => $groupname,
1381 foreach ($optoptions as $optvalue => $optoption) {
1382 $cleanedvalue = $this->clean_url($optvalue);
1383 $flattened[$groupname]['options'][$cleanedvalue] = [
1384 'name' => $optoption,
1385 'value' => $cleanedvalue,
1386 'selected' => $this->selected
== $optvalue,
1392 $cleanedvalue = $this->clean_url($value);
1393 $flattened[$cleanedvalue] = [
1395 'value' => $cleanedvalue,
1396 'selected' => $this->selected
== $value,
1401 if (!empty($nothing)) {
1402 $value = key($nothing);
1403 $name = reset($nothing);
1405 $value => ['name' => $name, 'value' => $value, 'selected' => $this->selected
== $value]
1409 // Make non-associative array.
1410 foreach ($flattened as $key => $value) {
1411 if (!empty($value['options'])) {
1412 $flattened[$key]['options'] = array_values($value['options']);
1415 $flattened = array_values($flattened);
1421 * Export for template.
1423 * @param renderer_base $output Renderer.
1426 public function export_for_template(renderer_base
$output) {
1427 $attributes = $this->attributes
;
1429 $data = new stdClass();
1430 $data->formid
= !empty($this->formid
) ?
$this->formid
: html_writer
::random_id('url_select_f');
1431 $data->classes
= $this->class;
1432 $data->label
= $this->label
;
1433 $data->disabled
= $this->disabled
;
1434 $data->title
= $this->tooltip
;
1435 $data->id
= !empty($attributes['id']) ?
$attributes['id'] : html_writer
::random_id('url_select');
1436 $data->sesskey
= sesskey();
1437 $data->action
= (new moodle_url('/course/jumpto.php'))->out(false);
1439 // Remove attributes passed as property directly.
1440 unset($attributes['class']);
1441 unset($attributes['id']);
1442 unset($attributes['name']);
1443 unset($attributes['title']);
1444 unset($attributes['disabled']);
1446 $data->showbutton
= $this->showbutton
;
1450 if (is_string($this->nothing
) && $this->nothing
!== '') {
1451 $nothing = ['' => $this->nothing
];
1452 } else if (is_array($this->nothing
)) {
1453 $nothingvalue = reset($this->nothing
);
1454 if ($nothingvalue === 'choose' ||
$nothingvalue === 'choosedots') {
1455 $nothing = [key($this->nothing
) => get_string('choosedots')];
1457 $nothing = $this->nothing
;
1460 $data->options
= $this->flatten_options($this->urls
, $nothing);
1462 // Label attributes.
1463 $data->labelattributes
= [];
1464 // Unset label attributes that are already in the template.
1465 unset($this->labelattributes
['for']);
1466 // Map the label attributes.
1467 foreach ($this->labelattributes
as $key => $value) {
1468 $data->labelattributes
[] = ['name' => $key, 'value' => $value];
1472 $data->helpicon
= !empty($this->helpicon
) ?
$this->helpicon
->export_for_template($output) : false;
1474 // Finally all the remaining attributes.
1475 $data->attributes
= [];
1476 foreach ($attributes as $key => $value) {
1477 $data->attributes
[] = ['name' => $key, 'value' => $value];
1485 * Data structure describing html link with special action attached.
1487 * @copyright 2010 Petr Skoda
1488 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1493 class action_link
implements renderable
{
1496 * @var moodle_url Href url
1501 * @var string Link text HTML fragment
1506 * @var array HTML attributes
1511 * @var array List of actions attached to link
1516 * @var pix_icon Optional pix icon to render with the link
1522 * @param moodle_url $url
1523 * @param string $text HTML fragment
1524 * @param component_action $action
1525 * @param array $attributes associative array of html link attributes + disabled
1526 * @param pix_icon $icon optional pix_icon to render with the link text
1528 public function __construct(moodle_url
$url,
1530 component_action
$action=null,
1531 array $attributes=null,
1532 pix_icon
$icon=null) {
1533 $this->url
= clone($url);
1534 $this->text
= $text;
1535 if (empty($attributes['id'])) {
1536 $attributes['id'] = html_writer
::random_id('action_link');
1538 $this->attributes
= (array)$attributes;
1540 $this->add_action($action);
1542 $this->icon
= $icon;
1546 * Add action to the link.
1548 * @param component_action $action
1550 public function add_action(component_action
$action) {
1551 $this->actions
[] = $action;
1555 * Adds a CSS class to this action link object
1556 * @param string $class
1558 public function add_class($class) {
1559 if (empty($this->attributes
['class'])) {
1560 $this->attributes
['class'] = $class;
1562 $this->attributes
['class'] .= ' ' . $class;
1567 * Returns true if the specified class has been added to this link.
1568 * @param string $class
1571 public function has_class($class) {
1572 return strpos(' ' . $this->attributes
['class'] . ' ', ' ' . $class . ' ') !== false;
1576 * Return the rendered HTML for the icon. Useful for rendering action links in a template.
1579 public function get_icon_html() {
1584 return $OUTPUT->render($this->icon
);
1588 * Export for template.
1590 * @param renderer_base $output The renderer.
1593 public function export_for_template(renderer_base
$output) {
1594 $data = new stdClass();
1595 $attributes = $this->attributes
;
1597 $data->id
= $attributes['id'];
1598 unset($attributes['id']);
1600 $data->disabled
= !empty($attributes['disabled']);
1601 unset($attributes['disabled']);
1603 $data->text
= $this->text
instanceof renderable ?
$output->render($this->text
) : (string) $this->text
;
1604 $data->url
= $this->url ?
$this->url
->out(false) : '';
1605 $data->icon
= $this->icon ?
$this->icon
->export_for_pix() : null;
1606 $data->classes
= isset($attributes['class']) ?
$attributes['class'] : '';
1607 unset($attributes['class']);
1609 $data->attributes
= array_map(function($key, $value) {
1614 }, array_keys($attributes), $attributes);
1616 $data->actions
= array_map(function($action) use ($output) {
1617 return $action->export_for_template($output);
1618 }, !empty($this->actions
) ?
$this->actions
: []);
1619 $data->hasactions
= !empty($this->actions
);
1626 * Simple html output class
1628 * @copyright 2009 Tim Hunt, 2010 Petr Skoda
1629 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1637 * Outputs a tag with attributes and contents
1639 * @param string $tagname The name of tag ('a', 'img', 'span' etc.)
1640 * @param string $contents What goes between the opening and closing tags
1641 * @param array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
1642 * @return string HTML fragment
1644 public static function tag($tagname, $contents, array $attributes = null) {
1645 return self
::start_tag($tagname, $attributes) . $contents . self
::end_tag($tagname);
1649 * Outputs an opening tag with attributes
1651 * @param string $tagname The name of tag ('a', 'img', 'span' etc.)
1652 * @param array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
1653 * @return string HTML fragment
1655 public static function start_tag($tagname, array $attributes = null) {
1656 return '<' . $tagname . self
::attributes($attributes) . '>';
1660 * Outputs a closing tag
1662 * @param string $tagname The name of tag ('a', 'img', 'span' etc.)
1663 * @return string HTML fragment
1665 public static function end_tag($tagname) {
1666 return '</' . $tagname . '>';
1670 * Outputs an empty tag with attributes
1672 * @param string $tagname The name of tag ('input', 'img', 'br' etc.)
1673 * @param array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
1674 * @return string HTML fragment
1676 public static function empty_tag($tagname, array $attributes = null) {
1677 return '<' . $tagname . self
::attributes($attributes) . ' />';
1681 * Outputs a tag, but only if the contents are not empty
1683 * @param string $tagname The name of tag ('a', 'img', 'span' etc.)
1684 * @param string $contents What goes between the opening and closing tags
1685 * @param array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
1686 * @return string HTML fragment
1688 public static function nonempty_tag($tagname, $contents, array $attributes = null) {
1689 if ($contents === '' ||
is_null($contents)) {
1692 return self
::tag($tagname, $contents, $attributes);
1696 * Outputs a HTML attribute and value
1698 * @param string $name The name of the attribute ('src', 'href', 'class' etc.)
1699 * @param string $value The value of the attribute. The value will be escaped with {@link s()}
1700 * @return string HTML fragment
1702 public static function attribute($name, $value) {
1703 if ($value instanceof moodle_url
) {
1704 return ' ' . $name . '="' . $value->out() . '"';
1707 // special case, we do not want these in output
1708 if ($value === null) {
1712 // no sloppy trimming here!
1713 return ' ' . $name . '="' . s($value) . '"';
1717 * Outputs a list of HTML attributes and values
1719 * @param array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
1720 * The values will be escaped with {@link s()}
1721 * @return string HTML fragment
1723 public static function attributes(array $attributes = null) {
1724 $attributes = (array)$attributes;
1726 foreach ($attributes as $name => $value) {
1727 $output .= self
::attribute($name, $value);
1733 * Generates a simple image tag with attributes.
1735 * @param string $src The source of image
1736 * @param string $alt The alternate text for image
1737 * @param array $attributes The tag attributes (array('height' => $max_height, 'class' => 'class1') etc.)
1738 * @return string HTML fragment
1740 public static function img($src, $alt, array $attributes = null) {
1741 $attributes = (array)$attributes;
1742 $attributes['src'] = $src;
1743 $attributes['alt'] = $alt;
1745 return self
::empty_tag('img', $attributes);
1749 * Generates random html element id.
1751 * @staticvar int $counter
1752 * @staticvar type $uniq
1753 * @param string $base A string fragment that will be included in the random ID.
1754 * @return string A unique ID
1756 public static function random_id($base='random') {
1757 static $counter = 0;
1760 if (!isset($uniq)) {
1765 return $base.$uniq.$counter;
1769 * Generates a simple html link
1771 * @param string|moodle_url $url The URL
1772 * @param string $text The text
1773 * @param array $attributes HTML attributes
1774 * @return string HTML fragment
1776 public static function link($url, $text, array $attributes = null) {
1777 $attributes = (array)$attributes;
1778 $attributes['href'] = $url;
1779 return self
::tag('a', $text, $attributes);
1783 * Generates a simple checkbox with optional label
1785 * @param string $name The name of the checkbox
1786 * @param string $value The value of the checkbox
1787 * @param bool $checked Whether the checkbox is checked
1788 * @param string $label The label for the checkbox
1789 * @param array $attributes Any attributes to apply to the checkbox
1790 * @param array $labelattributes Any attributes to apply to the label, if present
1791 * @return string html fragment
1793 public static function checkbox($name, $value, $checked = true, $label = '',
1794 array $attributes = null, array $labelattributes = null) {
1795 $attributes = (array) $attributes;
1798 if ($label !== '' and !is_null($label)) {
1799 if (empty($attributes['id'])) {
1800 $attributes['id'] = self
::random_id('checkbox_');
1803 $attributes['type'] = 'checkbox';
1804 $attributes['value'] = $value;
1805 $attributes['name'] = $name;
1806 $attributes['checked'] = $checked ?
'checked' : null;
1808 $output .= self
::empty_tag('input', $attributes);
1810 if ($label !== '' and !is_null($label)) {
1811 $labelattributes = (array) $labelattributes;
1812 $labelattributes['for'] = $attributes['id'];
1813 $output .= self
::tag('label', $label, $labelattributes);
1820 * Generates a simple select yes/no form field
1822 * @param string $name name of select element
1823 * @param bool $selected
1824 * @param array $attributes - html select element attributes
1825 * @return string HTML fragment
1827 public static function select_yes_no($name, $selected=true, array $attributes = null) {
1828 $options = array('1'=>get_string('yes'), '0'=>get_string('no'));
1829 return self
::select($options, $name, $selected, null, $attributes);
1833 * Generates a simple select form field
1835 * Note this function does HTML escaping on the optgroup labels, but not on the choice labels.
1837 * @param array $options associative array value=>label ex.:
1838 * array(1=>'One, 2=>Two)
1839 * it is also possible to specify optgroup as complex label array ex.:
1840 * array(array('Odd'=>array(1=>'One', 3=>'Three)), array('Even'=>array(2=>'Two')))
1841 * array(1=>'One', '--1uniquekey'=>array('More'=>array(2=>'Two', 3=>'Three')))
1842 * @param string $name name of select element
1843 * @param string|array $selected value or array of values depending on multiple attribute
1844 * @param array|bool $nothing add nothing selected option, or false of not added
1845 * @param array $attributes html select element attributes
1846 * @return string HTML fragment
1848 public static function select(array $options, $name, $selected = '', $nothing = array('' => 'choosedots'), array $attributes = null) {
1849 $attributes = (array)$attributes;
1850 if (is_array($nothing)) {
1851 foreach ($nothing as $k=>$v) {
1852 if ($v === 'choose' or $v === 'choosedots') {
1853 $nothing[$k] = get_string('choosedots');
1856 $options = $nothing +
$options; // keep keys, do not override
1858 } else if (is_string($nothing) and $nothing !== '') {
1860 $options = array(''=>$nothing) +
$options;
1863 // we may accept more values if multiple attribute specified
1864 $selected = (array)$selected;
1865 foreach ($selected as $k=>$v) {
1866 $selected[$k] = (string)$v;
1869 if (!isset($attributes['id'])) {
1871 // name may contaion [], which would make an invalid id. e.g. numeric question type editing form, assignment quickgrading
1872 $id = str_replace('[', '', $id);
1873 $id = str_replace(']', '', $id);
1874 $attributes['id'] = $id;
1877 if (!isset($attributes['class'])) {
1878 $class = 'menu'.$name;
1879 // name may contaion [], which would make an invalid class. e.g. numeric question type editing form, assignment quickgrading
1880 $class = str_replace('[', '', $class);
1881 $class = str_replace(']', '', $class);
1882 $attributes['class'] = $class;
1884 $attributes['class'] = 'select custom-select ' . $attributes['class']; // Add 'select' selector always.
1886 $attributes['name'] = $name;
1888 if (!empty($attributes['disabled'])) {
1889 $attributes['disabled'] = 'disabled';
1891 unset($attributes['disabled']);
1895 foreach ($options as $value=>$label) {
1896 if (is_array($label)) {
1897 // ignore key, it just has to be unique
1898 $output .= self
::select_optgroup(key($label), current($label), $selected);
1900 $output .= self
::select_option($label, $value, $selected);
1903 return self
::tag('select', $output, $attributes);
1907 * Returns HTML to display a select box option.
1909 * @param string $label The label to display as the option.
1910 * @param string|int $value The value the option represents
1911 * @param array $selected An array of selected options
1912 * @return string HTML fragment
1914 private static function select_option($label, $value, array $selected) {
1915 $attributes = array();
1916 $value = (string)$value;
1917 if (in_array($value, $selected, true)) {
1918 $attributes['selected'] = 'selected';
1920 $attributes['value'] = $value;
1921 return self
::tag('option', $label, $attributes);
1925 * Returns HTML to display a select box option group.
1927 * @param string $groupname The label to use for the group
1928 * @param array $options The options in the group
1929 * @param array $selected An array of selected values.
1930 * @return string HTML fragment.
1932 private static function select_optgroup($groupname, $options, array $selected) {
1933 if (empty($options)) {
1936 $attributes = array('label'=>$groupname);
1938 foreach ($options as $value=>$label) {
1939 $output .= self
::select_option($label, $value, $selected);
1941 return self
::tag('optgroup', $output, $attributes);
1945 * This is a shortcut for making an hour selector menu.
1947 * @param string $type The type of selector (years, months, days, hours, minutes)
1948 * @param string $name fieldname
1949 * @param int $currenttime A default timestamp in GMT
1950 * @param int $step minute spacing
1951 * @param array $attributes - html select element attributes
1952 * @return HTML fragment
1954 public static function select_time($type, $name, $currenttime = 0, $step = 5, array $attributes = null) {
1957 if (!$currenttime) {
1958 $currenttime = time();
1960 $calendartype = \core_calendar\type_factory
::get_calendar_instance();
1961 $currentdate = $calendartype->timestamp_to_date_array($currenttime);
1962 $userdatetype = $type;
1963 $timeunits = array();
1967 $timeunits = $calendartype->get_years();
1968 $userdatetype = 'year';
1971 $timeunits = $calendartype->get_months();
1972 $userdatetype = 'month';
1973 $currentdate['month'] = (int)$currentdate['mon'];
1976 $timeunits = $calendartype->get_days();
1977 $userdatetype = 'mday';
1980 for ($i=0; $i<=23; $i++
) {
1981 $timeunits[$i] = sprintf("%02d",$i);
1986 $currentdate['minutes'] = ceil($currentdate['minutes']/$step)*$step;
1989 for ($i=0; $i<=59; $i+
=$step) {
1990 $timeunits[$i] = sprintf("%02d",$i);
1994 throw new coding_exception("Time type $type is not supported by html_writer::select_time().");
1997 $attributes = (array) $attributes;
2000 'id' => !empty($attributes['id']) ?
$attributes['id'] : self
::random_id('ts_'),
2001 'label' => get_string(substr($type, 0, -1), 'form'),
2002 'options' => array_map(function($value) use ($timeunits, $currentdate, $userdatetype) {
2004 'name' => $timeunits[$value],
2006 'selected' => $currentdate[$userdatetype] == $value
2008 }, array_keys($timeunits)),
2011 unset($attributes['id']);
2012 unset($attributes['name']);
2013 $data->attributes
= array_map(function($name) use ($attributes) {
2016 'value' => $attributes[$name]
2018 }, array_keys($attributes));
2020 return $OUTPUT->render_from_template('core/select_time', $data);
2024 * Shortcut for quick making of lists
2026 * Note: 'list' is a reserved keyword ;-)
2028 * @param array $items
2029 * @param array $attributes
2030 * @param string $tag ul or ol
2033 public static function alist(array $items, array $attributes = null, $tag = 'ul') {
2034 $output = html_writer
::start_tag($tag, $attributes)."\n";
2035 foreach ($items as $item) {
2036 $output .= html_writer
::tag('li', $item)."\n";
2038 $output .= html_writer
::end_tag($tag);
2043 * Returns hidden input fields created from url parameters.
2045 * @param moodle_url $url
2046 * @param array $exclude list of excluded parameters
2047 * @return string HTML fragment
2049 public static function input_hidden_params(moodle_url
$url, array $exclude = null) {
2050 $exclude = (array)$exclude;
2051 $params = $url->params();
2052 foreach ($exclude as $key) {
2053 unset($params[$key]);
2057 foreach ($params as $key => $value) {
2058 $attributes = array('type'=>'hidden', 'name'=>$key, 'value'=>$value);
2059 $output .= self
::empty_tag('input', $attributes)."\n";
2065 * Generate a script tag containing the the specified code.
2067 * @param string $jscode the JavaScript code
2068 * @param moodle_url|string $url optional url of the external script, $code ignored if specified
2069 * @return string HTML, the code wrapped in <script> tags.
2071 public static function script($jscode, $url=null) {
2073 return self
::tag('script', "\n//<![CDATA[\n$jscode\n//]]>\n") . "\n";
2076 return self
::tag('script', '', ['src' => $url]) . "\n";
2084 * Renders HTML table
2086 * This method may modify the passed instance by adding some default properties if they are not set yet.
2087 * If this is not what you want, you should make a full clone of your data before passing them to this
2088 * method. In most cases this is not an issue at all so we do not clone by default for performance
2089 * and memory consumption reasons.
2091 * @param html_table $table data to be rendered
2092 * @return string HTML code
2094 public static function table(html_table
$table) {
2095 // prepare table data and populate missing properties with reasonable defaults
2096 if (!empty($table->align
)) {
2097 foreach ($table->align
as $key => $aa) {
2099 $table->align
[$key] = 'text-align:'. fix_align_rtl($aa) .';'; // Fix for RTL languages
2101 $table->align
[$key] = null;
2105 if (!empty($table->size
)) {
2106 foreach ($table->size
as $key => $ss) {
2108 $table->size
[$key] = 'width:'. $ss .';';
2110 $table->size
[$key] = null;
2114 if (!empty($table->wrap
)) {
2115 foreach ($table->wrap
as $key => $ww) {
2117 $table->wrap
[$key] = 'white-space:nowrap;';
2119 $table->wrap
[$key] = '';
2123 if (!empty($table->head
)) {
2124 foreach ($table->head
as $key => $val) {
2125 if (!isset($table->align
[$key])) {
2126 $table->align
[$key] = null;
2128 if (!isset($table->size
[$key])) {
2129 $table->size
[$key] = null;
2131 if (!isset($table->wrap
[$key])) {
2132 $table->wrap
[$key] = null;
2137 if (empty($table->attributes
['class'])) {
2138 $table->attributes
['class'] = 'generaltable';
2140 if (!empty($table->tablealign
)) {
2141 $table->attributes
['class'] .= ' boxalign' . $table->tablealign
;
2144 // explicitly assigned properties override those defined via $table->attributes
2145 $table->attributes
['class'] = trim($table->attributes
['class']);
2146 $attributes = array_merge($table->attributes
, array(
2148 'width' => $table->width
,
2149 'summary' => $table->summary
,
2150 'cellpadding' => $table->cellpadding
,
2151 'cellspacing' => $table->cellspacing
,
2153 $output = html_writer
::start_tag('table', $attributes) . "\n";
2157 // Output a caption if present.
2158 if (!empty($table->caption
)) {
2159 $captionattributes = array();
2160 if ($table->captionhide
) {
2161 $captionattributes['class'] = 'accesshide';
2163 $output .= html_writer
::tag(
2170 if (!empty($table->head
)) {
2171 $countcols = count($table->head
);
2173 $output .= html_writer
::start_tag('thead', array()) . "\n";
2174 $output .= html_writer
::start_tag('tr', array()) . "\n";
2175 $keys = array_keys($table->head
);
2176 $lastkey = end($keys);
2178 foreach ($table->head
as $key => $heading) {
2179 // Convert plain string headings into html_table_cell objects
2180 if (!($heading instanceof html_table_cell
)) {
2181 $headingtext = $heading;
2182 $heading = new html_table_cell();
2183 $heading->text
= $headingtext;
2184 $heading->header
= true;
2187 if ($heading->header
!== false) {
2188 $heading->header
= true;
2192 if ($heading->header
&& (string)$heading->text
!= '') {
2196 $heading->attributes
['class'] .= ' header c' . $key;
2197 if (isset($table->headspan
[$key]) && $table->headspan
[$key] > 1) {
2198 $heading->colspan
= $table->headspan
[$key];
2199 $countcols +
= $table->headspan
[$key] - 1;
2202 if ($key == $lastkey) {
2203 $heading->attributes
['class'] .= ' lastcol';
2205 if (isset($table->colclasses
[$key])) {
2206 $heading->attributes
['class'] .= ' ' . $table->colclasses
[$key];
2208 $heading->attributes
['class'] = trim($heading->attributes
['class']);
2209 $attributes = array_merge($heading->attributes
, [
2210 'style' => $table->align
[$key] . $table->size
[$key] . $heading->style
,
2211 'colspan' => $heading->colspan
,
2214 if ($tagtype == 'th') {
2215 $attributes['scope'] = !empty($heading->scope
) ?
$heading->scope
: 'col';
2218 $output .= html_writer
::tag($tagtype, $heading->text
, $attributes) . "\n";
2220 $output .= html_writer
::end_tag('tr') . "\n";
2221 $output .= html_writer
::end_tag('thead') . "\n";
2223 if (empty($table->data
)) {
2224 // For valid XHTML strict every table must contain either a valid tr
2225 // or a valid tbody... both of which must contain a valid td
2226 $output .= html_writer
::start_tag('tbody', array('class' => 'empty'));
2227 $output .= html_writer
::tag('tr', html_writer
::tag('td', '', array('colspan'=>count($table->head
))));
2228 $output .= html_writer
::end_tag('tbody');
2232 if (!empty($table->data
)) {
2233 $keys = array_keys($table->data
);
2234 $lastrowkey = end($keys);
2235 $output .= html_writer
::start_tag('tbody', array());
2237 foreach ($table->data
as $key => $row) {
2238 if (($row === 'hr') && ($countcols)) {
2239 $output .= html_writer
::tag('td', html_writer
::tag('div', '', array('class' => 'tabledivider')), array('colspan' => $countcols));
2241 // Convert array rows to html_table_rows and cell strings to html_table_cell objects
2242 if (!($row instanceof html_table_row
)) {
2243 $newrow = new html_table_row();
2245 foreach ($row as $cell) {
2246 if (!($cell instanceof html_table_cell
)) {
2247 $cell = new html_table_cell($cell);
2249 $newrow->cells
[] = $cell;
2254 if (isset($table->rowclasses
[$key])) {
2255 $row->attributes
['class'] .= ' ' . $table->rowclasses
[$key];
2258 if ($key == $lastrowkey) {
2259 $row->attributes
['class'] .= ' lastrow';
2262 // Explicitly assigned properties should override those defined in the attributes.
2263 $row->attributes
['class'] = trim($row->attributes
['class']);
2264 $trattributes = array_merge($row->attributes
, array(
2266 'style' => $row->style
,
2268 $output .= html_writer
::start_tag('tr', $trattributes) . "\n";
2269 $keys2 = array_keys($row->cells
);
2270 $lastkey = end($keys2);
2272 $gotlastkey = false; //flag for sanity checking
2273 foreach ($row->cells
as $key => $cell) {
2275 //This should never happen. Why do we have a cell after the last cell?
2276 mtrace("A cell with key ($key) was found after the last key ($lastkey)");
2279 if (!($cell instanceof html_table_cell
)) {
2280 $mycell = new html_table_cell();
2281 $mycell->text
= $cell;
2285 if (($cell->header
=== true) && empty($cell->scope
)) {
2286 $cell->scope
= 'row';
2289 if (isset($table->colclasses
[$key])) {
2290 $cell->attributes
['class'] .= ' ' . $table->colclasses
[$key];
2293 $cell->attributes
['class'] .= ' cell c' . $key;
2294 if ($key == $lastkey) {
2295 $cell->attributes
['class'] .= ' lastcol';
2299 $tdstyle .= isset($table->align
[$key]) ?
$table->align
[$key] : '';
2300 $tdstyle .= isset($table->size
[$key]) ?
$table->size
[$key] : '';
2301 $tdstyle .= isset($table->wrap
[$key]) ?
$table->wrap
[$key] : '';
2302 $cell->attributes
['class'] = trim($cell->attributes
['class']);
2303 $tdattributes = array_merge($cell->attributes
, array(
2304 'style' => $tdstyle . $cell->style
,
2305 'colspan' => $cell->colspan
,
2306 'rowspan' => $cell->rowspan
,
2308 'abbr' => $cell->abbr
,
2309 'scope' => $cell->scope
,
2312 if ($cell->header
=== true) {
2315 $output .= html_writer
::tag($tagtype, $cell->text
, $tdattributes) . "\n";
2318 $output .= html_writer
::end_tag('tr') . "\n";
2320 $output .= html_writer
::end_tag('tbody') . "\n";
2322 $output .= html_writer
::end_tag('table') . "\n";
2324 if ($table->responsive
) {
2325 return self
::div($output, 'table-responsive');
2332 * Renders form element label
2334 * By default, the label is suffixed with a label separator defined in the
2335 * current language pack (colon by default in the English lang pack).
2336 * Adding the colon can be explicitly disabled if needed. Label separators
2337 * are put outside the label tag itself so they are not read by
2338 * screenreaders (accessibility).
2340 * Parameter $for explicitly associates the label with a form control. When
2341 * set, the value of this attribute must be the same as the value of
2342 * the id attribute of the form control in the same document. When null,
2343 * the label being defined is associated with the control inside the label
2346 * @param string $text content of the label tag
2347 * @param string|null $for id of the element this label is associated with, null for no association
2348 * @param bool $colonize add label separator (colon) to the label text, if it is not there yet
2349 * @param array $attributes to be inserted in the tab, for example array('accesskey' => 'a')
2350 * @return string HTML of the label element
2352 public static function label($text, $for, $colonize = true, array $attributes=array()) {
2353 if (!is_null($for)) {
2354 $attributes = array_merge($attributes, array('for' => $for));
2356 $text = trim($text);
2357 $label = self
::tag('label', $text, $attributes);
2359 // TODO MDL-12192 $colonize disabled for now yet
2360 // if (!empty($text) and $colonize) {
2361 // // the $text may end with the colon already, though it is bad string definition style
2362 // $colon = get_string('labelsep', 'langconfig');
2363 // if (!empty($colon)) {
2364 // $trimmed = trim($colon);
2365 // if ((substr($text, -strlen($trimmed)) == $trimmed) or (substr($text, -1) == ':')) {
2366 // //debugging('The label text should not end with colon or other label separator,
2367 // // please fix the string definition.', DEBUG_DEVELOPER);
2369 // $label .= $colon;
2378 * Combines a class parameter with other attributes. Aids in code reduction
2379 * because the class parameter is very frequently used.
2381 * If the class attribute is specified both in the attributes and in the
2382 * class parameter, the two values are combined with a space between.
2384 * @param string $class Optional CSS class (or classes as space-separated list)
2385 * @param array $attributes Optional other attributes as array
2386 * @return array Attributes (or null if still none)
2388 private static function add_class($class = '', array $attributes = null) {
2389 if ($class !== '') {
2390 $classattribute = array('class' => $class);
2392 if (array_key_exists('class', $attributes)) {
2393 $attributes['class'] = trim($attributes['class'] . ' ' . $class);
2395 $attributes = $classattribute +
$attributes;
2398 $attributes = $classattribute;
2405 * Creates a <div> tag. (Shortcut function.)
2407 * @param string $content HTML content of tag
2408 * @param string $class Optional CSS class (or classes as space-separated list)
2409 * @param array $attributes Optional other attributes as array
2410 * @return string HTML code for div
2412 public static function div($content, $class = '', array $attributes = null) {
2413 return self
::tag('div', $content, self
::add_class($class, $attributes));
2417 * Starts a <div> tag. (Shortcut function.)
2419 * @param string $class Optional CSS class (or classes as space-separated list)
2420 * @param array $attributes Optional other attributes as array
2421 * @return string HTML code for open div tag
2423 public static function start_div($class = '', array $attributes = null) {
2424 return self
::start_tag('div', self
::add_class($class, $attributes));
2428 * Ends a <div> tag. (Shortcut function.)
2430 * @return string HTML code for close div tag
2432 public static function end_div() {
2433 return self
::end_tag('div');
2437 * Creates a <span> tag. (Shortcut function.)
2439 * @param string $content HTML content of tag
2440 * @param string $class Optional CSS class (or classes as space-separated list)
2441 * @param array $attributes Optional other attributes as array
2442 * @return string HTML code for span
2444 public static function span($content, $class = '', array $attributes = null) {
2445 return self
::tag('span', $content, self
::add_class($class, $attributes));
2449 * Starts a <span> tag. (Shortcut function.)
2451 * @param string $class Optional CSS class (or classes as space-separated list)
2452 * @param array $attributes Optional other attributes as array
2453 * @return string HTML code for open span tag
2455 public static function start_span($class = '', array $attributes = null) {
2456 return self
::start_tag('span', self
::add_class($class, $attributes));
2460 * Ends a <span> tag. (Shortcut function.)
2462 * @return string HTML code for close span tag
2464 public static function end_span() {
2465 return self
::end_tag('span');
2470 * Simple javascript output class
2472 * @copyright 2010 Petr Skoda
2473 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2481 * Returns javascript code calling the function
2483 * @param string $function function name, can be complex like Y.Event.purgeElement
2484 * @param array $arguments parameters
2485 * @param int $delay execution delay in seconds
2486 * @return string JS code fragment
2488 public static function function_call($function, array $arguments = null, $delay=0) {
2490 $arguments = array_map('json_encode', convert_to_array($arguments));
2491 $arguments = implode(', ', $arguments);
2495 $js = "$function($arguments);";
2498 $delay = $delay * 1000; // in miliseconds
2499 $js = "setTimeout(function() { $js }, $delay);";
2505 * Special function which adds Y as first argument of function call.
2507 * @param string $function The function to call
2508 * @param array $extraarguments Any arguments to pass to it
2509 * @return string Some JS code
2511 public static function function_call_with_Y($function, array $extraarguments = null) {
2512 if ($extraarguments) {
2513 $extraarguments = array_map('json_encode', convert_to_array($extraarguments));
2514 $arguments = 'Y, ' . implode(', ', $extraarguments);
2518 return "$function($arguments);\n";
2522 * Returns JavaScript code to initialise a new object
2524 * @param string $var If it is null then no var is assigned the new object.
2525 * @param string $class The class to initialise an object for.
2526 * @param array $arguments An array of args to pass to the init method.
2527 * @param array $requirements Any modules required for this class.
2528 * @param int $delay The delay before initialisation. 0 = no delay.
2529 * @return string Some JS code
2531 public static function object_init($var, $class, array $arguments = null, array $requirements = null, $delay=0) {
2532 if (is_array($arguments)) {
2533 $arguments = array_map('json_encode', convert_to_array($arguments));
2534 $arguments = implode(', ', $arguments);
2537 if ($var === null) {
2538 $js = "new $class(Y, $arguments);";
2539 } else if (strpos($var, '.')!==false) {
2540 $js = "$var = new $class(Y, $arguments);";
2542 $js = "var $var = new $class(Y, $arguments);";
2546 $delay = $delay * 1000; // in miliseconds
2547 $js = "setTimeout(function() { $js }, $delay);";
2550 if (count($requirements) > 0) {
2551 $requirements = implode("', '", $requirements);
2552 $js = "Y.use('$requirements', function(Y){ $js });";
2558 * Returns code setting value to variable
2560 * @param string $name
2561 * @param mixed $value json serialised value
2562 * @param bool $usevar add var definition, ignored for nested properties
2563 * @return string JS code fragment
2565 public static function set_variable($name, $value, $usevar = true) {
2569 if (strpos($name, '.')) {
2576 $output .= "$name = ".json_encode($value).";";
2582 * Writes event handler attaching code
2584 * @param array|string $selector standard YUI selector for elements, may be
2585 * array or string, element id is in the form "#idvalue"
2586 * @param string $event A valid DOM event (click, mousedown, change etc.)
2587 * @param string $function The name of the function to call
2588 * @param array $arguments An optional array of argument parameters to pass to the function
2589 * @return string JS code fragment
2591 public static function event_handler($selector, $event, $function, array $arguments = null) {
2592 $selector = json_encode($selector);
2593 $output = "Y.on('$event', $function, $selector, null";
2594 if (!empty($arguments)) {
2595 $output .= ', ' . json_encode($arguments);
2597 return $output . ");\n";
2602 * Holds all the information required to render a <table> by {@link core_renderer::table()}
2605 * $t = new html_table();
2606 * ... // set various properties of the object $t as described below
2607 * echo html_writer::table($t);
2609 * @copyright 2009 David Mudrak <david.mudrak@gmail.com>
2610 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2618 * @var string Value to use for the id attribute of the table
2623 * @var array Attributes of HTML attributes for the <table> element
2625 public $attributes = array();
2628 * @var array An array of headings. The n-th array item is used as a heading of the n-th column.
2629 * For more control over the rendering of the headers, an array of html_table_cell objects
2630 * can be passed instead of an array of strings.
2633 * $t->head = array('Student', 'Grade');
2638 * @var array An array that can be used to make a heading span multiple columns.
2639 * In this example, {@link html_table:$data} is supposed to have three columns. For the first two columns,
2640 * the same heading is used. Therefore, {@link html_table::$head} should consist of two items.
2643 * $t->headspan = array(2,1);
2648 * @var array An array of column alignments.
2649 * The value is used as CSS 'text-align' property. Therefore, possible
2650 * values are 'left', 'right', 'center' and 'justify'. Specify 'right' or 'left' from the perspective
2651 * of a left-to-right (LTR) language. For RTL, the values are flipped automatically.
2653 * Examples of usage:
2654 * $t->align = array(null, 'right');
2656 * $t->align[1] = 'right';
2661 * @var array The value is used as CSS 'size' property.
2663 * Examples of usage:
2664 * $t->size = array('50%', '50%');
2666 * $t->size[1] = '120px';
2671 * @var array An array of wrapping information.
2672 * The only possible value is 'nowrap' that sets the
2673 * CSS property 'white-space' to the value 'nowrap' in the given column.
2676 * $t->wrap = array(null, 'nowrap');
2681 * @var array Array of arrays or html_table_row objects containing the data. Alternatively, if you have
2682 * $head specified, the string 'hr' (for horizontal ruler) can be used
2683 * instead of an array of cells data resulting in a divider rendered.
2685 * Example of usage with array of arrays:
2686 * $row1 = array('Harry Potter', '76 %');
2687 * $row2 = array('Hermione Granger', '100 %');
2688 * $t->data = array($row1, $row2);
2690 * Example with array of html_table_row objects: (used for more fine-grained control)
2691 * $cell1 = new html_table_cell();
2692 * $cell1->text = 'Harry Potter';
2693 * $cell1->colspan = 2;
2694 * $row1 = new html_table_row();
2695 * $row1->cells[] = $cell1;
2696 * $cell2 = new html_table_cell();
2697 * $cell2->text = 'Hermione Granger';
2698 * $cell3 = new html_table_cell();
2699 * $cell3->text = '100 %';
2700 * $row2 = new html_table_row();
2701 * $row2->cells = array($cell2, $cell3);
2702 * $t->data = array($row1, $row2);
2707 * @deprecated since Moodle 2.0. Styling should be in the CSS.
2708 * @var string Width of the table, percentage of the page preferred.
2710 public $width = null;
2713 * @deprecated since Moodle 2.0. Styling should be in the CSS.
2714 * @var string Alignment for the whole table. Can be 'right', 'left' or 'center' (default).
2716 public $tablealign = null;
2719 * @deprecated since Moodle 2.0. Styling should be in the CSS.
2720 * @var int Padding on each cell, in pixels
2722 public $cellpadding = null;
2725 * @var int Spacing between cells, in pixels
2726 * @deprecated since Moodle 2.0. Styling should be in the CSS.
2728 public $cellspacing = null;
2731 * @var array Array of classes to add to particular rows, space-separated string.
2732 * Class 'lastrow' is added automatically for the last row in the table.
2735 * $t->rowclasses[9] = 'tenth'
2740 * @var array An array of classes to add to every cell in a particular column,
2741 * space-separated string. Class 'cell' is added automatically by the renderer.
2742 * Classes 'c0' or 'c1' are added automatically for every odd or even column,
2743 * respectively. Class 'lastcol' is added automatically for all last cells
2747 * $t->colclasses = array(null, 'grade');
2752 * @var string Description of the contents for screen readers.
2754 * The "summary" attribute on the "table" element is not supported in HTML5.
2755 * Consider describing the structure of the table in a "caption" element or in a "figure" element containing the table;
2756 * or, simplify the structure of the table so that no description is needed.
2758 * @deprecated since Moodle 3.9.
2763 * @var string Caption for the table, typically a title.
2766 * $t->caption = "TV Guide";
2771 * @var bool Whether to hide the table's caption from sighted users.
2774 * $t->caption = "TV Guide";
2775 * $t->captionhide = true;
2777 public $captionhide = false;
2779 /** @var bool Whether to make the table to be scrolled horizontally with ease. Make table responsive across all viewports. */
2780 public $responsive = true;
2785 public function __construct() {
2786 $this->attributes
['class'] = '';
2791 * Component representing a table row.
2793 * @copyright 2009 Nicolas Connault
2794 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2799 class html_table_row
{
2802 * @var string Value to use for the id attribute of the row.
2807 * @var array Array of html_table_cell objects
2809 public $cells = array();
2812 * @var string Value to use for the style attribute of the table row
2814 public $style = null;
2817 * @var array Attributes of additional HTML attributes for the <tr> element
2819 public $attributes = array();
2823 * @param array $cells
2825 public function __construct(array $cells=null) {
2826 $this->attributes
['class'] = '';
2827 $cells = (array)$cells;
2828 foreach ($cells as $cell) {
2829 if ($cell instanceof html_table_cell
) {
2830 $this->cells
[] = $cell;
2832 $this->cells
[] = new html_table_cell($cell);
2839 * Component representing a table cell.
2841 * @copyright 2009 Nicolas Connault
2842 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2847 class html_table_cell
{
2850 * @var string Value to use for the id attribute of the cell.
2855 * @var string The contents of the cell.
2860 * @var string Abbreviated version of the contents of the cell.
2862 public $abbr = null;
2865 * @var int Number of columns this cell should span.
2867 public $colspan = null;
2870 * @var int Number of rows this cell should span.
2872 public $rowspan = null;
2875 * @var string Defines a way to associate header cells and data cells in a table.
2877 public $scope = null;
2880 * @var bool Whether or not this cell is a header cell.
2882 public $header = null;
2885 * @var string Value to use for the style attribute of the table cell
2887 public $style = null;
2890 * @var array Attributes of additional HTML attributes for the <td> element
2892 public $attributes = array();
2895 * Constructs a table cell
2897 * @param string $text
2899 public function __construct($text = null) {
2900 $this->text
= $text;
2901 $this->attributes
['class'] = '';
2906 * Component representing a paging bar.
2908 * @copyright 2009 Nicolas Connault
2909 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2914 class paging_bar
implements renderable
, templatable
{
2917 * @var int The maximum number of pagelinks to display.
2919 public $maxdisplay = 18;
2922 * @var int The total number of entries to be pages through..
2927 * @var int The page you are currently viewing.
2932 * @var int The number of entries that should be shown per page.
2937 * @var string|moodle_url If this is a string then it is the url which will be appended with $pagevar,
2938 * an equals sign and the page number.
2939 * If this is a moodle_url object then the pagevar param will be replaced by
2940 * the page no, for each page.
2945 * @var string This is the variable name that you use for the pagenumber in your
2946 * code (ie. 'tablepage', 'blogpage', etc)
2951 * @var string A HTML link representing the "previous" page.
2953 public $previouslink = null;
2956 * @var string A HTML link representing the "next" page.
2958 public $nextlink = null;
2961 * @var string A HTML link representing the first page.
2963 public $firstlink = null;
2966 * @var string A HTML link representing the last page.
2968 public $lastlink = null;
2971 * @var array An array of strings. One of them is just a string: the current page
2973 public $pagelinks = array();
2976 * Constructor paging_bar with only the required params.
2978 * @param int $totalcount The total number of entries available to be paged through
2979 * @param int $page The page you are currently viewing
2980 * @param int $perpage The number of entries that should be shown per page
2981 * @param string|moodle_url $baseurl url of the current page, the $pagevar parameter is added
2982 * @param string $pagevar name of page parameter that holds the page number
2984 public function __construct($totalcount, $page, $perpage, $baseurl, $pagevar = 'page') {
2985 $this->totalcount
= $totalcount;
2986 $this->page
= $page;
2987 $this->perpage
= $perpage;
2988 $this->baseurl
= $baseurl;
2989 $this->pagevar
= $pagevar;
2993 * Prepares the paging bar for output.
2995 * This method validates the arguments set up for the paging bar and then
2996 * produces fragments of HTML to assist display later on.
2998 * @param renderer_base $output
2999 * @param moodle_page $page
3000 * @param string $target
3001 * @throws coding_exception
3003 public function prepare(renderer_base
$output, moodle_page
$page, $target) {
3004 if (!isset($this->totalcount
) ||
is_null($this->totalcount
)) {
3005 throw new coding_exception('paging_bar requires a totalcount value.');
3007 if (!isset($this->page
) ||
is_null($this->page
)) {
3008 throw new coding_exception('paging_bar requires a page value.');
3010 if (empty($this->perpage
)) {
3011 throw new coding_exception('paging_bar requires a perpage value.');
3013 if (empty($this->baseurl
)) {
3014 throw new coding_exception('paging_bar requires a baseurl value.');
3017 if ($this->totalcount
> $this->perpage
) {
3018 $pagenum = $this->page
- 1;
3020 if ($this->page
> 0) {
3021 $this->previouslink
= html_writer
::link(new moodle_url($this->baseurl
, array($this->pagevar
=>$pagenum)), get_string('previous'), array('class'=>'previous'));
3024 if ($this->perpage
> 0) {
3025 $lastpage = ceil($this->totalcount
/ $this->perpage
);
3030 if ($this->page
> round(($this->maxdisplay
/3)*2)) {
3031 $currpage = $this->page
- round($this->maxdisplay
/3);
3033 $this->firstlink
= html_writer
::link(new moodle_url($this->baseurl
, array($this->pagevar
=>0)), '1', array('class'=>'first'));
3038 $displaycount = $displaypage = 0;
3040 while ($displaycount < $this->maxdisplay
and $currpage < $lastpage) {
3041 $displaypage = $currpage +
1;
3043 if ($this->page
== $currpage) {
3044 $this->pagelinks
[] = html_writer
::span($displaypage, 'current-page');
3046 $pagelink = html_writer
::link(new moodle_url($this->baseurl
, array($this->pagevar
=>$currpage)), $displaypage);
3047 $this->pagelinks
[] = $pagelink;
3054 if ($currpage < $lastpage) {
3055 $lastpageactual = $lastpage - 1;
3056 $this->lastlink
= html_writer
::link(new moodle_url($this->baseurl
, array($this->pagevar
=>$lastpageactual)), $lastpage, array('class'=>'last'));
3059 $pagenum = $this->page +
1;
3061 if ($pagenum != $lastpage) {
3062 $this->nextlink
= html_writer
::link(new moodle_url($this->baseurl
, array($this->pagevar
=>$pagenum)), get_string('next'), array('class'=>'next'));
3068 * Export for template.
3070 * @param renderer_base $output The renderer.
3073 public function export_for_template(renderer_base
$output) {
3074 $data = new stdClass();
3075 $data->previous
= null;
3077 $data->first
= null;
3079 $data->label
= get_string('page');
3081 $data->haspages
= $this->totalcount
> $this->perpage
;
3082 $data->pagesize
= $this->perpage
;
3084 if (!$data->haspages
) {
3088 if ($this->page
> 0) {
3090 'page' => $this->page
,
3091 'url' => (new moodle_url($this->baseurl
, [$this->pagevar
=> $this->page
- 1]))->out(false)
3096 if ($this->page
> round(($this->maxdisplay
/ 3) * 2)) {
3097 $currpage = $this->page
- round($this->maxdisplay
/ 3);
3100 'url' => (new moodle_url($this->baseurl
, [$this->pagevar
=> 0]))->out(false)
3105 if ($this->perpage
> 0) {
3106 $lastpage = ceil($this->totalcount
/ $this->perpage
);
3111 while ($displaycount < $this->maxdisplay
and $currpage < $lastpage) {
3112 $displaypage = $currpage +
1;
3114 $iscurrent = $this->page
== $currpage;
3115 $link = new moodle_url($this->baseurl
, [$this->pagevar
=> $currpage]);
3118 'page' => $displaypage,
3119 'active' => $iscurrent,
3120 'url' => $iscurrent ?
null : $link->out(false)
3127 if ($currpage < $lastpage) {
3129 'page' => $lastpage,
3130 'url' => (new moodle_url($this->baseurl
, [$this->pagevar
=> $lastpage - 1]))->out(false)
3134 if ($this->page +
1 != $lastpage) {
3136 'page' => $this->page +
2,
3137 'url' => (new moodle_url($this->baseurl
, [$this->pagevar
=> $this->page +
1]))->out(false)
3146 * Component representing initials bar.
3148 * @copyright 2017 Ilya Tregubov
3149 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3154 class initials_bar
implements renderable
, templatable
{
3157 * @var string Currently selected letter.
3162 * @var string Class name to add to this initial bar.
3167 * @var string The name to put in front of this initial bar.
3172 * @var string URL parameter name for this initial.
3177 * @var string URL object.
3182 * @var array An array of letters in the alphabet.
3187 * Constructor initials_bar with only the required params.
3189 * @param string $current the currently selected letter.
3190 * @param string $class class name to add to this initial bar.
3191 * @param string $title the name to put in front of this initial bar.
3192 * @param string $urlvar URL parameter name for this initial.
3193 * @param string $url URL object.
3194 * @param array $alpha of letters in the alphabet.
3196 public function __construct($current, $class, $title, $urlvar, $url, $alpha = null) {
3197 $this->current
= $current;
3198 $this->class = $class;
3199 $this->title
= $title;
3200 $this->urlvar
= $urlvar;
3202 $this->alpha
= $alpha;
3206 * Export for template.
3208 * @param renderer_base $output The renderer.
3211 public function export_for_template(renderer_base
$output) {
3212 $data = new stdClass();
3214 if ($this->alpha
== null) {
3215 $this->alpha
= explode(',', get_string('alphabet', 'langconfig'));
3218 if ($this->current
== 'all') {
3219 $this->current
= '';
3222 // We want to find a letter grouping size which suits the language so
3223 // find the largest group size which is less than 15 chars.
3224 // The choice of 15 chars is the largest number of chars that reasonably
3225 // fits on the smallest supported screen size. By always using a max number
3226 // of groups which is a factor of 2, we always get nice wrapping, and the
3227 // last row is always the shortest.
3228 $groupsize = count($this->alpha
);
3230 while ($groupsize > 15) {
3232 $groupsize = ceil(count($this->alpha
) / $groups);
3235 $groupsizelimit = 0;
3237 foreach ($this->alpha
as $letter) {
3238 if ($groupsizelimit++
> 0 && $groupsizelimit %
$groupsize == 1) {
3241 $groupletter = new stdClass();
3242 $groupletter->name
= $letter;
3243 $groupletter->url
= $this->url
->out(false, array($this->urlvar
=> $letter));
3244 if ($letter == $this->current
) {
3245 $groupletter->selected
= $this->current
;
3247 if (!isset($data->group
[$groupnumber])) {
3248 $data->group
[$groupnumber] = new stdClass();
3250 $data->group
[$groupnumber]->letter
[] = $groupletter;
3253 $data->class = $this->class;
3254 $data->title
= $this->title
;
3255 $data->url
= $this->url
->out(false, array($this->urlvar
=> ''));
3256 $data->current
= $this->current
;
3257 $data->all
= get_string('all');
3264 * This class represents how a block appears on a page.
3266 * During output, each block instance is asked to return a block_contents object,
3267 * those are then passed to the $OUTPUT->block function for display.
3269 * contents should probably be generated using a moodle_block_..._renderer.
3271 * Other block-like things that need to appear on the page, for example the
3272 * add new block UI, are also represented as block_contents objects.
3274 * @copyright 2009 Tim Hunt
3275 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3280 class block_contents
{
3282 /** Used when the block cannot be collapsed **/
3283 const NOT_HIDEABLE
= 0;
3285 /** Used when the block can be collapsed but currently is not **/
3288 /** Used when the block has been collapsed **/
3292 * @var int Used to set $skipid.
3294 protected static $idcounter = 1;
3297 * @var int All the blocks (or things that look like blocks) printed on
3298 * a page are given a unique number that can be used to construct id="" attributes.
3299 * This is set automatically be the {@link prepare()} method.
3300 * Do not try to set it manually.
3305 * @var int If this is the contents of a real block, this should be set
3306 * to the block_instance.id. Otherwise this should be set to 0.
3308 public $blockinstanceid = 0;
3311 * @var int If this is a real block instance, and there is a corresponding
3312 * block_position.id for the block on this page, this should be set to that id.
3313 * Otherwise it should be 0.
3315 public $blockpositionid = 0;
3318 * @var array An array of attribute => value pairs that are put on the outer div of this
3319 * block. {@link $id} and {@link $classes} attributes should be set separately.
3324 * @var string The title of this block. If this came from user input, it should already
3325 * have had format_string() processing done on it. This will be output inside
3326 * <h2> tags. Please do not cause invalid XHTML.
3331 * @var string The label to use when the block does not, or will not have a visible title.
3332 * You should never set this as well as title... it will just be ignored.
3334 public $arialabel = '';
3337 * @var string HTML for the content
3339 public $content = '';
3342 * @var array An alternative to $content, it you want a list of things with optional icons.
3344 public $footer = '';
3347 * @var string Any small print that should appear under the block to explain
3348 * to the teacher about the block, for example 'This is a sticky block that was
3349 * added in the system context.'
3351 public $annotation = '';
3354 * @var int One of the constants NOT_HIDEABLE, VISIBLE, HIDDEN. Whether
3355 * the user can toggle whether this block is visible.
3357 public $collapsible = self
::NOT_HIDEABLE
;
3360 * Set this to true if the block is dockable.
3363 public $dockable = false;
3366 * @var array A (possibly empty) array of editing controls. Each element of
3367 * this array should be an array('url' => $url, 'icon' => $icon, 'caption' => $caption).
3368 * $icon is the icon name. Fed to $OUTPUT->image_url.
3370 public $controls = array();
3374 * Create new instance of block content
3375 * @param array $attributes
3377 public function __construct(array $attributes = null) {
3378 $this->skipid
= self
::$idcounter;
3379 self
::$idcounter +
= 1;
3383 $this->attributes
= $attributes;
3385 // simple "fake" blocks used in some modules and "Add new block" block
3386 $this->attributes
= array('class'=>'block');
3391 * Add html class to block
3393 * @param string $class
3395 public function add_class($class) {
3396 $this->attributes
['class'] .= ' '.$class;
3400 * Check if the block is a fake block.
3404 public function is_fake() {
3405 return isset($this->attributes
['data-block']) && $this->attributes
['data-block'] == '_fake';
3411 * This class represents a target for where a block can go when it is being moved.
3413 * This needs to be rendered as a form with the given hidden from fields, and
3414 * clicking anywhere in the form should submit it. The form action should be
3417 * @copyright 2009 Tim Hunt
3418 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3423 class block_move_target
{
3426 * @var moodle_url Move url
3432 * @param moodle_url $url
3434 public function __construct(moodle_url
$url) {
3442 * This class is used to represent one item within a custom menu that may or may
3443 * not have children.
3445 * @copyright 2010 Sam Hemelryk
3446 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3451 class custom_menu_item
implements renderable
, templatable
{
3454 * @var string The text to show for the item
3459 * @var moodle_url The link to give the icon if it has no children
3464 * @var string A title to apply to the item. By default the text
3469 * @var int A sort order for the item, not necessary if you order things in
3475 * @var custom_menu_item A reference to the parent for this item or NULL if
3476 * it is a top level item
3481 * @var array A array in which to store children this item has.
3483 protected $children = array();
3486 * @var int A reference to the sort var of the last child that was added
3488 protected $lastsort = 0;
3491 * Constructs the new custom menu item
3493 * @param string $text
3494 * @param moodle_url $url A moodle url to apply as the link for this item [Optional]
3495 * @param string $title A title to apply to this item [Optional]
3496 * @param int $sort A sort or to use if we need to sort differently [Optional]
3497 * @param custom_menu_item $parent A reference to the parent custom_menu_item this child
3498 * belongs to, only if the child has a parent. [Optional]
3500 public function __construct($text, moodle_url
$url=null, $title=null, $sort = null, custom_menu_item
$parent = null) {
3501 $this->text
= $text;
3503 $this->title
= $title;
3504 $this->sort
= (int)$sort;
3505 $this->parent
= $parent;
3509 * Adds a custom menu item as a child of this node given its properties.
3511 * @param string $text
3512 * @param moodle_url $url
3513 * @param string $title
3515 * @return custom_menu_item
3517 public function add($text, moodle_url
$url = null, $title = null, $sort = null) {
3518 $key = count($this->children
);
3520 $sort = $this->lastsort +
1;
3522 $this->children
[$key] = new custom_menu_item($text, $url, $title, $sort, $this);
3523 $this->lastsort
= (int)$sort;
3524 return $this->children
[$key];
3528 * Removes a custom menu item that is a child or descendant to the current menu.
3530 * Returns true if child was found and removed.
3532 * @param custom_menu_item $menuitem
3535 public function remove_child(custom_menu_item
$menuitem) {
3537 if (($key = array_search($menuitem, $this->children
)) !== false) {
3538 unset($this->children
[$key]);
3539 $this->children
= array_values($this->children
);
3542 foreach ($this->children
as $child) {
3543 if ($removed = $child->remove_child($menuitem)) {
3552 * Returns the text for this item
3555 public function get_text() {
3560 * Returns the url for this item
3561 * @return moodle_url
3563 public function get_url() {
3568 * Returns the title for this item
3571 public function get_title() {
3572 return $this->title
;
3576 * Sorts and returns the children for this item
3579 public function get_children() {
3581 return $this->children
;
3585 * Gets the sort order for this child
3588 public function get_sort_order() {
3593 * Gets the parent this child belong to
3594 * @return custom_menu_item
3596 public function get_parent() {
3597 return $this->parent
;
3601 * Sorts the children this item has
3603 public function sort() {
3604 usort($this->children
, array('custom_menu','sort_custom_menu_items'));
3608 * Returns true if this item has any children
3611 public function has_children() {
3612 return (count($this->children
) > 0);
3616 * Sets the text for the node
3617 * @param string $text
3619 public function set_text($text) {
3620 $this->text
= (string)$text;
3624 * Sets the title for the node
3625 * @param string $title
3627 public function set_title($title) {
3628 $this->title
= (string)$title;
3632 * Sets the url for the node
3633 * @param moodle_url $url
3635 public function set_url(moodle_url
$url) {
3640 * Export this data so it can be used as the context for a mustache template.
3642 * @param renderer_base $output Used to do a final render of any components that need to be rendered for export.
3645 public function export_for_template(renderer_base
$output) {
3648 require_once($CFG->libdir
. '/externallib.php');
3650 $syscontext = context_system
::instance();
3652 $context = new stdClass();
3653 $context->text
= external_format_string($this->text
, $syscontext->id
);
3654 $context->url
= $this->url ?
$this->url
->out() : null;
3655 $context->title
= external_format_string($this->title
, $syscontext->id
);
3656 $context->sort
= $this->sort
;
3657 $context->children
= array();
3658 if (preg_match("/^#+$/", $this->text
)) {
3659 $context->divider
= true;
3661 $context->haschildren
= !empty($this->children
) && (count($this->children
) > 0);
3662 foreach ($this->children
as $child) {
3663 $child = $child->export_for_template($output);
3664 array_push($context->children
, $child);
3674 * This class is used to operate a custom menu that can be rendered for the page.
3675 * The custom menu is built using $CFG->custommenuitems and is a structured collection
3676 * of custom_menu_item nodes that can be rendered by the core renderer.
3678 * To configure the custom menu:
3679 * Settings: Administration > Appearance > Themes > Theme settings
3681 * @copyright 2010 Sam Hemelryk
3682 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3687 class custom_menu
extends custom_menu_item
{
3690 * @var string The language we should render for, null disables multilang support.
3692 protected $currentlanguage = null;
3695 * Creates the custom menu
3697 * @param string $definition the menu items definition in syntax required by {@link convert_text_to_menu_nodes()}
3698 * @param string $currentlanguage the current language code, null disables multilang support
3700 public function __construct($definition = '', $currentlanguage = null) {
3701 $this->currentlanguage
= $currentlanguage;
3702 parent
::__construct('root'); // create virtual root element of the menu
3703 if (!empty($definition)) {
3704 $this->override_children(self
::convert_text_to_menu_nodes($definition, $currentlanguage));
3709 * Overrides the children of this custom menu. Useful when getting children
3710 * from $CFG->custommenuitems
3712 * @param array $children
3714 public function override_children(array $children) {
3715 $this->children
= array();
3716 foreach ($children as $child) {
3717 if ($child instanceof custom_menu_item
) {
3718 $this->children
[] = $child;
3724 * Converts a string into a structured array of custom_menu_items which can
3725 * then be added to a custom menu.
3728 * text|url|title|langs
3729 * The number of hyphens at the start determines the depth of the item. The
3730 * languages are optional, comma separated list of languages the line is for.
3732 * Example structure:
3733 * First level first item|http://www.moodle.com/
3734 * -Second level first item|http://www.moodle.com/partners/
3735 * -Second level second item|http://www.moodle.com/hq/
3736 * --Third level first item|http://www.moodle.com/jobs/
3737 * -Second level third item|http://www.moodle.com/development/
3738 * First level second item|http://www.moodle.com/feedback/
3739 * First level third item
3740 * English only|http://moodle.com|English only item|en
3741 * German only|http://moodle.de|Deutsch|de,de_du,de_kids
3745 * @param string $text the menu items definition
3746 * @param string $language the language code, null disables multilang support
3749 public static function convert_text_to_menu_nodes($text, $language = null) {
3750 $root = new custom_menu();
3753 $hiddenitems = array();
3754 $lines = explode("\n", $text);
3755 foreach ($lines as $linenumber => $line) {
3756 $line = trim($line);
3757 if (strlen($line) == 0) {
3760 // Parse item settings.
3764 $itemvisible = true;
3765 $settings = explode('|', $line);
3766 foreach ($settings as $i => $setting) {
3767 $setting = trim($setting);
3768 if (!empty($setting)) {
3770 case 0: // Menu text.
3771 $itemtext = ltrim($setting, '-');
3775 $itemurl = new moodle_url($setting);
3776 } catch (moodle_exception
$exception) {
3777 // We're not actually worried about this, we don't want to mess up the display
3778 // just for a wrongly entered URL.
3782 case 2: // Title attribute.
3783 $itemtitle = $setting;
3785 case 3: // Language.
3786 if (!empty($language)) {
3787 $itemlanguages = array_map('trim', explode(',', $setting));
3788 $itemvisible &= in_array($language, $itemlanguages);
3794 // Get depth of new item.
3795 preg_match('/^(\-*)/', $line, $match);
3796 $itemdepth = strlen($match[1]) +
1;
3797 // Find parent item for new item.
3798 while (($lastdepth - $itemdepth) >= 0) {
3799 $lastitem = $lastitem->get_parent();
3802 $lastitem = $lastitem->add($itemtext, $itemurl, $itemtitle, $linenumber +
1);
3804 if (!$itemvisible) {
3805 $hiddenitems[] = $lastitem;
3808 foreach ($hiddenitems as $item) {
3809 $item->parent
->remove_child($item);
3811 return $root->get_children();
3815 * Sorts two custom menu items
3817 * This function is designed to be used with the usort method
3818 * usort($this->children, array('custom_menu','sort_custom_menu_items'));
3821 * @param custom_menu_item $itema
3822 * @param custom_menu_item $itemb
3825 public static function sort_custom_menu_items(custom_menu_item
$itema, custom_menu_item
$itemb) {
3826 $itema = $itema->get_sort_order();
3827 $itemb = $itemb->get_sort_order();
3828 if ($itema == $itemb) {
3831 return ($itema > $itemb) ? +
1 : -1;
3838 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3841 class tabobject
implements renderable
, templatable
{
3842 /** @var string unique id of the tab in this tree, it is used to find selected and/or inactive tabs */
3844 /** @var moodle_url|string link */
3846 /** @var string text on the tab */
3848 /** @var string title under the link, by defaul equals to text */
3850 /** @var bool whether to display a link under the tab name when it's selected */
3851 var $linkedwhenselected = false;
3852 /** @var bool whether the tab is inactive */
3853 var $inactive = false;
3854 /** @var bool indicates that this tab's child is selected */
3855 var $activated = false;
3856 /** @var bool indicates that this tab is selected */
3857 var $selected = false;
3858 /** @var array stores children tabobjects */
3859 var $subtree = array();
3860 /** @var int level of tab in the tree, 0 for root (instance of tabtree), 1 for the first row of tabs */
3866 * @param string $id unique id of the tab in this tree, it is used to find selected and/or inactive tabs
3867 * @param string|moodle_url $link
3868 * @param string $text text on the tab
3869 * @param string $title title under the link, by defaul equals to text
3870 * @param bool $linkedwhenselected whether to display a link under the tab name when it's selected
3872 public function __construct($id, $link = null, $text = '', $title = '', $linkedwhenselected = false) {
3874 $this->link
= $link;
3875 $this->text
= $text;
3876 $this->title
= $title ?
$title : $text;
3877 $this->linkedwhenselected
= $linkedwhenselected;
3881 * Travels through tree and finds the tab to mark as selected, all parents are automatically marked as activated
3883 * @param string $selected the id of the selected tab (whatever row it's on),
3884 * if null marks all tabs as unselected
3885 * @return bool whether this tab is selected or contains selected tab in its subtree
3887 protected function set_selected($selected) {
3888 if ((string)$selected === (string)$this->id
) {
3889 $this->selected
= true;
3890 // This tab is selected. No need to travel through subtree.
3893 foreach ($this->subtree
as $subitem) {
3894 if ($subitem->set_selected($selected)) {
3895 // This tab has child that is selected. Mark it as activated. No need to check other children.
3896 $this->activated
= true;
3904 * Travels through tree and finds a tab with specified id
3907 * @return tabtree|null
3909 public function find($id) {
3910 if ((string)$this->id
=== (string)$id) {
3913 foreach ($this->subtree
as $tab) {
3914 if ($obj = $tab->find($id)) {
3922 * Allows to mark each tab's level in the tree before rendering.
3926 protected function set_level($level) {
3927 $this->level
= $level;
3928 foreach ($this->subtree
as $tab) {
3929 $tab->set_level($level +
1);
3934 * Export for template.
3936 * @param renderer_base $output Renderer.
3939 public function export_for_template(renderer_base
$output) {
3940 if ($this->inactive ||
($this->selected
&& !$this->linkedwhenselected
) ||
$this->activated
) {
3943 $link = $this->link
;
3945 $active = $this->activated ||
$this->selected
;
3949 'link' => is_object($link) ?
$link->out(false) : $link,
3950 'text' => $this->text
,
3951 'title' => $this->title
,
3952 'inactive' => !$active && $this->inactive
,
3953 'active' => $active,
3954 'level' => $this->level
,
3961 * Renderable for the main page header.
3966 * @copyright 2015 Adrian Greeve <adrian@moodle.com>
3967 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3969 class context_header
implements renderable
{
3972 * @var string $heading Main heading.
3976 * @var int $headinglevel Main heading 'h' tag level.
3978 public $headinglevel;
3980 * @var string|null $imagedata HTML code for the picture in the page header.
3984 * @var array $additionalbuttons Additional buttons for the header e.g. Messaging button for the user header.
3985 * array elements - title => alternate text for the image, or if no image is available the button text.
3986 * url => Link for the button to head to. Should be a moodle_url.
3987 * image => location to the image, or name of the image in /pix/t/{image name}.
3988 * linkattributes => additional attributes for the <a href> element.
3989 * page => page object. Don't include if the image is an external image.
3991 public $additionalbuttons;
3993 * @var string $prefix A string that is before the title.
4000 * @param string $heading Main heading data.
4001 * @param int $headinglevel Main heading 'h' tag level.
4002 * @param string|null $imagedata HTML code for the picture in the page header.
4003 * @param string $additionalbuttons Buttons for the header e.g. Messaging button for the user header.
4004 * @param string $prefix Text that precedes the heading.
4006 public function __construct($heading = null, $headinglevel = 1, $imagedata = null, $additionalbuttons = null, $prefix = null) {
4008 $this->heading
= $heading;
4009 $this->headinglevel
= $headinglevel;
4010 $this->imagedata
= $imagedata;
4011 $this->additionalbuttons
= $additionalbuttons;
4012 // If we have buttons then format them.
4013 if (isset($this->additionalbuttons
)) {
4014 $this->format_button_images();
4016 $this->prefix
= $prefix;
4020 * Adds an array element for a formatted image.
4022 protected function format_button_images() {
4024 foreach ($this->additionalbuttons
as $buttontype => $button) {
4025 $page = $button['page'];
4026 // If no image is provided then just use the title.
4027 if (!isset($button['image'])) {
4028 $this->additionalbuttons
[$buttontype]['formattedimage'] = $button['title'];
4030 // Check to see if this is an internal Moodle icon.
4031 $internalimage = $page->theme
->resolve_image_location('t/' . $button['image'], 'moodle');
4032 if ($internalimage) {
4033 $this->additionalbuttons
[$buttontype]['formattedimage'] = 't/' . $button['image'];
4035 // Treat as an external image.
4036 $this->additionalbuttons
[$buttontype]['formattedimage'] = $button['image'];
4040 if (isset($button['linkattributes']['class'])) {
4041 $class = $button['linkattributes']['class'] . ' btn';
4045 // Add the bootstrap 'btn' class for formatting.
4046 $this->additionalbuttons
[$buttontype]['linkattributes'] = array_merge($button['linkattributes'],
4047 array('class' => $class));
4055 * Example how to print a single line tabs:
4057 * new tabobject(...),
4058 * new tabobject(...)
4060 * echo $OUTPUT->tabtree($rows, $selectedid);
4062 * Multiple row tabs may not look good on some devices but if you want to use them
4063 * you can specify ->subtree for the active tabobject.
4065 * @copyright 2013 Marina Glancy
4066 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4071 class tabtree
extends tabobject
{
4075 * It is highly recommended to call constructor when list of tabs is already
4076 * populated, this way you ensure that selected and inactive tabs are located
4077 * and attribute level is set correctly.
4079 * @param array $tabs array of tabs, each of them may have it's own ->subtree
4080 * @param string|null $selected which tab to mark as selected, all parent tabs will
4081 * automatically be marked as activated
4082 * @param array|string|null $inactive list of ids of inactive tabs, regardless of
4083 * their level. Note that you can as weel specify tabobject::$inactive for separate instances
4085 public function __construct($tabs, $selected = null, $inactive = null) {
4086 $this->subtree
= $tabs;
4087 if ($selected !== null) {
4088 $this->set_selected($selected);
4090 if ($inactive !== null) {
4091 if (is_array($inactive)) {
4092 foreach ($inactive as $id) {
4093 if ($tab = $this->find($id)) {
4094 $tab->inactive
= true;
4097 } else if ($tab = $this->find($inactive)) {
4098 $tab->inactive
= true;
4101 $this->set_level(0);
4105 * Export for template.
4107 * @param renderer_base $output Renderer.
4110 public function export_for_template(renderer_base
$output) {
4114 foreach ($this->subtree
as $tab) {
4115 $tabs[] = $tab->export_for_template($output);
4116 if (!empty($tab->subtree
) && ($tab->level
== 0 ||
$tab->selected ||
$tab->activated
)) {
4117 $secondrow = new tabtree($tab->subtree
);
4123 'secondrow' => $secondrow ?
$secondrow->export_for_template($output) : false
4131 * This action menu component takes a series of primary and secondary actions.
4132 * The primary actions are displayed permanently and the secondary attributes are displayed within a drop
4137 * @copyright 2013 Sam Hemelryk
4138 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4140 class action_menu
implements renderable
, templatable
{
4143 * Top right alignment.
4148 * Top right alignment.
4153 * Top right alignment.
4158 * Top right alignment.
4163 * The instance number. This is unique to this instance of the action menu.
4166 protected $instance = 0;
4169 * An array of primary actions. Please use {@link action_menu::add_primary_action()} to add actions.
4172 protected $primaryactions = array();
4175 * An array of secondary actions. Please use {@link action_menu::add_secondary_action()} to add actions.
4178 protected $secondaryactions = array();
4181 * An array of attributes added to the container of the action menu.
4182 * Initialised with defaults during construction.
4185 public $attributes = array();
4187 * An array of attributes added to the container of the primary actions.
4188 * Initialised with defaults during construction.
4191 public $attributesprimary = array();
4193 * An array of attributes added to the container of the secondary actions.
4194 * Initialised with defaults during construction.
4197 public $attributessecondary = array();
4200 * The string to use next to the icon for the action icon relating to the secondary (dropdown) menu.
4203 public $actiontext = null;
4206 * The string to use for the accessible label for the menu.
4209 public $actionlabel = null;
4212 * An icon to use for the toggling the secondary menu (dropdown).
4218 * Any text to use for the toggling the secondary menu (dropdown).
4221 public $menutrigger = '';
4224 * Any extra classes for toggling to the secondary menu.
4227 public $triggerextraclasses = '';
4230 * Place the action menu before all other actions.
4233 public $prioritise = false;
4236 * Dropdown menu alignment class.
4239 public $dropdownalignment = '';
4242 * Constructs the action menu with the given items.
4244 * @param array $actions An array of actions (action_menu_link|pix_icon|string).
4246 public function __construct(array $actions = array()) {
4247 static $initialised = 0;
4248 $this->instance
= $initialised;
4251 $this->attributes
= array(
4252 'id' => 'action-menu-'.$this->instance
,
4253 'class' => 'moodle-actionmenu',
4254 'data-enhance' => 'moodle-core-actionmenu'
4256 $this->attributesprimary
= array(
4257 'id' => 'action-menu-'.$this->instance
.'-menubar',
4258 'class' => 'menubar',
4260 $this->attributessecondary
= array(
4261 'id' => 'action-menu-'.$this->instance
.'-menu',
4263 'data-rel' => 'menu-content',
4264 'aria-labelledby' => 'action-menu-toggle-'.$this->instance
,
4267 $this->dropdownalignment
= 'dropdown-menu-right';
4268 foreach ($actions as $action) {
4269 $this->add($action);
4274 * Sets the label for the menu trigger.
4276 * @param string $label The text
4278 public function set_action_label($label) {
4279 $this->actionlabel
= $label;
4283 * Sets the menu trigger text.
4285 * @param string $trigger The text
4286 * @param string $extraclasses Extra classes to style the secondary menu toggle.
4288 public function set_menu_trigger($trigger, $extraclasses = '') {
4289 $this->menutrigger
= $trigger;
4290 $this->triggerextraclasses
= $extraclasses;
4294 * Return true if there is at least one visible link in the menu.
4298 public function is_empty() {
4299 return !count($this->primaryactions
) && !count($this->secondaryactions
);
4303 * Initialises JS required fore the action menu.
4304 * The JS is only required once as it manages all action menu's on the page.
4306 * @param moodle_page $page
4308 public function initialise_js(moodle_page
$page) {
4309 static $initialised = false;
4310 if (!$initialised) {
4311 $page->requires
->yui_module('moodle-core-actionmenu', 'M.core.actionmenu.init');
4312 $initialised = true;
4317 * Adds an action to this action menu.
4319 * @param action_menu_link|pix_icon|string $action
4321 public function add($action) {
4322 if ($action instanceof action_link
) {
4323 if ($action->primary
) {
4324 $this->add_primary_action($action);
4326 $this->add_secondary_action($action);
4328 } else if ($action instanceof pix_icon
) {
4329 $this->add_primary_action($action);
4331 $this->add_secondary_action($action);
4336 * Adds a primary action to the action menu.
4338 * @param action_menu_link|action_link|pix_icon|string $action
4340 public function add_primary_action($action) {
4341 if ($action instanceof action_link ||
$action instanceof pix_icon
) {
4342 $action->attributes
['role'] = 'menuitem';
4343 $action->attributes
['tabindex'] = '-1';
4344 if ($action instanceof action_menu_link
) {
4345 $action->actionmenu
= $this;
4348 $this->primaryactions
[] = $action;
4352 * Adds a secondary action to the action menu.
4354 * @param action_link|pix_icon|string $action
4356 public function add_secondary_action($action) {
4357 if ($action instanceof action_link ||
$action instanceof pix_icon
) {
4358 $action->attributes
['role'] = 'menuitem';
4359 $action->attributes
['tabindex'] = '-1';
4360 if ($action instanceof action_menu_link
) {
4361 $action->actionmenu
= $this;
4364 $this->secondaryactions
[] = $action;
4368 * Returns the primary actions ready to be rendered.
4370 * @param core_renderer $output The renderer to use for getting icons.
4373 public function get_primary_actions(core_renderer
$output = null) {
4375 if ($output === null) {
4378 $pixicon = $this->actionicon
;
4379 $linkclasses = array('toggle-display');
4382 if (!empty($this->menutrigger
)) {
4383 $pixicon = '<b class="caret"></b>';
4384 $linkclasses[] = 'textmenu';
4386 $title = new lang_string('actionsmenu', 'moodle');
4387 $this->actionicon
= new pix_icon(
4391 array('class' => 'iconsmall actionmenu', 'title' => '')
4393 $pixicon = $this->actionicon
;
4395 if ($pixicon instanceof renderable
) {
4396 $pixicon = $output->render($pixicon);
4397 if ($pixicon instanceof pix_icon
&& isset($pixicon->attributes
['alt'])) {
4398 $title = $pixicon->attributes
['alt'];
4402 if ($this->actiontext
) {
4403 $string = $this->actiontext
;
4406 if ($this->actionlabel
) {
4407 $label = $this->actionlabel
;
4411 $actions = $this->primaryactions
;
4412 $attributes = array(
4413 'class' => implode(' ', $linkclasses),
4415 'aria-label' => $label,
4416 'id' => 'action-menu-toggle-'.$this->instance
,
4417 'role' => 'menuitem',
4420 $link = html_writer
::link('#', $string . $this->menutrigger
. $pixicon, $attributes);
4421 if ($this->prioritise
) {
4422 array_unshift($actions, $link);
4430 * Returns the secondary actions ready to be rendered.
4433 public function get_secondary_actions() {
4434 return $this->secondaryactions
;
4438 * Sets the selector that should be used to find the owning node of this menu.
4439 * @param string $selector A CSS/YUI selector to identify the owner of the menu.
4441 public function set_owner_selector($selector) {
4442 $this->attributes
['data-owner'] = $selector;
4446 * Sets the alignment of the dialogue in relation to button used to toggle it.
4448 * @deprecated since Moodle 4.0
4450 * @param int $dialogue One of action_menu::TL, action_menu::TR, action_menu::BL, action_menu::BR.
4451 * @param int $button One of action_menu::TL, action_menu::TR, action_menu::BL, action_menu::BR.
4453 public function set_alignment($dialogue, $button) {
4454 debugging('The method action_menu::set_alignment() is deprecated, use action_menu::set_menu_left()', DEBUG_DEVELOPER
);
4455 if (isset($this->attributessecondary
['data-align'])) {
4456 // We've already got one set, lets remove the old class so as to avoid troubles.
4457 $class = $this->attributessecondary
['class'];
4458 $search = 'align-'.$this->attributessecondary
['data-align'];
4459 $this->attributessecondary
['class'] = str_replace($search, '', $class);
4461 $align = $this->get_align_string($dialogue) . '-' . $this->get_align_string($button);
4462 $this->attributessecondary
['data-align'] = $align;
4463 $this->attributessecondary
['class'] .= ' align-'.$align;
4467 * Returns a string to describe the alignment.
4469 * @param int $align One of action_menu::TL, action_menu::TR, action_menu::BL, action_menu::BR.
4472 protected function get_align_string($align) {
4488 * Aligns the left corner of the dropdown.
4491 public function set_menu_left() {
4492 $this->dropdownalignment
= 'dropdown-menu-left';
4496 * Sets a constraint for the dialogue.
4498 * The constraint is applied when the dialogue is shown and limits the display of the dialogue to within the
4499 * element the constraint identifies.
4501 * This is required whenever the action menu is displayed inside any CSS element with the .no-overflow class
4502 * (flexible_table and any of it's child classes are a likely candidate).
4504 * @param string $ancestorselector A snippet of CSS used to identify the ancestor to contrain the dialogue to.
4506 public function set_constraint($ancestorselector) {
4507 $this->attributessecondary
['data-constraint'] = $ancestorselector;
4511 * If you call this method the action menu will be displayed but will not be enhanced.
4513 * By not displaying the menu enhanced all items will be displayed in a single row.
4515 * @deprecated since Moodle 3.2
4517 public function do_not_enhance() {
4518 debugging('The method action_menu::do_not_enhance() is deprecated, use a list of action_icon instead.', DEBUG_DEVELOPER
);
4522 * Returns true if this action menu will be enhanced.
4526 public function will_be_enhanced() {
4527 return isset($this->attributes
['data-enhance']);
4531 * Sets nowrap on items. If true menu items should not wrap lines if they are longer than the available space.
4533 * This property can be useful when the action menu is displayed within a parent element that is either floated
4534 * or relatively positioned.
4535 * In that situation the width of the menu is determined by the width of the parent element which may not be large
4536 * enough for the menu items without them wrapping.
4537 * This disables the wrapping so that the menu takes on the width of the longest item.
4539 * @param bool $value If true nowrap gets set, if false it gets removed. Defaults to true.
4541 public function set_nowrap_on_items($value = true) {
4542 $class = 'nowrap-items';
4543 if (!empty($this->attributes
['class'])) {
4544 $pos = strpos($this->attributes
['class'], $class);
4545 if ($value === true && $pos === false) {
4546 // The value is true and the class has not been set yet. Add it.
4547 $this->attributes
['class'] .= ' '.$class;
4548 } else if ($value === false && $pos !== false) {
4549 // The value is false and the class has been set. Remove it.
4550 $this->attributes
['class'] = substr($this->attributes
['class'], $pos, strlen($class));
4552 } else if ($value) {
4553 // The value is true and the class has not been set yet. Add it.
4554 $this->attributes
['class'] = $class;
4559 * Export for template.
4561 * @param renderer_base $output The renderer.
4564 public function export_for_template(renderer_base
$output) {
4565 $data = new stdClass();
4566 $attributes = $this->attributes
;
4567 $attributesprimary = $this->attributesprimary
;
4568 $attributessecondary = $this->attributessecondary
;
4570 $data->instance
= $this->instance
;
4572 $data->classes
= isset($attributes['class']) ?
$attributes['class'] : '';
4573 unset($attributes['class']);
4575 $data->attributes
= array_map(function($key, $value) {
4576 return [ 'name' => $key, 'value' => $value ];
4577 }, array_keys($attributes), $attributes);
4579 $primary = new stdClass();
4580 $primary->title
= '';
4581 $primary->prioritise
= $this->prioritise
;
4583 $primary->classes
= isset($attributesprimary['class']) ?
$attributesprimary['class'] : '';
4584 unset($attributesprimary['class']);
4585 $primary->attributes
= array_map(function($key, $value) {
4586 return [ 'name' => $key, 'value' => $value ];
4587 }, array_keys($attributesprimary), $attributesprimary);
4589 $actionicon = $this->actionicon
;
4590 if (!empty($this->menutrigger
)) {
4591 $primary->menutrigger
= $this->menutrigger
;
4592 $primary->triggerextraclasses
= $this->triggerextraclasses
;
4593 if ($this->actionlabel
) {
4594 $primary->title
= $this->actionlabel
;
4595 } else if ($this->actiontext
) {
4596 $primary->title
= $this->actiontext
;
4598 $primary->title
= strip_tags($this->menutrigger
);
4601 $primary->title
= get_string('actionsmenu');
4602 $iconattributes = ['class' => 'iconsmall actionmenu', 'title' => $primary->title
];
4603 $actionicon = new pix_icon('t/edit_menu', '', 'moodle', $iconattributes);
4606 if ($actionicon instanceof pix_icon
) {
4607 $primary->icon
= $actionicon->export_for_pix();
4608 if (!empty($actionicon->attributes
['alt'])) {
4609 $primary->title
= $actionicon->attributes
['alt'];
4612 $primary->iconraw
= $actionicon ?
$output->render($actionicon) : '';
4615 $primary->actiontext
= $this->actiontext ?
(string) $this->actiontext
: '';
4616 $primary->items
= array_map(function($item) use ($output) {
4617 $data = (object) [];
4618 if ($item instanceof action_menu_link
) {
4619 $data->actionmenulink
= $item->export_for_template($output);
4620 } else if ($item instanceof action_menu_filler
) {
4621 $data->actionmenufiller
= $item->export_for_template($output);
4622 } else if ($item instanceof action_link
) {
4623 $data->actionlink
= $item->export_for_template($output);
4624 } else if ($item instanceof pix_icon
) {
4625 $data->pixicon
= $item->export_for_template($output);
4627 $data->rawhtml
= ($item instanceof renderable
) ?
$output->render($item) : $item;
4630 }, $this->primaryactions
);
4632 $secondary = new stdClass();
4633 $secondary->classes
= isset($attributessecondary['class']) ?
$attributessecondary['class'] : '';
4634 unset($attributessecondary['class']);
4635 $secondary->attributes
= array_map(function($key, $value) {
4636 return [ 'name' => $key, 'value' => $value ];
4637 }, array_keys($attributessecondary), $attributessecondary);
4638 $secondary->items
= array_map(function($item) use ($output) {
4639 $data = (object) [];
4640 if ($item instanceof action_menu_link
) {
4641 $data->actionmenulink
= $item->export_for_template($output);
4642 } else if ($item instanceof action_menu_filler
) {
4643 $data->actionmenufiller
= $item->export_for_template($output);
4644 } else if ($item instanceof action_link
) {
4645 $data->actionlink
= $item->export_for_template($output);
4646 } else if ($item instanceof pix_icon
) {
4647 $data->pixicon
= $item->export_for_template($output);
4649 $data->rawhtml
= ($item instanceof renderable
) ?
$output->render($item) : $item;
4652 }, $this->secondaryactions
);
4654 $data->primary
= $primary;
4655 $data->secondary
= $secondary;
4656 $data->dropdownalignment
= $this->dropdownalignment
;
4664 * An action menu filler
4668 * @copyright 2013 Andrew Nicols
4669 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4671 class action_menu_filler
extends action_link
implements renderable
{
4674 * True if this is a primary action. False if not.
4677 public $primary = true;
4680 * Constructs the object.
4682 public function __construct() {
4683 $this->attributes
['id'] = html_writer
::random_id('action_link');
4688 * An action menu action
4692 * @copyright 2013 Sam Hemelryk
4693 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4695 class action_menu_link
extends action_link
implements renderable
{
4698 * True if this is a primary action. False if not.
4701 public $primary = true;
4704 * The action menu this link has been added to.
4707 public $actionmenu = null;
4710 * The number of instances of this action menu link (and its subclasses).
4713 protected static $instance = 1;
4716 * Constructs the object.
4718 * @param moodle_url $url The URL for the action.
4719 * @param pix_icon $icon The icon to represent the action.
4720 * @param string $text The text to represent the action.
4721 * @param bool $primary Whether this is a primary action or not.
4722 * @param array $attributes Any attribtues associated with the action.
4724 public function __construct(moodle_url
$url, pix_icon
$icon = null, $text, $primary = true, array $attributes = array()) {
4725 parent
::__construct($url, $text, null, $attributes, $icon);
4726 $this->primary
= (bool)$primary;
4727 $this->add_class('menu-action');
4728 $this->attributes
['role'] = 'menuitem';
4732 * Export for template.
4734 * @param renderer_base $output The renderer.
4737 public function export_for_template(renderer_base
$output) {
4738 $data = parent
::export_for_template($output);
4739 $data->instance
= self
::$instance++
;
4741 // Ignore what the parent did with the attributes, except for ID and class.
4742 $data->attributes
= [];
4743 $attributes = $this->attributes
;
4744 unset($attributes['id']);
4745 unset($attributes['class']);
4747 // Handle text being a renderable.
4748 if ($this->text
instanceof renderable
) {
4749 $data->text
= $this->render($this->text
);
4752 $data->showtext
= (!$this->icon ||
$this->primary
=== false);
4756 $icon = $this->icon
;
4757 if ($this->primary ||
!$this->actionmenu
->will_be_enhanced()) {
4758 $attributes['title'] = $data->text
;
4760 $data->icon
= $icon ?
$icon->export_for_pix() : null;
4763 $data->disabled
= !empty($attributes['disabled']);
4764 unset($attributes['disabled']);
4766 $data->attributes
= array_map(function($key, $value) {
4771 }, array_keys($attributes), $attributes);
4778 * A primary action menu action
4782 * @copyright 2013 Sam Hemelryk
4783 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4785 class action_menu_link_primary
extends action_menu_link
{
4787 * Constructs the object.
4789 * @param moodle_url $url
4790 * @param pix_icon $icon
4791 * @param string $text
4792 * @param array $attributes
4794 public function __construct(moodle_url
$url, pix_icon
$icon = null, $text, array $attributes = array()) {
4795 parent
::__construct($url, $icon, $text, true, $attributes);
4800 * A secondary action menu action
4804 * @copyright 2013 Sam Hemelryk
4805 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4807 class action_menu_link_secondary
extends action_menu_link
{
4809 * Constructs the object.
4811 * @param moodle_url $url
4812 * @param pix_icon $icon
4813 * @param string $text
4814 * @param array $attributes
4816 public function __construct(moodle_url
$url, pix_icon
$icon = null, $text, array $attributes = array()) {
4817 parent
::__construct($url, $icon, $text, false, $attributes);
4822 * Represents a set of preferences groups.
4826 * @copyright 2015 Frédéric Massart - FMCorz.net
4827 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4829 class preferences_groups
implements renderable
{
4832 * Array of preferences_group.
4839 * @param array $groups of preferences_group
4841 public function __construct($groups) {
4842 $this->groups
= $groups;
4848 * Represents a group of preferences page link.
4852 * @copyright 2015 Frédéric Massart - FMCorz.net
4853 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4855 class preferences_group
implements renderable
{
4858 * Title of the group.
4864 * Array of navigation_node.
4871 * @param string $title The title.
4872 * @param array $nodes of navigation_node.
4874 public function __construct($title, $nodes) {
4875 $this->title
= $title;
4876 $this->nodes
= $nodes;
4881 * Progress bar class.
4883 * Manages the display of a progress bar.
4885 * To use this class.
4887 * - call create (or use the 3rd param to the constructor)
4888 * - call update or update_full() or update() repeatedly
4890 * @copyright 2008 jamiesensei
4891 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4895 class progress_bar
implements renderable
, templatable
{
4896 /** @var string html id */
4898 /** @var int total width */
4900 /** @var int last percentage printed */
4901 private $percent = 0;
4902 /** @var int time when last printed */
4903 private $lastupdate = 0;
4904 /** @var int when did we start printing this */
4905 private $time_start = 0;
4910 * Prints JS code if $autostart true.
4912 * @param string $htmlid The container ID.
4913 * @param int $width The suggested width.
4914 * @param bool $autostart Whether to start the progress bar right away.
4916 public function __construct($htmlid = '', $width = 500, $autostart = false) {
4917 if (!CLI_SCRIPT
&& !NO_OUTPUT_BUFFERING
) {
4918 debugging('progress_bar used in a non-CLI script without setting NO_OUTPUT_BUFFERING.', DEBUG_DEVELOPER
);
4921 if (!empty($htmlid)) {
4922 $this->html_id
= $htmlid;
4924 $this->html_id
= 'pbar_'.uniqid();
4927 $this->width
= $width;
4938 public function get_id() : string {
4939 return $this->html_id
;
4943 * Create a new progress bar, this function will output html.
4945 * @return void Echo's output
4947 public function create() {
4950 $this->time_start
= microtime(true);
4953 echo $OUTPUT->render($this);
4958 * Update the progress bar.
4960 * @param int $percent From 1-100.
4961 * @param string $msg The message.
4962 * @return void Echo's output
4963 * @throws coding_exception
4965 private function _update($percent, $msg) {
4968 if (empty($this->time_start
)) {
4969 throw new coding_exception('You must call create() (or use the $autostart ' .
4970 'argument to the constructor) before you try updating the progress bar.');
4973 $estimate = $this->estimate($percent);
4975 if ($estimate === null) {
4976 // Always do the first and last updates.
4977 } else if ($estimate == 0) {
4978 // Always do the last updates.
4979 } else if ($this->lastupdate +
20 < time()) {
4980 // We must update otherwise browser would time out.
4981 } else if (round($this->percent
, 2) === round($percent, 2)) {
4982 // No significant change, no need to update anything.
4987 if ($estimate != 0 && is_numeric($estimate)) {
4988 $estimatemsg = format_time(round($estimate));
4991 $this->percent
= $percent;
4992 $this->lastupdate
= microtime(true);
4994 echo $OUTPUT->render_progress_bar_update($this->html_id
, sprintf("%.1f", $this->percent
), $msg, $estimatemsg);
4999 * Estimate how much time it is going to take.
5001 * @param int $pt From 1-100.
5002 * @return mixed Null (unknown), or int.
5004 private function estimate($pt) {
5005 if ($this->lastupdate
== 0) {
5008 if ($pt < 0.00001) {
5009 return null; // We do not know yet how long it will take.
5011 if ($pt > 99.99999) {
5012 return 0; // Nearly done, right?
5014 $consumed = microtime(true) - $this->time_start
;
5015 if ($consumed < 0.001) {
5019 return (100 - $pt) * ($consumed / $pt);
5023 * Update progress bar according percent.
5025 * @param int $percent From 1-100.
5026 * @param string $msg The message needed to be shown.
5028 public function update_full($percent, $msg) {
5029 $percent = max(min($percent, 100), 0);
5030 $this->_update($percent, $msg);
5034 * Update progress bar according the number of tasks.
5036 * @param int $cur Current task number.
5037 * @param int $total Total task number.
5038 * @param string $msg The message needed to be shown.
5040 public function update($cur, $total, $msg) {
5041 $percent = ($cur / $total) * 100;
5042 $this->update_full($percent, $msg);
5046 * Restart the progress bar.
5048 public function restart() {
5050 $this->lastupdate
= 0;
5051 $this->time_start
= 0;
5055 * Export for template.
5057 * @param renderer_base $output The renderer.
5060 public function export_for_template(renderer_base
$output) {
5062 'id' => $this->html_id
,
5063 'width' => $this->width
,