class WebformActions in Webform 6.x

Same name in this branch

6.x src/Element/WebformActions.php \Drupal\webform\Element\WebformActions
6.x src/Plugin/WebformElement/WebformActions.php \Drupal\webform\Plugin\WebformElement\WebformActions

Same name and namespace in other branches

8.5 src/Plugin/WebformElement/WebformActions.php \Drupal\webform\Plugin\WebformElement\WebformActions

Provides a 'webform_actions' element.

Plugin annotation


@WebformElement(
  id = "webform_actions",
  default_key = "actions",
  label = @Translation("Submit button(s)"),
  description = @Translation("Provides an element that contains a Webform's submit, draft, wizard, and/or preview buttons."),
  category = @Translation("Buttons"),
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\webform\Plugin\WebformElementBase implements TrustedCallbackInterface, WebformElementInterface uses MessengerTrait, StringTranslationTrait, WebformCompositeFormElementTrait, WebformEntityStorageTrait, WebformEntityInjectionTrait
  - class \Drupal\webform\Plugin\WebformElement\ContainerBase
    class \Drupal\webform\Plugin\WebformElement\WebformActions

Expanded class hierarchy of WebformActions

2 files declare their use of WebformActions

Webform.php in src/Entity/Webform.php
WebformExcludedElements.php in src/Element/WebformExcludedElements.php

File

src/Plugin/WebformElement/WebformActions.php, line 21

Namespace

Drupal\webform\Plugin\WebformElement

View source

class WebformActions extends ContainerBase {

  /**
   * {@inheritdoc}
   */
  protected function defineDefaultProperties() {
    $properties = [
      // Title.
      'title' => '',
      // Attributes.
      'attributes' => [],
    ] + $this
      ->defineDefaultBaseProperties();
    $buttons = array_merge(WebformActionsElement::$buttons, [
      'update',
    ]);
    foreach ($buttons as $button) {
      $properties[$button . '_hide'] = FALSE;
      $properties[$button . '__label'] = '';
      $properties[$button . '__attributes'] = [];
    }
    $properties['delete_hide'] = TRUE;
    $properties['delete__dialog'] = FALSE;
    return $properties;
  }

  /****************************************************************************/

  /**
   * {@inheritdoc}
   */
  public function isInput(array $element) {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function isContainer(array $element) {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function isRoot() {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  protected function build($format, array &$element, WebformSubmissionInterface $webform_submission, array $options = []) {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function getItemDefaultFormat() {
    return NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function getItemFormats() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function getTestValues(array $element, WebformInterface $webform, array $options = []) {

    // Containers should never have values and therefore should never have
    // a test value.
    return NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function preview() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function form(array $form, FormStateInterface $form_state) {
    $form = parent::form($form, $form_state);

    /** @var \Drupal\webform\WebformInterface $webform */
    $webform = $form_state
      ->getFormObject()
      ->getWebform();
    $form['actions'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Buttons'),
    ];
    $draft_enabled = $webform
      ->getSetting('draft') !== WebformInterface::DRAFT_NONE;
    $reset_enabled = $webform
      ->getSetting('form_reset');
    $wizard_enabled = $webform
      ->hasWizardPages();
    $preview_enabled = $webform
      ->getSetting('preview') !== DRUPAL_DISABLED;
    $buttons = [
      'submit' => [
        'title' => $this
          ->t('Submit'),
        'label' => $this
          ->t('submit'),
        'access' => TRUE,
      ],
      'reset' => [
        'title' => $this
          ->t('Reset'),
        'label' => $this
          ->t('reset'),
        'access' => $reset_enabled,
      ],
      'draft' => [
        'title' => $this
          ->t('Draft'),
        'label' => $this
          ->t('draft'),
        'access' => $draft_enabled,
      ],
      'update' => [
        'title' => $this
          ->t('Update'),
        'label' => $this
          ->t('update'),
        'description' => $this
          ->t('This is used after a submission has been saved and finalized to the database.'),
        'access' => !$webform
          ->isResultsDisabled(),
      ],
      'wizard_prev' => [
        'title' => $this
          ->t('Wizard previous'),
        'label' => $this
          ->t('wizard previous'),
        'description' => $this
          ->t('This is used for the previous page button within a wizard.'),
        'access' => $wizard_enabled,
      ],
      'wizard_next' => [
        'title' => $this
          ->t('Wizard next'),
        'label' => $this
          ->t('wizard next'),
        'description' => $this
          ->t('This is used for the next page button within a wizard.'),
        'access' => $wizard_enabled,
      ],
      'preview_prev' => [
        'title' => $this
          ->t('Preview previous'),
        'label' => $this
          ->t('preview previous'),
        'description' => $this
          ->t('The text for the button to go backwards from the preview page.'),
        'access' => $preview_enabled,
      ],
      'preview_next' => [
        'title' => $this
          ->t('Preview next'),
        'label' => $this
          ->t('preview next'),
        'description' => $this
          ->t('The text for the button that will proceed to the preview page.'),
        'access' => $preview_enabled,
      ],
      'delete' => [
        'title' => $this
          ->t('Delete'),
        'label' => $this
          ->t('delete'),
        'description' => $this
          ->t('This is displayed after a draft or submission has been saved to the database. The delete button is also included within the submission information.'),
        'access' => !$webform
          ->isResultsDisabled(),
      ],
    ];
    foreach ($buttons as $name => $button) {
      $t_args = [
        '@title' => $button['title'],
        '@label' => $button['label'],
        '%label' => $button['label'],
      ];
      $form[$name . '_settings'] = [
        '#type' => 'details',
        '#open' => TRUE,
        '#weight' => -10,
        '#title' => $this
          ->t('@title button', $t_args),
        '#access' => $button['access'],
      ];
      if (!empty($button['description'])) {
        $form[$name . '_settings']['description'] = [
          '#markup' => '<p>' . $button['description'] . '</p>',
          '#access' => TRUE,
        ];
      }
      $form[$name . '_settings'][$name . '_hide'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Hide @label button', $t_args),
        '#return_value' => TRUE,
      ];
      if (strpos($name, '_prev') === FALSE && !in_array($name, [
        'delete',
        'reset',
      ])) {
        $form[$name . '_settings'][$name . '_hide_message'] = [
          '#type' => 'webform_message',
          '#access' => TRUE,
          '#message_message' => $this
            ->t("Hiding the %label button can cause unexpected issues, please make sure to include the %label button using another 'Submit button(s)' element.", $t_args),
          '#message_type' => 'warning',
          '#states' => [
            'visible' => [
              ':input[name="properties[' . $name . '_hide]"]' => [
                'checked' => TRUE,
              ],
            ],
          ],
        ];
      }
      $form[$name . '_settings'][$name . '__label'] = [
        '#type' => 'textfield',
        '#title' => $this
          ->t('@title button label', $t_args),
        '#description' => $this
          ->t('Defaults to: %value', [
          '%value' => $this->configFactory
            ->get('webform.settings')
            ->get('settings.default_' . $name . '_button_label'),
        ]),
        '#size' => 20,
        '#attributes' => [
          // Make sure default value is never cleared by #states API.
          // @see js/webform.states.js
          'data-webform-states-no-clear' => TRUE,
        ],
        '#states' => [
          'visible' => [
            ':input[name="properties[' . $name . '_hide]"]' => [
              'checked' => FALSE,
            ],
          ],
        ],
      ];
      $form[$name . '_settings'][$name . '__attributes'] = [
        '#type' => 'webform_element_attributes',
        '#title' => $this
          ->t('@title button', $t_args),
        '#classes' => $this->configFactory
          ->get('webform.settings')
          ->get('settings.button_classes'),
        '#states' => [
          'visible' => [
            ':input[name="properties[' . $name . '_hide]"]' => [
              'checked' => FALSE,
            ],
          ],
        ],
      ];
    }
    $form['delete_settings']['delete__dialog'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Open delete confirmation form in a modal dialog.'),
      '#states' => [
        'visible' => [
          ':input[name="properties[delete_hide]"]' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);

    /** @var \Drupal\webform_ui\Form\WebformUiElementEditForm $form_object */
    $form_object = $form_state
      ->getFormObject();
    if (!$form_object
      ->getWebform()
      ->hasActions()) {
      $form['element']['title']['#default_value'] = (string) $this
        ->t('Submit button(s)');
    }

    // Hide element settings for default 'actions' to prevent UX confusion.
    $key = $form_object
      ->getKey() ?: $form_object
      ->getDefaultKey();
    if ($key === 'actions') {
      $form['element']['#access'] = FALSE;
    }
    return $form;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ContainerBase::defineDefaultBaseProperties	protected	function	Define default base properties used by all elements. Overrides WebformElementBase::defineDefaultBaseProperties
ContainerBase::formatCustomItem	protected	function	Format an element's item using custom HTML or plain text. Overrides WebformElementBase::formatCustomItem
ContainerBase::formatHtmlItem	protected	function	Format an element's value as HTML. Overrides WebformElementBase::formatHtmlItem	2
ContainerBase::formatTextItem	protected	function	Format an element's value as text. Overrides WebformElementBase::formatTextItem
ContainerBase::getElementSelectorOptions	public	function	Get an element's selectors as options. Overrides WebformElementBase::getElementSelectorOptions	1
ContainerBase::prepare	public	function	Prepare an element to be rendered within a webform. Overrides WebformElementBase::prepare	3
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
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.
TrustedCallbackInterface::THROW_EXCEPTION		constant	Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION		constant	Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING		constant	Untrusted callbacks trigger E_USER_WARNING errors.
WebformActions::build	protected	function	Build an element as text or HTML. Overrides ContainerBase::build
WebformActions::buildConfigurationForm	public	function	Form constructor. Overrides WebformElementBase::buildConfigurationForm
WebformActions::defineDefaultProperties	protected	function	Define an element's default properties. Overrides ContainerBase::defineDefaultProperties
WebformActions::form	public	function	Gets the actual configuration webform array to be built. Overrides ContainerBase::form
WebformActions::getItemDefaultFormat	public	function	Get an element's default single value format name. Overrides ContainerBase::getItemDefaultFormat
WebformActions::getItemFormats	public	function	Get an element's available single value formats. Overrides ContainerBase::getItemFormats
WebformActions::getTestValues	public	function	Get test values for an element. Overrides ContainerBase::getTestValues
WebformActions::isContainer	public	function	Checks if the element is a container that can contain elements. Overrides ContainerBase::isContainer
WebformActions::isInput	public	function	Checks if the element carries a value. Overrides ContainerBase::isInput
WebformActions::isRoot	public	function	Checks if the element is a root element. Overrides WebformElementBase::isRoot
WebformActions::preview	public	function	Generate a renderable preview of the element. Overrides WebformElementBase::preview
WebformCompositeFormElementTrait::preRenderWebformCompositeFormElement	public static	function	Adds form element theming to an element if its title or description is set.	1
WebformElementBase::$configFactory	protected	property	The configuration factory.
WebformElementBase::$currentUser	protected	property	The current user.
WebformElementBase::$defaultProperties	protected	property	An associative array of an element's default properties names and values.
WebformElementBase::$elementInfo	protected	property	A element info manager.
WebformElementBase::$elementManager	protected	property	The webform element manager.
WebformElementBase::$entityTypeManager	protected	property	The entity type manager. Overrides WebformEntityStorageTrait::$entityTypeManager
WebformElementBase::$librariesManager	protected	property	The webform libraries manager.
WebformElementBase::$logger	protected	property	A logger instance.
WebformElementBase::$moduleHandler	protected	property	The module handler.
WebformElementBase::$tokenManager	protected	property	The token manager.
WebformElementBase::$translatableProperties	protected	property	An indexed array of an element's translated properties.
WebformElementBase::alterForm	public	function	Alter an element's associated form. Overrides WebformElementInterface::alterForm	1
WebformElementBase::buildConfigurationFormTabs	protected	function	Build configuration form tabs.	1
WebformElementBase::buildExportHeader	public	function	Build an element's export header. Overrides WebformElementInterface::buildExportHeader	4
WebformElementBase::buildExportOptionsForm	public	function	Get an element's export options webform. Overrides WebformElementInterface::buildExportOptionsForm	4
WebformElementBase::buildExportRecord	public	function	Build an element's export row. Overrides WebformElementInterface::buildExportRecord	7
WebformElementBase::buildHtml	public	function	Build an element as HTML element. Overrides WebformElementInterface::buildHtml	2
WebformElementBase::buildText	public	function	Build an element as text element. Overrides WebformElementInterface::buildText	1
WebformElementBase::checkAccessRule	protected	function	Checks an access rule against a user account's roles and id.
WebformElementBase::checkAccessRules	public	function	Check element access (rules). Overrides WebformElementInterface::checkAccessRules
WebformElementBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	16
WebformElementBase::defineDefaultMultipleProperties	protected	function	Define default multiple properties used by most elements.	1
WebformElementBase::defineTranslatableProperties	protected	function	Define an element's translatable properties.	17
WebformElementBase::displayDisabledWarning	public	function	Display element disabled warning. Overrides WebformElementInterface::displayDisabledWarning	1
WebformElementBase::finalize	public	function	Finalize an element to be rendered within a webform. Overrides WebformElementInterface::finalize	1
WebformElementBase::format	protected	function	Format an element's value as HTML or plain text.	2
WebformElementBase::formatCustomItems	protected	function	Format an element's items using custom HTML or plain text.
WebformElementBase::formatHtml	public	function	Format an element's value as HTML. Overrides WebformElementInterface::formatHtml	2
WebformElementBase::formatHtmlItems	protected	function	Format an element's items as HTML.	2
WebformElementBase::formatTableColumn	public	function	Format an element's table column value. Overrides WebformElementInterface::formatTableColumn	4
WebformElementBase::formatText	public	function	Format an element's value as plain text. Overrides WebformElementInterface::formatText	2
WebformElementBase::formatTextItems	protected	function	Format an element's items as text.	2
WebformElementBase::getAdminLabel	public	function	Get an element's admin label (#admin_title, #title or #webform_key). Overrides WebformElementInterface::getAdminLabel
WebformElementBase::getConfigurationFormProperties	public	function	Get an associative array of element properties from configuration webform. Overrides WebformElementInterface::getConfigurationFormProperties	3
WebformElementBase::getConfigurationFormProperty	protected	function	Get configuration property value.	1
WebformElementBase::getDefaultKey	public	function	Gets the element's default key. Overrides WebformElementInterface::getDefaultKey	1
WebformElementBase::getDefaultProperties	public	function	Get default properties. Overrides WebformElementInterface::getDefaultProperties
WebformElementBase::getDefaultProperty	public	function	Get an element's default property value. Overrides WebformElementInterface::getDefaultProperty
WebformElementBase::getElementInfoDefaultProperty	protected	function	Get a render element's default property.
WebformElementBase::getElementProperty	public	function	Get an element's property value. Overrides WebformElementInterface::getElementProperty
WebformElementBase::getElementSelectorInputsOptions	protected	function	Get an element's (sub)inputs selectors as options.	9
WebformElementBase::getElementSelectorInputValue	public	function	Get an element's (sub)input selector value. Overrides WebformElementInterface::getElementSelectorInputValue	5
WebformElementBase::getElementSelectorSourceValues	public	function	Get an element's selectors source values. Overrides WebformElementInterface::getElementSelectorSourceValues	3
WebformElementBase::getElementStateOptions	public	function	Get an element's supported states as options. Overrides WebformElementInterface::getElementStateOptions	1
WebformElementBase::getExportDefaultOptions	public	function	Get an element's default export options. Overrides WebformElementInterface::getExportDefaultOptions	5
WebformElementBase::getFormElementClassDefinition	public	function	Get the Webform element's form element class definition. Overrides WebformElementInterface::getFormElementClassDefinition
WebformElementBase::getFormInlineContainer	protected	function	Get form--inline container which is used for side-by-side element layout.
WebformElementBase::getInfo	public	function	Retrieves the default properties for the defined element type. Overrides WebformElementInterface::getInfo
WebformElementBase::getItemFormat	public	function	Get element's single value format name by looking for '#format' property, global settings, and finally default settings. Overrides WebformElementInterface::getItemFormat	1
WebformElementBase::getItemsDefaultFormat	public	function	Get an element's default multiple value format name. Overrides WebformElementInterface::getItemsDefaultFormat	2
WebformElementBase::getItemsFormat	public	function	Get element's multiple value format name by looking for '#format' property, global settings, and finally default settings. Overrides WebformElementInterface::getItemsFormat
WebformElementBase::getItemsFormats	public	function	Get an element's available multiple value formats. Overrides WebformElementInterface::getItemsFormats	2
WebformElementBase::getKey	public	function	Get an element's key/name. Overrides WebformElementInterface::getKey
WebformElementBase::getLabel	public	function	Get an element's label (#title or #webform_key). Overrides WebformElementInterface::getLabel
WebformElementBase::getOffCanvasWidth	public	function	Get configuration form's off-canvas width. Overrides WebformElementInterface::getOffCanvasWidth	1
WebformElementBase::getPluginApiLink	public	function	Get link to element's API documentation. Overrides WebformElementInterface::getPluginApiLink
WebformElementBase::getPluginApiUrl	public	function	Get the URL for the element's API documentation. Overrides WebformElementInterface::getPluginApiUrl
WebformElementBase::getPluginCategory	public	function	Gets the category of the plugin instance. Overrides WebformElementInterface::getPluginCategory
WebformElementBase::getPluginDescription	public	function	Gets the description of the plugin instance. Overrides WebformElementInterface::getPluginDescription
WebformElementBase::getPluginLabel	public	function	Gets the label of the plugin instance. Overrides WebformElementInterface::getPluginLabel	3
WebformElementBase::getRawValue	public	function	Get an element's submission raw value. Overrides WebformElementInterface::getRawValue
WebformElementBase::getRelatedTypes	public	function	Get related element types. Overrides WebformElementInterface::getRelatedTypes	6
WebformElementBase::getTableColumn	public	function	Get element's table column(s) settings. Overrides WebformElementInterface::getTableColumn	4
WebformElementBase::getTranslatableProperties	public	function	Get translatable properties. Overrides WebformElementInterface::getTranslatableProperties
WebformElementBase::getTypeName	public	function	Gets the type name (aka id) of the plugin instance with the 'webform_' prefix. Overrides WebformElementInterface::getTypeName
WebformElementBase::getValue	public	function	Get an element's submission value. Overrides WebformElementInterface::getValue	1
WebformElementBase::hasCompositeFormElementWrapper	protected	function	Determine if the element has a composite field wrapper.
WebformElementBase::hasManagedFiles	public	function	Determine if the element is or includes a managed_file upload element. Overrides WebformElementInterface::hasManagedFiles	2
WebformElementBase::hasMultipleValues	public	function	Checks if the element value has multiple values. Overrides WebformElementInterface::hasMultipleValues	6
WebformElementBase::hasMultipleWrapper	public	function	Checks if the element uses the 'webform_multiple' element. Overrides WebformElementInterface::hasMultipleWrapper	3
WebformElementBase::hasProperty	public	function	Determine if the element supports a specified property. Overrides WebformElementInterface::hasProperty
WebformElementBase::hasValue	public	function	Determine if an element's has a submission value. Overrides WebformElementInterface::hasValue	2
WebformElementBase::hasWrapper	public	function	Checks if the element has a wrapper. Overrides WebformElementInterface::hasWrapper
WebformElementBase::hiddenElementAfterBuild	public static	function	Webform element #after_build callback.
WebformElementBase::initialize	public	function	Initialize an element to be displayed, rendered, or exported. Overrides WebformElementInterface::initialize	8
WebformElementBase::isComposite	public	function	Checks if the element is a composite element. Overrides WebformElementInterface::isComposite
WebformElementBase::isDisabled	public	function	Checks if the element is disabled. Overrides WebformElementInterface::isDisabled
WebformElementBase::isEmptyExcluded	public	function	Checks if an empty element is excluded. Overrides WebformElementInterface::isEmptyExcluded	1
WebformElementBase::isEnabled	public	function	Checks if the element is enabled. Overrides WebformElementInterface::isEnabled	1
WebformElementBase::isExcluded	public	function	Checks if the element is excluded via webform.settings. Overrides WebformElementInterface::isExcluded
WebformElementBase::isHidden	public	function	Checks if the element is hidden. Overrides WebformElementInterface::isHidden	2
WebformElementBase::isMultiline	public	function	Checks if the element value could contain multiple lines. Overrides WebformElementInterface::isMultiline	2
WebformElementBase::postCreate	public	function	Acts on a webform submission element after it is created. Overrides WebformElementInterface::postCreate	1
WebformElementBase::postDelete	public	function	Delete any additional value associated with an element. Overrides WebformElementInterface::postDelete	5
WebformElementBase::postLoad	public	function	Acts on loaded webform submission. Overrides WebformElementInterface::postLoad	1
WebformElementBase::postSave	public	function	Acts on a saved webform submission element before the insert or update hook is invoked. Overrides WebformElementInterface::postSave	5
WebformElementBase::preCreate	public	function	Changes the values of an entity before it is created. Overrides WebformElementInterface::preCreate	1
WebformElementBase::preDelete	public	function		1
WebformElementBase::prefixExportHeader	protected	function	Prefix an element's export header.
WebformElementBase::prepareCompositeFormElement	protected	function	Replace Core's composite #pre_render with Webform's composite #pre_render.
WebformElementBase::prepareElementPreRenderCallbacks	protected	function	Prepare an element's pre render callbacks.	3
WebformElementBase::prepareElementValidateCallbacks	protected	function	Prepare an element's validation callbacks.	8
WebformElementBase::prepareMultipleWrapper	protected	function	Set multiple element wrapper.	1
WebformElementBase::prepareWrapper	protected	function	Set an elements #states and flexbox wrapper.	1
WebformElementBase::preRenderFixFlexboxWrapper	public static	function	Fix flexbox wrapper.
WebformElementBase::preRenderFixStatesWrapper	public static	function	Fix state wrapper.
WebformElementBase::preSave	public	function	Acts on a webform submission element before the presave hook is invoked. Overrides WebformElementInterface::preSave	4
WebformElementBase::replaceTokens	public	function	Replace tokens for all element properties. Overrides WebformElementInterface::replaceTokens
WebformElementBase::setConfigurationFormDefaultValue	protected	function	Set an element's configuration webform element default value.	2
WebformElementBase::setConfigurationFormDefaultValueRecursive	protected	function	Set configuration webform default values recursively.
WebformElementBase::setDefaultValue	public	function	Set an element's default value using saved data. Overrides WebformElementInterface::setDefaultValue	7
WebformElementBase::setElementDefaultCallback	protected	function	Set element's default callback.
WebformElementBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
WebformElementBase::supportsMultipleValues	public	function	Checks if the element supports multiple values. Overrides WebformElementInterface::supportsMultipleValues	8
WebformElementBase::trustedCallbacks	public static	function	Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface::trustedCallbacks	1
WebformElementBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm	6
WebformElementBase::validateMinlength	public static	function	Form API callback. Validate element #minlength value.
WebformElementBase::validateMultiple	public static	function	Form API callback. Validate element #multiple > 1 value.
WebformElementBase::validateUnique	public static	function	Form API callback. Validate element #unique value.
WebformElementBase::validateUniqueMultiple	public static	function	Form API callback. Validate element #unique multiple values.
WebformEntityInjectionTrait::$webform	protected	property	The webform.	1
WebformEntityInjectionTrait::$webformSubmission	protected	property	The webform submission.	1
WebformEntityInjectionTrait::getWebform	public	function	Get the webform that this handler is attached to.
WebformEntityInjectionTrait::getWebformSubmission	public	function	Set webform and webform submission entity.
WebformEntityInjectionTrait::resetEntities	public	function	Reset webform and webform submission entity.
WebformEntityInjectionTrait::setEntities	public	function
WebformEntityInjectionTrait::setWebform	public	function	Set the webform that this is handler is attached to.
WebformEntityInjectionTrait::setWebformSubmission	public	function	Get the webform submission that this handler is handling.
WebformEntityStorageTrait::$entityStorageToTypeMappings	protected	property	An associate array of entity type storage aliases.
WebformEntityStorageTrait::getEntityStorage	protected	function	Retrieves the entity storage.
WebformEntityStorageTrait::getSubmissionStorage	protected	function	Retrieves the webform submission storage.
WebformEntityStorageTrait::getWebformStorage	protected	function	Retrieves the webform storage.
WebformEntityStorageTrait::__get	public	function	Implements the magic __get() method.

You are here

class WebformActions in Webform 6.x

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation