You are here

class TfaSend in Two-factor Authentication (TFA) 8

Defines a TFA Send annotation object.

Hierarchy

Expanded class hierarchy of TfaSend

File

src/Annotation/TfaSend.php, line 12

Namespace

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

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

  /**
   * The human-readable name of the Tfa send.
   *
   * @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 send 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
TfaSend::$description public property The description shown to users.
TfaSend::$id public property The plugin ID.
TfaSend::$setupPluginId public property Plugin ID for user-specific setup plugin for this send plugin.
TfaSend::$title public property The human-readable name of the Tfa send.