Documentation

controller extends controller
in package
implements isAccessible Uses tools

Module controller base

Tags
author

Stefan Seehafer sea75300@yahoo.de

copyright

(c) 2011-2020, Stefan Seehafer

license

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

abstract
since
4.1

Interfaces, Classes, Traits and Enums

isAccessible

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
__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
getRequestVar()  : mixed
Gibt Wert in $_GET, $_POST, $_FILE zurück
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
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

$cacheName

Cache name

protected string $cacheName = false

$checkPageToken

Page token check result

protected bool $checkPageToken = true

$execDestruct

Execute defined actions on __destruct

protected bool $execDestruct = true

$moduleCheckExit

Cache name

protected string $moduleCheckExit = true

$moduleElement

Check if controller was defined in module

protected bool $moduleElement = false

$viewEvents

View events namespace

protected string $viewEvents = 'theme'

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

getRequestVar()

Gibt Wert in $_GET, $_POST, $_FILE zurück

public final getRequestVar([string $varname = null ][, array<string|int, mixed> $filter = [ pcmclasseshttp::FILTER_STRIPTAGS, pcmclasseshttp::FILTER_HTMLENTITIES, pcmclasseshttp::FILTER_STRIPSLASHES, pcmclasseshttp::FILTER_TRIM] ]) : mixed
Parameters
$varname : string = null
$filter : array<string|int, mixed> = [ pcmclasseshttp::FILTER_STRIPTAGS, pcmclasseshttp::FILTER_HTMLENTITIES, pcmclasseshttp::FILTER_STRIPSLASHES, pcmclasseshttp::FILTER_TRIM]
Tags
deprecated

FPCM 4.4, use $this->request instead

Return values
mixed

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
see
controller
Return values
bool

isAccessible()

Must return true, if controller is accessible

public isAccessible() : bool
Tags
since
4.4
Return values
bool

process()

Controller processing

public process() : bool
Tags
see
controller
Return values
bool

processButtons()

Process click of form items as function

public processButtons() : bool
Tags
since
4.4
todo

experimental

Return values
bool

request()

Request processing, false prevent execution

public request() : bool
Tags
see
controller
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
since
4.5-b7
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
since
4.1
Return values
int

Create controller link

protected getControllerLink([string $controller = '' ][, array<string|int, mixed> $params = [] ]) : string
Parameters
$controller : string = ''
$params : array<string|int, mixed> = []
Return values
string

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

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
since
4.4
Return values
bool

initView()

Initialises view object

protected final initView() : bool
Return values
bool

maintenanceMode()

Hinweis das Wartungsmodus aktiv ist

protected final 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
since
4.3
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>
Return values
bool

Search results