You are here

class WebformExampleElement in Webform 6.x

Same name in this branch
  1. 6.x modules/webform_example_element/src/Element/WebformExampleElement.php \Drupal\webform_example_element\Element\WebformExampleElement
  2. 6.x modules/webform_example_element/src/Plugin/WebformElement/WebformExampleElement.php \Drupal\webform_example_element\Plugin\WebformElement\WebformExampleElement
Same name and namespace in other branches
  1. 8.5 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

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\Element
View 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

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FormElement::processAutocomplete public static function Adds autocomplete functionality to elements.
FormElement::processPattern public static function #process callback for #pattern form element property.
FormElement::validatePattern public static function #element_validate callback for #pattern form element property.
FormElement::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElementInterface::valueCallback 15
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 2
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 98
RenderElement::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup public static function Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm public static function Form element processing handler for the #ajax form property. 1
RenderElement::processGroup public static function Arranges elements into groups.
RenderElement::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
WebformExampleElement::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
WebformExampleElement::preRenderWebformExampleElement public static function Prepares a #type 'email_multiple' render element for theme_element().
WebformExampleElement::processWebformElementExample public static function Processes a 'webform_example_element' element.
WebformExampleElement::validateWebformExampleElement public static function Webform element validation handler for #type 'webform_example_element'.