class WebformOptionsCustom in Webform 6.x

Same name in this branch

6.x modules/webform_options_custom/src/Element/WebformOptionsCustom.php \Drupal\webform_options_custom\Element\WebformOptionsCustom
6.x modules/webform_options_custom/src/Entity/WebformOptionsCustom.php \Drupal\webform_options_custom\Entity\WebformOptionsCustom
6.x modules/webform_options_custom/src/Plugin/WebformElement/WebformOptionsCustom.php \Drupal\webform_options_custom\Plugin\WebformElement\WebformOptionsCustom

Same name and namespace in other branches

8.5 modules/webform_options_custom/src/Plugin/WebformElement/WebformOptionsCustom.php \Drupal\webform_options_custom\Plugin\WebformElement\WebformOptionsCustom

Provides a custom options element.

Plugin annotation


@WebformElement(
  id = "webform_options_custom",
  label = @Translation("Custom element"),
  description = @Translation("Provides a form element for creating custom options using HTML and SVG markup."),
  category = @Translation("Custom elements"),
  deriver = "Drupal\webform_options_custom\Plugin\Derivative\WebformOptionsCustomDeriver"
)

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\OptionsBase uses TextBaseTrait
    class \Drupal\webform\Plugin\WebformElement\Select
    class \Drupal\webform_options_custom\Plugin\WebformElement\WebformOptionsCustom implements WebformElementAssetInterface, WebformOptionsCustomInterface

Expanded class hierarchy of WebformOptionsCustom

File

modules/webform_options_custom/src/Plugin/WebformElement/WebformOptionsCustom.php, line 27

Namespace

Drupal\webform_options_custom\Plugin\WebformElement

View source

class WebformOptionsCustom extends Select implements WebformOptionsCustomInterface, WebformElementAssetInterface {

  /**
   * {@inheritdoc}
   */
  protected function defineDefaultProperties() {
    $properties = [
      // Options settings.
      'multiple' => FALSE,
      'multiple_error' => '',
      'empty_option' => '',
      'empty_value' => '',
      'select2' => FALSE,
      'choices' => FALSE,
      'chosen' => FALSE,
      'placeholder' => '',
      'help_display' => '',
      'size' => '',
      'options_custom' => '',
      'options_description_display' => TRUE,
    ] + parent::defineDefaultProperties();
    unset($properties['options_randomize']);
    return $properties;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function initialize(array &$element) {

    // Make sure the #template property is not set by the element
    // since it allows for unfiltered HTML, CSS, and JS.
    unset($element['#template']);
  }

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

    // Remove the #template property to make sure people can't inject
    // custom markup.
    $this
      ->setOptions($element, [
      'webform_submission' => $webform_submission,
    ]);
    parent::prepare($element, $webform_submission);
  }

  /**
   * {@inheritdoc}
   */
  protected function getElementSelectorInputsOptions(array $element) {
    $this
      ->setOptions($element);
    $title = $this
      ->getAdminLabel($element);
    return [
      'select' => $title . ' [' . $this
        ->t('Select') . ']',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getElementSelectorSourceValues(array $element) {
    $this
      ->setOptions($element);
    return parent::getElementSelectorSourceValues($element);
  }

  /**
   * Build an element as text or HTML.
   *
   * @param string $format
   *   Format of the element, text or html.
   * @param array $element
   *   An element.
   * @param \Drupal\webform\WebformSubmissionInterface $webform_submission
   *   A webform submission.
   * @param array $options
   *   An array of options.
   *
   * @return array
   *   A render array representing an element as text or HTML.
   */
  protected function build($format, array &$element, WebformSubmissionInterface $webform_submission, array $options = []) {
    $this
      ->setOptions($element, [
      'webform_submission' => $webform_submission,
    ]);
    return parent::build($format, $element, $webform_submission, $options);
  }

  /**
   * {@inheritdoc}
   */
  public function form(array $form, FormStateInterface $form_state) {
    $form = parent::form($form, $form_state);
    list(, $webform_options_custom_id) = explode(':', $this
      ->getPluginId());

    /** @var \Drupal\webform_options_custom\WebformOptionsCustomInterface $webform_options_custom */
    $webform_options_custom = $this->entityTypeManager
      ->getStorage('webform_options_custom')
      ->load($webform_options_custom_id);
    $element = $webform_options_custom
      ->getElement();
    $this
      ->setOptions($element);
    $rows = [];
    foreach ($element['#options'] as $value => $text) {
      $rows[] = [
        $value,
        [
          'data' => [
            '#markup' => str_replace(WebformOptionsHelper::DESCRIPTION_DELIMITER, '<br/>', $text),
          ],
        ],
      ];
    }

    // If the custom options are defined, then the options element
    // is not required.
    if ($this
      ->hasProperty('options')) {
      $form['options']['options']['#options_description'] = TRUE;
      if ($this
        ->getEntity()
        ->getOptions() || $this
        ->getEntity()
        ->getTemplateOptions()) {
        $form['options']['options']['#type'] = 'webform_options';
        $form['options']['options']['#required'] = FALSE;
        $form['options']['options_message'] = [
          '#type' => 'webform_message',
          '#message_type' => 'info',
          '#message_message' => $this
            ->t('Below options are used to enhance and also translate the custom options.'),
          '#message_close' => TRUE,
          '#message_storage' => WebformMessage::STORAGE_SESSION,
          '#access' => TRUE,
          '#weight' => -20,
        ];
      }
    }
    if ($rows) {
      $form['options']['custom_options'] = [
        '#type' => 'details',
        '#title' => $this
          ->t('Custom options'),
        'table' => [
          '#type' => 'table',
          '#header' => [
            $this
              ->t('Option value'),
            $this
              ->t('Option text / description'),
          ],
          '#rows' => $rows,
          '#access' => TRUE,
        ],
        '#access' => TRUE,
        '#weight' => -20,
      ];
    }

    // Set help to the description.
    $form['options']['#description'] = WebformHtmlEditor::checkMarkup($webform_options_custom
      ->get('help'));

    // Do not allows options disable to be altered since this handled
    // via tooltips.
    unset($form['options']['options_display_container']);
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function preview() {
    list(, $webform_options_custom_id) = explode(':', $this
      ->getPluginId());

    /** @var \Drupal\webform_options_custom\WebformOptionsCustomInterface $webform_options_custom */
    $webform_options_custom = $this->entityTypeManager
      ->getStorage('webform_options_custom')
      ->load($webform_options_custom_id);
    return $webform_options_custom
      ->getPreview() + [
      '#title' => $webform_options_custom
        ->label(),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getTestValues(array $element, WebformInterface $webform, array $options = []) {
    $this
      ->setOptions($element);
    return array_keys($element['#options']);
  }

  /**
   * {@inheritdoc}
   */
  public function hasAssets() {
    return $this
      ->getCss() || $this
      ->getJavaScript() ? TRUE : FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function getAssetId() {
    return $this
      ->getEntity()
      ->id();
  }

  /**
   * {@inheritdoc}
   */
  public function getCss() {
    return $this
      ->getEntity()
      ->get('css');
  }

  /**
   * {@inheritdoc}
   */
  public function getJavaScript() {
    return $this
      ->getEntity()
      ->get('javascript');
  }

  /**
   * Get element custom options.
   *
   * @param array $element
   *   An element.
   * @param array $settings
   *   An array of settings used to limit and randomize options.
   */
  protected function setOptions(array &$element, array $settings = []) {

    // Set element options.
    if (!empty($element['#options'])) {
      $element['#options'] = WebformOptions::getElementOptions($element);
    }

    // Set element custom template options.
    list($type, $options_custom) = explode(':', $this
      ->getPluginId());
    $element['#type'] = $type;
    $element['#options_custom'] = $options_custom;

    /** @var \Drupal\webform_options_custom\Element\WebformOptionsCustomInterface $class */
    $class = $this
      ->getFormElementClassDefinition();
    $class::setTemplateOptions($element);
  }

  /**
   * Get webform custom options entity.
   *
   * @return \Drupal\webform_options_custom\WebformOptionsCustomInterface
   *   A webform custom options entity.
   */
  protected function getEntity() {
    list(, $webform_options_custom_id) = explode(':', $this
      ->getPluginId());
    return $this->entityTypeManager
      ->getStorage('webform_options_custom')
      ->load($webform_options_custom_id);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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::defineTranslatableProperties	protected	function	Define an element's translatable properties. Overrides WebformElementBase::defineTranslatableProperties	2
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::getElementSelectorInputValue	public	function	Get an element's (sub)input selector value. Overrides WebformElementBase::getElementSelectorInputValue	1
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::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	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.
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. 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::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	16
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::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::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::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::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.
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.
WebformOptionsCustom::build	protected	function	Build an element as text or HTML. Overrides WebformElementBase::build
WebformOptionsCustom::defineDefaultProperties	protected	function	Define an element's default properties. Overrides Select::defineDefaultProperties
WebformOptionsCustom::form	public	function	Gets the actual configuration webform array to be built. Overrides Select::form
WebformOptionsCustom::getAssetId	public	function	Returns the webform element's asset ID. Overrides WebformElementAssetInterface::getAssetId
WebformOptionsCustom::getCss	public	function	Returns the webform element's CSS. Overrides WebformElementAssetInterface::getCss
WebformOptionsCustom::getElementSelectorInputsOptions	protected	function	Get an element's (sub)inputs selectors as options. Overrides OptionsBase::getElementSelectorInputsOptions
WebformOptionsCustom::getElementSelectorSourceValues	public	function	Get an element's selectors source values. Overrides OptionsBase::getElementSelectorSourceValues
WebformOptionsCustom::getEntity	protected	function	Get webform custom options entity.
WebformOptionsCustom::getJavaScript	public	function	Returns the webform element's JavaScript. Overrides WebformElementAssetInterface::getJavaScript
WebformOptionsCustom::getTestValues	public	function	Get test values for an element. Overrides WebformElementBase::getTestValues
WebformOptionsCustom::hasAssets	public	function	Determine if the element has assets. Overrides WebformElementAssetInterface::hasAssets
WebformOptionsCustom::initialize	public	function	Initialize an element to be displayed, rendered, or exported. Overrides WebformElementBase::initialize
WebformOptionsCustom::prepare	public	function	Prepare an element to be rendered within a webform. Overrides Select::prepare
WebformOptionsCustom::preview	public	function	Generate a renderable preview of the element. Overrides OptionsBase::preview
WebformOptionsCustom::setOptions	protected	function	Get element custom options.
WebformOptionsCustom::supportsMultipleValues	public	function	Checks if the element supports multiple values. Overrides Select::supportsMultipleValues

You are here

class WebformOptionsCustom in Webform 6.x

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation