You are here

class TfaValidation in Two-factor Authentication (TFA) 8

Defines a TFA Validation annotation object.

Hierarchy

Expanded class hierarchy of TfaValidation

2 classes are annotated with TfaValidation
TfaRecoveryCode in src/Plugin/TfaValidation/TfaRecoveryCode.php
Recovery validation class for performing recovery codes validation.
TfaTestValidationPlugin in tests/modules/tfa_test_plugins/src/Plugin/TfaValidation/TfaTestValidationPlugin.php
TFA Test Validation Plugin.

File

src/Annotation/TfaValidation.php, line 12

Namespace

Drupal\tfa\Annotation
View source
class TfaValidation extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The human-readable name of the Tfa validation.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $title;

  /**
   * The description shown to users.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description;

  /**
   * Plugin ID for user-specific setup plugin for this validation plugin.
   *
   * @var string
   */
  public $setupPluginId;

}

Members

Namesort descending Modifiers Type Description Overrides
Plugin::$definition protected property The plugin definition read from the class annotation. 1
Plugin::get public function Gets the value of an annotation. Overrides AnnotationInterface::get 5
Plugin::getClass public function Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId public function Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider public function Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse protected function Parses an annotation into its definition.
Plugin::setClass public function Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider public function Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct public function Constructs a Plugin object. 2
TfaValidation::$description public property The description shown to users.
TfaValidation::$id public property The plugin ID.
TfaValidation::$setupPluginId public property Plugin ID for user-specific setup plugin for this validation plugin.
TfaValidation::$title public property The human-readable name of the Tfa validation.