controller
extends controller
in package
Uses
tools, controllerProperties
Module controller base
Tags
Table of Contents
- BYPARAM_DEFAULT_ACTION = 'fn'
- BYPARAM_DEFAULT_PREFIX = 'process'
- ERROR_PROCESS_BYPARAMS = 0x404
- $cache : cache
- Cache
- $cacheName : string
- Cache name
- $checkPageToken : bool
- Page token check result
- $config : config
- System-Configuration
- $crons : cronlist
- Cronjobs
- $crypt : crypt
- Crypt object
- $events : events
- Events
- $execDestruct : bool
- Execute defined actions on __destruct
- $ipList : iplist
- IP-Sperren-List-Objekt
- $language : language
- Language object
- $moduleCheckExit : string
- Cache name
- $moduleElement : bool
- Check if controller was defined in module
- $notifications : notifications
- Notifications
- $permissions : permissions
- Berechtigungen
- $request : request
- Request object
- $session : session
- Aktuelle Sessions
- $view : view
- View object
- $viewEvents : string
- View events namespace
- $activeTab : int
- Active tab save
- __call() : bool
- Magische Methode für nicht vorhandene Methoden
- __callStatic() : bool
- Magische Methode für nicht vorhandene, statische Methoden
- __construct() : void
- Konstruktor
- __destruct() : void
- Destruktor
- buttonClicked() : string
- Prüft ob Button gesendet wurde
- getSession() : session
- Session zurückgeben
- hasAccess() : bool
- Access check processing, false prevent execution of request() and process()
- isAccessible() : bool
- Must return true, if controller is accessible
- process() : bool
- Controller processing
- processButtons() : bool
- Process click of form items as function
- request() : bool
- Request processing, false prevent execution
- addLangVarPrefix() : string
- Returns language variable with module prefix
- checkPageToken() : bool
- Check page token
- checkReferer() : bool
- Checks referrer
- getActiveNavigationElement() : string
- Get active navigation item id
- getActiveTab() : int
- Returns active tab ID, jQuery UI zero-based index
- getControllerLink() : string
- Create controller link
- getHelpLink() : string
- Get help link
- getIpLockedModul() : string
- Get controller access lock module
- getModuleKey() : string
- Returns modul key based on current class
- getObject() : module
- Get module object instance
- getToolbarButtonToggleClass() : string
- Get toolbar button toggle class
- getViewPath() : string
- Get view path for controller
- hasActiveModule() : bool
- Check if active module was called
- initActionObjects() : bool
- Init action objects
- initConstruct() : bool
- Additional initialize process after @see self::__construct
- initPermissionObject() : bool
- Initialize permission object
- initView() : bool
- Initialises view object
- maintenanceMode() : bool
- Hinweis das Wartungsmodus aktiv ist
- processByParam() : float|bool
- Executes function by param from GET-request in current controller
- redirect() : bool
- Controller Redirect
- redirectNoSession() : bool
- Redirect if user is not logged in
- requestExit() : bool
- Additional frontend request check
Constants
BYPARAM_DEFAULT_ACTION
public
mixed
BYPARAM_DEFAULT_ACTION
= 'fn'
BYPARAM_DEFAULT_PREFIX
public
mixed
BYPARAM_DEFAULT_PREFIX
= 'process'
ERROR_PROCESS_BYPARAMS
public
mixed
ERROR_PROCESS_BYPARAMS
= 0x404
Properties
$cache
Cache
protected
cache
$cache
$cacheName
Cache name
protected
string
$cacheName
= false
$checkPageToken
Page token check result
protected
bool
$checkPageToken
= true
$config
System-Configuration
protected
config
$config
$crons
Cronjobs
protected
cronlist
$crons
$crypt
Crypt object
protected
crypt
$crypt
$events
Events
protected
events
$events
$execDestruct
Execute defined actions on __destruct
protected
bool
$execDestruct
= true
$ipList
IP-Sperren-List-Objekt
protected
iplist
$ipList
$language
Language object
protected
language
$language
$moduleCheckExit
Cache name
protected
string
$moduleCheckExit
= true
$moduleElement
Check if controller was defined in module
protected
bool
$moduleElement
= false
$notifications
Notifications
protected
notifications
$notifications
$permissions
Berechtigungen
protected
permissions
$permissions
$request
Request object
protected
request
$request
$session
Aktuelle Sessions
protected
session
$session
$view
View object
protected
view
$view
$viewEvents
View events namespace
protected
string
$viewEvents
= 'theme'
$activeTab
Active tab save
private
int
$activeTab
Methods
__call()
Magische Methode für nicht vorhandene Methoden
public
__call(string $name, mixed $arguments) : bool
Parameters
- $name : string
- $arguments : mixed
Return values
bool —__callStatic()
Magische Methode für nicht vorhandene, statische Methoden
public
static __callStatic(string $name, mixed $arguments) : bool
Parameters
- $name : string
- $arguments : mixed
Return values
bool —__construct()
Konstruktor
public
final __construct() : void
Return values
void —__destruct()
Destruktor
public
__destruct() : void
Return values
void —buttonClicked()
Prüft ob Button gesendet wurde
public
final buttonClicked(string $buttonName) : string
Parameters
- $buttonName : string
Return values
string —getSession()
Session zurückgeben
public
final getSession() : session
Return values
session —hasAccess()
Access check processing, false prevent execution of request() and process()
public
hasAccess() : bool
Tags
Return values
bool —isAccessible()
Must return true, if controller is accessible
public
isAccessible() : bool
Tags
Return values
bool —process()
Controller processing
public
process() : bool
Tags
Return values
bool —processButtons()
Process click of form items as function
public
processButtons() : bool
Tags
Return values
bool —request()
Request processing, false prevent execution
public
request() : bool
Tags
Return values
bool —addLangVarPrefix()
Returns language variable with module prefix
protected
addLangVarPrefix(string $var) : string
Parameters
- $var : string
Return values
string —checkPageToken()
Check page token
protected
checkPageToken([string $name = '' ]) : bool
Parameters
- $name : string = ''
Return values
bool —checkReferer()
Checks referrer
protected
final checkReferer([bool $ext = false ]) : bool
Parameters
- $ext : bool = false
Tags
Return values
bool —getActiveNavigationElement()
Get active navigation item id
protected
getActiveNavigationElement() : string
Return values
string —getActiveTab()
Returns active tab ID, jQuery UI zero-based index
protected
final getActiveTab() : int
Tags
Return values
int —getControllerLink()
Create controller link
protected
getControllerLink([string $controller = '' ][, array<string|int, mixed> $params = [] ]) : string
Parameters
- $controller : string = ''
- $params : array<string|int, mixed> = []
Return values
string —getHelpLink()
Get help link
protected
getHelpLink() : string
Return values
string —getIpLockedModul()
Get controller access lock module
protected
getIpLockedModul() : 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 —getToolbarButtonToggleClass()
Get toolbar button toggle class
protected
getToolbarButtonToggleClass(int $tabIndex[, string $class = '' ][, bool $notIfNull = false ]) : string
Parameters
- $tabIndex : int
- $class : string = ''
- $notIfNull : bool = false
Tags
Return values
string —getViewPath()
Get view path for controller
protected
getViewPath() : string
Return values
string —hasActiveModule()
Check if active module was called
protected
final hasActiveModule() : bool
Return values
bool —initActionObjects()
Init action objects
protected
initActionObjects() : bool
Return values
bool —initConstruct()
Additional initialize process after @see self::__construct
protected
initConstruct() : bool
Return values
bool —initPermissionObject()
Initialize permission object
protected
initPermissionObject() : bool
Tags
Return values
bool —initView()
Initialises view object
protected
final initView() : bool
Return values
bool —maintenanceMode()
Hinweis das Wartungsmodus aktiv ist
protected
maintenanceMode([bool $simplemsg = true ]) : bool
Parameters
- $simplemsg : bool = true
Return values
bool —processByParam()
Executes function by param from GET-request in current controller
protected
final processByParam([string $prefix = self::BYPARAM_DEFAULT_PREFIX ][, string $actionFrom = self::BYPARAM_DEFAULT_ACTION ]) : float|bool
Parameters
- $prefix : string = self::BYPARAM_DEFAULT_PREFIX
- $actionFrom : string = self::BYPARAM_DEFAULT_ACTION
Tags
Return values
float|bool —redirect()
Controller Redirect
protected
redirect([string $controller = '' ][, array<string|int, mixed> $params = [] ]) : bool
Parameters
- $controller : string = ''
- $params : array<string|int, mixed> = []
Return values
bool —redirectNoSession()
Redirect if user is not logged in
protected
redirectNoSession() : bool
Return values
bool —requestExit()
Additional frontend request check
protected
final requestExit(array<string|int, mixed> $vars) : bool
Parameters
- $vars : array<string|int, mixed>