[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/plugins/multifactorauth/email/src/Extension/ -> Email.php (summary)

(no description)

Copyright: (C) 2022 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 582 lines (21 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Email:: (9 methods):
  getSubscribedEvents()
  onUserMultifactorGetMethod()
  onUserMultifactorCaptive()
  onUserMultifactorGetSetup()
  onUserMultifactorSaveSetup()
  onUserMultifactorValidate()
  onUserMultifactorBeforeDisplayMethods()
  decodeRecordOptions()
  sendCode()


Class: Email  - X-Ref

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).

getSubscribedEvents()   X-Ref
Returns an array of events this subscriber will listen to.

return: array

onUserMultifactorGetMethod(GetMethod $event)   X-Ref
Gets the identity of this MFA Method

param: GetMethod  $event  The event we are handling
return: void

onUserMultifactorCaptive(Captive $event)   X-Ref
Returns the information which allows Joomla to render the Captive MFA page. This is the page
which appears right after you log in and asks you to validate your login with MFA.

param: Captive  $event  The event we are handling
return: void

onUserMultifactorGetSetup(GetSetup $event)   X-Ref
Returns the information which allows Joomla to render the MFA setup page. This is the page
which allows the user to add or modify a MFA Method for their user account. If the record
does not correspond to your plugin return an empty array.

param: GetSetup  $event  The event we are handling
return: void

onUserMultifactorSaveSetup(SaveSetup $event)   X-Ref
Parse the input from the MFA setup page and return the configuration information to be saved to the database. If
the information is invalid throw a RuntimeException to signal the need to display the editor page again. The
message of the exception will be displayed to the user. If the record does not correspond to your plugin return
an empty array.

param: SaveSetup  $event  The event we are handling
return: void The configuration data to save to the database

onUserMultifactorValidate(Validate $event)   X-Ref
Validates the Multi-factor Authentication code submitted by the user in the Multi-Factor
Authentication page. If the record does not correspond to your plugin return FALSE.

param: Validate  $event  The event we are handling
return: void

onUserMultifactorBeforeDisplayMethods(BeforeDisplayMethods $event)   X-Ref
Executes before showing the MFA Methods for the user. Used for the Force Enable feature.

param: BeforeDisplayMethods  $event  The event we are handling
return: void

decodeRecordOptions(MfaTable $record)   X-Ref
No description

sendCode(string $key, ?User $user = null)   X-Ref
Creates a new TOTP code based on secret key $key and sends it to the user via email.

param: string     $key   The TOTP secret key
param: User|null  $user  The Joomla! user to use
return: void



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer