Documentation

userlist extends dashcontainer
in
Uses dashContainerCols

User list dashboard container object

Table of Contents

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

Properties

$checkPermissions

ggf. nötige Container-Berechtigungen

protected array $checkPermissions = []

$id

Objekt-ID

protected int $id

$table

Tabellen-Name

protected string $table

$data

data-Array für nicht weiter definierte Eigenschaften

protected array $data

$dbExcludes

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

protected array $dbExcludes = []

$nodata

$this->data beim Speichern nicht berücksichtigen

protected bool $nodata = true

$editAction

Controller-Pfad, wenn Objekt Edit-Action besitzt

protected string $editAction

$objExists

Objektexistiert

protected bool $objExists = false

$cacheName

Cache name

protected string $cacheName = false

$cacheModule

Cache name

protected string $cacheModule = ''

Methods

getName()

Returns name

public getName( ) : string
Return values
string

getContent()

Returns content

public getContent( ) : string
Return values
string

getHeadline()

Return container headline

public getHeadline( ) : string
Return values
string

getPosition()

Returns container position

public getPosition( ) : int
Return values
int

renderContent()

Content rendern

private renderContent( ) : mixed
Return values
mixed

get2ColRow()

Row with two columns, small right hand side

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

get2ColRowSmallLeftAuto()

Row with two columns, small left hand side

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

__construct()

Konstruktor

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

getCacheName()

Cache-Name zurückgeben

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

getWidth()

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

public getWidth( ) : string
Return values
string

getHeight()

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

public getHeight( ) : string
Return values
string

getStoredPosition()

Returns stored container position

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

getPermissions()

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

public getPermissions( ) : string
Return values
string

getJavascriptVars()

Return JavaScript view vars

public getJavascriptVars( ) : array
Tags
since
Return values
array

getJavascriptLangVars()

Return JavaScript language vars

public getJavascriptLangVars( ) : array
Tags
since
Return values
array

getJavascriptFiles()

Return JavaScript files

public getJavascriptFiles( ) : array
Tags
since
Return values
array

getControllerViewVars()

Returns view vars

public getControllerViewVars( ) : array
Tags
since
Return values
array

getView()

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

public getView( ) : string
Tags
since
Return values
string

initObjects()

Initialize objects

protected initObjects( ) : bool
Return values
bool

getName()

Container-Name zurückgeben

public abstract getName( ) : string
Return values
string

__toString()

Magic string

public __toString( ) : string
Return values
string

__get()

Magic get

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

__set()

Magic set

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

__call()

Magische Methode für nicht vorhandene Methoden

public __call( $name : string , $arguments : mixed ) : bool
Parameters
$name : string
$arguments : mixed
Return values
bool

__callStatic()

Magische Methode für nicht vorhandene, statische Methoden

public static __callStatic( $name : string , $arguments : mixed ) : bool
Parameters
$name : string
$arguments : mixed
Return values
bool

__destruct()

Konstruktor

public __destruct( ) : void

getData()

Gibt Inhalt von "data" zurück

public getData( ) : array
Return values
array

init()

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

public init( ) : bool
Return values
bool

getId()

Gibt Object-ID zurück

public getId( ) : int
Return values
int

exists()

Prüft ob Objekt existiert

public exists( ) : bool
Return values
bool

getNodata()

Prüft, ob "data" gespeichert werden soll

public getNodata( ) : bool
Return values
bool

setNodata()

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

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

delete()

Löscht ein Objekt in der Datenbank

public delete( ) : bool
Return values
bool

createFromDbObject()

Füllt Objekt mit Daten aus Datenbank-Result

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

getPreparedSaveParams()

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

protected getPreparedSaveParams( ) : array
Return values
array

getPreparedValueParams()

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

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

prepareDataSave()

Bereitet Daten für Speicherung in Datenbank vor

public prepareDataSave( ) : bool
Tags
since
Return values
bool

getEditLink()

Gibt Link für Edit-Action zurück

public getEditLink( ) : string
Return values
string

Search results