class Captcha in Webform 8.5

Same name and namespace in other branches

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

Provides a 'captcha' element.

Plugin annotation


@WebformElement(
  id = "captcha",
  default_key = "captcha",
  api = "https://www.drupal.org/project/captcha",
  label = @Translation("CAPTCHA"),
  description = @Translation("Provides a form element that determines whether the user is human."),
  category = @Translation("Advanced elements"),
  states_wrapper = TRUE,
  dependencies = {
    "captcha",
  }
)

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\Captcha

Expanded class hierarchy of Captcha

File

src/Plugin/WebformElement/Captcha.php, line 29

Namespace

Drupal\webform\Plugin\WebformElement

View source

class Captcha extends WebformElementBase {

  /**
   * {@inheritdoc}
   */
  protected function defineDefaultProperties() {
    return [
      // Captcha settings.
      'captcha_type' => 'default',
      'captcha_admin_mode' => FALSE,
      'captcha_title' => '',
      'captcha_description' => '',
      // Flexbox.
      'flex' => 1,
    ];
  }

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

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

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

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

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

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

    // Hide and solve the element if the user is assigned 'skip CAPTCHA'
    // and '#captcha_admin_mode' is not enabled.
    $is_admin = \Drupal::currentUser()
      ->hasPermission('skip CAPTCHA');
    if ($is_admin && empty($element['#captcha_admin_mode'])) {
      $element['#access'] = FALSE;
      $element['#captcha_admin_mode'] = TRUE;
    }

    // Always enable admin mode for test.
    $is_test = strpos(\Drupal::routeMatch()
      ->getRouteName(), '.webform.test_form') !== FALSE ? TRUE : FALSE;
    if ($is_test) {
      $element['#captcha_admin_mode'] = TRUE;
    }
    parent::prepare($element, $webform_submission);
    $element['#after_build'][] = [
      get_class($this),
      'afterBuildCaptcha',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function preview() {
    $element = parent::preview() + [
      '#captcha_admin_mode' => TRUE,
      // Define empty form id to prevent fatal error when preview is
      // rendered via Ajax.
      // @see \Drupal\captcha\Element\Captcha::processCaptchaElement
      '#captcha_info' => [
        'form_id' => '',
      ],
    ];
    if (\Drupal::moduleHandler()
      ->moduleExists('image_captcha')) {
      $element['#captcha_type'] = 'image_captcha/Image';
    }
    return $element;
  }

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

    // Remove all captcha related keys from the webform submission's data.
    $key = $element['#webform_key'];
    $data = $webform_submission
      ->getData();
    unset($data[$key]);

    // @see \Drupal\captcha\Element\Captcha
    $sub_keys = [
      'sid',
      'token',
      'response',
    ];
    foreach ($sub_keys as $sub_key) {
      unset($data[$key . '_' . $sub_key]);
    }
    $webform_submission
      ->setData($data);
  }

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

    // Issue #3090624: Call to undefined function trying to add CAPTCHA
    // element to form.
    // @see _captcha_available_challenge_types();
    // @see \Drupal\captcha\Service\CaptchaService::getAvailableChallengeTypes
    $captcha_types = [];
    $captcha_types['default'] = $this
      ->t('Default challenge type');

    // We do our own version of Drupal's module_invoke_all() here because
    // we want to build an array with custom keys and values.
    foreach (\Drupal::moduleHandler()
      ->getImplementations('captcha') as $module) {
      $result = call_user_func_array($module . '_captcha', [
        'list',
      ]);
      if (is_array($result)) {
        foreach ($result as $type) {
          $captcha_types["{$module}/{$type}"] = $this
            ->t('@type (from module @module)', [
            '@type' => $type,
            '@module' => $module,
          ]);
        }
      }
    }
    $form['captcha'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('CAPTCHA settings'),
    ];
    $form['captcha']['message'] = [
      '#type' => 'webform_message',
      '#message_type' => 'warning',
      '#message_message' => $this
        ->t('Note that the CAPTCHA module disables page caching of pages that include a CAPTCHA challenge.'),
      '#message_close' => TRUE,
      '#message_storage' => WebformMessageElement::STORAGE_SESSION,
      '#access' => TRUE,
    ];
    $form['captcha']['captcha_type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Challenge type'),
      '#required' => TRUE,
      '#options' => $captcha_types,
    ];

    // Custom title and description.
    $form['captcha']['captcha_container'] = [
      '#type' => 'container',
      '#states' => [
        'invisible' => [
          [
            ':input[name="properties[captcha_type]"]' => [
              'value' => 'recaptcha/reCAPTCHA',
            ],
          ],
        ],
      ],
    ];
    $form['captcha']['captcha_container']['captcha_title'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Question title'),
    ];
    $form['captcha']['captcha_container']['captcha_description'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Question description'),
    ];

    // Admin mode.
    $form['captcha']['captcha_admin_mode'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Admin mode'),
      '#description' => $this
        ->t('Presolve the CAPTCHA and always shows it. This is useful for debugging and preview CAPTCHA integration.'),
      '#return_value' => TRUE,
    ];
    return $form;
  }

  /**
   * After build handler for CAPTCHA elements.
   */
  public static function afterBuildCaptcha(array $element, FormStateInterface $form_state) {

    // Make sure that the CAPTCHA response supports #title.
    if (isset($element['captcha_widgets']) && isset($element['captcha_widgets']['captcha_response']) && isset($element['captcha_widgets']['captcha_response']['#title'])) {
      if (!empty($element['#captcha_title'])) {
        $element['captcha_widgets']['captcha_response']['#title'] = $element['#captcha_title'];
      }
      if (!empty($element['#captcha_description'])) {
        $element['captcha_widgets']['captcha_response']['#description'] = $element['#captcha_description'];
      }
    }

    // Add image refresh button to captcha form element.
    // @see image_captcha_after_build_process()
    if ($form_state
      ->getFormObject() instanceof WebformSubmissionForm) {
      $is_image_captcha = FALSE;
      if ($element['#captcha_type'] === 'image_captcha/Image') {
        $is_image_captcha = TRUE;
      }
      elseif ($element['#captcha_type'] === 'default') {
        $default_challenge = \Drupal::service('config.manager')
          ->getConfigFactory()
          ->get('captcha.settings')
          ->get('default_challenge');
        if ($default_challenge === 'image_captcha/Image') {
          $is_image_captcha = TRUE;
        }
      }
      if ($is_image_captcha && isset($element['#captcha_info']['form_id'])) {
        $form_id = $element['#captcha_info']['form_id'];
        $uri = Link::fromTextAndUrl(t('Get new captcha!'), new CoreUrl('image_captcha.refresh', [
          'form_id' => $form_id,
        ], [
          'attributes' => [
            'class' => [
              'reload-captcha',
            ],
          ],
        ]));
        $element['captcha_widgets']['captcha_refresh'] = [
          '#theme' => 'image_captcha_refresh',
          '#captcha_refresh_link' => $uri,
          '#parents' => array_merge($element['#parents'], [
            'captcha_widgets',
          ]),
        ];
      }
    }
    return $element;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Captcha::afterBuildCaptcha	public static	function	After build handler for CAPTCHA elements.
Captcha::defineDefaultProperties	protected	function	Define an element's default properties. Overrides WebformElementBase::defineDefaultProperties
Captcha::form	public	function	Gets the actual configuration webform array to be built. Overrides WebformElementBase::form
Captcha::getItemDefaultFormat	public	function	Get an element's default single value format name. Overrides WebformElementBase::getItemDefaultFormat
Captcha::getItemFormats	public	function	Get an element's available single value formats. Overrides WebformElementBase::getItemFormats
Captcha::isContainer	public	function	Checks if the element is a container that can contain elements. Overrides WebformElementBase::isContainer
Captcha::isInput	public	function	Checks if the element carries a value. Overrides WebformElementBase::isInput
Captcha::prepare	public	function	Prepare an element to be rendered within a webform. Overrides WebformElementBase::prepare
Captcha::preSave	public	function	Acts on a webform submission element before the presave hook is invoked. Overrides WebformElementBase::preSave
Captcha::preview	public	function	Generate a renderable preview of the element. Overrides WebformElementBase::preview
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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	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.
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::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	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::defineTranslatableProperties	protected	function	Define an element's translatable properties.	15
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::formatHtmlItem	protected	function	Format an element's value as HTML.	19
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::formatTextItem	protected	function	Format an element's value as text.	19
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::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::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::getElementSelectorOptions	public	function	Get an element's selectors as options. Overrides WebformElementInterface::getElementSelectorOptions	11
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::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::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::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::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::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.
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 Captcha in Webform 8.5

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation