summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNathaniel Catchpole2016-12-19 22:01:20 (GMT)
committerNathaniel Catchpole2016-12-19 22:01:20 (GMT)
commitc6344b0673b373f2d348cd922fe3d67ddb800309 (patch)
treee13d90c987c70495a321aa6ed8992612194f618d
parent1f0a629875ae4f1b63ca218573145b3a5491081b (diff)
Issue #2721725 by Vinay15, snehi, zerbash, er.pushpinderrana, jhodgdon, xjm, Ashish.Dalvi, joachim, Kevin Davison, ckrina: Select form element has undocumented properties
-rw-r--r--core/lib/Drupal/Core/Render/Element/Date.php1
-rw-r--r--core/lib/Drupal/Core/Render/Element/Email.php1
-rw-r--r--core/lib/Drupal/Core/Render/Element/Number.php1
-rw-r--r--core/lib/Drupal/Core/Render/Element/Password.php3
-rw-r--r--core/lib/Drupal/Core/Render/Element/PasswordConfirm.php3
-rw-r--r--core/lib/Drupal/Core/Render/Element/Select.php53
-rw-r--r--core/lib/Drupal/Core/Render/Element/Table.php1
-rw-r--r--core/lib/Drupal/Core/Render/Element/Tel.php3
-rw-r--r--core/lib/Drupal/Core/Render/Element/Url.php1
9 files changed, 40 insertions, 27 deletions
diff --git a/core/lib/Drupal/Core/Render/Element/Date.php b/core/lib/Drupal/Core/Render/Element/Date.php
index dcee062..7a0801d 100644
--- a/core/lib/Drupal/Core/Render/Element/Date.php
+++ b/core/lib/Drupal/Core/Render/Element/Date.php
@@ -11,6 +11,7 @@ use Drupal\Core\Render\Element;
* 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(
diff --git a/core/lib/Drupal/Core/Render/Element/Email.php b/core/lib/Drupal/Core/Render/Element/Email.php
index 4b4da7b..2479676 100644
--- a/core/lib/Drupal/Core/Render/Element/Email.php
+++ b/core/lib/Drupal/Core/Render/Element/Email.php
@@ -10,6 +10,7 @@ use Drupal\Core\Render\Element;
*
* Properties:
* - #default_value: An RFC-compliant email address.
+ * - #size: The size of the input element in characters.
*
* Example usage:
* @code
diff --git a/core/lib/Drupal/Core/Render/Element/Number.php b/core/lib/Drupal/Core/Render/Element/Number.php
index b2fbb11..788aa1e 100644
--- a/core/lib/Drupal/Core/Render/Element/Number.php
+++ b/core/lib/Drupal/Core/Render/Element/Number.php
@@ -16,6 +16,7 @@ use Drupal\Component\Utility\Number as NumberUtility;
* - #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
diff --git a/core/lib/Drupal/Core/Render/Element/Password.php b/core/lib/Drupal/Core/Render/Element/Password.php
index e16e8bb..06d5532 100644
--- a/core/lib/Drupal/Core/Render/Element/Password.php
+++ b/core/lib/Drupal/Core/Render/Element/Password.php
@@ -8,6 +8,9 @@ use Drupal\Core\Render\Element;
/**
* 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(
diff --git a/core/lib/Drupal/Core/Render/Element/PasswordConfirm.php b/core/lib/Drupal/Core/Render/Element/PasswordConfirm.php
index 98b65ed..0d5e0e2 100644
--- a/core/lib/Drupal/Core/Render/Element/PasswordConfirm.php
+++ b/core/lib/Drupal/Core/Render/Element/PasswordConfirm.php
@@ -10,6 +10,9 @@ use Drupal\Core\Form\FormStateInterface;
* 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(
diff --git a/core/lib/Drupal/Core/Render/Element/Select.php b/core/lib/Drupal/Core/Render/Element/Select.php
index f78dfa9..b1e0f4a 100644
--- a/core/lib/Drupal/Core/Render/Element/Select.php
+++ b/core/lib/Drupal/Core/Render/Element/Select.php
@@ -14,8 +14,31 @@ use Drupal\Core\Render\Element;
* 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 @@ class Select extends FormElement {
* 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
diff --git a/core/lib/Drupal/Core/Render/Element/Table.php b/core/lib/Drupal/Core/Render/Element/Table.php
index 75bcab5..298a27f 100644
--- a/core/lib/Drupal/Core/Render/Element/Table.php
+++ b/core/lib/Drupal/Core/Render/Element/Table.php
@@ -24,6 +24,7 @@ use Drupal\Component\Utility\Html as HtmlUtility;
* 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
diff --git a/core/lib/Drupal/Core/Render/Element/Tel.php b/core/lib/Drupal/Core/Render/Element/Tel.php
index 02b071d..0909393 100644
--- a/core/lib/Drupal/Core/Render/Element/Tel.php
+++ b/core/lib/Drupal/Core/Render/Element/Tel.php
@@ -10,6 +10,9 @@ use Drupal\Core\Render\Element;
* 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(
diff --git a/core/lib/Drupal/Core/Render/Element/Url.php b/core/lib/Drupal/Core/Render/Element/Url.php
index 33d91ed..c66cadc 100644
--- a/core/lib/Drupal/Core/Render/Element/Url.php
+++ b/core/lib/Drupal/Core/Render/Element/Url.php
@@ -11,6 +11,7 @@ use Drupal\Core\Render\Element;
*
* Properties:
* - #default_value: A valid URL string.
+ * - #size: The size of the input element in characters.
*
* Usage example:
* @code