Properties

$req

$req : \FAA\Obj\Request

Store request

Holds the request object instance

Type

\FAA\Obj\Request — A system request instance

$google

$google : \Google\Authenticator\GoogleAuthenticator

The instance of the google lib

Type

\Google\Authenticator\GoogleAuthenticator

Methods

SetupTemplate()

SetupTemplate(null  $data = null) : \FAA\Obj\Result

Getter and setter for config data

When no data is given it will read otherwise write. This method is cached by setup handler

Parameters

null $data

Returns

\FAA\Obj\Result

RegisterHooks()

RegisterHooks() : array

register system hooks Register a set of handler functions to be called in certain positions.

Returns

array —

A list of registered hooks

OnRenderLoginExtra()

OnRenderLoginExtra(  $param) 

Parameters

$param

HookArgument

OnRenderLoginExtraPre()

OnRenderLoginExtraPre(  $param) 

Parameters

$param

HookArgument

OnMapArrayIncludes()

OnMapArrayIncludes(  $param) 

Parameters

$param

HookArgument

OnWebLogin()

OnWebLogin(\FAA\Obj\Sys\HookArgument  $param) 

Called before login function when the items

Parameters

\FAA\Obj\Sys\HookArgument $param

OnRegisterWidgetIncludes()

OnRegisterWidgetIncludes(  $param) 

Parameters

$param

HookArgument

OnGetEntityAttributes()

OnGetEntityAttributes(  $reference) 

Parameters

$reference

OnPreUserRegisterSession()

OnPreUserRegisterSession(\FAA\Obj\Sys\HookArgument  $param) 

Called on after login before register the session

Parameters

\FAA\Obj\Sys\HookArgument $param

OnAfterUserLoginByPassword()

OnAfterUserLoginByPassword(\FAA\Obj\Sys\HookArgument  $param) 

Called on after login before register the session

Parameters

\FAA\Obj\Sys\HookArgument $param

OnBeforeUserAdminSave()

OnBeforeUserAdminSave(\FAA\Obj\Sys\HookArgument  $param) 

Parameters

\FAA\Obj\Sys\HookArgument $param

OnAfterRestUserPassword()

OnAfterRestUserPassword(\FAA\Obj\Sys\HookArgument  $param) 

Called on after reset before register the session

Parameters

\FAA\Obj\Sys\HookArgument $param

RequestOnUrlParsed()

RequestOnUrlParsed(\FAA\Obj\Sys\HookArgument  $param) : void

Must parse the url in an hook

Parameters

\FAA\Obj\Sys\HookArgument $param

ServeRequest()

ServeRequest(\FAA\Obj\Request  $request) : \FAA\Obj\Response

Map the url to endpoint and execute the handler function

Serve the request and return appropriate result.

Parameters

\FAA\Obj\Request $request

The http request object

Returns

\FAA\Obj\Response

sendGoogleAuthMail()

sendGoogleAuthMail(  $id) 

Parameters

$id

Confirm()

Confirm() 

Register()

Register() 

GetQrCode()

GetQrCode() 

settings()

settings() : object|null

Get the settings object

Returns

object|null

request()

request() : \FAA\Obj\Request

Get the request object

Get the registered request object.

Returns

\FAA\Obj\Request

A system http request

GA()

GA() : \Google\Authenticator\GoogleAuthenticator|null

Get the api instance

Returns

\Google\Authenticator\GoogleAuthenticator|null