Commit c6344b06 authored by catch's avatar catch

Issue #2721725 by Vinay15, snehi, zerbash, er.pushpinderrana, jhodgdon, xjm,...

Issue #2721725 by Vinay15, snehi, zerbash, er.pushpinderrana, jhodgdon, xjm, Ashish.Dalvi, joachim, Kevin Davison, ckrina: Select form element has undocumented properties
parent 1f0a6298
......@@ -11,6 +11,7 @@
* Properties:
* - #default_value: An array with the keys: 'year', 'month', and 'day'.
* Defaults to the current date if no value is supplied.
* - #size: The size of the input element in characters.
*
* @code
* $form['expiration'] = array(
......
......@@ -10,6 +10,7 @@
*
* Properties:
* - #default_value: An RFC-compliant email address.
* - #size: The size of the input element in characters.
*
* Example usage:
* @code
......
......@@ -16,6 +16,7 @@
* - #step: Ensures that the number is an even multiple of step, offset by #min
* if specified. A #min of 1 and a #step of 2 would allow values of 1, 3, 5,
* etc.
* - #size: The size of the input element in characters.
*
* Usage example:
* @code
......
......@@ -8,6 +8,9 @@
/**
* Provides a form element for entering a password, with hidden text.
*
* Properties:
* - #size: The size of the input element in characters.
*
* Usage example:
* @code
* $form['pass'] = array(
......
......@@ -10,6 +10,9 @@
* Formats as a pair of password fields, which do not validate unless the two
* entered passwords match.
*
* Properties:
* - #size: The size of the input element in characters.
*
* Usage example:
* @code
* $form['pass'] = array(
......
......@@ -14,8 +14,31 @@
* list. If a value is an array, it will be rendered similarly, but as an
* optgroup. The key of the sub-array will be used as the label for the
* optgroup. Nesting optgroups is not allowed.
* - #empty_option: The label that will be displayed to denote no selection.
* - #empty_value: The value of the option that is used to denote no selection.
* - #empty_option: (optional) The label to show for the first default option.
* By default, the label is automatically set to "- Select -" for a required
* field and "- None -" for an optional field.
* - #empty_value: (optional) The value for the first default option, which is
* used to determine whether the user submitted a value or not.
* - If #required is TRUE, this defaults to '' (an empty string).
* - If #required is not TRUE and this value isn't set, then no extra option
* is added to the select control, leaving the control in a slightly
* illogical state, because there's no way for the user to select nothing,
* since all user agents automatically preselect the first available
* option. But people are used to this being the behavior of select
* controls.
* @todo Address the above issue in Drupal 8.
* - If #required is not TRUE and this value is set (most commonly to an
* empty string), then an extra option (see #empty_option above)
* representing a "non-selection" is added with this as its value.
* - #multiple: (optional) Indicates whether one or more options can be
* selected. Defaults to FALSE.
* - #default_value: Must be NULL or not set in case there is no value for the
* element yet, in which case a first default option is inserted by default.
* Whether this first option is a valid option depends on whether the field
* is #required or not.
* - #required: (optional) Whether the user needs to select an option (TRUE)
* or not (FALSE). Defaults to FALSE.
* - #size: The size of the input element in characters.
*
* Usage example:
* @code
......@@ -66,31 +89,7 @@ public function getInfo() {
* select lists.
*
* @param array $element
* The form element to process. Properties used:
* - #multiple: (optional) Indicates whether one or more options can be
* selected. Defaults to FALSE.
* - #default_value: Must be NULL or not set in case there is no value for the
* element yet, in which case a first default option is inserted by default.
* Whether this first option is a valid option depends on whether the field
* is #required or not.
* - #required: (optional) Whether the user needs to select an option (TRUE)
* or not (FALSE). Defaults to FALSE.
* - #empty_option: (optional) The label to show for the first default option.
* By default, the label is automatically set to "- Select -" for a required
* field and "- None -" for an optional field.
* - #empty_value: (optional) The value for the first default option, which is
* used to determine whether the user submitted a value or not.
* - If #required is TRUE, this defaults to '' (an empty string).
* - If #required is not TRUE and this value isn't set, then no extra option
* is added to the select control, leaving the control in a slightly
* illogical state, because there's no way for the user to select nothing,
* since all user agents automatically preselect the first available
* option. But people are used to this being the behavior of select
* controls.
* @todo Address the above issue in Drupal 8.
* - If #required is not TRUE and this value is set (most commonly to an
* empty string), then an extra option (see #empty_option above)
* representing a "non-selection" is added with this as its value.
* The form element to process.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
* @param array $complete_form
......
......@@ -24,6 +24,7 @@
* providing responsive tables. Defaults to TRUE.
* - #sticky: Indicates whether to add the drupal.tableheader library that makes
* table headers always visible at the top of the page. Defaults to FALSE.
* - #size: The size of the input element in characters.
*
* Usage example:
* @code
......
......@@ -10,6 +10,9 @@
* Provides an HTML5 input element with type of "tel". It provides no special
* validation.
*
* Properties:
* - #size: The size of the input element in characters.
*
* Usage example:
* @code
* $form['phone'] = array(
......
......@@ -11,6 +11,7 @@
*
* Properties:
* - #default_value: A valid URL string.
* - #size: The size of the input element in characters.
*
* Usage example:
* @code
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment