\FAA\Plugin\PasswordResetHandler

Summary

Methods

Properties

Constants

SetupTemplate()
RegisterHooks()
RequestOnUrlParsed()
ServeRequest()
ResetPasswordInit()
ResetPassword()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

Request()

$req
$config
$is_system
$config_file

N/A

Properties

$req

$req :\FAA\Obj\Request

Store request

Holds the request object instance

Type

\FAA\Obj\Request—A system request instance

$config

$config :\stdClass

Store configuration Holds the configuration object instance

Type

\stdClass—A simple object

$is_system

$is_system :boolean

Is system call Hold information if this is the system handler

Type

boolean—Is system

$config_file

$config_file :string

Type

string—The config file name

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 hooks to register

RequestOnUrlParsed()

RequestOnUrlParsed(  $param): void

Must parse the url in an hook

Parameters

$param

HookArgument

ServeRequest()

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

Serve request Serve the request and return appropriate result.

Serve the request and return appropriate result.

Parameters

\FAA\Obj\Request

$request

The http request object

Returns

\FAA\Obj\Response —

A response object

ResetPasswordInit()

ResetPasswordInit(): \FAA\Obj\Response

Init the reset call chain Register the reset password token in the user account when found

Returns

\FAA\Obj\Response —

A system response object

ResetPassword()

ResetPassword(): \FAA\Obj\Response

Finish reset When successful set the new user password

Returns

\FAA\Obj\Response —

A system response object

Request()

Request(): \FAA\Obj\Request

Get request Get the stored request object of the http call.

Returns

\FAA\Obj\Request —

The request object