class WebformExampleComposite in Webform 6.x

Provides a 'webform_example_composite'.

Webform composites contain a group of sub-elements.

IMPORTANT: Webform composite can not contain multiple value elements (i.e. checkboxes) or composites (i.e. webform_address)

Plugin annotation

@FormElement("webform_example_composite");

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\Element\WebformCompositeBase implements WebformCompositeInterface uses WebformCompositeFormElementTrait
          • class \Drupal\webform_example_composite\Element\WebformExampleComposite

See also

\Drupal\webform\Element\WebformCompositeBase

\Drupal\webform_example_composite\Element\WebformExampleComposite

File

modules/webform_example_composite/src/Element/WebformExampleComposite.php, line 23

Namespace

Drupal\webform_example_composite\Element

class WebformExampleComposite extends WebformCompositeBase {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    return parent::getInfo() + [
      '#theme' => 'webform_example_composite',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function getCompositeElements(array $element) {
    $elements = [];
    $elements['first_name'] = [
      '#type' => 'textfield',
      '#title' => t('First name'),
    ];
    $elements['last_name'] = [
      '#type' => 'textfield',
      '#title' => t('Last name'),
    ];
    $elements['date_of_birth'] = [
      '#type' => 'date',
      '#title' => t('Date of birth'),
      // Use #after_build to add #states.
      '#after_build' => [
        [
          get_called_class(),
          'afterBuild',
        ],
      ],
    ];
    $elements['sex'] = [
      '#type' => 'select',
      '#title' => t('Sex'),
      '#options' => 'sex',
      // Use #after_build to add #states.
      '#after_build' => [
        [
          get_called_class(),
          'afterBuild',
        ],
      ],
    ];
    return $elements;
  }

  /**
   * Performs the after_build callback.
   */
  public static function afterBuild(array $element, FormStateInterface $form_state) {

    // Add #states targeting the specific element and table row.
    preg_match('/^(.+)\\[[^]]+]$/', $element['#name'], $match);
    $composite_name = $match[1];
    $element['#states']['disabled'] = [
      [
        ':input[name="' . $composite_name . '[first_name]"]' => [
          'empty' => TRUE,
        ],
      ],
      [
        ':input[name="' . $composite_name . '[last_name]"]' => [
          'empty' => TRUE,
        ],
      ],
    ];

    // Add .js-form-wrapper to wrapper (ie td) to prevent #states API from
    // disabling the entire table row when this element is disabled.
    $element['#wrapper_attributes']['class'][] = 'js-form-wrapper';
    return $element;
  }

}

Members

Name	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.
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.
WebformCompositeBase::initializeCompositeElements	public static	function	Initialize a composite's elements. Overrides WebformCompositeInterface::initializeCompositeElements
WebformCompositeBase::initializeCompositeElementsRecursive	protected static	function	Initialize a composite's elements recursively.
WebformCompositeBase::preRenderCompositeFormElement	public static	function
WebformCompositeBase::processWebformComposite	public static	function	Processes a composite webform element.	2
WebformCompositeBase::processWebformCompositeElementsRecursive	public static	function	Recursively processes a composite's elements.
WebformCompositeBase::validateWebformComposite	public static	function	Validates a composite element.
WebformCompositeBase::valueCallback	public static	function	Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback
WebformCompositeFormElementTrait::preRenderWebformCompositeFormElement	public static	function	Adds form element theming to an element if its title or description is set.	1
WebformExampleComposite::afterBuild	public static	function	Performs the after_build callback.
WebformExampleComposite::getCompositeElements	public static	function	Get a renderable array of webform elements. Overrides WebformCompositeBase::getCompositeElements
WebformExampleComposite::getInfo	public	function	Returns the element properties for this element. Overrides WebformCompositeBase::getInfo