*/
/**
- * Base class for classes representing HTML elements, like moodle_select.
+ * Base class for classes representing HTML elements, like html_select.
*
* Handles the id and class attributes.
*
}
/**
- * This class represents a select option element
+ * This class hold all the information required to describe a <select> menu that
+ * will be printed by {@link moodle_core_renderer::select()}. (Or by an overridden
+ * version of that method in a subclass.)
*
- * @copyright 2009 Nicolas Connault
+ * This component can also hold enough metadata to be used as a popup form. It just
+ * needs a bit more setting up than for a simple menu. See the shortcut methods for
+ * developer-friendly usage.
+ *
+ * All the fields that are not set by the constructor have sensible defaults, so
+ * you only need to set the properties where you want non-default behaviour.
+ *
+ * @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
*/
-class html_select_option extends moodle_html_component {
- /**
- * @var string $value The value of this option (will be sent with form)
- */
- public $value;
+class html_select extends moodle_html_component {
/**
- * @var string $text The display value of the option
+ * The html_select object parses an array of options into component objects
+ * @see nested attribute
+ * @var mixed $options the choices to show in the menu. An array $value => $display, of html_select_option or of html_select_optgroup objects.
*/
- public $text;
+ public $options;
/**
- * @var boolean $selected Whether or not this option is selected
+ * @var string $name the name of this form control. That is, the name of the GET/POST
+ * variable that will be set if this select is submitted as part of a form.
*/
- public $selected = false;
+ public $name;
/**
* @var mixed $label The label for that component. String or html_label object
*/
public $label;
-
- public function __construct() {
- $this->label = new html_label();
- }
-
/**
- * @see moodle_html_component::prepare()
- * @return void
+ * @var string $selectedvalue the option to select initially. Should match one
+ * of the $options array keys. Default none.
*/
- public function prepare() {
- if (empty($this->text)) {
- throw new coding_exception('html_select_option requires a $text value.');
- }
-
- if (empty($this->label->text)) {
- $this->set_label($this->text);
- } else if (!($this->label instanceof html_label)) {
- $this->set_label($this->label);
- }
- if (empty($this->id)) {
- $this->generate_id();
- }
-
- parent::prepare();
- }
-
+ public $selectedvalue;
/**
- * Shortcut for making a checkbox-ready option
- * @param string $value The value of the checkbox
- * @param boolean $checked
- * @param string $label
- * @param string $alt
- * @return html_select_option A component ready for $OUTPUT->checkbox()
+ * Defaults to get_string('choosedots').
+ * Set this to '' if you do not want a 'nothing is selected' option.
+ * This is ignored if the rendertype is 'radio' or 'checkbox'
+ * @var string The label for the 'nothing is selected' option.
*/
- public function make_checkbox($value, $checked, $label='', $alt='') {
- $checkbox = new html_select_option();
- $checkbox->value = $value;
- $checkbox->selected = $checked;
- $checkbox->text = $label;
- $checkbox->label->text = $label;
- $checkbox->alt = $alt;
- return $checkbox;
- }
-}
-
-/**
- * This class represents a select optgroup element
- *
- * @copyright 2009 Nicolas Connault
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @since Moodle 2.0
- */
-class html_select_optgroup extends moodle_html_component {
+ public $nothinglabel = null;
/**
- * @var string $text The display value of the optgroup
+ * @var string The value returned by the 'nothing is selected' option. Defaults to 0.
*/
- public $text;
+ public $nothingvalue = 0;
/**
- * @var array $options An array of html_select_option objects
+ * @var boolean set this to true if you want the control to appear disabled.
*/
- public $options = array();
-
- public function prepare() {
- if (empty($this->text)) {
- throw new coding_exception('html_select_optgroup requires a $text value.');
- }
- if (empty($this->options)) {
- throw new coding_exception('html_select_optgroup requires at least one html_select_option object');
- }
- parent::prepare();
- }
-}
-
-/**
- * This class represents an input field
- *
- * @copyright 2009 Nicolas Connault
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @since Moodle 2.0
- */
-class html_field extends moodle_html_component {
+ public $disabled = false;
/**
- * @var string $name The name attribute of the field
+ * @var integer if non-zero, sets the tabindex attribute on the <select> element. Default 0.
*/
- public $name;
+ public $tabindex = 0;
/**
- * @var string $value The value attribute of the field
+ * @var mixed Defaults to false, which means display the select as a dropdown menu.
+ * If true, display this select as a list box whose size is chosen automatically.
+ * If an integer, display as list box of that size.
*/
- public $value;
+ public $listbox = false;
/**
- * @var string $type The type attribute of the field (text, submit, checkbox etc)
+ * @var integer if you are using $listbox === true to get an automatically
+ * sized list box, the size of the list box will be the number of options,
+ * or this number, whichever is smaller.
*/
- public $type;
+ public $maxautosize = 10;
/**
- * @var string $maxlength The maxlength attribute of the field (only applies to text type)
+ * @var boolean if true, allow multiple selection. Only used if $listbox is true, or if
+ * the select is to be output as checkboxes.
*/
- public $maxlength;
+ public $multiple = false;
/**
- * @var mixed $label The label for that component. String or html_label object
+ * Another way to use nested menu is to prefix optgroup labels with -- and end the optgroup with --
+ * Leave this setting to false if you are using the latter method.
+ * @var boolean $nested if true, uses $options' keys as option headings (optgroup)
*/
- public $label;
-
- public function __construct() {
- $this->label = new html_label();
- }
+ public $nested = false;
+ /**
+ * @var html_form $form An optional html_form component
+ */
+ public $form;
+ /**
+ * @var moodle_help_icon $form An optional moodle_help_icon component
+ */
+ public $helpicon;
+ /**
+ * @var boolean $rendertype How the select element should be rendered: menu or radio (checkbox is just radio + multiple)
+ */
+ public $rendertype = 'menu';
/**
* @see moodle_html_component::prepare()
* @return void
*/
public function prepare() {
- if (empty($this->style)) {
- $this->style = 'width: 4em;';
- }
+ global $CFG;
+
+ // name may contain [], which would make an invalid id. e.g. numeric question type editing form, assignment quickgrading
if (empty($this->id)) {
- $this->generate_id();
+ $this->id = 'menu' . str_replace(array('[', ']'), '', $this->name);
+ }
+
+ if (empty($this->classes)) {
+ $this->set_classes(array('menu' . str_replace(array('[', ']'), '', $this->name)));
+ }
+
+ if (is_null($this->nothinglabel)) {
+ $this->nothinglabel = get_string('choosedots');
+ }
+
+ if (!empty($this->label) && !($this->label instanceof html_label)) {
+ $label = new html_label();
+ $label->text = $this->label;
+ $label->for = $this->name;
+ $this->label = $label;
}
+
+ $this->add_class('select');
+
+ $this->initialise_options();
parent::prepare();
}
/**
- * Shortcut for creating a text input component.
- * @param string $name The name of the text field
- * @param string $value The value of the text field
- * @param string $alt The info to be inserted in the alt tag
- * @param int $maxlength Sets the maxlength attribute of the field. Not set by default
- * @return html_field The field component
+ * This is a shortcut for making a simple select menu. It lets you specify
+ * the options, name and selected option in one line of code.
+ * @param array $options used to initialise {@link $options}.
+ * @param string $name used to initialise {@link $name}.
+ * @param string $selected used to initialise {@link $selected}.
+ * @return html_select A html_select object with the three common fields initialised.
*/
- public static function make_text($name='unnamed', $value, $alt, $maxlength=0) {
- $field = new html_field();
- if (empty($alt)) {
- $alt = get_string('textfield');
- }
- $field->type = 'text';
- $field->name = $name;
- $field->value = $value;
- $field->alt = $alt;
- $field->maxlength = $maxlength;
- return $field;
+ public static function make($options, $name, $selected = '') {
+ $menu = new html_select();
+ $menu->options = $options;
+ $menu->name = $name;
+ $menu->selectedvalue = $selected;
+ return $menu;
}
-}
-/**
- * Holds all the information required to render a <table> by
- * {@see moodle_core_renderer::table()} or by an overridden version of that
- * method in a subclass.
- *
- * Example of usage:
- * $t = new html_table();
- * ... // set various properties of the object $t as described below
- * echo $OUTPUT->table($t);
- *
- * @copyright 2009 David Mudrak <david.mudrak@gmail.com>
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @since Moodle 2.0
- */
-class html_table extends moodle_html_component {
/**
- * @var array of headings. The n-th array item is used as a heading of the n-th column.
- *
- * Example of usage:
- * $t->head = array('Student', 'Grade');
+ * This is a shortcut for making a yes/no select menu.
+ * @param string $name used to initialise {@link $name}.
+ * @param string $selected used to initialise {@link $selected}.
+ * @return html_select A menu initialised with yes/no options.
*/
- public $head;
+ public static function make_yes_no($name, $selected) {
+ return self::make(array(0 => get_string('no'), 1 => get_string('yes')), $name, $selected);
+ }
+
/**
- * @var array can be used to make a heading span multiple columns
- *
- * Example of usage:
- * $t->headspan = array(2,1);
- *
- * In this example, {@see html_table:$data} is supposed to have three columns. For the first two columns,
- * the same heading is used. Therefore, {@see html_table::$head} should consist of two items.
+ * This is a shortcut for making an hour selector menu.
+ * @param string $type The type of selector (years, months, days, hours, minutes)
+ * @param string $name fieldname
+ * @param int $currenttime A default timestamp in GMT
+ * @param int $step minute spacing
+ * @return html_select A menu initialised with hour options.
*/
- public $headspan;
- /**
- * @var array of column alignments. The value is used as CSS 'text-align' property. Therefore, possible
- * values are 'left', 'right', 'center' and 'justify'. Specify 'right' or 'left' from the perspective
- * of a left-to-right (LTR) language. For RTL, the values are flipped automatically.
- *
+ public static function make_time_selector($type, $name, $currenttime=0, $step=5) {
+
+ if (!$currenttime) {
+ $currenttime = time();
+ }
+ $currentdate = usergetdate($currenttime);
+ $userdatetype = $type;
+
+ switch ($type) {
+ case 'years':
+ for ($i=1970; $i<=2020; $i++) {
+ $timeunits[$i] = $i;
+ }
+ $userdatetype = 'year';
+ break;
+ case 'months':
+ for ($i=1; $i<=12; $i++) {
+ $timeunits[$i] = userdate(gmmktime(12,0,0,$i,15,2000), "%B");
+ }
+ $userdatetype = 'month';
+ break;
+ case 'days':
+ for ($i=1; $i<=31; $i++) {
+ $timeunits[$i] = $i;
+ }
+ $userdatetype = 'mday';
+ break;
+ case 'hours':
+ for ($i=0; $i<=23; $i++) {
+ $timeunits[$i] = sprintf("%02d",$i);
+ }
+ break;
+ case 'minutes':
+ if ($step != 1) {
+ $currentdate['minutes'] = ceil($currentdate['minutes']/$step)*$step;
+ }
+
+ for ($i=0; $i<=59; $i+=$step) {
+ $timeunits[$i] = sprintf("%02d",$i);
+ }
+ break;
+ default:
+ throw new coding_exception("Time type $type is not supported by html_select::make_time_selector().");
+ }
+
+ $timerselector = self::make($timeunits, $name, $currentdate[$userdatetype]);
+ $timerselector->label = new html_label();
+ $timerselector->label->text = get_string(substr($type, -1), 'form');
+ $timerselector->label->for = "menu$timerselector->name";
+ $timerselector->label->add_class('accesshide');
+ $timerselector->nothinglabel = '';
+
+ return $timerselector;
+ }
+
+ /**
+ * Given an associative array of type => fieldname and an optional timestamp,
+ * returns an array of html_select components representing date/time selectors.
+ * @param array $selectors Arrays of type => fieldname. Selectors will be returned in the order of the types given
+ * @param int $currenttime A UNIX timestamp
+ * @param int $step minute spacing
+ * @return array Instantiated date/time selectors
+ */
+ public function make_time_selectors($selectors, $currenttime=0, $step=5) {
+ $selects = array();
+ foreach ($selectors as $type => $name) {
+ $selects[] = html_select::make_time_selector($type, $name, $currenttime, $step);
+ }
+ return $selects;
+ }
+
+ /**
+ * This is a shortcut for making a select popup form.
+ * @param mixed $baseurl The target URL, string or moodle_url
+ * @param string $name The variable which this select's options are changing in the URL
+ * @param array $options A list of value-label pairs for the popup list
+ * @param string $formid id for the control. Must be unique on the page. Used in the HTML.
+ * @param string $selected The option that is initially selected
+ * @return html_select A menu initialised as a popup form.
+ */
+ public function make_popup_form($baseurl, $name, $options, $formid, $selected=null) {
+ global $CFG;
+
+ $selectedurl = null;
+
+ if (!($baseurl instanceof moodle_url)) {
+ $baseurl = new moodle_url($baseurl);
+ }
+
+ if (!empty($selected)) {
+ $selectedurl = $baseurl->out(false, array($name => $selected), false);
+ }
+
+ if (!($baseurl instanceof moodle_url)) {
+ $baseurl = new moodle_url($baseurl);
+ }
+
+ // Replace real value by formatted URLs
+ foreach ($options as $value => $label) {
+ $options[$baseurl->out(false, array($name => $value), false)] = $label;
+ unset($options[$value]);
+ }
+
+ $select = self::make($options, 'jump', $selectedurl);
+
+ $select->form = new html_form();
+ $select->form->id = $formid;
+ $select->form->method = 'get';
+ $select->form->add_class('popupform');
+ $select->form->url = new moodle_url($CFG->wwwroot . '/course/jumpto.php', array('sesskey' => sesskey()));
+ $select->form->button->text = get_string('go');
+
+ $select->id = $formid . '_jump';
+
+ $select->add_action('change', 'submit_form_by_id', array('id' => $formid, 'selectid' => $select->id));
+
+ return $select;
+ }
+
+ /**
+ * Override the URLs of the default popup_form, which only supports one base URL
+ * @param array $options value=>label pairs representing select options
+ * @return void
+ */
+ public function override_option_values($options) {
+ global $PAGE;
+
+ $this->initialise_options();
+
+ reset($options);
+
+ foreach ($this->options as $optkey => $optgroup) {
+ if ($optgroup instanceof html_select_optgroup) {
+ foreach ($optgroup->options as $key => $option) {
+ next($options);
+ $this->options[$optkey]->options[$key]->value = key($options);
+
+ $optionurl = new moodle_url(key($options));
+
+ if ($optionurl->compare($PAGE->url, URL_MATCH_PARAMS)) {
+ $this->options[$optkey]->options[$key]->selected = 'selected';
+ }
+ }
+ next($options);
+ } else if ($optgroup instanceof html_select_option) {
+ next($options);
+ $this->options[$optkey]->value = key($options);
+ $optionurl = new moodle_url(key($options));
+
+ if ($optionurl->compare($PAGE->url, URL_MATCH_PARAMS)) {
+ $this->options[$optkey]->selected = 'selected';
+ }
+ }
+ }
+ }
+
+ /**
+ * Adds a help icon next to the select menu.
+ *
+ * This can be used in two ways:
+ *
+ * <pre>
+ * $select->set_help_icon($page, $text, $linktext);
+ * // OR
+ * $helpicon = new moodle_help_icon();
+ * $helpicon->page = $page;
+ * $helpicon->text = $text;
+ * $helpicon->linktext = $linktext;
+ * $select->set_help_icon($helpicon);
+ * </pre>
+ *
+ * Use the second form when you need to add additional HTML attributes
+ * to the label and/or JS actions.
+ *
+ * @param mixed $page Either the keyword that defines a help page or a moodle_help_icon object
+ * @param text $text The text of the help icon
+ * @param boolean $linktext Whether or not to show text next to the icon
+ * @return void
+ */
+ public function set_help_icon($page, $text, $linktext=false) {
+ if ($page instanceof moodle_help_icon) {
+ $this->helpicon = $page;
+ } else if (!empty($page)) {
+ $this->helpicon = new moodle_help_icon();
+ $this->helpicon->page = $page;
+ $this->helpicon->text = $text;
+ $this->helpicon->linktext = $linktext;
+ }
+ }
+
+ /**
+ * Parses the $options array and instantiates html_select_option objects in
+ * the place of the original value => label pairs. This is useful for when you
+ * need to setup extra html attributes and actions on individual options before
+ * the component is sent to the renderer
+ * @return void;
+ */
+ public function initialise_options() {
+ // If options are already instantiated objects, stop here
+ $firstoption = reset($this->options);
+ if ($firstoption instanceof html_select_option || $firstoption instanceof html_select_optgroup) {
+ return;
+ }
+
+ if ($this->rendertype == 'radio' && $this->multiple) {
+ $this->rendertype = 'checkbox';
+ }
+
+ // If nested is on, or if radio/checkbox rendertype is set, remove the default Choose option
+ if ($this->nested || $this->rendertype == 'radio' || $this->rendertype == 'checkbox') {
+ $this->nothinglabel = '';
+ }
+
+ $options = $this->options;
+
+ $this->options = array();
+
+ if ($this->nested && $this->rendertype != 'menu') {
+ throw new coding_exception('html_select cannot render nested options as radio buttons or checkboxes.');
+ } else if ($this->nested) {
+ foreach ($options as $section => $values) {
+ $optgroup = new html_select_optgroup();
+ $optgroup->text = $section;
+
+ foreach ($values as $value => $display) {
+ $option = new html_select_option();
+ $option->value = s($value);
+ $option->text = $display;
+ if ($display === '') {
+ $option->text = $value;
+ }
+
+ if ((string) $value == (string) $this->selectedvalue ||
+ (is_array($this->selectedvalue) && in_array($value, $this->selectedvalue))) {
+ $option->selected = 'selected';
+ }
+
+ $optgroup->options[] = $option;
+ }
+
+ $this->options[] = $optgroup;
+ }
+ } else {
+ $inoptgroup = false;
+ $optgroup = false;
+
+ foreach ($options as $value => $display) {
+ if ($display == '--') { /// we are ending previous optgroup
+ // $this->options[] = $optgroup;
+ $inoptgroup = false;
+ continue;
+ } else if (substr($display,0,2) == '--') { /// we are starting a new optgroup
+ if (!empty($optgroup->options)) {
+ $this->options[] = $optgroup;
+ }
+
+ $optgroup = new html_select_optgroup();
+ $optgroup->text = substr($display,2); // stripping the --
+
+ $inoptgroup = true; /// everything following will be in an optgroup
+ continue;
+
+ } else {
+ // Add $nothing option if there are not optgroups
+ if ($this->nothinglabel && empty($this->options[0]) && !$inoptgroup) {
+ $nothingoption = new html_select_option();
+ $nothingoption->value = 0;
+ if (!empty($this->nothingvalue)) {
+ $nothingoption->value = $this->nothingvalue;
+ }
+ $nothingoption->text = $this->nothinglabel;
+ $this->options = array($nothingoption) + $this->options;
+ }
+
+ $option = new html_select_option();
+ $option->text = $display;
+
+ if ($display === '') {
+ $option->text = $value;
+ }
+
+ if ((string) $value == (string) $this->selectedvalue ||
+ (is_array($this->selectedvalue) && in_array($value, $this->selectedvalue))) {
+ $option->selected = 'selected';
+ }
+
+ $option->value = s($value);
+
+ if ($inoptgroup) {
+ $optgroup->options[] = $option;
+ } else {
+ $this->options[] = $option;
+ }
+ }
+ }
+
+ if ($optgroup) {
+ $this->options[] = $optgroup;
+ }
+ }
+ }
+}
+
+/**
+ * This class represents a select option element
+ *
+ * @copyright 2009 Nicolas Connault
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ */
+class html_select_option extends moodle_html_component {
+ /**
+ * @var string $value The value of this option (will be sent with form)
+ */
+ public $value;
+ /**
+ * @var string $text The display value of the option
+ */
+ public $text;
+ /**
+ * @var boolean $selected Whether or not this option is selected
+ */
+ public $selected = false;
+ /**
+ * @var mixed $label The label for that component. String or html_label object
+ */
+ public $label;
+
+ public function __construct() {
+ $this->label = new html_label();
+ }
+
+ /**
+ * @see moodle_html_component::prepare()
+ * @return void
+ */
+ public function prepare() {
+ if (empty($this->text)) {
+ throw new coding_exception('html_select_option requires a $text value.');
+ }
+
+ if (empty($this->label->text)) {
+ $this->set_label($this->text);
+ } else if (!($this->label instanceof html_label)) {
+ $this->set_label($this->label);
+ }
+ if (empty($this->id)) {
+ $this->generate_id();
+ }
+
+ parent::prepare();
+ }
+
+ /**
+ * Shortcut for making a checkbox-ready option
+ * @param string $value The value of the checkbox
+ * @param boolean $checked
+ * @param string $label
+ * @param string $alt
+ * @return html_select_option A component ready for $OUTPUT->checkbox()
+ */
+ public function make_checkbox($value, $checked, $label='', $alt='') {
+ $checkbox = new html_select_option();
+ $checkbox->value = $value;
+ $checkbox->selected = $checked;
+ $checkbox->text = $label;
+ $checkbox->label->text = $label;
+ $checkbox->alt = $alt;
+ return $checkbox;
+ }
+}
+
+/**
+ * This class represents a select optgroup element
+ *
+ * @copyright 2009 Nicolas Connault
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ */
+class html_select_optgroup extends moodle_html_component {
+ /**
+ * @var string $text The display value of the optgroup
+ */
+ public $text;
+ /**
+ * @var array $options An array of html_select_option objects
+ */
+ public $options = array();
+
+ public function prepare() {
+ if (empty($this->text)) {
+ throw new coding_exception('html_select_optgroup requires a $text value.');
+ }
+ if (empty($this->options)) {
+ throw new coding_exception('html_select_optgroup requires at least one html_select_option object');
+ }
+ parent::prepare();
+ }
+}
+
+/**
+ * This class represents an input field
+ *
+ * @copyright 2009 Nicolas Connault
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ */
+class html_field extends moodle_html_component {
+ /**
+ * @var string $name The name attribute of the field
+ */
+ public $name;
+ /**
+ * @var string $value The value attribute of the field
+ */
+ public $value;
+ /**
+ * @var string $type The type attribute of the field (text, submit, checkbox etc)
+ */
+ public $type;
+ /**
+ * @var string $maxlength The maxlength attribute of the field (only applies to text type)
+ */
+ public $maxlength;
+ /**
+ * @var mixed $label The label for that component. String or html_label object
+ */
+ public $label;
+
+ public function __construct() {
+ $this->label = new html_label();
+ }
+
+ /**
+ * @see moodle_html_component::prepare()
+ * @return void
+ */
+ public function prepare() {
+ if (empty($this->style)) {
+ $this->style = 'width: 4em;';
+ }
+ if (empty($this->id)) {
+ $this->generate_id();
+ }
+ parent::prepare();
+ }
+
+ /**
+ * Shortcut for creating a text input component.
+ * @param string $name The name of the text field
+ * @param string $value The value of the text field
+ * @param string $alt The info to be inserted in the alt tag
+ * @param int $maxlength Sets the maxlength attribute of the field. Not set by default
+ * @return html_field The field component
+ */
+ public static function make_text($name='unnamed', $value, $alt, $maxlength=0) {
+ $field = new html_field();
+ if (empty($alt)) {
+ $alt = get_string('textfield');
+ }
+ $field->type = 'text';
+ $field->name = $name;
+ $field->value = $value;
+ $field->alt = $alt;
+ $field->maxlength = $maxlength;
+ return $field;
+ }
+}
+
+/**
+ * Holds all the information required to render a <table> by
+ * {@see moodle_core_renderer::table()} or by an overridden version of that
+ * method in a subclass.
+ *
+ * Example of usage:
+ * $t = new html_table();
+ * ... // set various properties of the object $t as described below
+ * echo $OUTPUT->table($t);
+ *
+ * @copyright 2009 David Mudrak <david.mudrak@gmail.com>
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ */
+class html_table extends moodle_html_component {
+ /**
+ * @var array of headings. The n-th array item is used as a heading of the n-th column.
+ *
+ * Example of usage:
+ * $t->head = array('Student', 'Grade');
+ */
+ public $head;
+ /**
+ * @var array can be used to make a heading span multiple columns
+ *
+ * Example of usage:
+ * $t->headspan = array(2,1);
+ *
+ * In this example, {@see html_table:$data} is supposed to have three columns. For the first two columns,
+ * the same heading is used. Therefore, {@see html_table::$head} should consist of two items.
+ */
+ public $headspan;
+ /**
+ * @var array of column alignments. The value is used as CSS 'text-align' property. Therefore, possible
+ * values are 'left', 'right', 'center' and 'justify'. Specify 'right' or 'left' from the perspective
+ * of a left-to-right (LTR) language. For RTL, the values are flipped automatically.
+ *
* Examples of usage:
* $t->align = array(null, 'right');
* or
public function __set($name, $value) {
if ($name == 'rowclass') {
debugging('rowclass[] has been deprecated for html_table ' .
- 'and should be replaced with rowclasses[]. please fix the code.');
- $this->rowclasses = $value;
- } else {
- parent::__set($name, $value);
- }
- }
-}
-
-/**
- * Component representing a table row.
- *
- * @copyright 2009 Nicolas Connault
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @since Moodle 2.0
- */
-class html_table_row extends moodle_html_component {
- /**
- * @var array $cells Array of html_table_cell objects
- */
- public $cells = array();
-
- /**
- * @see lib/moodle_html_component#prepare()
- * @return void
- */
- public function prepare() {
- parent::prepare();
- }
-}
-
-/**
- * Component representing a table cell.
- *
- * @copyright 2009 Nicolas Connault
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @since Moodle 2.0
- */
-class html_table_cell extends moodle_html_component {
- /**
- * @var string $text The contents of the cell
- */
- public $text;
- /**
- * @var string $abbr Abbreviated version of the contents of the cell
- */
- public $abbr = '';
- /**
- * @var int $colspan Number of columns this cell should span
- */
- public $colspan = '';
- /**
- * @var int $rowspan Number of rows this cell should span
- */
- public $rowspan = '';
- /**
- * @var string $scope Defines a way to associate header cells and data cells in a table
- */
- public $scope = '';
-
- /**
- * @see lib/moodle_html_component#prepare()
- * @return void
- */
- public function prepare() {
- parent::prepare();
- }
-}
-
-/**
- * Component representing a XHTML link.
- *
- * @copyright 2009 Nicolas Connault
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @since Moodle 2.0
- */
-class html_link extends moodle_html_component {
- /**
- * URL can be simple text or a moodle_url object
- * @var mixed $url
- */
- public $url;
-
- /**
- * @var string $text The text that will appear between the link tags
- */
- public $text;
-
- /**
- * @see lib/moodle_html_component#prepare()
- * @return void
- */
- public function prepare() {
- // We can't accept an empty text value
- if (empty($this->text)) {
- throw new coding_exception('A html_link must have a descriptive text value!');
- }
-
- parent::prepare();
- }
-
- /**
- * Shortcut for creating a link component.
- * @param mixed $url String or moodle_url
- * @param string $text The text of the link
- * @return html_link The link component
- */
- public function make($url, $text) {
- $link = new html_link();
- $link->url = $url;
- $link->text = $text;
- return $link;
- }
-}
-
-/**
- * Component representing a XHTML button (input of type 'button').
- * The renderer will either output it as a button with an onclick event,
- * or as a form with hidden inputs.
- *
- * @copyright 2009 Nicolas Connault
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @since Moodle 2.0
- */
-class html_button extends moodle_html_component {
- /**
- * @var string $text
- */
- public $text;
-
- /**
- * @var boolean $disabled Whether or not this button is disabled
- */
- public $disabled = false;
-
- /**
- * @see lib/moodle_html_component#prepare()
- * @return void
- */
- public function prepare() {
- $this->add_class('singlebutton');
-
- if (empty($this->text)) {
- throw new coding_exception('A html_button must have a text value!');
- }
-
- if ($this->disabled) {
- $this->disabled = 'disabled';
+ 'and should be replaced with rowclasses[]. please fix the code.');
+ $this->rowclasses = $value;
+ } else {
+ parent::__set($name, $value);
}
-
- parent::prepare();
}
}
/**
- * Component representing an image.
+ * Component representing a table row.
*
* @copyright 2009 Nicolas Connault
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
*/
-class html_image extends moodle_html_component {
- /**
- * @var string $alt A descriptive text
- */
- public $alt = HTML_ATTR_EMPTY;
+class html_table_row extends moodle_html_component {
/**
- * @var string $src The path to the image being used
+ * @var array $cells Array of html_table_cell objects
*/
- public $src;
+ public $cells = array();
/**
* @see lib/moodle_html_component#prepare()
* @return void
*/
public function prepare() {
- $this->add_class('image');
parent::prepare();
}
}
/**
- * Component representing a textarea.
+ * Component representing a table cell.
*
* @copyright 2009 Nicolas Connault
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
*/
-class html_textarea extends moodle_html_component {
+class html_table_cell extends moodle_html_component {
/**
- * @param string $name Name to use for the textarea element.
+ * @var string $text The contents of the cell
*/
- public $name;
+ public $text;
/**
- * @param string $value Initial content to display in the textarea.
+ * @var string $abbr Abbreviated version of the contents of the cell
*/
- public $value;
+ public $abbr = '';
/**
- * @param int $rows Number of rows to display (minimum of 10 when $height is non-null)
+ * @var int $colspan Number of columns this cell should span
*/
- public $rows;
+ public $colspan = '';
/**
- * @param int $cols Number of columns to display (minimum of 65 when $width is non-null)
+ * @var int $rowspan Number of rows this cell should span
*/
- public $cols;
+ public $rowspan = '';
/**
- * @param bool $usehtmleditor Enables the use of the htmleditor for this field.
+ * @var string $scope Defines a way to associate header cells and data cells in a table
*/
- public $usehtmleditor;
+ public $scope = '';
/**
* @see lib/moodle_html_component#prepare()
* @return void
*/
public function prepare() {
- $this->add_class('form-textarea');
-
- if (empty($this->id)) {
- $this->id = "edit-$this->name";
- }
-
- if ($this->usehtmleditor) {
- editors_head_setup();
- $editor = get_preferred_texteditor(FORMAT_HTML);
- $editor->use_editor($this->id, array('legacy'=>true));
- $this->value = htmlspecialchars($value);
- }
-
parent::prepare();
}
}
/**
- * Component representing a simple form wrapper. Its purpose is mainly to enclose
- * a submit input with the appropriate action and hidden inputs.
+ * Component representing a XHTML link.
*
* @copyright 2009 Nicolas Connault
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
*/
-class html_form extends moodle_html_component {
- /**
- * @var string $method post or get
- */
- public $method = 'post';
+class html_link extends moodle_html_component {
/**
- * If a string is given, it will be converted to a moodle_url during prepare()
- * @var mixed $url A moodle_url including params or a string
+ * URL can be simple text or a moodle_url object
+ * @var mixed $url
*/
public $url;
- /**
- * @var array $params Optional array of parameters. Ignored if $url instanceof moodle_url
- */
- public $params = array();
- /**
- * @var boolean $showbutton If true, the submit button will always be shown even if JavaScript is available
- */
- public $showbutton = false;
- /**
- * @var string $targetwindow The name of the target page to open the linked page in.
- */
- public $targetwindow = 'self';
- /**
- * @var html_button $button A submit button
- */
- public $button;
/**
- * Constructor: sets up the other components in case they are needed
- * @return void
+ * @var string $text The text that will appear between the link tags
*/
- public function __construct() {
- static $yes;
- $this->button = new html_button();
- if (!isset($yes)) {
- $yes = get_string('yes');
- $this->button->text = $yes;
- }
- }
+ public $text;
/**
* @see lib/moodle_html_component#prepare()
* @return void
*/
public function prepare() {
-
- if (empty($this->url)) {
- throw new coding_exception('A html_form must have a $url value (string or moodle_url).');
- }
-
- if (!($this->url instanceof moodle_url)) {
- $this->url = new moodle_url($this->url, $this->params);
- }
-
- if ($this->method == 'post') {
- $this->url->param('sesskey', sesskey());
+ // We can't accept an empty text value
+ if (empty($this->text)) {
+ throw new coding_exception('A html_link must have a descriptive text value!');
}
parent::prepare();
}
-}
-
-/**
- * Component representing a list.
- *
- * The advantage of using this object instead of a flat array is that you can load it
- * with metadata (CSS classes, event handlers etc.) which can be used by the renderers.
- *
- * @copyright 2009 Nicolas Connault
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @since Moodle 2.0
- */
-class html_list extends moodle_html_component {
-
- /**
- * @var array $items An array of html_list_item or html_list objects
- */
- public $items = array();
-
- /**
- * @var string $type The type of list (ordered|unordered), definition type not yet supported
- */
- public $type = 'unordered';
-
- /**
- * @see lib/moodle_html_component#prepare()
- * @return void
- */
- public function prepare() {
- parent::prepare();
- }
-
- /**
- * This function takes a nested array of data and maps it into this list's $items array
- * as proper html_list_item and html_list objects, with appropriate metadata.
- *
- * @param array $tree A nested array (array keys are ignored);
- * @param int $row Used in identifying the iteration level and in ul classes
- * @return void
- */
- public function load_data($tree, $level=0) {
-
- $this->add_class("list-$level");
-
- foreach ($tree as $key => $element) {
- if (is_array($element)) {
- $newhtmllist = new html_list();
- $newhtmllist->load_data($element, $level + 1);
- $this->items[] = $newhtmllist;
- } else {
- $listitem = new html_list_item();
- $listitem->value = $element;
- $listitem->add_class("list-item-$level-$key");
- $this->items[] = $listitem;
- }
- }
- }
/**
- * Adds a html_list_item or html_list to this list.
- * If the param is a string, a html_list_item will be added.
- * @param mixed $item String, html_list or html_list_item object
- * @return void
+ * Shortcut for creating a link component.
+ * @param mixed $url String or moodle_url
+ * @param string $text The text of the link
+ * @return html_link The link component
*/
- public function add_item($item) {
- if ($item instanceof html_list_item || $item instanceof html_list) {
- $this->items[] = $item;
- } else {
- $listitem = new html_list_item();
- $listitem->value = $item;
- $this->items[] = $item;
- }
+ public function make($url, $text) {
+ $link = new html_link();
+ $link->url = $url;
+ $link->text = $text;
+ return $link;
}
}
/**
- * Component representing a list item.
+ * Component representing a XHTML button (input of type 'button').
+ * The renderer will either output it as a button with an onclick event,
+ * or as a form with hidden inputs.
*
* @copyright 2009 Nicolas Connault
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
*/
-class html_list_item extends moodle_html_component {
- /**
- * @var string $value The value of the list item
- */
- public $value;
-
+class html_button extends moodle_html_component {
/**
- * @see lib/moodle_html_component#prepare()
- * @return void
+ * @var string $text
*/
- public function prepare() {
- parent::prepare();
- }
-}
-
-/// Complex components aggregating simpler components
+ public $text;
-/**
- * This class hold all the information required to describe a <select> menu that
- * will be printed by {@link moodle_core_renderer::select()}. (Or by an overridden
- * version of that method in a subclass.)
- *
- * This component can also hold enough metadata to be used as a popup form. It just
- * needs a bit more setting up than for a simple menu. See the shortcut methods for
- * developer-friendly usage.
- *
- * All the fields that are not set by the constructor have sensible defaults, so
- * you only need to set the properties where you want non-default behaviour.
- *
- * @copyright 2009 Tim Hunt
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @since Moodle 2.0
- */
-class moodle_select extends moodle_html_component {
- /**
- * The moodle_select object parses an array of options into component objects
- * @see nested attribute
- * @var mixed $options the choices to show in the menu. An array $value => $display, of html_select_option or of html_select_optgroup objects.
- */
- public $options;
- /**
- * @var string $name the name of this form control. That is, the name of the GET/POST
- * variable that will be set if this select is submitted as part of a form.
- */
- public $name;
- /**
- * @var mixed $label The label for that component. String or html_label object
- */
- public $label;
- /**
- * @var string $selectedvalue the option to select initially. Should match one
- * of the $options array keys. Default none.
- */
- public $selectedvalue;
- /**
- * Defaults to get_string('choosedots').
- * Set this to '' if you do not want a 'nothing is selected' option.
- * This is ignored if the rendertype is 'radio' or 'checkbox'
- * @var string The label for the 'nothing is selected' option.
- */
- public $nothinglabel = null;
- /**
- * @var string The value returned by the 'nothing is selected' option. Defaults to 0.
- */
- public $nothingvalue = 0;
/**
- * @var boolean set this to true if you want the control to appear disabled.
+ * @var boolean $disabled Whether or not this button is disabled
*/
public $disabled = false;
+
/**
- * @var integer if non-zero, sets the tabindex attribute on the <select> element. Default 0.
+ * @see lib/moodle_html_component#prepare()
+ * @return void
*/
- public $tabindex = 0;
+ public function prepare() {
+ $this->add_class('singlebutton');
+
+ if (empty($this->text)) {
+ throw new coding_exception('A html_button must have a text value!');
+ }
+
+ if ($this->disabled) {
+ $this->disabled = 'disabled';
+ }
+
+ parent::prepare();
+ }
+}
+
+/**
+ * Component representing an image.
+ *
+ * @copyright 2009 Nicolas Connault
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ */
+class html_image extends moodle_html_component {
/**
- * @var mixed Defaults to false, which means display the select as a dropdown menu.
- * If true, display this select as a list box whose size is chosen automatically.
- * If an integer, display as list box of that size.
+ * @var string $alt A descriptive text
*/
- public $listbox = false;
+ public $alt = HTML_ATTR_EMPTY;
/**
- * @var integer if you are using $listbox === true to get an automatically
- * sized list box, the size of the list box will be the number of options,
- * or this number, whichever is smaller.
+ * @var string $src The path to the image being used
*/
- public $maxautosize = 10;
+ public $src;
+
/**
- * @var boolean if true, allow multiple selection. Only used if $listbox is true, or if
- * the select is to be output as checkboxes.
+ * @see lib/moodle_html_component#prepare()
+ * @return void
*/
- public $multiple = false;
+ public function prepare() {
+ $this->add_class('image');
+ parent::prepare();
+ }
+}
+
+/**
+ * Component representing a textarea.
+ *
+ * @copyright 2009 Nicolas Connault
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ */
+class html_textarea extends moodle_html_component {
/**
- * Another way to use nested menu is to prefix optgroup labels with -- and end the optgroup with --
- * Leave this setting to false if you are using the latter method.
- * @var boolean $nested if true, uses $options' keys as option headings (optgroup)
+ * @param string $name Name to use for the textarea element.
*/
- public $nested = false;
+ public $name;
/**
- * @var html_form $form An optional html_form component
+ * @param string $value Initial content to display in the textarea.
*/
- public $form;
+ public $value;
/**
- * @var moodle_help_icon $form An optional moodle_help_icon component
+ * @param int $rows Number of rows to display (minimum of 10 when $height is non-null)
*/
- public $helpicon;
+ public $rows;
/**
- * @var boolean $rendertype How the select element should be rendered: menu or radio (checkbox is just radio + multiple)
+ * @param int $cols Number of columns to display (minimum of 65 when $width is non-null)
*/
- public $rendertype = 'menu';
+ public $cols;
+ /**
+ * @param bool $usehtmleditor Enables the use of the htmleditor for this field.
+ */
+ public $usehtmleditor;
/**
- * @see moodle_html_component::prepare()
+ * @see lib/moodle_html_component#prepare()
* @return void
*/
public function prepare() {
- global $CFG;
+ $this->add_class('form-textarea');
- // name may contain [], which would make an invalid id. e.g. numeric question type editing form, assignment quickgrading
if (empty($this->id)) {
- $this->id = 'menu' . str_replace(array('[', ']'), '', $this->name);
- }
-
- if (empty($this->classes)) {
- $this->set_classes(array('menu' . str_replace(array('[', ']'), '', $this->name)));
- }
-
- if (is_null($this->nothinglabel)) {
- $this->nothinglabel = get_string('choosedots');
+ $this->id = "edit-$this->name";
}
- if (!empty($this->label) && !($this->label instanceof html_label)) {
- $label = new html_label();
- $label->text = $this->label;
- $label->for = $this->name;
- $this->label = $label;
+ if ($this->usehtmleditor) {
+ editors_head_setup();
+ $editor = get_preferred_texteditor(FORMAT_HTML);
+ $editor->use_editor($this->id, array('legacy'=>true));
+ $this->value = htmlspecialchars($value);
}
- $this->add_class('select');
-
- $this->initialise_options();
parent::prepare();
}
+}
+/**
+ * Component representing a simple form wrapper. Its purpose is mainly to enclose
+ * a submit input with the appropriate action and hidden inputs.
+ *
+ * @copyright 2009 Nicolas Connault
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ */
+class html_form extends moodle_html_component {
/**
- * This is a shortcut for making a simple select menu. It lets you specify
- * the options, name and selected option in one line of code.
- * @param array $options used to initialise {@link $options}.
- * @param string $name used to initialise {@link $name}.
- * @param string $selected used to initialise {@link $selected}.
- * @return moodle_select A moodle_select object with the three common fields initialised.
+ * @var string $method post or get
*/
- public static function make($options, $name, $selected = '') {
- $menu = new moodle_select();
- $menu->options = $options;
- $menu->name = $name;
- $menu->selectedvalue = $selected;
- return $menu;
- }
-
+ public $method = 'post';
/**
- * This is a shortcut for making a yes/no select menu.
- * @param string $name used to initialise {@link $name}.
- * @param string $selected used to initialise {@link $selected}.
- * @return moodle_select A menu initialised with yes/no options.
+ * If a string is given, it will be converted to a moodle_url during prepare()
+ * @var mixed $url A moodle_url including params or a string
*/
- public static function make_yes_no($name, $selected) {
- return self::make(array(0 => get_string('no'), 1 => get_string('yes')), $name, $selected);
- }
-
+ public $url;
/**
- * This is a shortcut for making an hour selector menu.
- * @param string $type The type of selector (years, months, days, hours, minutes)
- * @param string $name fieldname
- * @param int $currenttime A default timestamp in GMT
- * @param int $step minute spacing
- * @return moodle_select A menu initialised with hour options.
+ * @var array $params Optional array of parameters. Ignored if $url instanceof moodle_url
*/
- public static function make_time_selector($type, $name, $currenttime=0, $step=5) {
-
- if (!$currenttime) {
- $currenttime = time();
- }
- $currentdate = usergetdate($currenttime);
- $userdatetype = $type;
-
- switch ($type) {
- case 'years':
- for ($i=1970; $i<=2020; $i++) {
- $timeunits[$i] = $i;
- }
- $userdatetype = 'year';
- break;
- case 'months':
- for ($i=1; $i<=12; $i++) {
- $timeunits[$i] = userdate(gmmktime(12,0,0,$i,15,2000), "%B");
- }
- $userdatetype = 'month';
- break;
- case 'days':
- for ($i=1; $i<=31; $i++) {
- $timeunits[$i] = $i;
- }
- $userdatetype = 'mday';
- break;
- case 'hours':
- for ($i=0; $i<=23; $i++) {
- $timeunits[$i] = sprintf("%02d",$i);
- }
- break;
- case 'minutes':
- if ($step != 1) {
- $currentdate['minutes'] = ceil($currentdate['minutes']/$step)*$step;
- }
-
- for ($i=0; $i<=59; $i+=$step) {
- $timeunits[$i] = sprintf("%02d",$i);
- }
- break;
- default:
- throw new coding_exception("Time type $type is not supported by moodle_select::make_time_selector().");
- }
-
- $timerselector = self::make($timeunits, $name, $currentdate[$userdatetype]);
- $timerselector->label = new html_label();
- $timerselector->label->text = get_string(substr($type, -1), 'form');
- $timerselector->label->for = "menu$timerselector->name";
- $timerselector->label->add_class('accesshide');
- $timerselector->nothinglabel = '';
-
- return $timerselector;
- }
+ public $params = array();
+ /**
+ * @var boolean $showbutton If true, the submit button will always be shown even if JavaScript is available
+ */
+ public $showbutton = false;
+ /**
+ * @var string $targetwindow The name of the target page to open the linked page in.
+ */
+ public $targetwindow = 'self';
+ /**
+ * @var html_button $button A submit button
+ */
+ public $button;
/**
- * Given an associative array of type => fieldname and an optional timestamp,
- * returns an array of moodle_select components representing date/time selectors.
- * @param array $selectors Arrays of type => fieldname. Selectors will be returned in the order of the types given
- * @param int $currenttime A UNIX timestamp
- * @param int $step minute spacing
- * @return array Instantiated date/time selectors
+ * Constructor: sets up the other components in case they are needed
+ * @return void
*/
- public function make_time_selectors($selectors, $currenttime=0, $step=5) {
- $selects = array();
- foreach ($selectors as $type => $name) {
- $selects[] = moodle_select::make_time_selector($type, $name, $currenttime, $step);
+ public function __construct() {
+ static $yes;
+ $this->button = new html_button();
+ if (!isset($yes)) {
+ $yes = get_string('yes');
+ $this->button->text = $yes;
}
- return $selects;
}
/**
- * This is a shortcut for making a select popup form.
- * @param mixed $baseurl The target URL, string or moodle_url
- * @param string $name The variable which this select's options are changing in the URL
- * @param array $options A list of value-label pairs for the popup list
- * @param string $formid id for the control. Must be unique on the page. Used in the HTML.
- * @param string $selected The option that is initially selected
- * @return moodle_select A menu initialised as a popup form.
+ * @see lib/moodle_html_component#prepare()
+ * @return void
*/
- public function make_popup_form($baseurl, $name, $options, $formid, $selected=null) {
- global $CFG;
-
- $selectedurl = null;
-
- if (!($baseurl instanceof moodle_url)) {
- $baseurl = new moodle_url($baseurl);
- }
+ public function prepare() {
- if (!empty($selected)) {
- $selectedurl = $baseurl->out(false, array($name => $selected), false);
+ if (empty($this->url)) {
+ throw new coding_exception('A html_form must have a $url value (string or moodle_url).');
}
- if (!($baseurl instanceof moodle_url)) {
- $baseurl = new moodle_url($baseurl);
+ if (!($this->url instanceof moodle_url)) {
+ $this->url = new moodle_url($this->url, $this->params);
}
- // Replace real value by formatted URLs
- foreach ($options as $value => $label) {
- $options[$baseurl->out(false, array($name => $value), false)] = $label;
- unset($options[$value]);
+ if ($this->method == 'post') {
+ $this->url->param('sesskey', sesskey());
}
- $select = self::make($options, 'jump', $selectedurl);
+ parent::prepare();
+ }
+}
- $select->form = new html_form();
- $select->form->id = $formid;
- $select->form->method = 'get';
- $select->form->add_class('popupform');
- $select->form->url = new moodle_url($CFG->wwwroot . '/course/jumpto.php', array('sesskey' => sesskey()));
- $select->form->button->text = get_string('go');
+/**
+ * Component representing a list.
+ *
+ * The advantage of using this object instead of a flat array is that you can load it
+ * with metadata (CSS classes, event handlers etc.) which can be used by the renderers.
+ *
+ * @copyright 2009 Nicolas Connault
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ */
+class html_list extends moodle_html_component {
- $select->id = $formid . '_jump';
+ /**
+ * @var array $items An array of html_list_item or html_list objects
+ */
+ public $items = array();
- $select->add_action('change', 'submit_form_by_id', array('id' => $formid, 'selectid' => $select->id));
+ /**
+ * @var string $type The type of list (ordered|unordered), definition type not yet supported
+ */
+ public $type = 'unordered';
- return $select;
+ /**
+ * @see lib/moodle_html_component#prepare()
+ * @return void
+ */
+ public function prepare() {
+ parent::prepare();
}
/**
- * Override the URLs of the default popup_form, which only supports one base URL
- * @param array $options value=>label pairs representing select options
+ * This function takes a nested array of data and maps it into this list's $items array
+ * as proper html_list_item and html_list objects, with appropriate metadata.
+ *
+ * @param array $tree A nested array (array keys are ignored);
+ * @param int $row Used in identifying the iteration level and in ul classes
* @return void
*/
- public function override_option_values($options) {
- global $PAGE;
-
- $this->initialise_options();
-
- reset($options);
-
- foreach ($this->options as $optkey => $optgroup) {
- if ($optgroup instanceof html_select_optgroup) {
- foreach ($optgroup->options as $key => $option) {
- next($options);
- $this->options[$optkey]->options[$key]->value = key($options);
-
- $optionurl = new moodle_url(key($options));
+ public function load_data($tree, $level=0) {
- if ($optionurl->compare($PAGE->url, URL_MATCH_PARAMS)) {
- $this->options[$optkey]->options[$key]->selected = 'selected';
- }
- }
- next($options);
- } else if ($optgroup instanceof html_select_option) {
- next($options);
- $this->options[$optkey]->value = key($options);
- $optionurl = new moodle_url(key($options));
+ $this->add_class("list-$level");
- if ($optionurl->compare($PAGE->url, URL_MATCH_PARAMS)) {
- $this->options[$optkey]->selected = 'selected';
- }
+ foreach ($tree as $key => $element) {
+ if (is_array($element)) {
+ $newhtmllist = new html_list();
+ $newhtmllist->load_data($element, $level + 1);
+ $this->items[] = $newhtmllist;
+ } else {
+ $listitem = new html_list_item();
+ $listitem->value = $element;
+ $listitem->add_class("list-item-$level-$key");
+ $this->items[] = $listitem;
}
}
}
/**
- * Adds a help icon next to the select menu.
- *
- * This can be used in two ways:
- *
- * <pre>
- * $select->set_help_icon($page, $text, $linktext);
- * // OR
- * $helpicon = new moodle_help_icon();
- * $helpicon->page = $page;
- * $helpicon->text = $text;
- * $helpicon->linktext = $linktext;
- * $select->set_help_icon($helpicon);
- * </pre>
- *
- * Use the second form when you need to add additional HTML attributes
- * to the label and/or JS actions.
- *
- * @param mixed $page Either the keyword that defines a help page or a moodle_help_icon object
- * @param text $text The text of the help icon
- * @param boolean $linktext Whether or not to show text next to the icon
+ * Adds a html_list_item or html_list to this list.
+ * If the param is a string, a html_list_item will be added.
+ * @param mixed $item String, html_list or html_list_item object
* @return void
*/
- public function set_help_icon($page, $text, $linktext=false) {
- if ($page instanceof moodle_help_icon) {
- $this->helpicon = $page;
- } else if (!empty($page)) {
- $this->helpicon = new moodle_help_icon();
- $this->helpicon->page = $page;
- $this->helpicon->text = $text;
- $this->helpicon->linktext = $linktext;
+ public function add_item($item) {
+ if ($item instanceof html_list_item || $item instanceof html_list) {
+ $this->items[] = $item;
+ } else {
+ $listitem = new html_list_item();
+ $listitem->value = $item;
+ $this->items[] = $item;
}
}
+}
+/**
+ * Component representing a list item.
+ *
+ * @copyright 2009 Nicolas Connault
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since Moodle 2.0
+ */
+class html_list_item extends moodle_html_component {
/**
- * Parses the $options array and instantiates html_select_option objects in
- * the place of the original value => label pairs. This is useful for when you
- * need to setup extra html attributes and actions on individual options before
- * the component is sent to the renderer
- * @return void;
+ * @var string $value The value of the list item
*/
- public function initialise_options() {
- // If options are already instantiated objects, stop here
- $firstoption = reset($this->options);
- if ($firstoption instanceof html_select_option || $firstoption instanceof html_select_optgroup) {
- return;
- }
-
- if ($this->rendertype == 'radio' && $this->multiple) {
- $this->rendertype = 'checkbox';
- }
-
- // If nested is on, or if radio/checkbox rendertype is set, remove the default Choose option
- if ($this->nested || $this->rendertype == 'radio' || $this->rendertype == 'checkbox') {
- $this->nothinglabel = '';
- }
-
- $options = $this->options;
-
- $this->options = array();
-
- if ($this->nested && $this->rendertype != 'menu') {
- throw new coding_exception('moodle_select cannot render nested options as radio buttons or checkboxes.');
- } else if ($this->nested) {
- foreach ($options as $section => $values) {
- $optgroup = new html_select_optgroup();
- $optgroup->text = $section;
-
- foreach ($values as $value => $display) {
- $option = new html_select_option();
- $option->value = s($value);
- $option->text = $display;
- if ($display === '') {
- $option->text = $value;
- }
-
- if ((string) $value == (string) $this->selectedvalue ||
- (is_array($this->selectedvalue) && in_array($value, $this->selectedvalue))) {
- $option->selected = 'selected';
- }
-
- $optgroup->options[] = $option;
- }
-
- $this->options[] = $optgroup;
- }
- } else {
- $inoptgroup = false;
- $optgroup = false;
-
- foreach ($options as $value => $display) {
- if ($display == '--') { /// we are ending previous optgroup
- // $this->options[] = $optgroup;
- $inoptgroup = false;
- continue;
- } else if (substr($display,0,2) == '--') { /// we are starting a new optgroup
- if (!empty($optgroup->options)) {
- $this->options[] = $optgroup;
- }
-
- $optgroup = new html_select_optgroup();
- $optgroup->text = substr($display,2); // stripping the --
-
- $inoptgroup = true; /// everything following will be in an optgroup
- continue;
-
- } else {
- // Add $nothing option if there are not optgroups
- if ($this->nothinglabel && empty($this->options[0]) && !$inoptgroup) {
- $nothingoption = new html_select_option();
- $nothingoption->value = 0;
- if (!empty($this->nothingvalue)) {
- $nothingoption->value = $this->nothingvalue;
- }
- $nothingoption->text = $this->nothinglabel;
- $this->options = array($nothingoption) + $this->options;
- }
-
- $option = new html_select_option();
- $option->text = $display;
-
- if ($display === '') {
- $option->text = $value;
- }
-
- if ((string) $value == (string) $this->selectedvalue ||
- (is_array($this->selectedvalue) && in_array($value, $this->selectedvalue))) {
- $option->selected = 'selected';
- }
-
- $option->value = s($value);
-
- if ($inoptgroup) {
- $optgroup->options[] = $option;
- } else {
- $this->options[] = $option;
- }
- }
- }
+ public $value;
- if ($optgroup) {
- $this->options[] = $optgroup;
- }
- }
+ /**
+ * @see lib/moodle_html_component#prepare()
+ * @return void
+ */
+ public function prepare() {
+ parent::prepare();
}
}
+/// Complex components aggregating simpler components
+
/**
* Component representing a paging bar.
*
projects / moodle.git / commitdiff