interface TfaSetupPluginInterface in Two-factor Authentication (TFA) 7.2

Interface TfaSetupPluginInterface.

Setup plugins are used by TfaSetup for configuring a plugin.

Implementations of a begin plugin should also be a validation plugin.

Hierarchy

• interface \TfaSetupPluginInterface

File

./tfa.inc, line 838

TFA module classes.

interface TfaSetupPluginInterface {

  /**
   * Get setup form.
   *
   * @param array $form
   *   The form array structure.
   * @param array $form_state
   *   The current form state array.
   *
   * @return array
   *   Form array structure.
   */
  public function getSetupForm(array $form, array &$form_state);

  /**
   * Validate setup form.
   *
   * @param array $form
   *   The form array structure.
   * @param array $form_state
   *   The current form state array.
   *
   * @return bool
   *   Indicates whether the form is valid.
   */
  public function validateSetupForm(array $form, array &$form_state);

  /**
   * Submit setup form.
   *
   * @param array $form
   *   The form array structure.
   * @param array $form_state
   *   The current form state array.
   *
   * @return bool
   *   Indicates whether the form submission succeeded.
   */
  public function submitSetupForm(array $form, array &$form_state);

}

Members

Name	Modifiers	Type	Description	Overrides
TfaSetupPluginInterface::getSetupForm	public	function	Get setup form.	1
TfaSetupPluginInterface::submitSetupForm	public	function	Submit setup form.	1
TfaSetupPluginInterface::validateSetupForm	public	function	Validate setup form.	1