class TfaBasicHelp in TFA Basic plugins 7

Class TfaBasicHelp

Hierarchy

• class \TfaBasePlugin
  • class \TfaBasicHelp implements TfaValidationPluginInterface

1 string reference to 'TfaBasicHelp'

tfa_basic_tfa_api in ./tfa_basic.module

Implements hook_tfa_api().

File

includes/tfa_help.inc, line 10

class for TFA Basic

class TfaBasicHelp extends TfaBasePlugin implements TfaValidationPluginInterface {

  /**
   * @copydoc TfaBasePlugin::getForm()
   */
  public function getForm(array $form, array &$form_state) {
    $default = t('Contact support to reset your access');
    $content = variable_get('tfa_basic_help_text', $default);
    $form['help'] = array(
      '#type' => 'markup',
      '#markup' => check_plain($content),
    );

    // Disallow login plugins from applying to this step.
    $form['#tfa_no_login'] = TRUE;
    return $form;
  }

  /**
   * @copydoc TfaValidationPluginInterface::validateForm()
   */
  public function validateForm(array $form, array &$form_state) {

    // Unused.
  }

}

Members

Name	Modifiers	Type	Description	Overrides
TfaBasePlugin::$code	protected	property	TFA code.
TfaBasePlugin::$codeLength	protected	property	Code Length.
TfaBasePlugin::$context	protected	property	Context of current TFA process.
TfaBasePlugin::$encryptionKey	protected	property	Encryption key.
TfaBasePlugin::$errorMessages	protected	property	Error messages.
TfaBasePlugin::$isValid	protected	property	Code is valid.
TfaBasePlugin::CRYPT_VERSION		constant
TfaBasePlugin::decrypt	protected	function	Decrypt a encrypted string.
TfaBasePlugin::decryptLegacyDataWithMcrypt	protected	function	Decrypt using the deprecated Mcrypt extension.
TfaBasePlugin::decryptLegacyDataWithOpenSSL	protected	function	Use OpenSSL to decrypt data that was originally encrypted with Mcrypt.
TfaBasePlugin::encrypt	protected	function	Encrypt a plaintext string.
TfaBasePlugin::encryptWithMcrypt	protected	function	Encrypt using the deprecated Mcrypt extension.
TfaBasePlugin::generate	protected	function	Generate a random string of characters of length $this->codeLength.
TfaBasePlugin::getErrorMessages	public	function	Get error messages suitable for form_set_error().
TfaBasePlugin::ready	public	function	Determine if the plugin can run for the current TFA context.	2
TfaBasePlugin::submitForm	public	function	Submit form.	1
TfaBasePlugin::timingSafeEquals	private	function	A timing safe equals comparison.
TfaBasePlugin::validate	protected	function	Validate code.
TfaBasePlugin::__construct	public	function	Plugin constructor.	3
TfaBasicHelp::getForm	public	function	@copydoc TfaBasePlugin::getForm() Overrides TfaValidationPluginInterface::getForm
TfaBasicHelp::validateForm	public	function	@copydoc TfaValidationPluginInterface::validateForm() Overrides TfaValidationPluginInterface::validateForm