Same name and namespace in other branches
- 8.9.x core/lib/Drupal/Core/Render/Element/Radios.php \Drupal\Core\Render\Element\Radios
- 9 core/lib/Drupal/Core/Render/Element/Radios.php \Drupal\Core\Render\Element\Radios
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\Core\Render\Element\RenderElementBase implements ElementInterface
- class \Drupal\Core\Render\Element\FormElementBase implements FormElementInterface
- class \Drupal\Core\Render\Element\Radios uses CompositeFormElementTrait
- class \Drupal\Core\Render\Element\FormElementBase implements FormElementInterface
- class \Drupal\Core\Render\Element\RenderElementBase implements ElementInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of Radios
1 file declares its use of Radios
- views_ui.theme.inc in core/
modules/ views_ui/ views_ui.theme.inc - Preprocessors and theme functions for the Views UI.
3 string references to 'Radios'
- FormTestCheckboxesRadiosForm::buildForm in core/
modules/ system/ tests/ modules/ form_test/ src/ Form/ FormTestCheckboxesRadiosForm.php - Form constructor.
- FormTestRadiosCheckedForm::buildForm in core/
modules/ system/ tests/ modules/ form_test/ src/ Form/ FormTestRadiosCheckedForm.php - Form constructor.
- FormTestValidateRequiredForm::buildForm in core/
modules/ system/ tests/ modules/ form_test/ src/ Form/ FormTestValidateRequiredForm.php - Form constructor.
File
- core/
lib/ Drupal/ Core/ Render/ Element/ Radios.php, line 37
Namespace
Drupal\Core\Render\ElementView source
class Radios extends FormElementBase {
use CompositeFormElementTrait;
/**
* {@inheritdoc}
*/
public function getInfo() {
$class = static::class;
return [
'#input' => TRUE,
'#process' => [
[
$class,
'processRadios',
],
],
'#theme_wrappers' => [
'radios',
],
'#pre_render' => [
[
$class,
'preRenderCompositeFormElement',
],
],
];
}
/**
* Expands a radios element into individual radio elements.
*/
public static function processRadios(&$element, FormStateInterface $form_state, &$complete_form) {
if (count($element['#options']) > 0) {
$weight = 0;
foreach ($element['#options'] as $key => $choice) {
// Maintain order of options as defined in #options, in case the element
// defines custom option sub-elements, but does not define all option
// sub-elements.
$weight += 0.001;
$element += [
$key => [],
];
// Generate the parents as the autogenerator does, so we will have a
// unique id for each radio button.
$parents_for_id = array_merge($element['#parents'], [
$key,
]);
$element[$key] += [
'#type' => 'radio',
'#title' => $choice,
// The key is sanitized in Drupal\Core\Template\Attribute during output
// from the theme function.
'#return_value' => $key,
// Use default or FALSE. A value of FALSE means that the radio button is
// not 'checked'.
'#default_value' => $element['#default_value'] ?? FALSE,
'#attributes' => $element['#attributes'],
'#parents' => $element['#parents'],
'#id' => HtmlUtility::getUniqueId('edit-' . implode('-', $parents_for_id)),
'#ajax' => $element['#ajax'] ?? NULL,
// Errors should only be shown on the parent radios element.
'#error_no_message' => TRUE,
'#weight' => $weight,
];
}
}
return $element;
}
/**
* {@inheritdoc}
*/
public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
if ($input !== FALSE) {
// When there's user input (including NULL), return it as the value.
// However, if NULL is submitted, FormBuilder::handleInputElement() will
// apply the default value, and we want that validated against #options
// unless it's empty. (An empty #default_value, such as NULL or FALSE, can
// be used to indicate that no radio button is selected by default.)
if (!isset($input) && !empty($element['#default_value'])) {
$element['#needs_validation'] = TRUE;
}
return $input;
}
else {
// For default value handling, simply return #default_value. Additionally,
// for a NULL default value, set #has_garbage_value to prevent
// FormBuilder::handleInputElement() converting the NULL to an empty
// string, so that code can distinguish between nothing selected and the
// selection of a radio button whose value is an empty string.
$value = $element['#default_value'] ?? NULL;
if (!isset($value)) {
$element['#has_garbage_value'] = TRUE;
}
return $value;
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 1 |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 3 |
RenderElementBase:: |
public static | function |
Sets a form element's class attribute. Overrides ElementInterface:: |
2 |
RenderElementBase:: |
public static | function | Arranges elements into groups. | 2 |
RenderElementBase:: |
public static | function | Form element processing handler for the #ajax form property. | 3 |
RenderElementBase:: |
public static | function | Adds members of this group as actual elements for rendering. | 2 |
RenderElementBase:: |
public static | function | Adds Ajax information about an element to communicate with JavaScript. | 2 |
Radios:: |
public static | function |
Determines how user input is mapped to an element's #value property. Overrides FormElementBase:: |
|
Radios:: |
public static | function | Expands a radios element into individual radio elements. | |
Radios:: |
public | function |
Returns the element properties for this element. Overrides ElementInterface:: |
|
PluginBase:: |
public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 40 |
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
1 |
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
MessengerTrait:: |
public | function | Sets the messenger. | |
MessengerTrait:: |
public | function | Gets the messenger. | 8 |
MessengerTrait:: |
protected | property | The messenger. | 8 |
FormElementBase:: |
public static | function | #element_validate callback for #pattern form element property. | 1 |
FormElementBase:: |
public static | function | #process callback for #pattern form element property. | 1 |
FormElementBase:: |
public static | function | Adds autocomplete functionality to elements. | 1 |
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
CompositeFormElementTrait:: |
public static | function | Adds form element theming to an element if its title or description is set. |