class CaptchaService in CAPTCHA 8

Helper service for CAPTCHA module.

Hierarchy

• class \Drupal\captcha\Service\CaptchaService uses StringTranslationTrait

2 files declare their use of CaptchaService

CaptchaPointForm.php in src/Form/CaptchaPointForm.php

CaptchaSettingsForm.php in src/Form/CaptchaSettingsForm.php

1 string reference to 'CaptchaService'

captcha.services.yml in ./captcha.services.yml

captcha.services.yml

1 service uses CaptchaService

captcha.helper in ./captcha.services.yml

Drupal\captcha\Service\CaptchaService

File

src/Service/CaptchaService.php, line 10

Namespace

Drupal\captcha\Service

class CaptchaService {
  use StringTranslationTrait;

  /**
   * Return an array with the available CAPTCHA types.
   *
   * For use as options array for a select form elements.
   *
   * @param bool $add_special_options
   *   If true: also add the 'default' option.
   *
   * @return array
   *   An associative array mapping "$module/$type" to
   *   "$type (from module $module)" with $module the module name
   *   implementing the CAPTCHA and $type the name of the CAPTCHA type.
   */
  public function getAvailableChallengeTypes(bool $add_special_options = TRUE) {
    $challenges = [];
    if ($add_special_options) {
      $challenges['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) {
          $challenges["{$module}/{$type}"] = $this
            ->t('@type (from module @module)', [
            '@type' => $type,
            '@module' => $module,
          ]);
        }
      }
    }
    return $challenges;
  }

  /**
   * Helper function to insert a CAPTCHA element before a given form element.
   *
   * @param array $form
   *   the form to add the CAPTCHA element to.
   * @param array $placement
   *   information where the CAPTCHA element should be inserted.
   *   $placement should be an associative array with fields:
   *     - 'path': path (array of path items) of the container in
   *       the form where the CAPTCHA element should be inserted.
   *     - 'key': the key of the element before which the CAPTCHA element
   *       should be inserted. If the field 'key' is undefined or NULL,
   *       the CAPTCHA will just be appended in the container.
   *     - 'weight': if 'key' is not NULL: should be the weight of the
   *       element defined by 'key'. If 'key' is NULL and weight is not NULL:
   *       set the weight property of the CAPTCHA element to this value.
   * @param array $captcha_element
   *   the CAPTCHA element to insert.
   */
  public function insertCaptchaElement(array &$form, array $placement, array $captcha_element) {

    // Get path, target and target weight or use defaults if not available.
    $target_key = isset($placement['key']) ? $placement['key'] : NULL;
    $target_weight = isset($placement['weight']) ? $placement['weight'] : NULL;
    $path = isset($placement['path']) ? $placement['path'] : [];

    // Walk through the form along the path.
    $form_stepper =& $form;
    foreach ($path as $step) {
      if (isset($form_stepper[$step])) {
        $form_stepper =& $form_stepper[$step];
      }
      else {

        // Given path is invalid: stop stepping and
        // continue in best effort (append instead of insert).
        $target_key = NULL;
        break;
      }
    }

    // If no target is available: just append the CAPTCHA element
    // to the container.
    if ($target_key == NULL || !array_key_exists($target_key, $form_stepper)) {

      // Optionally, set weight of CAPTCHA element.
      if ($target_weight != NULL) {
        $captcha_element['#weight'] = $target_weight;
      }
      $form_stepper['captcha'] = $captcha_element;
    }
    else {

      // If target has a weight: set weight of CAPTCHA element a bit smaller
      // and just append the CAPTCHA: sorting will fix the ordering anyway.
      if ($target_weight != NULL) {
        $captcha_element['#weight'] = $target_weight - 0.1;
        $form_stepper['captcha'] = $captcha_element;
      }
      else {

        // If we can't play with weights: insert the CAPTCHA element
        // at the right position. Because PHP lacks a function for
        // this (array_splice() comes close, but it does not preserve
        // the key of the inserted element), we do it by hand: chop of
        // the end, append the CAPTCHA element and put the end back.
        $offset = array_search($target_key, array_keys($form_stepper));
        $end = array_splice($form_stepper, $offset);
        $form_stepper['captcha'] = $captcha_element;
        foreach ($end as $k => $v) {
          $form_stepper[$k] = $v;
        }
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CaptchaService::getAvailableChallengeTypes	public	function	Return an array with the available CAPTCHA types.
CaptchaService::insertCaptchaElement	public	function	Helper function to insert a CAPTCHA element before a given form element.
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.