Documentation

event

Event model base

Table of Contents

RETURNTYPE_ARRAY Array returntype für Module-Event 'array'
RETURNTYPE_OBJ Object returntype für Module-Event 'object'
RETURNTYPE_SCALAR Object returntype für Module-Event 'scalar'
RETURNTYPE_VOID Object returntype für Module-Event null
EVENT_BASE_INSTANCE Base instaces a module event has to implement '\\fpcm\\module\\event'
$data Event-Daten array
$modules Events mit aktuellem Event array
$activeModules Liste mit aktiven Modulen array
$cache Event-Cache cache
$permissions Berechtigungen permissions
__construct() Konstruktor bool
isExecutable() User acan execute event bool
getReturnType() Defines type of returned data string|bool|null
is_a() Checks if module event class has implemented \fpcm\module\event bool
getEventClasses() Liefert Array mit Event-Klassen in installierten Modulen zurück array
getEventClassBase() Returns event base class data string
run() Executes a certain event array
getEventNamespace() Returns full event namespace string

Constants

RETURNTYPE_ARRAY

Array returntype für Module-Event

mixed $RETURNTYPE_ARRAY = 'array'

RETURNTYPE_OBJ

Object returntype für Module-Event

mixed $RETURNTYPE_OBJ = 'object'

RETURNTYPE_SCALAR

Object returntype für Module-Event

mixed $RETURNTYPE_SCALAR = 'scalar'

RETURNTYPE_VOID

Object returntype für Module-Event

mixed $RETURNTYPE_VOID = null

EVENT_BASE_INSTANCE

Base instaces a module event has to implement

mixed $EVENT_BASE_INSTANCE = '\\fpcm\\module\\event'

Properties

$data

Event-Daten

protected array $data

$modules

Events mit aktuellem Event

protected array $modules

$activeModules

Liste mit aktiven Modulen

protected array $activeModules = []

Methods

__construct()

Konstruktor

public __construct( [ $dataParams : mixed = null ] ) : bool
Parameters
$dataParams : mixed = null
Return values
bool

isExecutable()

User acan execute event

public isExecutable( ) : bool
Tags
since
Return values
bool

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( $object : mixed ) : bool
Parameters
$object : mixed
Return values
bool

getEventClasses()

Liefert Array mit Event-Klassen in installierten Modulen zurück

protected getEventClasses( ) : array
Tags
since
Return values
array

getEventClassBase()

Returns event base class data

protected getEventClassBase( ) : string
Return values
string

run()

Executes a certain event

public run( ) : array
Return values
array

getEventNamespace()

Returns full event namespace

public final static getEventNamespace( $event : string ) : string
Parameters
$event : string
Return values
string

Search results