class FormElementHelper
Same name in other branches
- 8.9.x core/lib/Drupal/Core/Form/FormElementHelper.php \Drupal\Core\Form\FormElementHelper
- 10 core/lib/Drupal/Core/Form/FormElementHelper.php \Drupal\Core\Form\FormElementHelper
- 11.x core/lib/Drupal/Core/Form/FormElementHelper.php \Drupal\Core\Form\FormElementHelper
Provides common functionality for form elements.
Hierarchy
- class \Drupal\Core\Form\FormElementHelper
Expanded class hierarchy of FormElementHelper
2 files declare their use of FormElementHelper
- FormElementHelperTest.php in core/
tests/ Drupal/ Tests/ Core/ Form/ FormElementHelperTest.php - FormErrorHandler.php in core/
modules/ inline_form_errors/ src/ FormErrorHandler.php
File
-
core/
lib/ Drupal/ Core/ Form/ FormElementHelper.php, line 10
Namespace
Drupal\Core\FormView source
class FormElementHelper {
/**
* Retrieves a form element.
*
* @param string $name
* The name of the form element. If the #parents property of your form
* element is ['foo', 'bar', 'baz'] then the name is 'foo][bar][baz'.
* @param array $form
* An associative array containing the structure of the form.
*
* @return array
* The form element.
*/
public static function getElementByName($name, array $form) {
foreach (Element::children($form) as $key) {
if (implode('][', $form[$key]['#parents']) === $name) {
return $form[$key];
}
elseif ($element = static::getElementByName($name, $form[$key])) {
return $element;
}
}
return [];
}
/**
* Returns the title for the element.
*
* If the element has no title, this will recurse through all children of the
* element until a title is found.
*
* @param array $element
* An associative array containing the properties of the form element.
*
* @return string
* The title of the element, or an empty string if none is found.
*/
public static function getElementTitle(array $element) {
$title = '';
if (isset($element['#title'])) {
$title = $element['#title'];
}
else {
foreach (Element::children($element) as $key) {
if ($title = static::getElementTitle($element[$key])) {
break;
}
}
}
return $title;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary |
---|---|---|---|
FormElementHelper::getElementByName | public static | function | Retrieves a form element. |
FormElementHelper::getElementTitle | public static | function | Returns the title for the element. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.