Sand
extends Molecule
in package
Uses
Logging
Zakladni objekt urceny k rodicovstvi vsem pouzivanym objektum.
Tags
Table of Contents
- $data : array<string|int, mixed>|null
- Common object data holder.
- $debug : bool
- Debug mode flag.
- $easeShared : Shared
- Sdílený objekt frameworku.
- $langCode : string
- Default Language Code.
- $logger : Regent|null
- Objekt pro logování.
- $objectName : string
- Object name
- $parentObject : Sand|mixed
- Odkaz na vlastnící objekt.
- __toString() : string
- Magical function for all descendants (childern).
- addStatusMessage() : bool
- Add message to stack to show or write to file Přidá zprávu do zásobníku pro zobrazení uživateli inbo do logu.
- cleanSatatusMessages() : bool
- Erase all status messages
- dataReset() : mixed
- Vynuluje všechny pole vlastností objektu.
- draw() : string
- Default draw method.
- getData() : array<string|int, mixed>
- Obtain data holded by object
- getDataCount() : int
- Vrací počet položek dat objektu.
- getDataValue() : mixed
- Vrací hodnotu z pole dat pro MySQL.
- getLogger() : Regent
- Provide logger object
- getObjectName() : string
- Returns object name
- getStatusMessages() : array<string|int, mixed>
- Obtain global status messages
- logBanner() : mixed
- Add Info about used PHP and EasePHP Library
- setData() : int
- Načte $data do polí objektu.
- setDataValue() : bool
- Set data filed value
- setObjectName() : string
- Set object name
- setupProperty() : mixed
- Set up one of the properties by 1) array 2) ENV 3) Constant
- takeData() : int
- Převezme data do aktuálního pole dat.
- unsetDataValue() : bool
- Odstrani polozku z pole dat pro MySQL.
Properties
$data
Common object data holder.
public
array<string|int, mixed>|null
$data
= null
$debug
Debug mode flag.
public
bool
$debug
= false
$easeShared
Sdílený objekt frameworku.
public
Shared
$easeShared
= null
$langCode
Default Language Code.
public
string
$langCode
= null
$logger
Objekt pro logování.
public
Regent|null
$logger
= null
$objectName
Object name
public
string
$objectName
= 'Molecule'
$parentObject
Odkaz na vlastnící objekt.
public
Sand|mixed
$parentObject
= null
object
Methods
__toString()
Magical function for all descendants (childern).
public
__toString() : string
Return values
string —addStatusMessage()
Add message to stack to show or write to file Přidá zprávu do zásobníku pro zobrazení uživateli inbo do logu.
public
addStatusMessage(string $message[, string $type = 'info' ][, object $caller = null ]) : bool
Parameters
- $message : string
-
text zpravy
- $type : string = 'info'
-
fronta
- $caller : object = null
-
Message source name
Return values
bool —message added
cleanSatatusMessages()
Erase all status messages
public
cleanSatatusMessages() : bool
Return values
bool —dataReset()
Vynuluje všechny pole vlastností objektu.
public
dataReset() : mixed
Return values
mixed —draw()
Default draw method.
public
draw() : string
Return values
string —getData()
Obtain data holded by object
public
getData() : array<string|int, mixed>
Return values
array<string|int, mixed> —getDataCount()
Vrací počet položek dat objektu.
public
getDataCount() : int
Return values
int —getDataValue()
Vrací hodnotu z pole dat pro MySQL.
public
getDataValue(string $columnName) : mixed
Parameters
- $columnName : string
-
název hodnoty/sloupečku
Return values
mixed —getLogger()
Provide logger object
public
getLogger([string|array<string|int, mixed> $options = null ]) : Regent
Parameters
- $options : string|array<string|int, mixed> = null
Return values
Regent —getObjectName()
Returns object name
public
getObjectName() : string
Return values
string —getStatusMessages()
Obtain global status messages
public
getStatusMessages() : array<string|int, mixed>
Return values
array<string|int, mixed> —logBanner()
Add Info about used PHP and EasePHP Library
public
logBanner([string $prefix = '' ][, string $suffix = '' ]) : mixed
Parameters
- $prefix : string = ''
-
banner prefix text (default is APPName)
- $suffix : string = ''
-
banner suffix text
Return values
mixed —setData()
Načte $data do polí objektu.
public
setData(array<string|int, mixed> $data[, bool $reset = false ]) : int
Parameters
- $data : array<string|int, mixed>
-
asociativní pole dat
- $reset : bool = false
-
vyprazdnit pole před naplněním ?
Return values
int —počet načtených položek
setDataValue()
Set data filed value
public
setDataValue(string $columnName, mixed $value) : bool
Parameters
- $columnName : string
-
název datové kolonky
- $value : mixed
-
hodnota dat
Return values
bool —Success
setObjectName()
Set object name
public
setObjectName([string $objectName = null ]) : string
Parameters
- $objectName : string = null
Return values
string —Object name
setupProperty()
Set up one of the properties by 1) array 2) ENV 3) Constant
public
setupProperty(array<string|int, mixed> $options, string $name[, string $constant = '' ]) : mixed
Parameters
- $options : array<string|int, mixed>
-
array of given availble properties
- $name : string
-
name of property to set up
- $constant : string = ''
-
load default property value from constant / ENV
Return values
mixed —takeData()
Převezme data do aktuálního pole dat.
public
takeData(array<string|int, mixed> $data) : int
Parameters
- $data : array<string|int, mixed>
-
asociativní pole dat
Return values
int —unsetDataValue()
Odstrani polozku z pole dat pro MySQL.
public
unsetDataValue(string $columnName) : bool
Parameters
- $columnName : string
-
název klíče k vymazání
Return values
bool —success