class Checkboxes in Webform 8.5

Same name and namespace in other branches

6.x src/Plugin/WebformElement/Checkboxes.php \Drupal\webform\Plugin\WebformElement\Checkboxes

Provides a 'checkboxes' element.

Plugin annotation


@WebformElement(
  id = "checkboxes",
  api = "https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Render!Element!Checkboxes.php/class/Checkboxes",
  label = @Translation("Checkboxes"),
  description = @Translation("Provides a form element for a set of checkboxes."),
  category = @Translation("Options elements"),
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\webform\Plugin\WebformElementBase implements TrustedCallbackInterface, WebformElementInterface uses MessengerTrait, StringTranslationTrait, WebformCompositeFormElementTrait, WebformEntityInjectionTrait
  - class \Drupal\webform\Plugin\WebformElement\OptionsBase uses TextBaseTrait
    class \Drupal\webform\Plugin\WebformElement\Checkboxes

Expanded class hierarchy of Checkboxes

1 file declares its use of Checkboxes

WebformElementBase.php in src/Plugin/WebformElementBase.php

3 string references to 'Checkboxes'

webform.webform.test_handler_email_mapping.yml in tests/modules/webform_test/config/install/webform.webform.test_handler_email_mapping.yml: tests/modules/webform_test/config/install/webform.webform.test_handler_email_mapping.yml
WebformCheckboxesOther::getElementSelectorOptions in src/Plugin/WebformElement/WebformCheckboxesOther.php: Get an element's selectors as options.
WebformExampleCustomFormSettingsForm::buildForm in modules/webform_example_custom_form/src/Form/WebformExampleCustomFormSettingsForm.php: Form constructor.

File

src/Plugin/WebformElement/Checkboxes.php, line 22

Namespace

Drupal\webform\Plugin\WebformElement

View source

class Checkboxes extends OptionsBase {

  /**
   * {@inheritdoc}
   */
  protected function defineDefaultProperties() {
    return [
      'multiple' => TRUE,
      'multiple_error' => '',
      // Options settings.
      'options_display' => 'one_column',
      'options_description_display' => 'description',
      'options__properties' => [],
      // Options all and none.
      'options_all' => FALSE,
      'options_all_value' => 'all',
      'options_all_text' => (string) $this
        ->t('All of the above'),
      'options_none' => FALSE,
      'options_none_value' => 'none',
      'options_none_text' => (string) $this
        ->t('None of the above'),
      // Wrapper.
      'wrapper_type' => 'fieldset',
    ] + parent::defineDefaultProperties();
  }

  /**
   * {@inheritdoc}
   */
  protected function defineTranslatableProperties() {
    return array_merge(parent::defineTranslatableProperties(), [
      'options_all_text',
      'options_none_text',
    ]);
  }

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

  /**
   * {@inheritdoc}
   */
  public function supportsMultipleValues() {
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function hasMultipleValues(array $element) {
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function initialize(array &$element) {
    parent::initialize($element);
    $option_types = [
      'options_all',
      'options_none',
    ];
    foreach ($option_types as $option_type) {
      if (!empty($element['#' . $option_type])) {
        $element['#' . $option_type . '_value'] = $this
          ->getElementProperty($element, $option_type . '_value');
        $element['#' . $option_type . '_text'] = $this
          ->getElementProperty($element, $option_type . '_text');

        // Set #options for every element except 'webform_entity_checkboxes'.
        // @see \Drupal\webform\Plugin\WebformElement\WebformEntityReferenceTrait::setOptions
        if ($element['#type'] !== 'webform_entity_checkboxes') {
          $element['#options'][$element['#' . $option_type . '_value']] = $element['#' . $option_type . '_text'];
        }
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function prepare(array &$element, WebformSubmissionInterface $webform_submission = NULL) {
    parent::prepare($element, $webform_submission);

    // Set 'data-options-all' and 'data-options-all' attribute.
    $option_types = [
      'options_all',
      'options_none',
    ];
    foreach ($option_types as $option_type) {
      if (!empty($element['#' . $option_type])) {

        // If options are randomized, make sure the 'all' and 'none' checkboxes
        // are always last.
        if (!empty($element['#options_randomize'])) {
          unset($element['#options'][$element['#' . $option_type . '_value']]);
          $element['#options'][$element['#' . $option_type . '_value']] = $element['#' . $option_type . '_text'];
        }
        $element['#wrapper_attributes']['data-' . str_replace('_', '-', $option_type)] = $element['#' . $option_type . '_value'];
      }
    }
    $element['#attached']['library'][] = 'webform/webform.element.checkboxes';
    if (!empty($element['#options_all']) || !empty($element['#options_none'])) {
      $element['#element_validate'][] = [
        get_class($this),
        'validateCheckAllOrNone',
      ];
    }
  }

  /**
   * Form API callback. Handle check all or none option.
   */
  public static function validateCheckAllOrNone(array &$element, FormStateInterface $form_state, array &$completed_form) {
    $values = $form_state
      ->getValue($element['#parents'], []);
    if (!empty($element['#options_all'])) {

      // Remove options all value.
      WebformArrayHelper::removeValue($values, $element['#options_all_value']);
    }
    elseif (!empty($element['#options_none']) && in_array($element['#options_none_value'], $values)) {

      // Only allow none option to be submitted.
      $values = [
        $element['#options_none_value'],
      ];
    }
    $form_state
      ->setValueForElement($element, $values);
  }

  /**
   * {@inheritdoc}
   */
  protected function getElementSelectorInputsOptions(array $element) {
    $selectors = $element['#options'];
    foreach ($selectors as $index => $text) {

      // Remove description from text.
      list($text) = WebformOptionsHelper::splitOption($text);

      // Append element type to text.
      $text .= ' [' . $this
        ->t('Checkbox') . ']';
      $selectors[$index] = $text;
    }
    return $selectors;
  }

  /**
   * {@inheritdoc}
   */
  public function getElementSelectorInputValue($selector, $trigger, array $element, WebformSubmissionInterface $webform_submission) {
    $input_name = WebformSubmissionConditionsValidator::getSelectorInputName($selector);
    $option_value = WebformSubmissionConditionsValidator::getInputNameAsArray($input_name, 1);
    $value = $this
      ->getRawValue($element, $webform_submission) ?: [];
    if (in_array($option_value, $value, TRUE)) {
      return in_array($trigger, [
        'checked',
        'unchecked',
      ]) ? TRUE : $value;
    }
    else {
      return in_array($trigger, [
        'checked',
        'unchecked',
      ]) ? FALSE : NULL;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getElementSelectorSourceValues(array $element) {
    return [];
  }

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

    // Checkboxes must require > 2 options.
    $form['element']['multiple']['#min'] = 2;

    // Include options all and none.
    $option_types = [
      'options_all' => $this
        ->t('All'),
      'options_none' => $this
        ->t('None'),
    ];
    foreach ($option_types as $option_type => $option_label) {
      if (!$this
        ->hasProperty($option_type)) {
        continue;
      }
      $t_args = [
        '@type' => $option_label,
      ];
      $form['options'][$option_type] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t("Include '@type of the above' option", $t_args),
        '#return_value' => TRUE,
      ];
      $form['options'][$option_type . '_container'] = $this
        ->getFormInlineContainer() + [
        '#states' => [
          'visible' => [
            [
              ':input[name="properties[' . $option_type . ']"]' => [
                'checked' => TRUE,
              ],
            ],
          ],
          'required' => [
            [
              ':input[name="properties[' . $option_type . ']"]' => [
                'checked' => TRUE,
              ],
            ],
          ],
        ],
      ];
      $form['options'][$option_type . '_container']['#attributes']['data-webform-states-no-clear'] = TRUE;
      $form['options'][$option_type . '_container'][$option_type . '_value'] = [
        '#type' => 'textfield',
        '#title' => $this
          ->t("@type option value", $t_args),
      ];
      $form['options'][$option_type . '_container'][$option_type . '_text'] = [
        '#type' => 'textfield',
        '#title' => $this
          ->t("@type option text", $t_args),
        '#attributes' => [
          'class' => [
            'webform-ui-element-form-inline--input-double-width',
          ],
        ],
      ];
    }
    return $form;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Checkboxes::defineDefaultProperties	protected	function	Define an element's default properties. Overrides OptionsBase::defineDefaultProperties	1
Checkboxes::defineTranslatableProperties	protected	function	Define an element's translatable properties. Overrides OptionsBase::defineTranslatableProperties
Checkboxes::form	public	function	Gets the actual configuration webform array to be built. Overrides OptionsBase::form
Checkboxes::getElementSelectorInputsOptions	protected	function	Get an element's (sub)inputs selectors as options. Overrides OptionsBase::getElementSelectorInputsOptions
Checkboxes::getElementSelectorInputValue	public	function	Get an element's (sub)input selector value. Overrides OptionsBase::getElementSelectorInputValue	1
Checkboxes::getElementSelectorSourceValues	public	function	Get an element's selectors source values. Overrides OptionsBase::getElementSelectorSourceValues
Checkboxes::hasMultipleValues	public	function	Checks if the element value has multiple values. Overrides WebformElementBase::hasMultipleValues
Checkboxes::initialize	public	function	Initialize an element to be displayed, rendered, or exported. Overrides WebformElementBase::initialize
Checkboxes::prepare	public	function	Prepare an element to be rendered within a webform. Overrides OptionsBase::prepare
Checkboxes::supportsMultipleValues	public	function	Checks if the element supports multiple values. Overrides WebformElementBase::supportsMultipleValues
Checkboxes::validateCheckAllOrNone	public static	function	Form API callback. Handle check all or none option.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
OptionsBase::$exportDelta	protected	property	Export delta for multiple options.	2
OptionsBase::$otherOptionType	protected	property	The other option base element type.
OptionsBase::buildExportHeader	public	function	Build an element's export header. Overrides WebformElementBase::buildExportHeader
OptionsBase::buildExportOptionsForm	public	function	Get an element's export options webform. Overrides WebformElementBase::buildExportOptionsForm
OptionsBase::buildExportRecord	public	function	Build an element's export row. Overrides WebformElementBase::buildExportRecord
OptionsBase::formatHtmlItem	protected	function	Format an element's value as HTML. Overrides WebformElementBase::formatHtmlItem	1
OptionsBase::formatHtmlItems	protected	function	Format an element's items as HTML. Overrides WebformElementBase::formatHtmlItems
OptionsBase::formatTextItem	protected	function	Format an element's value as text. Overrides WebformElementBase::formatTextItem	1
OptionsBase::formatTextItems	protected	function	Format an element's items as text. Overrides WebformElementBase::formatTextItems
OptionsBase::getElementSelectorOptions	public	function	Overrides WebformElementBase::getElementSelectorOptions	4
OptionsBase::getExportDefaultOptions	public	function	Get an element's default export options. Overrides WebformElementBase::getExportDefaultOptions
OptionsBase::getItemFormats	public	function	Get an element's available single value formats. Overrides WebformElementBase::getItemFormats	1
OptionsBase::getItemsDefaultFormat	public	function	Get an element's default multiple value format name. Overrides WebformElementBase::getItemsDefaultFormat	1
OptionsBase::getItemsFormats	public	function	Get an element's available multiple value formats. Overrides WebformElementBase::getItemsFormats	1
OptionsBase::getOptionsOtherType	protected	function	Get the other option base element type.
OptionsBase::getRelatedTypes	public	function	Get related element types. Overrides WebformElementBase::getRelatedTypes	1
OptionsBase::getTableColumn	public	function	Get element's table column(s) settings. Overrides WebformElementBase::getTableColumn
OptionsBase::hasMultipleWrapper	public	function	Checks if the element uses the 'webform_multiple' element. Overrides WebformElementBase::hasMultipleWrapper
OptionsBase::isMultiline	public	function	Checks if the element value could contain multiple lines. Overrides WebformElementBase::isMultiline
OptionsBase::isOptionsOther	protected	function	Determine if the element plugin type includes an other option text field.
OptionsBase::prepareElementValidateCallbacks	protected	function	Prepare an element's validation callbacks. Overrides WebformElementBase::prepareElementValidateCallbacks
OptionsBase::preview	public	function	Generate a renderable preview of the element. Overrides WebformElementBase::preview	2
OptionsBase::processOptionsProperties	public static	function	Processes options (custom) properties.
OptionsBase::setDefaultValue	public	function	Set an element's default value using saved data. Overrides WebformElementBase::setDefaultValue	1
OptionsBase::validateMultipleOptions	public static	function	Form API callback. Remove unchecked options from value array.
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	3
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.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.
TextBaseTrait::buildCounterForm	public	function	Build counter widget used by text elements and other element.
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.
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.
WebformElementBase::$librariesManager	protected	property	The webform libraries manager.
WebformElementBase::$logger	protected	property	A logger instance.
WebformElementBase::$submissionStorage	protected	property	The webform submission storage.
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::build	protected	function	Build an element as text or HTML.	4
WebformElementBase::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm	3
WebformElementBase::buildConfigurationFormTabs	protected	function	Build configuration form tabs.	1
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	2
WebformElementBase::defineDefaultBaseProperties	protected	function	Define default base properties used by all elements.	4
WebformElementBase::defineDefaultMultipleProperties	protected	function	Define default multiple properties used by most elements.	1
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::formatCustomItem	protected	function	Format an element's item using custom 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::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::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::getDefaultBaseProperties Deprecated	protected	function	Get default base properties used by all elements.
WebformElementBase::getDefaultKey	public	function	Gets the element's default key. Overrides WebformElementInterface::getDefaultKey	1
WebformElementBase::getDefaultMultipleProperties Deprecated	protected	function	Get default multiple properties used by most elements.
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::getElementStateOptions	public	function	Get an element's supported states as options. Overrides WebformElementInterface::getElementStateOptions	1
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::getItemDefaultFormat	public	function	Get an element's default single value format name. Overrides WebformElementInterface::getItemDefaultFormat	23
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::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::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::getTestValues	public	function	Get test values for an element. Overrides WebformElementInterface::getTestValues	23
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::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::isComposite	public	function	Checks if the element is a composite element. Overrides WebformElementInterface::isComposite
WebformElementBase::isContainer	public	function	Checks if the element is a container that can contain elements. Overrides WebformElementInterface::isContainer	9
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::isInput	public	function	Checks if the element carries a value. Overrides WebformElementInterface::isInput	11
WebformElementBase::isRoot	public	function	Checks if the element is a root element. Overrides WebformElementInterface::isRoot	3
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::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::setElementDefaultCallback	protected	function	Set element's default callback.
WebformElementBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
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.
WebformElementBase::__construct	public	function	Constructs a WebformElementBase object. Overrides PluginBase::__construct	2
WebformEntityInjectionTrait::$webform	protected	property	The webform.
WebformEntityInjectionTrait::$webformSubmission	protected	property	The webform submission.
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.

You are here

class Checkboxes in Webform 8.5

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation