Documentation

dataViewList extends dataViewList

Module Dataview controller base

Tags
author

Stefan Seehafer sea75300@yahoo.de

copyright

(c) 2011-2022, Stefan Seehafer

license

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

abstract
since
5.3.2

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
$conditions  : searchWrapper
Conditions object
$config  : config
System-Configuration
$countCurrent  : int
Current items on page
$countMax  : int
Max count of item
$crons  : cronlist
Cronjobs
$crypt  : crypt
Crypt object
$dataView  : dataView
Data view object
$events  : events
Events
$execDestruct  : bool
Execute defined actions on __destruct
$filter  : array<string|int, mixed>|null
Filter array
$hasPager  : bool
has pager
$ipList  : iplist
IP-Sperren-List-Objekt
$isFilter  : bool
Is filter view
$items  : mixed
Items list array
$itemsPerPage  : int
Items per page
$language  : language
Language object
$message  : message|null
Message object
$moduleCheckExit  : string
Cache name
$moduleElement  : bool
Check if controller was defined in module
$notifications  : notifications
Notifications
$offset  : int
Current offset
$page  : int|null
Current Page
$pager  : pager|null
Pager object
$permissions  : permissions
Berechtigungen
$request  : request
Request object
$response  : response
response object
$session  : session
Aktuelle Sessions
$updateCheckEnabled  : bool
Update-Check de/aktivieren
$userList  : userList
User list object
$users  : array<string|int, mixed>
$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()  : mixed
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
afterProcess()  : bool
After process list
checkPageToken()  : bool
Check page token
checkReferer()  : bool
Checks referrer
execute()  : bool
Execute filter
getActiveNavigationElement()  : string
Get active navigation item id
getActiveTab()  : int
Returns active tab ID, jQuery UI zero-based index
getCols()  : array<string|int, mixed>
Dataview columns
getControllerLink()  : string
Create controller link
getHelpLink()  : string
Get help link
getIpLockedModul()  : string
Get controller access lock module
getModul()  : string
Returns Module name
getName()  : string
Returns list name
getRow()  : row
Get dataview row
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
initLists()  : void
Init lists objects
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
initPageData()  : bool
Init page(r) data

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

$countCurrent

Current items on page

protected int $countCurrent = 0

$execDestruct

Execute defined actions on __destruct

protected bool $execDestruct = true

$filter

Filter array

protected array<string|int, mixed>|null $filter = null

$isFilter

Is filter view

protected bool $isFilter = false

$itemsPerPage

Items per page

protected int $itemsPerPage = 0

$moduleCheckExit

Cache name

protected string $moduleCheckExit = true

$moduleElement

Check if controller was defined in module

protected bool $moduleElement = false

$offset

Current offset

protected int $offset = 0

$page

Current Page

protected int|null $page = 1

$updateCheckEnabled

Update-Check de/aktivieren

protected bool $updateCheckEnabled = false

$users

protected array<string|int, mixed> $users = []

$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 __construct() : mixed
Return values
mixed

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

isAccessible()

Must return true, if controller is accessible

public isAccessible() : bool
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
Return values
bool

request()

Request processing, false prevent execution

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

afterProcess()

After process list

protected afterProcess() : bool
Return values
bool

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

execute()

Execute filter

protected abstract execute() : bool
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

getCols()

Dataview columns

protected abstract getCols() : array<string|int, mixed>
Return values
array<string|int, mixed>

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

getModul()

Returns Module name

protected abstract getModul() : string
Return values
string

getName()

Returns list name

protected abstract getName() : string
Return values
string

getRow()

Get dataview row

protected abstract getRow(comments $item, mixed $index) : row
Parameters
$item : comments
$index : mixed
Return values
row

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
since
5.2.0.a1
deprecated
5.3.0-a1
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

initLists()

Init lists objects

protected abstract initLists() : void
Return values
void

initPermissionObject()

Initialize permission object

protected initPermissionObject() : bool
Tags
since
4.4
Return values
bool

initView()

Initialises view object

protected 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
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

initPageData()

Init page(r) data

private initPageData() : bool
Return values
bool

Search results