[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/administrator/components/com_users/src/Helper/ -> Mfa.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: 361 lines (12 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 6 functions

  getConfigurationInterface()
  getMfaMethods()
  canAddEditMethod()
  canDeleteMethod()
  getUserMfaRecords()
  canShowConfigurationInterface()

Functions
Functions that are not part of a class:

getConfigurationInterface(User $user)   X-Ref
Get the HTML for the Multi-factor Authentication configuration interface for a user.

This helper method uses a sort of primitive HMVC to display the com_users' Methods page which
renders the MFA configuration interface.

param: User  $user  The user we are going to show the configuration UI for.
return: string|null  The HTML of the UI; null if we cannot / must not show it.

getMfaMethods()   X-Ref
Get a list of all of the MFA Methods

return: MethodDescriptor[]

canAddEditMethod(?User $user = null)   X-Ref
Is the current user allowed to add/edit MFA methods for $user?

This is only allowed if I am adding / editing methods for myself.

If the target user is a member of any group disallowed to use MFA this will return false.

param: User|null  $user  The user you want to know if we're allowed to edit
return: boolean

canDeleteMethod(?User $user = null)   X-Ref
Is the current user allowed to delete MFA methods / disable MFA for $user?

This is allowed if:
- The user being queried is the same as the logged-in user
- The logged-in user is a Super User AND the queried user is NOT a Super User.

Note that Super Users can be edited by their own user only for security reasons. If a Super
User gets locked out they must use the Backup Codes to regain access. If that's not possible,
they will need to delete their records from the `#__user_mfa` table.

param: User|null  $user  The user being queried.
return: boolean

getUserMfaRecords(?int $userId)   X-Ref
Return all MFA records for a specific user

param: int|null  $userId  User ID. NULL for currently logged in user.
return: MfaTable[]

canShowConfigurationInterface(?User $user = null)   X-Ref
No description



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