Documentation

pm_Hook_Auth
in package
implements pm_Hook_Interface

Custom authentication mechanism

Tags
since
12.0

Interfaces, Classes and Traits

pm_Hook_Interface
Generic interface for hooks

Table of Contents

auth()  : bool
Check if credentials are valid or not
breakChainOnFailure()  : bool
If is true, then if the authentication fails, the next hook in the chain, if one exists, will not be executed.
destroy()  : mixed
Handle session destroy event
isEnabled()  : bool
Check if hook is enabled or not

Methods

auth()

Check if credentials are valid or not

public abstract auth(string $login, string $password) : bool
Parameters
$login : string
$password : string
Return values
bool

breakChainOnFailure()

If is true, then if the authentication fails, the next hook in the chain, if one exists, will not be executed.

public breakChainOnFailure() : bool
Return values
bool

destroy()

Handle session destroy event

public destroy() : mixed
Return values
mixed

isEnabled()

Check if hook is enabled or not

public isEnabled() : bool
Return values
bool

Search results