Documentation

event
in package
Uses tools

Module-Event-Base-Class

Tags
author

Stefan Seehafer sea75300@yahoo.de

Table of Contents

$data  : mixed
Event data
$params  : array<string|int, mixed>
Extra event params
__construct()  : mixed
Konstruktor
init()  : bool
Initialize event
run()  : mixed
Execute event
addLangVarPrefix()  : string
Returns language variable with module prefix
getModuleKey()  : string
Returns modul key based on current class
getObject()  : module
Get module object instance
initConstruct()  : bool
Additional initialize process after @see self::__construct

Properties

$data

Event data

protected mixed $data = ''

$params

Extra event params

protected array<string|int, mixed> $params = []
Tags
since
5.2.0-rc3

Methods

__construct()

Konstruktor

public final __construct(mixed $data) : mixed
Parameters
$data : mixed
Return values
mixed

init()

Initialize event

public abstract init() : bool
Return values
bool

run()

Execute event

public abstract run() : mixed
Return values
mixed

addLangVarPrefix()

Returns language variable with module prefix

protected addLangVarPrefix(string $var) : string
Parameters
$var : string
Return values
string

getModuleKey()

Returns modul key based on current class

protected final getModuleKey() : string
Return values
string

getObject()

Get module object instance

protected final getObject([string $key = '' ][, bool $initDb = true ]) : module
Parameters
$key : string = ''
$initDb : bool = true
Return values
module

initConstruct()

Additional initialize process after @see self::__construct

protected initConstruct() : bool
Return values
bool

Search results