models
extends event
in package
Module-Event: models
Event is executed before global search is executed to add additional search models Return value eventResult object with array of class names with implements \fpcm\model\interfaces\gsearchIndex
Tags
Table of Contents
- EVENT_BASE_INSTANCE = '\\fpcm\\module\\event'
- Base instaces a module event has to implement
- RETURNTYPE_ARRAY = 'array'
- Array returntype für Module-Event
- RETURNTYPE_EVENTRESULT = '\\fpcm\\module\\eventResult'
- Object returntype für Module-Event
- RETURNTYPE_OBJ = 'object'
- Object returntype für Module-Event
- RETURNTYPE_SCALAR = 'scalar'
- Object returntype für Module-Event
- RETURNTYPE_VOID = null
- Object returntype für Module-Event
- $cache : cache
- Event-Cache
- $data : array<string|int, mixed>
- Event-Daten
- $permissions : permissions
- Berechtigungen
- __construct() : bool
- Konstruktor
- getEventNamespace() : string
- Returns full event namespace
- isExecutable() : bool
- User acan execute event
- run() : array<string|int, mixed>
- Executes a certain event
- getEventClassBase() : string
- Returns event base class data
- getEventClasses() : array<string|int, mixed>
- Liefert Array mit Event-Klassen in installierten Modulen zurück
- getReturnType() : string|bool|null
- Defines type of returned data
- is_a() : bool
- Checks if module event class has implemented \fpcm\module\event
- toEventResult() : eventResult
- Convert event result to eventResult object
Constants
EVENT_BASE_INSTANCE
Base instaces a module event has to implement
public
mixed
EVENT_BASE_INSTANCE
= '\\fpcm\\module\\event'
RETURNTYPE_ARRAY
Array returntype für Module-Event
public
mixed
RETURNTYPE_ARRAY
= 'array'
Tags
RETURNTYPE_EVENTRESULT
Object returntype für Module-Event
public
mixed
RETURNTYPE_EVENTRESULT
= '\\fpcm\\module\\eventResult'
Tags
RETURNTYPE_OBJ
Object returntype für Module-Event
public
mixed
RETURNTYPE_OBJ
= 'object'
Tags
RETURNTYPE_SCALAR
Object returntype für Module-Event
public
mixed
RETURNTYPE_SCALAR
= 'scalar'
Tags
RETURNTYPE_VOID
Object returntype für Module-Event
public
mixed
RETURNTYPE_VOID
= null
Tags
Properties
$cache
Event-Cache
protected
cache
$cache
$data
Event-Daten
protected
array<string|int, mixed>
$data
$permissions
Berechtigungen
protected
permissions
$permissions
Methods
__construct()
Konstruktor
public
__construct([mixed $dataParams = null ]) : bool
Parameters
- $dataParams : mixed = null
Return values
bool —getEventNamespace()
Returns full event namespace
public
final static getEventNamespace(string $event) : string
Parameters
- $event : string
Return values
string —isExecutable()
User acan execute event
public
isExecutable() : bool
Tags
Return values
bool —run()
Executes a certain event
public
run() : array<string|int, mixed>
Return values
array<string|int, mixed> —getEventClassBase()
Returns event base class data
protected
getEventClassBase() : string
Return values
string —getEventClasses()
Liefert Array mit Event-Klassen in installierten Modulen zurück
protected
getEventClasses() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getReturnType()
Defines type of returned data
protected
getReturnType() : string|bool|null
Return values
string|bool|null —is_a()
Checks if module event class has implemented \fpcm\module\event
protected
is_a(mixed $object) : bool
Parameters
- $object : mixed
Return values
bool —toEventResult()
Convert event result to eventResult object
protected
final toEventResult(mixed $data) : eventResult
Parameters
- $data : mixed