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
- $channel : AMQPChannel|null
- A storage pointer for the channel
- $connection : AMQPStreamConnection|null
- A storage for the connection
- $queue_name : string
- __construct() : mixed
- Handler constructor.
- __destruct() : mixed
- Tear down connection
- GetAccessList() : array<string|int, mixed>
- Name() : string
- OnAddOrUpdateContent() : void
- Trigger when an email was sent
- OnAfterAddOrUpdateNotice() : void
- Trigger when an email was sent
- OnAfterSendMail() : void
- Trigger when an email was sent
- OnCommandLineInterfaceCall() : void
- Cli to recreate a whole set of vimeo assets
- OnCronJobCompleted() : void
- Trigger when a new cronjob has ended
- OnCronJobProgressChanged() : void
- The progress of a certain running job changed
- OnCronJobRegistered() : void
- Trigger when a new cronjob was scheduled
- OnCronJobStarted() : void
- Trigger when a new cronjob was started
- OnDeleteContent() : void
- React on email delete
- OnMailRegistered() : void
- Trigger when an email was sent
- OnMapArrayIncludes() : void
- OnRegisterWidgetIncludes() : void
- RegisterHooks() : array<string|int, mixed>
- Register system hooks
- RequestOnUrlParsed() : mixed
- The request hook
- ServeRequest() : mixed
- Serve request
- ServerVersion() : string|null
- settings() : Result|object
- Get/Set the settings
- SetupTemplate() : mixed
- TriggerMessage() : Result
- 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
- active() : bool
- Is enabled and configured with passwords
- connect() : AMQPChannel|null
- Connect
- handleConfigPreset() : void
- Handle the context requests
- handleConfigTest() : void
- sendMessage() : void
- Fire and forget method to send a message
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
= ''
$channel
A storage pointer for the channel
private
AMQPChannel|null
$channel
= null
$connection
A storage for the connection
private
AMQPStreamConnection|null
$connection
= null
$queue_name
private
string
$queue_name
= 'faa'
Methods
__construct()
Handler constructor.
public
__construct() : mixed
Defines the name and the permission set
Return values
mixed —__destruct()
Tear down connection
public
__destruct() : mixed
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 —OnAddOrUpdateContent()
Trigger when an email was sent
public
OnAddOrUpdateContent(HookArgument $param) : void
Parameters
- $param : HookArgument
Return values
void —OnAfterAddOrUpdateNotice()
Trigger when an email was sent
public
OnAfterAddOrUpdateNotice(HookArgument $param) : void
Parameters
- $param : HookArgument
Return values
void —OnAfterSendMail()
Trigger when an email was sent
public
OnAfterSendMail(HookArgument $param) : void
Parameters
- $param : HookArgument
Return values
void —OnCommandLineInterfaceCall()
Cli to recreate a whole set of vimeo assets
public
OnCommandLineInterfaceCall( $param) : void
Parameters
Return values
void —OnCronJobCompleted()
Trigger when a new cronjob has ended
public
OnCronJobCompleted(HookArgument $param) : void
Parameters
- $param : HookArgument
Return values
void —OnCronJobProgressChanged()
The progress of a certain running job changed
public
OnCronJobProgressChanged(HookArgument $param) : void
Parameters
- $param : HookArgument
Return values
void —OnCronJobRegistered()
Trigger when a new cronjob was scheduled
public
OnCronJobRegistered(HookArgument $param) : void
Parameters
- $param : HookArgument
Return values
void —OnCronJobStarted()
Trigger when a new cronjob was started
public
OnCronJobStarted(HookArgument $param) : void
Parameters
- $param : HookArgument
Return values
void —OnDeleteContent()
React on email delete
public
OnDeleteContent( $param) : void
Parameters
Return values
void —OnMailRegistered()
Trigger when an email was sent
public
OnMailRegistered(HookArgument $param) : void
Parameters
- $param : HookArgument
Return values
void —OnMapArrayIncludes()
public
OnMapArrayIncludes( $param) : void
Parameters
Return values
void —OnRegisterWidgetIncludes()
public
OnRegisterWidgetIncludes( $param) : void
Parameters
Return values
void —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
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 —ServerVersion()
public
ServerVersion() : string|null
Return values
string|null —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 —TriggerMessage()
public
TriggerMessage(array<string|int, mixed> $payload[, string $event = 'Event' ][, array<string|int, mixed> $roles = ['root', 'admin'] ]) : Result
Parameters
- $payload : array<string|int, mixed>
- $event : string = 'Event'
- $roles : array<string|int, mixed> = ['root', 'admin']
Return values
Result —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 —active()
Is enabled and configured with passwords
private
active() : bool
Return values
bool —connect()
Connect
private
connect() : AMQPChannel|null
Return values
AMQPChannel|null —handleConfigPreset()
Handle the context requests
private
handleConfigPreset(Request $request, Response $response) : void
Parameters
Return values
void —handleConfigTest()
private
handleConfigTest(Request $request, Response $response) : void
Parameters
Return values
void —sendMessage()
Fire and forget method to send a message
private
sendMessage(array<string|int, mixed> $payload) : void
Parameters
- $payload : array<string|int, mixed>