Sender
Class Sender
Transport and utility for REST events.
Table of Contents
Methods
- bind() : mixed
- Binds REST event handler on PHP event.
- call() : mixed
- Calls or schedules the query to SQS.
- getAuth() : array<string|int, mixed>|bool|null
- Returns authorization array for event handlers and BP activities.
- getDefaultEventParams() : array<string|int, mixed>
- Getter for default event params array.
- getProvider() : ProviderInterface
- getProviderOffline() : ProviderOfflineInterface
- parseEventName() : array<string|int, mixed>
- Utility function to parse pseudo-method name
- queueEvent() : mixed
- send() : void
- Sends all scheduled handlers to SQS.
- setProvider() : mixed
- setProviderOffline() : mixed
- unbind() : mixed
- Unbinds REST event handler on PHP event.
Methods
bind()
Binds REST event handler on PHP event.
public
static bind(string $moduleId, string $eventName) : mixed
Parameters
- $moduleId : string
-
Event owner module.
- $eventName : string
-
Event name.
call()
Calls or schedules the query to SQS.
public
static call(array<string|int, mixed> $handlersList) : mixed
Parameters
- $handlersList : array<string|int, mixed>
-
Event handlers to call.
Tags
getAuth()
Returns authorization array for event handlers and BP activities.
public
static getAuth(string|int $appId, int $userId[, array<string|int, mixed> $additionalData = array() ][, array<string|int, mixed> $additional = array() ]) : array<string|int, mixed>|bool|null
Parameters
- $appId : string|int
-
Application ID or CODE.
- $userId : int
-
User ID which will be the owner of access_token.
- $additionalData : array<string|int, mixed> = array()
-
Additional data which will be stored with access_token.
- $additional : array<string|int, mixed> = array()
-
Event parameters. Keys sendAuth and sendRefreshToken supported.
Return values
array<string|int, mixed>|bool|nullgetDefaultEventParams()
Getter for default event params array.
public
static getDefaultEventParams() : array<string|int, mixed>
Return values
array<string|int, mixed>getProvider()
public
static getProvider() : ProviderInterface
Return values
ProviderInterfacegetProviderOffline()
public
static getProviderOffline() : ProviderOfflineInterface
Return values
ProviderOfflineInterfaceparseEventName()
Utility function to parse pseudo-method name
public
static parseEventName(string $name) : array<string|int, mixed>
Parameters
- $name : string
-
Pseudo-method name.
Return values
array<string|int, mixed>queueEvent()
public
static queueEvent(mixed $queryItem) : mixed
Parameters
- $queryItem : mixed
send()
Sends all scheduled handlers to SQS.
public
static send() : void
setProvider()
public
static setProvider(ProviderInterface $provider) : mixed
Parameters
- $provider : ProviderInterface
setProviderOffline()
public
static setProviderOffline(ProviderOfflineInterface $providerOffline) : mixed
Parameters
- $providerOffline : ProviderOfflineInterface
unbind()
Unbinds REST event handler on PHP event.
public
static unbind(string $moduleId, string $eventName) : mixed
Parameters
- $moduleId : string
-
Event owner module.
- $eventName : string
-
Event name.