You are here

TfaSetup.php in Two-factor Authentication (TFA) 8

File

src/Annotation/TfaSetup.php
View source
<?php

namespace Drupal\tfa\Annotation;

use Drupal\Component\Annotation\Plugin;

/**
 * Defines a TFA Setup annotation object.
 *
 * @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;

}

Classes

Namesort descending Description
TfaSetup Defines a TFA Setup annotation object.