mirror of
https://github.com/kamilwylegala/cakephp2-php8.git
synced 2025-01-31 09:06:17 +00:00
Expanding the documentation related to showParents and options. Fixes #479.
This commit is contained in:
parent
5e8665cd8d
commit
8f20b12c58
1 changed files with 26 additions and 1 deletions
|
@ -1342,13 +1342,38 @@ class FormHelper extends AppHelper {
|
||||||
* ### Attributes:
|
* ### Attributes:
|
||||||
*
|
*
|
||||||
* - `showParents` - If included in the array and set to true, an additional option element
|
* - `showParents` - If included in the array and set to true, an additional option element
|
||||||
* will be added for the parent of each option group.
|
* will be added for the parent of each option group. You can set an option with the same name
|
||||||
|
* and it's key will be used for the value of the option.
|
||||||
* - `multiple` - show a multiple select box. If set to 'checkbox' multiple checkboxes will be
|
* - `multiple` - show a multiple select box. If set to 'checkbox' multiple checkboxes will be
|
||||||
* created instead.
|
* created instead.
|
||||||
* - `empty` - If true, the empty select option is shown. If a string,
|
* - `empty` - If true, the empty select option is shown. If a string,
|
||||||
* that string is displayed as the empty element.
|
* that string is displayed as the empty element.
|
||||||
* - `escape` - If true contents of options will be HTML entity encoded. Defaults to true.
|
* - `escape` - If true contents of options will be HTML entity encoded. Defaults to true.
|
||||||
*
|
*
|
||||||
|
* ### Using options
|
||||||
|
*
|
||||||
|
* A simple array will create normal options:
|
||||||
|
*
|
||||||
|
* {{{
|
||||||
|
* $options = array(1 => 'one', 2 => 'two);
|
||||||
|
* $this->Form->select('Model.field', $options));
|
||||||
|
* }}}
|
||||||
|
*
|
||||||
|
* While a nested options array will create optgroups with options inside them.
|
||||||
|
* {{{
|
||||||
|
* $options = array(
|
||||||
|
* 1 => 'bill',
|
||||||
|
* 'fred' => array(
|
||||||
|
* 2 => 'fred',
|
||||||
|
* 3 => 'fred jr.'
|
||||||
|
* )
|
||||||
|
* );
|
||||||
|
* $this->Form->select('Model.field', $options);
|
||||||
|
* }}}
|
||||||
|
*
|
||||||
|
* In the above `2 => 'fred'` will not generate an option element. You should enable the `showParents`
|
||||||
|
* attribute to show the fred option.
|
||||||
|
*
|
||||||
* @param string $fieldName Name attribute of the SELECT
|
* @param string $fieldName Name attribute of the SELECT
|
||||||
* @param array $options Array of the OPTION elements (as 'value'=>'Text' pairs) to be used in the
|
* @param array $options Array of the OPTION elements (as 'value'=>'Text' pairs) to be used in the
|
||||||
* SELECT element
|
* SELECT element
|
||||||
|
|
Loading…
Add table
Reference in a new issue