class ImageButton
Same name in other branches
- 9 core/lib/Drupal/Core/Render/Element/ImageButton.php \Drupal\Core\Render\Element\ImageButton
- 8.9.x core/lib/Drupal/Core/Render/Element/ImageButton.php \Drupal\Core\Render\Element\ImageButton
- 10 core/lib/Drupal/Core/Render/Element/ImageButton.php \Drupal\Core\Render\Element\ImageButton
Provides a form element for a submit button with an image.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\Core\Render\Element\RenderElementBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Render\Element\ElementInterface
- class \Drupal\Core\Render\Element\FormElementBase extends \Drupal\Core\Render\Element\RenderElementBase implements \Drupal\Core\Render\Element\FormElementInterface
- class \Drupal\Core\Render\Element\Button extends \Drupal\Core\Render\Element\FormElementBase
- class \Drupal\Core\Render\Element\Submit extends \Drupal\Core\Render\Element\Button
- class \Drupal\Core\Render\Element\ImageButton extends \Drupal\Core\Render\Element\Submit
- class \Drupal\Core\Render\Element\Submit extends \Drupal\Core\Render\Element\Button
- class \Drupal\Core\Render\Element\Button extends \Drupal\Core\Render\Element\FormElementBase
- class \Drupal\Core\Render\Element\FormElementBase extends \Drupal\Core\Render\Element\RenderElementBase implements \Drupal\Core\Render\Element\FormElementInterface
- class \Drupal\Core\Render\Element\RenderElementBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Render\Element\ElementInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of ImageButton
File
-
core/
lib/ Drupal/ Core/ Render/ Element/ ImageButton.php, line 12
Namespace
Drupal\Core\Render\ElementView source
class ImageButton extends Submit {
/**
* {@inheritdoc}
*/
public function getInfo() {
$info = parent::getInfo();
unset($info['name']);
return [
'#return_value' => TRUE,
'#has_garbage_value' => TRUE,
'#src' => NULL,
'#theme_wrappers' => [
'input__image_button',
],
] + $info;
}
/**
* {@inheritdoc}
*/
public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
if ($input !== FALSE) {
if (!empty($input)) {
// If we're dealing with Mozilla or Opera, we're lucky. It will
// return a proper value, and we can get on with things.
return $element['#return_value'];
}
else {
// Unfortunately, in IE we never get back a proper value for THIS
// form element. Instead, we get back two split values: one for the
// X and one for the Y coordinates on which the user clicked the
// button. We'll find this element in the #post data, and search
// in the same spot for its name, with '_x'.
$input = $form_state->getUserInput();
foreach (explode('[', $element['#name']) as $element_name) {
// Chop off the ] that may exist.
if (str_ends_with($element_name, ']')) {
$element_name = substr($element_name, 0, -1);
}
if (!isset($input[$element_name])) {
if (isset($input[$element_name . '_x'])) {
return $element['#return_value'];
}
return NULL;
}
$input = $input[$element_name];
}
return $element['#return_value'];
}
}
}
/**
* {@inheritdoc}
*/
public static function preRenderButton($element) {
$element['#attributes']['type'] = 'image';
Element::setAttributes($element, [
'id',
'name',
'value',
]);
$element['#attributes']['src'] = \Drupal::service('file_url_generator')->generateString($element['#src']);
if (!empty($element['#title'])) {
$element['#attributes']['alt'] = $element['#title'];
$element['#attributes']['title'] = $element['#title'];
}
$element['#attributes']['class'][] = 'image-button';
if (!empty($element['#button_type'])) {
$element['#attributes']['class'][] = 'image-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
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
Button::processButton | public static | function | Processes a form button element. | ||
FormElementBase::processAutocomplete | public static | function | Adds autocomplete functionality to elements. | 1 | |
FormElementBase::processPattern | public static | function | #process callback for #pattern form element property. | 1 | |
FormElementBase::validatePattern | public static | function | #element_validate callback for #pattern form element property. | 1 | |
ImageButton::getInfo | public | function | Returns the element properties for this element. | Overrides Submit::getInfo | |
ImageButton::preRenderButton | public static | function | Prepares a #type 'button' render element for input.html.twig. | Overrides Button::preRenderButton | |
ImageButton::valueCallback | public static | function | Determines how user input is mapped to an element's #value property. | Overrides FormElementBase::valueCallback | |
PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 7 | |
PluginInspectionInterface::getPluginId | public | function | Gets the plugin ID of the plugin instance. | 3 | |
RenderElementBase::preRenderAjaxForm | public static | function | Adds Ajax information about an element to communicate with JavaScript. | 2 | |
RenderElementBase::preRenderGroup | public static | function | Adds members of this group as actual elements for rendering. | 2 | |
RenderElementBase::processAjaxForm | public static | function | Form element processing handler for the #ajax form property. | 3 | |
RenderElementBase::processGroup | public static | function | Arranges elements into groups. | 2 | |
RenderElementBase::setAttributes | public static | function | Sets a form element's class attribute. | Overrides ElementInterface::setAttributes | 2 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.