class WebformExampleElement in Webform 8.5
Same name in this branch
- 8.5 modules/webform_example_element/src/Element/WebformExampleElement.php \Drupal\webform_example_element\Element\WebformExampleElement
- 8.5 modules/webform_example_element/src/Plugin/WebformElement/WebformExampleElement.php \Drupal\webform_example_element\Plugin\WebformElement\WebformExampleElement
Same name and namespace in other branches
- 6.x modules/webform_example_element/src/Element/WebformExampleElement.php \Drupal\webform_example_element\Element\WebformExampleElement
Provides a 'webform_example_element'.
Webform elements are just wrappers around form elements, therefore every webform element must have correspond FormElement.
Below is the definition for a custom 'webform_example_element' which just renders a simple text field.
Plugin annotation
@FormElement("webform_example_element");
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\Core\Render\Element\FormElement implements FormElementInterface
- class \Drupal\webform_example_element\Element\WebformExampleElement
- class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of WebformExampleElement
See also
\Drupal\Core\Render\Element\FormElement
https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Render%21...
\Drupal\Core\Render\Element\RenderElement
https://api.drupal.org/api/drupal/namespace/Drupal%21Core%21Render%21Ele...
\Drupal\webform_example_element\Element\WebformExampleElement
File
- modules/
webform_example_element/ src/ Element/ WebformExampleElement.php, line 26
Namespace
Drupal\webform_example_element\ElementView source
class WebformExampleElement extends FormElement {
/**
* {@inheritdoc}
*/
public function getInfo() {
$class = get_class($this);
return [
'#input' => TRUE,
'#size' => 60,
'#process' => [
[
$class,
'processWebformElementExample',
],
[
$class,
'processAjaxForm',
],
],
'#element_validate' => [
[
$class,
'validateWebformExampleElement',
],
],
'#pre_render' => [
[
$class,
'preRenderWebformExampleElement',
],
],
'#theme' => 'input__webform_example_element',
'#theme_wrappers' => [
'form_element',
],
];
}
/**
* Processes a 'webform_example_element' element.
*/
public static function processWebformElementExample(&$element, FormStateInterface $form_state, &$complete_form) {
// Here you can add and manipulate your element's properties and callbacks.
return $element;
}
/**
* Webform element validation handler for #type 'webform_example_element'.
*/
public static function validateWebformExampleElement(&$element, FormStateInterface $form_state, &$complete_form) {
// Here you can add custom validation logic.
}
/**
* Prepares a #type 'email_multiple' render element for theme_element().
*
* @param array $element
* An associative array containing the properties of the element.
* Properties used: #title, #value, #description, #size, #maxlength,
* #placeholder, #required, #attributes.
*
* @return array
* The $element with prepared variables ready for theme_element().
*/
public static function preRenderWebformExampleElement(array $element) {
$element['#attributes']['type'] = 'text';
Element::setAttributes($element, [
'id',
'name',
'value',
'size',
'maxlength',
'placeholder',
]);
static::setAttributes($element, [
'form-text',
'webform-example-element',
]);
return $element;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
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 |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
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:: |
3 |
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. | 92 |
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. | 1 |
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. | |
WebformExampleElement:: |
public | function |
Returns the element properties for this element. Overrides ElementInterface:: |
|
WebformExampleElement:: |
public static | function | Prepares a #type 'email_multiple' render element for theme_element(). | |
WebformExampleElement:: |
public static | function | Processes a 'webform_example_element' element. | |
WebformExampleElement:: |
public static | function | Webform element validation handler for #type 'webform_example_element'. |