Handler
extends SecuredServerPlugin
in package
Implement special handler
This class provides interfaces for system hooks
Tags
Table of Contents
- $config : stdClass|null
- Buffer for configuration
- $defaultPermissions : array<string|int, mixed>
- The default permission set
- $dir : string
- The implementation directory
- $name : string
- Name of the plugin
- $request : Request
- __construct() : mixed
- set the plugin name
- GetAccessList() : array<string|int, mixed>
- Name() : string
- OnRegisterWidgetIncludes() : mixed
- Path() : string
- Get dir of this file
- RegisterHooks() : array<string|int, mixed>
- Register system hooks
- RegisterPublicAssetBasePath() : void
- Register the assets
- RequestOnUrlParsed() : mixed
- The request hook
- ServeRequest() : mixed
- Serve request
- settings() : Result|object
- Get/Set the settings
- SetupTemplate() : mixed
- handleConfig() : void
- Handle the context requests
- hasAccess() : bool
- Check if endpoint is accessible for this user group
- isInContext() : bool
- Is in certain context?
- setupAttributes() : void
- Set up the permission attribute table
- allowCookies() : void
- declineCookies() : void
- Decline certain cookies
- getAllowedServices() : array<string|int, mixed>|false|array<string|int, string>
- Extract allowed services
- getServices() : mixed
- Get enabled services
- getServicesImplementations() : mixed
- Get available and active services
- handleConfigPreset() : mixed
- Handle the context requests
- isServiceAllowed() : bool
- Check if the service is activated
- removeServiceCookies() : void
- Unset certain service cookie
- serviceSettings() : stdClass|null
- setCookie() : void
- Add cookie to response object
- updatePrivacySetting() : void
Properties
$config
Buffer for configuration
protected
stdClass|null
$config
= null
$defaultPermissions
The default permission set
protected
array<string|int, mixed>
$defaultPermissions
= [['endpoint' => 'config', 'root' => true, 'admin' => true]]
$dir
The implementation directory
protected
string
$dir
= ''
$name
Name of the plugin
protected
string
$name
= ''
$request
private
Request
$request
Methods
__construct()
set the plugin name
public
__construct() : mixed
Handler constructor.
Return values
mixed —GetAccessList()
public
GetAccessList(User $user) : array<string|int, mixed>
Parameters
- $user : User
Return values
array<string|int, mixed> —Name()
public
Name() : string
Return values
string —OnRegisterWidgetIncludes()
public
OnRegisterWidgetIncludes( $param) : mixed
Parameters
Return values
mixed —Path()
Get dir of this file
public
Path() : string
Return values
string —RegisterHooks()
Register system hooks
public
RegisterHooks() : array<string|int, mixed>
Register a set of handler functions to be called in certain positions.
Return values
array<string|int, mixed> —A list of hooks to register
RegisterPublicAssetBasePath()
Register the assets
public
RegisterPublicAssetBasePath(HookArgument $reference) : void
Parameters
- $reference : HookArgument
Return values
void —RequestOnUrlParsed()
The request hook
public
RequestOnUrlParsed(HookArgument $param) : mixed
Parameters
- $param : HookArgument
-
The hook values
Return values
mixed —ServeRequest()
Serve request
public
ServeRequest(Request $request, Response $response) : mixed
Serve the request and return appropriate result.
Parameters
Return values
mixed —settings()
Get/Set the settings
public
settings([null|object $new = null ]) : Result|object
This method is cached per instance
Parameters
- $new : null|object = null
-
New set of settings to store
Return values
Result|object —SetupTemplate()
public
SetupTemplate([mixed $data = null ]) : mixed
Parameters
- $data : mixed = null
Tags
Return values
mixed —handleConfig()
Handle the context requests
protected
handleConfig(Request &$request, Response &$response) : void
Parameters
Return values
void —hasAccess()
Check if endpoint is accessible for this user group
protected
hasAccess(string|array<string|int, string> $right[, Response|null $response = null ][, User|null $user = null ]) : bool
Parameters
Return values
bool —isInContext()
Is in certain context?
protected
isInContext(HookArgument $param, string $type, string $widget) : bool
Parameters
- $param : HookArgument
-
The hook argument
- $type : string
-
The type can be scss, css and js to search in widgets or _ to search in global includes
- $widget : string
-
The widget to search for
Return values
bool —setupAttributes()
Set up the permission attribute table
protected
setupAttributes( &$attributes, $l) : void
Parameters
Return values
void —allowCookies()
private
allowCookies(Response $resp) : void
Parameters
- $resp : Response
Return values
void —declineCookies()
Decline certain cookies
private
declineCookies(Response $resp) : void
Parameters
- $resp : Response
Return values
void —getAllowedServices()
Extract allowed services
private
getAllowedServices(Request $request) : array<string|int, mixed>|false|array<string|int, string>
Parameters
- $request : Request
Return values
array<string|int, mixed>|false|array<string|int, string> —getServices()
Get enabled services
private
getServices(Request $request, Response $resp) : mixed
Parameters
Return values
mixed —getServicesImplementations()
Get available and active services
private
getServicesImplementations(Request $request, Response $resp) : mixed
Parameters
Return values
mixed —handleConfigPreset()
Handle the context requests
private
handleConfigPreset(Request $request, Response $response) : mixed
Parameters
Return values
mixed —isServiceAllowed()
Check if the service is activated
private
isServiceAllowed(string $name, Request $request) : bool
Parameters
- $name : string
- $request : Request
Return values
bool —removeServiceCookies()
Unset certain service cookie
private
removeServiceCookies(Response $resp, string $service_name) : void
Parameters
- $resp : Response
- $service_name : string
Return values
void —serviceSettings()
private
serviceSettings(string $service_name) : stdClass|null
Parameters
- $service_name : string
Return values
stdClass|null —setCookie()
Add cookie to response object
private
setCookie(Response $resp, string $name, string $value) : void
Parameters
- $resp : Response
- $name : string
- $value : string
Return values
void —updatePrivacySetting()
private
updatePrivacySetting(Request $request, Response $resp) : void