tool_mfa

Directories
directory	factor

Namespaces
namespace	tool_mfa
namespace	tool_mfa\event
namespace	tool_mfa\hook
namespace	tool_mfa\local
namespace	tool_mfa\local\factor
namespace	tool_mfa\local\form
namespace	tool_mfa\output
namespace	tool_mfa\plugininfo
namespace	tool_mfa\privacy
	Privacy provider.

Classes
class	tool_mfa\event\user_deleted_factor
	Event for when user factor is deleted. More...
class	tool_mfa\event\user_failed_mfa
	Event for when user successfully passed all MFA factor checks. More...
class	tool_mfa\event\user_passed_mfa
	Event for when user successfully passed all MFA factor checks. More...
class	tool_mfa\event\user_revoked_factor
	Event for when user successfully revoked MFA Factor. More...
class	tool_mfa\event\user_setup_factor
	Event for when user successfully setup new MFA Factor. More...
class	tool_mfa\hook\after_user_passed_mfa
	Allow plugins to callback as soon possible after user has passed MFA. More...
class	tool_mfa\local\admin_setting_managemfa
	Admin setting for MFA. More...
class	tool_mfa\local\factor\fallback
	Fallback factor class. More...
interface	tool_mfa\local\factor\object_factor
class	tool_mfa\local\factor\object_factor_base
	MFA factor abstract class. More...
class	tool_mfa\local\form\global_form_manager
	MFA login form. More...
class	tool_mfa\local\form\login_form
	MFA login form. More...
class	tool_mfa\local\form\reset_factor
	Form to reset gracemode timer for users. More...
class	tool_mfa\local\form\revoke_factor_form
	Revoke factor form. More...
class	tool_mfa\local\form\setup_factor_form
	Setup factor form. More...
class	tool_mfa\local\form\verification_field
	MFA Verification code element. More...
class	tool_mfa\local\secret_manager
	MFA secret management class. More...
class	tool_mfa\manager
	MFA management class. More...
class	tool_mfa\output\renderer
	MFA renderer. More...
class	tool_mfa\plugininfo\factor
	Subplugin info class. More...
class	tool_mfa\privacy\provider
	Privacy provider. More...

Functions
	tool_mfa_after_config ()
	Triggered as soon as practical on every moodle bootstrap after config has been loaded.
	tool_mfa_after_require_login ($courseorid=null, $autologinguest=null, $cm=null, $setwantsurltome=null, $preventredirect=null)
	Main hook.
	tool_mfa_bulk_user_actions ()
	Any plugin typically an admin tool can add new bulk user actions.
	tool_mfa_extend_navigation_user_settings (navigation_node $navigation, stdClass $user, $usercontext, stdClass $course, $coursecontext)
	Extends navigation bar and injects MFA Preferences menu to user preferences.
	tool_mfa_pluginfile (stdClass $course, stdClass $cm, context $context, string $filearea, array $args, bool $forcedownload, array $options=[])
	Serves any files for the guidance page.

Variables
	$capabilities
global	tool_mfa::$CFG
	$plugin = 2023100400
	$subplugins = (array) json_decode(file_get_contents($CFG->dirroot."/admin/tool/mfa/db/subplugins.json"))->plugintypes
$plugin	component = 'tool_mfa'
$plugin	maturity = MATURITY_STABLE
$plugin	version = 2023100900

Detailed Description

Function Documentation

tool_mfa_after_config()

tool_mfa_after_config

(

)

Triggered as soon as practical on every moodle bootstrap after config has been loaded.

The $USER object is available at this point too.

Return values

void

tool_mfa_after_require_login()

tool_mfa_after_require_login	(		$courseorid = null,
			$autologinguest = null,
			$cm = null,
			$setwantsurltome = null,
			$preventredirect = null )

Main hook.

e.g. Add permissions logic across a site or course

Parameters

mixed	$courseorid
mixed	$autologinguest
mixed	$cm
mixed	$setwantsurltome
mixed	$preventredirect

Return values

void

Exceptions

moodle_exception

tool_mfa_bulk_user_actions()

tool_mfa_bulk_user_actions

(

)

Any plugin typically an admin tool can add new bulk user actions.

Return values

array

tool_mfa_extend_navigation_user_settings()

tool_mfa_extend_navigation_user_settings	(	navigation_node	$navigation,
		stdClass	$user,
			$usercontext,
		stdClass	$course,
			$coursecontext )

Extends navigation bar and injects MFA Preferences menu to user preferences.

Parameters

navigation_node	$navigation
stdClass	$user
context_user	$usercontext
stdClass	$course
context_course	$coursecontext

Return values

mix	void or null

Exceptions

moodle_exception

tool_mfa_pluginfile()

tool_mfa_pluginfile	(	stdClass	$course,
		stdClass	$cm,
		context	$context,
		string	$filearea,
		array	$args,
		bool	$forcedownload,
		array	$options = [] )

Serves any files for the guidance page.

Parameters

stdClass	$course
stdClass	$cm
context	$context
string	$filearea
array	$args
bool	$forcedownload
array	$options

Return values

bool

Variable Documentation

$capabilities

$capabilities

Initial value:

= [
    'tool/mfa:mfaaccess' => [
        'captype' => 'write',
        'contextlevel' => CONTEXT_USER,
        'archetypes' => ['user' => CAP_ALLOW],
    ],
]