Documentation

welcome extends dashcontainer

in package

• fpcm
• model
• dashboard

Welcome 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

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 button object

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

isDisabled()  : int|bool

Returns stored container position

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

getSystemButtons()  : string

Add disable button if not disabled