Documentation

TFASetup
in package
implements ActionInterface uses ActionTrait

Provides interface to set up two-factor authentication in SMF.

Table of Contents

Interfaces

ActionInterface
Interface for all action classes.

Properties

$obj  : static
$totp  : Auth

Methods

call()  : void
Convenience method to load() and execute() an instance of this class.
canBeLogged()  : bool
Determines whether this action can be logged in the online log.
canShowDebuggingInfo()  : bool
Determines whether debugging info should be shown.
canShowInMaintenanceMode()  : bool
Determines whether this action allows access in maintenance mode.
execute()  : void
Does the job.
getOutputType()  : OutputTypeInterface
Gets the output type for this action.
isAgreementAction()  : bool
Determines whether this action can be accessed without accepting the registration agreement and privacy policy.
isRestrictedGuestAccessAllowed()  : bool
Determines whether this action allows access if guest access is restricted.
isSimpleAction()  : bool
Determines whether this is a simple action.
load()  : static
Static wrapper for constructor.
__construct()  : mixed
Constructor. Protected to force instantiation via self::load().
generate()  : void
Generates a new TFA secret.
validateAndSave()  : void
Validates the submitted TFA secret and (if valid) saves it.

Properties

$obj

protected static static $obj

An instance of this class. This is used by the load() method to prevent multiple instantiations.

$totp

protected Auth $totp

An instance of the SMF\TOTP\Auth class.

Methods

call()

Convenience method to load() and execute() an instance of this class.

public static call() : void

canBeLogged()

Determines whether this action can be logged in the online log.

public canBeLogged() : bool
Return values
bool

canShowDebuggingInfo()

Determines whether debugging info should be shown.

public canShowDebuggingInfo() : bool
Return values
bool

canShowInMaintenanceMode()

Determines whether this action allows access in maintenance mode.

public canShowInMaintenanceMode() : bool
Return values
bool —

True if access is allowed, false otherwise.

execute()

Does the job.

public execute() : void

isAgreementAction()

Determines whether this action can be accessed without accepting the registration agreement and privacy policy.

public isAgreementAction() : bool
Return values
bool

isRestrictedGuestAccessAllowed()

Determines whether this action allows access if guest access is restricted.

public isRestrictedGuestAccessAllowed() : bool
Return values
bool —

True if access is allowed, false otherwise.

isSimpleAction()

Determines whether this is a simple action.

public isSimpleAction() : bool
Return values
bool

load()

Static wrapper for constructor.

public static load() : static
Return values
static —

An instance of this class.

__construct()

Constructor. Protected to force instantiation via self::load().

protected __construct() : mixed

generate()

Generates a new TFA secret.

protected generate() : void

validateAndSave()

Validates the submitted TFA secret and (if valid) saves it.

protected validateAndSave() : void

Shows an error message if validation failed.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results