Documentation

Brick extends Sand
in package
Uses RecordKey

Zakladni objekt urceny k rodicovstvi vsem pouzivanym objektum.

Tags
author

Vitex vitex@hippy.cz

copyright

2009-2021 Vitex@hippy.cz (G)

PHP 7

Table of Contents

$data  : array|null
Common object data holder.
$debug  : bool
Flag debugovacího režimu.
$easeShared  : Shared
Sdílený objekt frameworku.
$frameworkVersion  : string
Version of EasePHP Framework
$keyColumn  : string
Key Column for Current Record
$langCode  : string
Default Language Code.
$logger  : Regent
Objekt pro logování.
$objectName  : string
Object name place
$parentObject  : Sand|mixed
Odkaz na vlastnící objekt.
__toString()  : string
Magická funkce pro všechny potomky.
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
Obtain data holded by object
getDataCount()  : int
Vrací počet položek dat objektu.
getDataValue()  : mixed
Vrací hodnotu z pole dat pro MySQL.
getKeyColumn()  : string
Gives you Current KeyColumn Name
getLogger()  : Regent
Provide logger object
getMyKey()  : int
Gives you value of KEY Column
getObjectName()  : string
Vrací jméno objektu.
getStatusMessages()  : array
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
setKeyColumn()  : mixed
Nastaví jméno klíčového sloupečku v shopu.
setMyKey()  : bool
Nastavuje hodnotu klíčového políčka pro SQL.
setObjectName()  : string
Nastavuje jméno objektu Je li známý, doplní jméno objektu hodnotu klíče např User#vitex nebo ProductInCart#4542.
setupProperty()  : mixed
Set up one of 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|null $data = null

$debug

Flag debugovacího režimu.

public bool $debug = false

$easeShared

Sdílený objekt frameworku.

public Shared $easeShared = null

$frameworkVersion

Version of EasePHP Framework

public static string $frameworkVersion = '0.5'

$keyColumn

Key Column for Current Record

public string $keyColumn = 'id'

$langCode

Default Language Code.

public string $langCode = null

$objectName

Object name place

public string $objectName = 'Molecule'

$parentObject

Odkaz na vlastnící objekt.

public Sand|mixed $parentObject = null

Methods

__toString()

Magická funkce pro všechny potomky.

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' ][, string $caller = null ]) : bool
Parameters
$message : string

text zpravy

$type : string = 'info'

fronta

$caller : string = 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
Return values
array

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

getKeyColumn()

Gives you Current KeyColumn Name

public getKeyColumn() : string
Return values
string

getLogger()

Provide logger object

public getLogger([string|array $options = null ]) : Regent
Parameters
$options : string|array = null
Return values
Regent

getMyKey()

Gives you value of KEY Column

public getMyKey([array $data = null ]) : int
Parameters
$data : array = null

data z nichž se vrací hodnota klíče

Return values
int

key column value

getObjectName()

Vrací jméno objektu.

public getObjectName() : string
Return values
string

getStatusMessages()

Obtain global status messages

public getStatusMessages() : array
Return values
array

logBanner()

Add Info about used PHP and EasePHP Library

public logBanner([string $prefix = null ][, string $suffix = null ]) : mixed
Parameters
$prefix : string = null

banner prefix text

$suffix : string = null

banner suffix text

Return values
mixed

setData()

Načte $data do polí objektu.

public setData(array $data[, bool $reset = false ]) : int
Parameters
$data : array

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

setKeyColumn()

Nastaví jméno klíčového sloupečku v shopu.

public setKeyColumn(string $keyColumn) : mixed
Parameters
$keyColumn : string
Return values
mixed

setMyKey()

Nastavuje hodnotu klíčového políčka pro SQL.

public setMyKey(int|string $myKeyValue) : bool
Parameters
$myKeyValue : int|string
Return values
bool

setObjectName()

Nastavuje jméno objektu Je li známý, doplní jméno objektu hodnotu klíče např User#vitex nebo ProductInCart#4542.

public setObjectName([string $objectName = null ]) : string
Parameters
$objectName : string = null
Return values
string

new name

setupProperty()

Set up one of properties by 1) array 2) ENV 3) Constant

public setupProperty(array $options, string $name[, string $constant = false ]) : mixed
Parameters
$options : array

array of given availble properties

$name : string

name of property to set up

$constant : string = false

load default property value from constant / ENV

Return values
mixed

takeData()

Převezme data do aktuálního pole dat.

public takeData(array $data) : int
Parameters
$data : array

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

Search results