[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/plugins/multifactorauth/fixed/src/Extension/ -> Fixed.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: 308 lines (11 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Fixed:: (7 methods):
  getSubscribedEvents()
  onUserMultifactorGetMethod()
  onUserMultifactorCaptive()
  onUserMultifactorGetSetup()
  onUserMultifactorSaveSetup()
  onUserMultifactorValidate()
  decodeRecordOptions()


Class: Fixed  - X-Ref

Joomla! Multi-factor Authentication using a fixed code.

Requires a static string (password), different for each user. It effectively works as a second
password. The fixed code is stored hashed, like a regular password.

This is NOT to be used on production sites. It serves as a demonstration plugin and as a template
for developers to create their own custom Multi-factor Authentication plugins.

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. If the record does not correspond to your plugin return FALSE.

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

decodeRecordOptions(MfaTable $record)   X-Ref
Decodes the options from a record into an options object.

param: MfaTable  $record  The record to decode options for
return: object



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