class WebformCard in Webform 6.x
Same name in this branch
- 6.x modules/webform_cards/src/Element/WebformCard.php \Drupal\webform_cards\Element\WebformCard
- 6.x modules/webform_cards/src/Plugin/WebformElement/WebformCard.php \Drupal\webform_cards\Plugin\WebformElement\WebformCard
Same name and namespace in other branches
- 8.5 modules/webform_cards/src/Element/WebformCard.php \Drupal\webform_cards\Element\WebformCard
Provides a render element for a card container.
Plugin annotation
@RenderElement("webform_card");
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\webform_cards\Element\WebformCard
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of WebformCard
1 #type use of WebformCard
- webform_test_test_cards_long in tests/
modules/ webform_test/ includes/ webform_test.test_cards_long.inc - Generate long webform card elements.
File
- modules/
webform_cards/ src/ Element/ WebformCard.php, line 12
Namespace
Drupal\webform_cards\ElementView source
class WebformCard extends RenderElement {
/**
* {@inheritdoc}
*/
public function getInfo() {
$class = get_class($this);
return [
'#prev_button_label' => '',
'#next_button_label' => '',
'#process' => [
[
$class,
'processGroup',
],
[
$class,
'processAjaxForm',
],
],
'#pre_render' => [
[
$class,
'preRenderWebformCard',
],
[
$class,
'preRenderGroup',
],
],
'#value' => NULL,
'#theme_wrappers' => [
'webform_card',
],
];
}
/**
* Adds form element theming to webform card.
*
* @param array $element
* An associative array containing the properties and children of the
* webform card.
*
* @return array
* The modified element.
*/
public static function preRenderWebformCard(array $element) {
$element['#attributes']['data-title'] = $element['#title'];
if (!empty($element['#webform_key'])) {
$element['#attributes']['data-webform-key'] = $element['#webform_key'];
}
if (!empty($element['#prev_button_label'])) {
$element['#attributes']['data-prev-button-label'] = $element['#prev_button_label'];
}
if (!empty($element['#next_button_label'])) {
$element['#attributes']['data-next-button-label'] = $element['#next_button_label'];
}
return $element;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
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:: |
2 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 98 |
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. | 1 |
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. | 4 |
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. | |
WebformCard:: |
public | function |
Returns the element properties for this element. Overrides ElementInterface:: |
|
WebformCard:: |
public static | function | Adds form element theming to webform card. |