EventBase
extends ExtensionBase
in package
implements
Event
Notification event base class
Tags
Interfaces, Classes and Traits
- Event
- This contract represents a notification event.
Table of Contents
- $conditions : array<string|int, mixed>
- $extendableStaticCalledClass : string
- $extensionCallbacks : array<string|int, mixed>
- $extensionHidden : mixed
- $host : Model
- $params : array<string|int, mixed>
- __construct() : mixed
- defineConditions() : mixed
- Local conditions supported by this event.
- defineParams() : mixed
- Defines the parameters used by this class.
- eventDetails() : array<string|int, mixed>
- Returns information about this event, including name and description.
- extend() : mixed
- extensionApplyInitCallbacks() : mixed
- extensionExtendCallback() : void
- Helper method for `::extend()` static method
- extensionIsHiddenField() : mixed
- extensionIsHiddenMethod() : mixed
- findEventByIdentifier() : mixed
- findEventGroups() : mixed
- findEventPresets() : array<string|int, mixed>
- Spins over preset registered in plugin base class with `registerNotificationRules`.
- findEventPresetsByClass() : mixed
- findEvents() : array<string|int, mixed>
- Spins over types registered in plugin base class with `registerNotificationRules`.
- findEventsByGroup() : mixed
- getCalledExtensionClass() : mixed
- getEventDescription() : mixed
- getEventGroup() : mixed
- getEventIdentifier() : string
- Resolves an event or action identifier from a class name or object.
- getEventName() : mixed
- getParams() : array<string|int, mixed>
- Returns all params.
- makeParamsFromEvent() : void
- Generates event parameters based on arguments from the triggering system event.
- setParams() : void
- Sets multiple params.
- extensionHideField() : mixed
- extensionHideMethod() : mixed
Properties
$conditions
public
array<string|int, mixed>
$conditions
= []
Local conditions supported by this event.
$extendableStaticCalledClass
public
static string
$extendableStaticCalledClass
= null
The calling class when using a static method.
$extensionCallbacks
protected
static array<string|int, mixed>
$extensionCallbacks
= []
Used to extend the constructor of an extension class. Eg:
BehaviorClass::extend(function($obj) { })
$extensionHidden
protected
mixed
$extensionHidden
= ['fields' => [], 'methods' => ['extensionIsHiddenField', 'extensionIsHiddenMethod']]
$host
protected
Model
$host
host object
$params
protected
array<string|int, mixed>
$params
= []
Contains the event parameter values.
Methods
__construct()
public
__construct([mixed $host = null ]) : mixed
Parameters
- $host : mixed = null
Return values
mixed —defineConditions()
Local conditions supported by this event.
public
defineConditions() : mixed
Return values
mixed —defineParams()
Defines the parameters used by this class.
public
defineParams() : mixed
This method should be used as an override in the extended class.
Return values
mixed —eventDetails()
Returns information about this event, including name and description.
public
eventDetails() : array<string|int, mixed>
Return values
array<string|int, mixed> —extend()
public
static extend(callable $callback) : mixed
Parameters
- $callback : callable
Return values
mixed —extensionApplyInitCallbacks()
public
extensionApplyInitCallbacks() : mixed
Return values
mixed —extensionExtendCallback()
Helper method for `::extend()` static method
public
static extensionExtendCallback(callable $callback) : void
Parameters
- $callback : callable
Return values
void —extensionIsHiddenField()
public
extensionIsHiddenField(mixed $name) : mixed
Parameters
- $name : mixed
Return values
mixed —extensionIsHiddenMethod()
public
extensionIsHiddenMethod(mixed $name) : mixed
Parameters
- $name : mixed
Return values
mixed —findEventByIdentifier()
public
static findEventByIdentifier(mixed $identifier) : mixed
Parameters
- $identifier : mixed
Return values
mixed —findEventGroups()
public
static findEventGroups() : mixed
Return values
mixed —findEventPresets()
Spins over preset registered in plugin base class with `registerNotificationRules`.
public
static findEventPresets() : array<string|int, mixed>
Return values
array<string|int, mixed> —findEventPresetsByClass()
public
static findEventPresetsByClass(mixed $className) : mixed
Parameters
- $className : mixed
Return values
mixed —findEvents()
Spins over types registered in plugin base class with `registerNotificationRules`.
public
static findEvents() : array<string|int, mixed>
Return values
array<string|int, mixed> —findEventsByGroup()
public
static findEventsByGroup(mixed $group) : mixed
Parameters
- $group : mixed
Return values
mixed —getCalledExtensionClass()
public
static getCalledExtensionClass() : mixed
Return values
mixed —getEventDescription()
public
getEventDescription() : mixed
Return values
mixed —getEventGroup()
public
getEventGroup() : mixed
Return values
mixed —getEventIdentifier()
Resolves an event or action identifier from a class name or object.
public
getEventIdentifier() : string
Return values
string —Identifier in format of vendor-plugin-class
getEventName()
public
getEventName() : mixed
Return values
mixed —getParams()
Returns all params.
public
getParams() : array<string|int, mixed>
Return values
array<string|int, mixed> —makeParamsFromEvent()
Generates event parameters based on arguments from the triggering system event.
public
static makeParamsFromEvent(array<string|int, mixed> $args[, string $eventName = null ]) : void
Parameters
- $args : array<string|int, mixed>
- $eventName : string = null
Return values
void —setParams()
Sets multiple params.
public
setParams(array<string|int, mixed> $params) : void
Parameters
- $params : array<string|int, mixed>
Return values
void —extensionHideField()
protected
extensionHideField(mixed $name) : mixed
Parameters
- $name : mixed
Return values
mixed —extensionHideMethod()
protected
extensionHideMethod(mixed $name) : mixed
Parameters
- $name : mixed