class TfaSetup in Two-factor Authentication (TFA) 8

Defines a TFA Setup annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\tfa\Annotation\TfaSetup

3 classes are annotated with TfaSetup

TfaRecoveryCodeSetup in src/Plugin/TfaSetup/TfaRecoveryCodeSetup.php

TFA Recovery Code Setup Plugin.

TfaTestValidationPluginSetupPlugin in tests/modules/tfa_test_plugins/src/Plugin/TfaSetup/TfaTestValidationPluginSetupPlugin.php

TFA Test Validation Plugin Setup Plugin.

TfaTrustedBrowserSetup in src/Plugin/TfaSetup/TfaTrustedBrowserSetup.php

TFA Trusted Browser Setup Plugin.

File

src/Annotation/TfaSetup.php, line 12

Namespace

Drupal\tfa\Annotation

class TfaSetup extends Plugin {

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

  /**
   * The human-readable name of the Tfa setup.
   *
   * @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;

  /**
   * The helper metadata for setup plugin.
   *
   * @var string[]
   */
  public $helpLinks;

  /**
   * The messages to be displayed during setup steps.
   *
   * @var string[]
   */
  public $setupMessages;

}

Members

Name	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
TfaSetup::$description	public	property	The description shown to users.
TfaSetup::$helpLinks	public	property	The helper metadata for setup plugin.
TfaSetup::$id	public	property	The plugin ID.
TfaSetup::$setupMessages	public	property	The messages to be displayed during setup steps.
TfaSetup::$title	public	property	The human-readable name of the Tfa setup.