Documentation

userlist extends dashcontainer
in package
Uses dashContainerCols

User list dashboard container object

Tags
author

Stefan Seehafer aka imagine fanpress@nobody-knows.org

copyright

(c) 2011-2022, Stefan Seehafer

license

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

since
3.2.0

Table of Contents

CACHE_M0DULE_DASHBOARD  = 'dashboard'
Default container cache module
DASHBOARD_HEIGHT_BIG  = 'big'
Container height big
DASHBOARD_HEIGHT_MEDIUM  = 'middle'
Container height medium
DASHBOARD_HEIGHT_SMALL  = 'small'
Container height SMALL
DASHBOARD_HEIGHT_SMALL_MEDIUM  = 'small-medium'
Container height medium
DASHBOARD_HEIGHT_VERYBIG  = 'very-big'
Container height big
DASHBOARD_POS_MAX  = '{{max}}'
Container max position
$cache  : cache
System-Cache
$cacheModule  : string
Cache name
$cacheName  : string
Cache name
$checkPermissions  : array<string|int, mixed>
ggf. nötige Container-Berechtigungen
$config  : config
System-Config-Objekt
$data  : array<string|int, mixed>
data-Array für nicht weiter definierte Eigenschaften
$dbcon  : database
DB-Verbindung
$dbExcludes  : array<string|int, mixed>
Eigenschaften, welche beim Speichern in DB nicht von getPreparedSaveParams() zurückgegeben werden sollen
$editAction  : string
Controller-Pfad, wenn Objekt Edit-Action besitzt
$events  : events
Event-Liste
$id  : int
Objekt-ID
$language  : language
System-Sprachen-Objekt
$name  : string
Container-Name
$nodata  : bool
$this->data beim Speichern nicht berücksichtigen
$notifications  : notifications
Notifications
$objExists  : bool
Objektexistiert
$permissions  : permissions
Berechtigungen
$position  : int
Container-Position
$table  : string
Tabellen-Name
__construct()  : void
Konstruktor
__destruct()  : void
Konstruktor
__get()  : mixed
Magic get
__set()  : mixed
Magic set
__toString()  : string
Magic string
createFromDbObject()  : bool
Füllt Objekt mit Daten aus Datenbank-Result
delete()  : bool
Löscht ein Objekt in der Datenbank
exists()  : bool
Prüft ob Objekt existiert
getButton()  : linkButton|null
Return container button
getCacheName()  : string
Cache-Name zurückgeben
getContent()  : string
Returns content
getControllerViewVars()  : array<string|int, mixed>
Returns view vars
getData()  : array<string|int, mixed>
Gibt Inhalt von "data" zurück
getEditLink()  : string
Gibt Link für Edit-Action zurück
getHeadline()  : string
Return container headline
getHeight()  : string
Container-Höhe-Klasse (big/middle/small) zurückgeben
getId()  : int
Gibt Object-ID zurück
getJavascriptFiles()  : array<string|int, mixed>
Return JavaScript files
getJavascriptLangVars()  : array<string|int, mixed>
Return JavaScript language vars
getJavascriptVars()  : array<string|int, mixed>
Return JavaScript view vars
getName()  : string
Returns name
getNodata()  : bool
Prüft, ob "data" gespeichert werden soll
getPermissions()  : string
Container-Berechtigungen, die geprüft werden müssen, zurückgeben
getPosition()  : int
Returns container position
getPreparedValueParams()  : int
Gibt array mit Values für Prepared Statements zurück
getStoredPosition()  : int|bool
Returns stored container position
getView()  : string
Gibt Liste mit zu Variablen zurück, welche an Dashboard-Controller-View übergeben werden sollen
getWidth()  : string
Container-Breite-CSS-Klasse (big/small) zurückgeben
init()  : bool
Inittiert Objekt mit Daten aus der Datenbank, sofern ID vergeben wurde
prepareDataSave()  : bool
Bereitet Daten für Speicherung in Datenbank vor
setNodata()  : mixed
Möglichkeit, "data"-Eigenschaft mit an Datenbank zu senden
getPreparedSaveParams()  : array<string|int, mixed>
Bereitet Eigenschaften des Objects zum Speichern ind er Datenbank vor und entfernt nicht speicherbare Eigenschaften
initObjects()  : bool
Initialize objects
get2ColRow()  : string
Row with two columns, small right hand side
get2ColRowSmallLeftAuto()  : string
Row with two columns, small left hand side
renderContent()  : mixed
Content rendern

Constants

CACHE_M0DULE_DASHBOARD

Default container cache module

public mixed CACHE_M0DULE_DASHBOARD = 'dashboard'

DASHBOARD_HEIGHT_BIG

Container height big

public mixed DASHBOARD_HEIGHT_BIG = 'big'

DASHBOARD_HEIGHT_MEDIUM

Container height medium

public mixed DASHBOARD_HEIGHT_MEDIUM = 'middle'

DASHBOARD_HEIGHT_SMALL

Container height SMALL

public mixed DASHBOARD_HEIGHT_SMALL = 'small'

DASHBOARD_HEIGHT_SMALL_MEDIUM

Container height medium

public mixed DASHBOARD_HEIGHT_SMALL_MEDIUM = 'small-medium'

DASHBOARD_HEIGHT_VERYBIG

Container height big

public mixed DASHBOARD_HEIGHT_VERYBIG = 'very-big'

DASHBOARD_POS_MAX

Container max position

public mixed DASHBOARD_POS_MAX = '{{max}}'

Properties

$cacheModule

Cache name

protected string $cacheModule = ''

$cacheName

Cache name

protected string $cacheName = false

$checkPermissions

ggf. nötige Container-Berechtigungen

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

$data

data-Array für nicht weiter definierte Eigenschaften

protected array<string|int, mixed> $data

$dbExcludes

Eigenschaften, welche beim Speichern in DB nicht von getPreparedSaveParams() zurückgegeben werden sollen

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

$editAction

Controller-Pfad, wenn Objekt Edit-Action besitzt

protected string $editAction

$id

Objekt-ID

protected int $id

$nodata

$this->data beim Speichern nicht berücksichtigen

protected bool $nodata = true

$objExists

Objektexistiert

protected bool $objExists = false

$table

Tabellen-Name

protected string $table

Methods

__construct()

Konstruktor

public __construct([int $id = null ]) : void
Parameters
$id : int = null
Return values
void

__destruct()

Konstruktor

public __destruct() : void
Return values
void

__get()

Magic get

public __get(string $name) : mixed
Parameters
$name : string
Return values
mixed

__set()

Magic set

public __set(mixed $name, mixed $value) : mixed
Parameters
$name : mixed
$value : mixed
Return values
mixed

__toString()

Magic string

public __toString() : string
Return values
string

createFromDbObject()

Füllt Objekt mit Daten aus Datenbank-Result

public createFromDbObject(object $object) : bool
Parameters
$object : object
Return values
bool

delete()

Löscht ein Objekt in der Datenbank

public delete() : bool
Return values
bool

exists()

Prüft ob Objekt existiert

public exists() : bool
Return values
bool

getCacheName()

Cache-Name zurückgeben

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

getContent()

Returns content

public getContent() : string
Return values
string

getControllerViewVars()

Returns view vars

public getControllerViewVars() : array<string|int, mixed>
Tags
since
3.1.3
Return values
array<string|int, mixed>

getData()

Gibt Inhalt von "data" zurück

public getData() : array<string|int, mixed>
Return values
array<string|int, mixed>

Gibt Link für Edit-Action zurück

public getEditLink() : string
Return values
string

getHeadline()

Return container headline

public getHeadline() : string
Return values
string

getHeight()

Container-Höhe-Klasse (big/middle/small) zurückgeben

public getHeight() : string
Return values
string

getId()

Gibt Object-ID zurück

public getId() : int
Return values
int

getJavascriptFiles()

Return JavaScript files

public getJavascriptFiles() : array<string|int, mixed>
Tags
since
3.1.3
Return values
array<string|int, mixed>

getJavascriptLangVars()

Return JavaScript language vars

public getJavascriptLangVars() : array<string|int, mixed>
Tags
since
3.1.3
Return values
array<string|int, mixed>

getJavascriptVars()

Return JavaScript view vars

public getJavascriptVars() : array<string|int, mixed>
Tags
since
3.1.3
Return values
array<string|int, mixed>

getName()

Returns name

public getName() : string
Return values
string

getNodata()

Prüft, ob "data" gespeichert werden soll

public getNodata() : bool
Return values
bool

getPermissions()

Container-Berechtigungen, die geprüft werden müssen, zurückgeben

public getPermissions() : string
Return values
string

getPosition()

Returns container position

public getPosition() : int
Return values
int

getPreparedValueParams()

Gibt array mit Values für Prepared Statements zurück

public getPreparedValueParams([int $count = false ]) : int
Parameters
$count : int = false
Return values
int

getStoredPosition()

Returns stored container position

public final getStoredPosition() : int|bool
Tags
since
4.1
Return values
int|bool

getView()

Gibt Liste mit zu Variablen zurück, welche an Dashboard-Controller-View übergeben werden sollen

public getView() : string
Tags
since
3.1.3
Return values
string

getWidth()

Container-Breite-CSS-Klasse (big/small) zurückgeben

public getWidth() : string
Return values
string

init()

Inittiert Objekt mit Daten aus der Datenbank, sofern ID vergeben wurde

public init() : bool
Return values
bool

prepareDataSave()

Bereitet Daten für Speicherung in Datenbank vor

public prepareDataSave() : bool
Tags
since
3.6
Return values
bool

setNodata()

Möglichkeit, "data"-Eigenschaft mit an Datenbank zu senden

public setNodata(bool $nodata) : mixed
Parameters
$nodata : bool
Return values
mixed

getPreparedSaveParams()

Bereitet Eigenschaften des Objects zum Speichern ind er Datenbank vor und entfernt nicht speicherbare Eigenschaften

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

initObjects()

Initialize objects

protected initObjects() : bool
Return values
bool

get2ColRow()

Row with two columns, small right hand side

private get2ColRow(string $col1, string $col2[, string $class = '' ]) : string
Parameters
$col1 : string
$col2 : string
$class : string = ''
Return values
string

get2ColRowSmallLeftAuto()

Row with two columns, small left hand side

private get2ColRowSmallLeftAuto(string $col1, string $col2[, string $class = '' ]) : string
Parameters
$col1 : string
$col2 : string
$class : string = ''
Return values
string

renderContent()

Content rendern

private renderContent() : mixed
Return values
mixed

Search results