Handler
in package
implements
ServerPlugin
Implement password handler This class provides interfaces for password reset handling
Tags
Interfaces, Classes, Traits and Enums
- ServerPlugin
- Define a system plugin Extended version of plugin with additional predefined server request method
Table of Contents
- $config : stdClass|null
- Store configuration Holds the configuration object instance
- $config_file : string
- $is_system : bool
- Is system call Hold information if this is the system handler
- $req : Request|null
- Store request
- RegisterHooks() : array<string|int, mixed>
- register system hooks Register a set of handler functions to be called in certain positions.
- RequestOnUrlParsed() : void
- Must parse the url in a hook
- ServeRequest() : void
- Serve request
- SetupTemplate() : Result
- Getter and setter for config data
- Request() : Request
- Get request Get the stored request object of the http call.
- ResetPassword() : void
- Finish reset When successful set the new user password
- resetPasswordInit() : void
- Init the reset call chain Register the reset password token in the user account when found
Properties
$config
Store configuration Holds the configuration object instance
private
stdClass|null
$config
= null
A simple object
$config_file
private
string
$config_file
= 'users'
The config file name
$is_system
Is system call Hold information if this is the system handler
private
bool
$is_system
= false
Is system
$req
Store request
private
Request|null
$req
= null
Holds the request object instance
A system request instance
Methods
RegisterHooks()
register system hooks Register a set of handler functions to be called in certain positions.
public
RegisterHooks() : array<string|int, mixed>
Return values
array<string|int, mixed> —A list of hooks to register
RequestOnUrlParsed()
Must parse the url in a hook
public
RequestOnUrlParsed(HookArgument $param) : void
Parameters
- $param : HookArgument
-
HookArgument
Return values
void —ServeRequest()
Serve request
public
ServeRequest(Request $request, Response $response) : void
Parameters
Tags
Return values
void —SetupTemplate()
Getter and setter for config data
public
SetupTemplate([null $data = null ]) : Result
When no data is given it will read otherwise write. This method is cached by setup handler
Parameters
- $data : null = null
Return values
Result —Request()
Get request Get the stored request object of the http call.
private
Request() : Request
Return values
Request —The request object
ResetPassword()
Finish reset When successful set the new user password
private
ResetPassword(Response $response) : void
Parameters
- $response : Response
Return values
void —resetPasswordInit()
Init the reset call chain Register the reset password token in the user account when found
private
resetPasswordInit(Response $response) : void
Parameters
- $response : Response