Same name and namespace in other branches
- 8.9.x core/lib/Drupal/Core/Render/Element/Button.php \Drupal\Core\Render\Element\Button
- 9 core/lib/Drupal/Core/Render/Element/Button.php \Drupal\Core\Render\Element\Button
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\Button
- 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 Button
6 string references to 'Button'
- ckeditor5.schema.yml in core/
modules/ ckeditor5/ config/ schema/ ckeditor5.schema.yml - core/modules/ckeditor5/config/schema/ckeditor5.schema.yml
- ComponentMetadataTest::dataProviderMetadata in core/
tests/ Drupal/ Tests/ Core/ Theme/ Component/ ComponentMetadataTest.php - Data provider for the test testMetadataEnforceSchema.
- FormTestDisabledElementsForm::buildForm in core/
modules/ system/ tests/ modules/ form_test/ src/ Form/ FormTestDisabledElementsForm.php - Form constructor.
- my-button.component.yml in core/
modules/ system/ tests/ modules/ sdc_test/ components/ my-button/ my-button.component.yml - core/modules/system/tests/modules/sdc_test/components/my-button/my-button.component.yml
- my-button.component.yml in core/
modules/ system/ tests/ modules/ sdc_test_replacements/ components/ my-button/ my-button.component.yml - core/modules/system/tests/modules/sdc_test_replacements/components/my-button/my-button.component.yml
File
- core/
lib/ Drupal/ Core/ Render/ Element/ Button.php, line 33
Namespace
Drupal\Core\Render\ElementView source
class Button extends FormElementBase {
/**
* {@inheritdoc}
*/
public function getInfo() {
$class = static::class;
return [
'#input' => TRUE,
'#name' => 'op',
'#is_button' => TRUE,
'#executes_submit_callback' => FALSE,
'#limit_validation_errors' => FALSE,
'#process' => [
[
$class,
'processButton',
],
[
$class,
'processAjaxForm',
],
],
'#pre_render' => [
[
$class,
'preRenderButton',
],
],
'#theme_wrappers' => [
'input__submit',
],
];
}
/**
* Processes a form button element.
*/
public static function processButton(&$element, FormStateInterface $form_state, &$complete_form) {
// If this is a button intentionally allowing incomplete form submission
// (e.g., a "Previous" or "Add another item" button), then also skip
// client-side validation.
if (isset($element['#limit_validation_errors']) && $element['#limit_validation_errors'] !== FALSE) {
$element['#attributes']['formnovalidate'] = 'formnovalidate';
}
return $element;
}
/**
* Prepares a #type 'button' render element for input.html.twig.
*
* @param array $element
* An associative array containing the properties of the element.
* Properties used: #attributes, #button_type, #name, #value. The
* #button_type property accepts any value, though core themes have CSS that
* styles the following button_types appropriately: 'primary', 'danger'.
*
* @return array
* The $element with prepared variables ready for input.html.twig.
*/
public static function preRenderButton($element) {
$element['#attributes']['type'] = 'submit';
Element::setAttributes($element, [
'id',
'name',
'value',
]);
$element['#attributes']['class'][] = 'button';
if (!empty($element['#button_type'])) {
$element['#attributes']['class'][] = 'button--' . $element['#button_type'];
}
$element['#attributes']['class'][] = 'js-form-submit';
$element['#attributes']['class'][] = 'form-submit';
if (!empty($element['#attributes']['disabled'])) {
$element['#attributes']['class'][] = 'is-disabled';
}
return $element;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
Button:: |
public | function |
Returns the element properties for this element. Overrides ElementInterface:: |
1 |
Button:: |
public static | function | Processes a form button element. | |
Button:: |
public static | function | Prepares a #type 'button' render element for input.html.twig. | 1 |
FormElementBase:: |
public static | function |
Determines how user input is mapped to an element's #value property. Overrides FormElementInterface:: |
17 |
FormElementBase:: |
public static | function | #process callback for #pattern form element property. | 1 |
FormElementBase:: |
public static | function | #element_validate callback for #pattern form element property. | 1 |
FormElementBase:: |
public static | function | Adds autocomplete functionality to elements. | 1 |
RenderElementBase:: |
public static | function |
Sets a form element's class attribute. Overrides ElementInterface:: |
2 |
RenderElementBase:: |
public static | function | Adds members of this group as actual elements for rendering. | 2 |
RenderElementBase:: |
public static | function | Form element processing handler for the #ajax form property. | 3 |
RenderElementBase:: |
public static | function | Adds Ajax information about an element to communicate with JavaScript. | 2 |
RenderElementBase:: |
public static | function | Arranges elements into groups. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
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. | 1 |
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
MessengerTrait:: |
public | function | Sets the messenger. | |
MessengerTrait:: |
public | function | Gets the messenger. | 8 |
PluginBase:: |
public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 40 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
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:: |
1 |
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 3 |
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
MessengerTrait:: |
protected | property | The messenger. | 8 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |