Référence de la classe Email

Graphe d'héritage de Email:

Fonctions membres publiques
	onUserMultifactorGetMethod (GetMethod $event)
Fonctions membres publiques hérités de CMSPlugin
	__construct (&$subject, $config=array())
	loadLanguage ($extension='', $basePath=JPATH_ADMINISTRATOR)
	setApplication (CMSApplicationInterface $application)
Fonctions membres publiques hérités de DispatcherAwareInterface
	setDispatcher (DispatcherInterface $dispatcher)
Fonctions membres publiques hérités de PluginInterface
	registerListeners ()

Fonctions membres publiques statiques
static	getSubscribedEvents ()

Attributs protégés
	$allowLegacyListeners = false
	$autoloadLanguage = true
Attributs protégés hérités de CMSPlugin
	$_name = null
	$_type = null
	$autoloadLanguage = false
	$allowLegacyListeners = true

Fonctions membres privées
	decodeRecordOptions (MfaTable $record)
	sendCode (string $key, ?User $user=null)

Attributs privés
const	CODE_LENGTH = 6
const	SECRET_KEY_LENGTH = 20
	$mfaMethodName = 'email'

Membres hérités additionnels
Champs de données hérités de CMSPlugin
	$params = null
Fonctions membres protégées hérités de CMSPlugin
	registerLegacyListener (string $methodName)
	registerListener (string $methodName)
	getApplication ()

Description détaillée

Joomla! Multi-factor Authentication using a Validation Code sent by Email.

Requires entering a 6-digit code sent to the user through email. These codes change automatically on a frequency set in the plugin options (30 seconds to 5 minutes, default 2 minutes).

Depuis

4.2.0

Documentation des fonctions membres

decodeRecordOptions()

decodeRecordOptions ( MfaTable  $record )

private

Decodes the options from a record into an options object.

Paramètres

MfaTable

$record

The record to decode

Renvoie

array

Depuis

4.2.0

Références $options.

getSubscribedEvents()

static getSubscribedEvents ( )

static

Returns an array of events this subscriber will listen to.

Renvoie

array

Depuis

4.2.0

Implémente SubscriberInterface.

onUserMultifactorGetMethod()

onUserMultifactorGetMethod

(

GetMethod

$event

)

Gets the identity of this MFA Method

Paramètres

GetMethod

$event

The event we are handling

Renvoie

void

Depuis

4.2.0

Références Text\_(), et ResultAwareInterface\addResult().

sendCode()

sendCode ( string  $key, ?User  $user = null  )

private

Creates a new TOTP code based on secret key $key and sends it to the user via email.

Paramètres

string	$key	The TOTP secret key
User | null	$user	The Joomla! user to use

Renvoie

void

Exceptions

Exception

Depuis

4.2.0

Références $key, $subject, $user, $value, Text\_(), Log\add(), MailTemplate\addRecipient(), Uri\base(), class, Factory\getContainer(), Factory\getMailer(), et Log\WARNING.

Documentation des champs

$allowLegacyListeners

$allowLegacyListeners = false

protected

$autoloadLanguage

$autoloadLanguage = true

protected

$mfaMethodName

$mfaMethodName = 'email'

private

CODE_LENGTH

const CODE_LENGTH = 6

private

Generated OTP length. Constant: 6 numeric digits.

Depuis

4.2.0

SECRET_KEY_LENGTH

const SECRET_KEY_LENGTH = 20

private

Length of the secret key used for generating the OTPs. Constant: 20 characters.

Depuis

4.2.0

---

La documentation de cette classe a été générée à partir du fichier suivant :

• plugins/multifactorauth/email/src/Extension/Email.php