class Radio in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/lib/Drupal/Core/Render/Element/Radio.php \Drupal\Core\Render\Element\Radio
Provides a form element for a single radio button.
This is an internal element that is primarily used to render the radios form element. Refer to \Drupal\Core\Render\Element\Radios for more documentation.
Plugin annotation
@FormElement("radio");
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
- class \Drupal\Core\Render\Element\Radio
- class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
Expanded class hierarchy of Radio
See also
\Drupal\Core\Render\Element\Radios
\Drupal\Core\Render\Element\Checkbox
7 #type uses of Radio
- ArgumentPluginBase::processContainerRadios in core/
modules/ views/ src/ Plugin/ views/ argument/ ArgumentPluginBase.php - Custom form radios process function.
- LanguageListBuilder::buildRow in core/
modules/ language/ src/ LanguageListBuilder.php - Builds a row for an entity in the entity listing.
- Radios::processRadios in core/
lib/ Drupal/ Core/ Render/ Element/ Radios.php - Expands a radios element into individual radio elements.
- RenderWebTest::testDrupalRenderFormElements in core/
modules/ system/ src/ Tests/ Common/ RenderWebTest.php - Tests rendering form elements without passing through \Drupal::formBuilder()->doBuildForm().
- Table::buildOptionsForm in core/
modules/ views/ src/ Plugin/ views/ style/ Table.php - Render the given style.
File
- core/
lib/ Drupal/ Core/ Render/ Element/ Radio.php, line 23 - Contains \Drupal\Core\Render\Element\Radio.
Namespace
Drupal\Core\Render\ElementView source
class Radio extends FormElement {
/**
* {@inheritdoc}
*/
public function getInfo() {
$class = get_class($this);
return array(
'#input' => TRUE,
'#default_value' => NULL,
'#process' => array(
array(
$class,
'processAjaxForm',
),
),
'#pre_render' => array(
array(
$class,
'preRenderRadio',
),
),
'#theme' => 'input__radio',
'#theme_wrappers' => array(
'form_element',
),
'#title_display' => 'after',
);
}
/**
* Prepares a #type 'radio' render element for input.html.twig.
*
* @param array $element
* An associative array containing the properties of the element.
* Properties used: #required, #return_value, #value, #attributes, #title,
* #description.
*
* Note: The input "name" attribute needs to be sanitized before output, which
* is currently done by initializing Drupal\Core\Template\Attribute with
* all the attributes.
*
* @return array
* The $element with prepared variables ready for input.html.twig.
*/
public static function preRenderRadio($element) {
$element['#attributes']['type'] = 'radio';
Element::setAttributes($element, array(
'id',
'name',
'#return_value' => 'value',
));
if (isset($element['#return_value']) && $element['#value'] !== FALSE && $element['#value'] == $element['#return_value']) {
$element['#attributes']['checked'] = 'checked';
}
static::setAttributes($element, array(
'form-radio',
));
return $element;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormElement:: |
public static | function | Adds autocomplete functionality to elements. | |
FormElement:: |
public static | function | #process callback for #pattern form element property. | |
FormElement:: |
public static | function | #element_validate callback for #pattern form element property. | |
FormElement:: |
public static | function |
Determines how user input is mapped to an element's #value property. Overrides FormElementInterface:: |
15 |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 2 |
PluginBase:: |
protected | property | The plugin implementation definition. | |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Constructs a Drupal\Component\Plugin\PluginBase object. | 69 |
Radio:: |
public | function |
Returns the element properties for this element. Overrides ElementInterface:: |
|
Radio:: |
public static | function | Prepares a #type 'radio' render element for input.html.twig. | |
RenderElement:: |
public static | function | Adds Ajax information about an element to communicate with JavaScript. | |
RenderElement:: |
public static | function | Adds members of this group as actual elements for rendering. | |
RenderElement:: |
public static | function | Form element processing handler for the #ajax form property. | |
RenderElement:: |
public static | function | Arranges elements into groups. | |
RenderElement:: |
public static | function |
Sets a form element's class attribute. Overrides ElementInterface:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |