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
- $cache : cache
- Event-Cache
- $data : mixed|eventResult
- Event-Daten
- $permissions : permissions
- Berechtigungen
- __construct() : bool
- Konstruktor
- getEventNamespace() : string
- Returns full event namespace
- isExecutable() : bool
- User acan execute event
- run() : eventResult
- Executes event
- afterProcess() : bool
- After event running
- afterRun() : bool
- After event running
- beforeProcess() : void
- Prepare event before processing
- beforeRun() : bool
- Prepare event before running
- getEventClassBase() : string
- Returns event base class data
- getEventClasses() : array<string|int, mixed>
- Liefert Array mit Event-Klassen in installierten Modulen zurück
- getEventParams() : mixed
- Returns event params
- is_a() : bool
- Checks if module event class has implemented \fpcm\module\event
- onNoClasses() : eventResult
- Return event result object if no events will be triggered
- processClass() : bool
- Process class data
Constants
EVENT_BASE_INSTANCE
Base instaces a module event has to implement
public
mixed
EVENT_BASE_INSTANCE
= '\\fpcm\\module\\event'
Properties
$cache
Event-Cache
protected
cache
$cache
$data
Event-Daten
protected
mixed|eventResult
$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 event
public
run() : eventResult
Return values
eventResult —afterProcess()
After event running
protected
afterProcess() : bool
Tags
Return values
bool —afterRun()
After event running
protected
afterRun() : bool
Tags
Return values
bool —beforeProcess()
Prepare event before processing
protected
beforeProcess(event $event) : void
Parameters
- $event : event
Tags
Return values
void —beforeRun()
Prepare event before running
protected
beforeRun() : bool
Tags
Return values
bool —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> —getEventParams()
Returns event params
protected
getEventParams() : mixed
Return values
mixed —is_a()
Checks if module event class has implemented \fpcm\module\event
protected
is_a(mixed $object) : bool
Parameters
- $object : mixed
Return values
bool —onNoClasses()
Return event result object if no events will be triggered
protected
onNoClasses() : eventResult
Tags
Return values
eventResult —processClass()
Process class data
protected
processClass(string $class) : bool
Parameters
- $class : string