Add support for optgroup-tags for select-fields #1778
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,18 +10,59 @@ | |
| */ | ||
| class DropdownElement extends InputElement { | ||
|
|
||
| /** @var array OptGroup[] */ | ||
| protected $optGroups = array(); | ||
|
|
||
| /** | ||
| * @param string $name The name of this form element | ||
| * @param array $options The available options | ||
| * @param string $label The label text for this element (will be autoescaped) | ||
| */ | ||
| public function __construct($name, $options, $label = '') { | ||
| parent::__construct('dropdown', $name, $label); | ||
| $this->rmattr('type'); | ||
| $this->optGroups[''] = new OptGroup(null, $options); | ||
| $this->val(''); | ||
| } | ||
|
|
||
| /** | ||
| * Add an `<optgroup>` and respective options | ||
| * | ||
| * @param string $label | ||
| * @param array $options | ||
| * @return OptGroup a reference to the added optgroup | ||
| * @throws \Exception | ||
| */ | ||
| public function addOptGroup($label, $options) { | ||
| if (empty($label)) { | ||
| throw new \InvalidArgumentException(hsc('<optgroup> must have a label!')); | ||
| } | ||
| $this->optGroups[$label] = new OptGroup($label, $options); | ||
| return end($this->optGroups); | ||
| } | ||
|
|
||
| /** | ||
| * Set or get the optgroups of an Dropdown-Element. | ||
| * | ||
| * optgroups have to be given as associative array | ||
| * * the key being the label of the group | ||
| * * the value being an array of options as defined in @see OptGroup::options() | ||
| * | ||
| * @param null|array $optGroups | ||
| * @return OptGroup[]|DropdownElement | ||
| */ | ||
| public function optGroups($optGroups = null) { | ||
| if($optGroups === null) { | ||
| return $this->optGroups; | ||
| } | ||
| if (!is_array($optGroups)) { | ||
| throw new \InvalidArgumentException(hsc('Argument must be an associative array of label => [options]!')); | ||
| } | ||
| $this->optGroups = array(); | ||
| foreach ($optGroups as $label => $options) { | ||
| $this->addOptGroup($label, $options); | ||
| } | ||
| return $this; | ||
| } | ||
|
|
||
| /** | ||
|
|
@@ -41,21 +82,10 @@ public function __construct($name, $options, $label = '') { | |
| * @return $this|array | ||
| */ | ||
| public function options($options = null) { | ||
| if ($options === null) { | ||
| return $this->optGroups['']->options(); | ||
| } | ||
| $this->optGroups[''] = new OptGroup(null, $options); | ||
| return $this; | ||
| } | ||
|
|
||
|
|
@@ -91,17 +121,55 @@ public function attr($name, $value = null) { | |
| public function val($value = null) { | ||
| if($value === null) return $this->value; | ||
|
|
||
| $value_exists = $this->setValueInOptGroups($value); | ||
|
|
||
| if($value_exists) { | ||
| $this->value = $value; | ||
| } else { | ||
| // unknown value set, select first option instead | ||
| $this->value = $this->getFirstOption(); | ||
| $this->setValueInOptGroups($this->value); | ||
|
There was a problem hiding this comment. how are we handling multi selects? it seems this only works with a single value? There was a problem hiding this comment. We are not, we are throwing an exception when setting the |
||
| } | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the first options as it will be rendered in HTML | ||
| * | ||
| * @return string | ||
| */ | ||
| protected function getFirstOption() { | ||
| $options = $this->options(); | ||
| if (!empty($options)) { | ||
| return (string) array_shift(array_keys($options)); | ||
| } | ||
| foreach ($this->optGroups as $optGroup) { | ||
| $options = $optGroup->options(); | ||
| if (!empty($options)) { | ||
| return (string) array_shift(array_keys($options)); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Set the value in the OptGroups, including the optgroup for the options without optgroup. | ||
| * | ||
| * @param string $value | ||
| * @return bool | ||
| */ | ||
| protected function setValueInOptGroups($value) { | ||
| $value_exists = false; | ||
| /** @var OptGroup $optGroup */ | ||
| foreach ($this->optGroups as $optGroup) { | ||
| $value_exists = $optGroup->storeValue($value) || $value_exists; | ||
| if ($value_exists) { | ||
| $value = null; | ||
| } | ||
| } | ||
| return $value_exists; | ||
| } | ||
|
|
||
| /** | ||
| * Create the HTML for the select it self | ||
| * | ||
|
|
@@ -111,15 +179,7 @@ protected function mainElementHTML() { | |
| if($this->useInput) $this->prefillInput(); | ||
|
|
||
| $html = '<select ' . buildAttributes($this->attrs()) . '>'; | ||
| $html = array_reduce($this->optGroups, function($html, OptGroup $optGroup) {return $html . $optGroup->toHTML();}, $html); | ||
|
There was a problem hiding this comment. I think it's a bit weird that not all options are handled through the optgroups in |
||
| $html .= '</select>'; | ||
|
|
||
| return $html; | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| <?php | ||
|
|
||
| namespace dokuwiki\Form; | ||
|
|
||
|
|
||
| class OptGroup extends Element { | ||
| protected $options = array(); | ||
| protected $value; | ||
|
|
||
| /** | ||
| * @param string $label The label text for this element (will be autoescaped) | ||
|
|
||
| * @param array $options The available options | ||
| */ | ||
| public function __construct($label, $options) { | ||
| parent::__construct('optGroup', array('label' => $label)); | ||
| $this->options($options); | ||
| } | ||
|
|
||
| /** | ||
| * Store the given value so it can be used during rendering | ||
| * | ||
| * This is intended to be only called from within @see DropdownElement::val() | ||
| * | ||
| * @param string $value | ||
| * @return bool true if an option with the given value exists, false otherwise | ||
| */ | ||
| public function storeValue($value) { | ||
| $this->value = $value; | ||
| return isset($this->options[$value]); | ||
| } | ||
|
There was a problem hiding this comment. It's a bit unclear what this function does. It seems to store the currently selected value? What if this optgroup is part of a multiselect? What exactly is the return value? |
||
|
|
||
| /** | ||
| * Get or set the options of the optgroup | ||
| * | ||
| * Options can be given as associative array (value => label) or as an | ||
| * indexd array (label = value) or as an array of arrays. In the latter | ||
| * case an element has to look as follows: | ||
| * option-value => array ( | ||
| * 'label' => option-label, | ||
| * 'attrs' => array ( | ||
| * attr-key => attr-value, ... | ||
| * ) | ||
| * ) | ||
| * | ||
| * @param null|array $options | ||
| * @return $this|array | ||
| */ | ||
| public function options($options = null) { | ||
| if($options === null) return $this->options; | ||
| if(!is_array($options)) throw new \InvalidArgumentException('Options have to be an array'); | ||
| $this->options = array(); | ||
| foreach($options as $key => $val) { | ||
| if(is_int($key)) { | ||
| $this->options[$val] = array('label' => (string) $val); | ||
| } elseif (!is_array($val)) { | ||
| $this->options[$key] = array('label' => (string) $val); | ||
| } else { | ||
| if (!key_exists('label', $val)) throw new \InvalidArgumentException('If option is given as array, it has to have a "label"-key!'); | ||
| $this->options[$key] = $val; | ||
| } | ||
| } | ||
| return $this; | ||
| } | ||
|
|
||
|
|
||
| /** | ||
| * The HTML representation of this element | ||
| * | ||
| * @return string | ||
| */ | ||
| public function toHTML() { | ||
| if ($this->attributes['label'] === null) { | ||
| return $this->renderOptions(); | ||
| } | ||
| $html = '<optgroup '. buildAttributes($this->attrs()) . '>'; | ||
| $html .= $this->renderOptions(); | ||
| $html .= '</optgroup>'; | ||
| return $html; | ||
| } | ||
|
|
||
|
|
||
| /** | ||
| * @return string | ||
| */ | ||
| protected function renderOptions() { | ||
| $html = ''; | ||
| foreach($this->options as $key => $val) { | ||
| $selected = ($key == $this->value) ? ' selected="selected"' : ''; | ||
| $attrs = ''; | ||
| if (!empty($val['attrs']) && is_array($val['attrs'])) { | ||
| $attrs = buildAttributes($val['attrs']); | ||
| } | ||
| $html .= '<option' . $selected . ' value="' . hsc($key) . '" '.$attrs.'>' . hsc($val['label']) . '</option>'; | ||
| } | ||
| return $html; | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should it return
$thishere?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed in 2bd1d2c