Documentation

api extends staticModel
in package
Uses tools

Module api wrapper

Tags
author

Stefan Seehafer sea75300@yahoo.de

copyright

(c) 2025, Stefan Seehafer

license

http://www.gnu.org/licenses/gpl.txt GPLv3

Table of Contents

$cache  : cache
Cache object
$cacheModule  : string
Cache Modul
$cacheName  : string
Cache name
$config  : config
Config object
$data  : array<string|int, mixed>
Data array
$events  : events
Event list
$language  : language
Sprachobjekt
$notifications  : notifications
Notifications
$permissions  : permissions
Permissions
$session  : session
Session objekt
__construct()  : void
Konstruktor
getCacheName()  : string
Cache-Name zurückgeben
init()  : void
Intialize function
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

$cacheModule

Cache Modul

protected string $cacheModule = ''
Tags
since
3.4

$cacheName

Cache name

protected string $cacheName = false

$data

Data array

protected array<string|int, mixed> $data

Methods

__construct()

Konstruktor

public __construct() : void
Return values
void —

getCacheName()

Cache-Name zurückgeben

public getCacheName([string $addName = '' ]) : string
Parameters
$addName : string = ''
Return values
string —

init()

Intialize function

public init() : void
Return values
void —

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