diff options
Diffstat (limited to 'includes')
| -rw-r--r-- | includes/form.inc | 22 |
1 files changed, 21 insertions, 1 deletions
diff --git a/includes/form.inc b/includes/form.inc index 5ce1c6568..3d60afee3 100644 --- a/includes/form.inc +++ b/includes/form.inc @@ -2042,12 +2042,32 @@ function _form_set_value(&$form_values, $element, $parents, $value) { } } +/** + * Allows PHP array processing of multiple select options with the same value. + * + * Used for form select elements which need to validate HTML option groups + * and multiple options which may return the same value. Associative PHP arrays + * cannot handle these structures, since they share a common key. + * + * @param $array + * The form options array to process. + * + * @return + * An array with all hierarchical elements flattened to a single array. + */ function form_options_flatten($array) { // Always reset static var when first entering the recursion. drupal_static_reset('_form_options_flatten'); return _form_options_flatten($array); } +/** + * Helper function for form_options_flatten(). + * + * Iterates over arrays which may share common values and produces a flat + * array that has removed duplicate keys. Also handles cases where objects + * are passed as array values. + */ function _form_options_flatten($array) { $return = &drupal_static(__FUNCTION__); @@ -2090,7 +2110,7 @@ function theme_select($variables) { } /** - * Convert a select form element's options array into an HTML. + * Converts a select form element's options array into an HTML. * * @param $element * An associative array containing the properties of the element. |