\Bazalt\ORMBaseRecord

Summary

Methods

Properties

Constants

initRelations()
initPlugins()
__construct()
registerEvent()
__sleep()
__wakeup()
getSQLConnectionName()
getSQLConnectionNameByModel()
getSettedFields()
getFieldsValues()
getField()
setField()
getColumns()
getReferences()
getAllReferences()
getByPlugin()
getPlugins()
getPlugin()
getIndexes()
getTable()
getTableName()
getAllColumns()
getPrimaryKeys()
getAutoIncrementColumn()
getAutoIncrementValue()
__set()
__get()
hasColumn()
removeColumn()
hasRelation()
hasPlugin()
getIterator()
__isset()
exists()
__unset()
toArray()
fromArray()
__call()
extend()
getModelName()

No public properties found

ON_FIELD_GET
ON_FIELD_SET
ON_RECORD_SAVE
ON_AFTER_RECORD_SAVE
ON_RECORD_DELETE
FIELD_IS_SETTED
FIELD_NOT_SETTED

initFields()
initIndexes()
checkEvent()
initModelPlugins()

$extensions
$allTables
$allKeys
$allReferences
$allModels
$tableName
$modelName
$engine
$indexes
$plugins
$connections
$values
$setted
$updated
$autoIncrementColumn
$pluginsEvents

N/A

initModel()

No private properties found

N/A

abstract

File: ORM/BaseRecord.php
Package: Default
Class hierarchy: \Bazalt\ORM\BaseRecord
Implements

Constants

ON_FIELD_GET

ON_FIELD_GET

Обробляти при виклику __get

ON_FIELD_SET

ON_FIELD_SET

Обробляти при виклику __set

ON_RECORD_SAVE

ON_RECORD_SAVE

Fire before record save

ON_AFTER_RECORD_SAVE

ON_AFTER_RECORD_SAVE

Fire after record save

ON_RECORD_DELETE

ON_RECORD_DELETE

Fire before record delete

FIELD_IS_SETTED

FIELD_IS_SETTED

Обробляти, якщо поле встановлене

FIELD_NOT_SETTED

FIELD_NOT_SETTED

Обробляти, якщо поле не встановлене

Properties

$extensions

$extensions : array

Array of extensions

Type

array

$allTables

$allTables : string

Масив усіх таблиць

Type

string

$allKeys

$allKeys : string

Масив усіх ключів

Type

string

$allReferences

$allReferences : string

Масив усіх звязків

Type

string

$allModels

$allModels : string

Масив усіх моделей

Type

string

$tableName

$tableName : string

Назва таблиці в СУБД, яка буде відповідати цій моделі

Type

string

$modelName

$modelName : string

Назва моделі

Type

string

$engine

$engine : string

Table engine (InnoDB or MyISAM)

Type

string

$indexes

$indexes : string

Масив усіх індексів

Type

string

$plugins

$plugins : string

Масив усіх плагінів

Type

string

$connections

$connections : string

Масив усіх з'єднань з серврером

Type

string

$values

$values : array

Значення, які були змінені при редаруванні

Type

array

$setted

$setted : array

Флаг о заполнении поля

Type

array

$updated

$updated : array

Флаг о изменении поля

Type

array

$autoIncrementColumn

$autoIncrementColumn : \Bazalt\ORM\ORMColumn

Колонка з автоінкрементом

Type

\Bazalt\ORM\ORMColumn

$pluginsEvents

$pluginsEvents : array

Масив евентів плагінів

Type

array

Methods

initRelations()

initRelations() : void

Ініціалізує звязки

initPlugins()

initPlugins() : void

Ініціалізує плагіни

Tags

codeCoverageIgnore

__construct()

__construct(string  $name, string  $modelName, string  $engine = null)

Constructor

Parameters

string	$name	Назва таблиці
string	$modelName	Назва моделі
string	$engine	Engine (InnoDB, MyISAM)

Throws

\Bazalt\ORM\Exception\Model

registerEvent()

registerEvent(string  $model, integer  $type = self::ON_FIELD_GET, callable  $callback, integer  $condition = null) : void

Підписує на евент моделі

Parameters

string	$model	Назва моделі
integer	$type	Тип евента (ON_FIELD_GET, ON_FIELD_SET, ON_RECORD_SAVE, ON_AFTER_RECORD_SAVE, ON_RECORD_DELETE)
callable	$callback	Callback ф-ція або метод
integer	$condition	Умова вкилкику калбека

__sleep()

__sleep() : array

__sleep

Returns

array

__wakeup()

__wakeup() : void

__wakeup

getSQLConnectionName()

getSQLConnectionName() : string

Повертає назву конекта до БД по замовчуванню

Returns

string

getSQLConnectionNameByModel()

getSQLConnectionNameByModel(string  $modelName) : \Bazalt\ORM\ORM_Connection_Abstract

Повертає об'єкт конекта до БД для моделі

Parameters

string

$modelName

Назва моделі

Returns

\Bazalt\ORM\ORM_Connection_Abstract

getSettedFields()

getSettedFields() : array

Повертає масив всіх установлених полів

Returns

array

getFieldsValues()

getFieldsValues() : array

Повертає масив всіх значень об'єкту моделі

Returns

array

getField()

getField(string  $field) : mixed

Повертаэ значення поля об'єкту моделі або null якщо воно не встановлене

Parameters

string

$field

Назва поля

Returns

mixed —

Значення

setField()

setField(string  $field, string  $value, boolean  $isCreate = false) : void

Встановлює значення в поле об'єкту моделі

Parameters

string	$field	Назва поля
string	$value	Значення
boolean	$isCreate

getColumns()

getColumns() : array<mixed,\Bazalt\ORM\Column>

Повертає масив стовпців ORM_Column

Throws

\Exception

Returns

array<mixed,\Bazalt\ORM\Column>

getReferences()

getReferences() : array

Повертає масив стовпців звязків ORM_Relation

Throws

\Bazalt\ORM\Exception

Returns

array

getAllReferences()

getAllReferences() : array

Повертає масив усіх звязків

Returns

array

getByPlugin()

getByPlugin(string  $plugin) : array

Повертає масив моделей які мають плагін $plugin

Parameters

string

$plugin

Назва плагіна

Returns

array

getPlugins()

getPlugins() : array

Повертає масив плагінів моделі

Returns

array

getPlugin()

getPlugin(  $name) : array

Повертає плагін моделі

Parameters

$name

Returns

array

getIndexes()

getIndexes() : array

Повертає масив індексів моделі

Returns

array

getTable()

getTable(string  $className) : \Bazalt\ORM\ORM_Record

Повертає об'єкт моделі

Parameters

string

$className

= null Назва моделі

Returns

\Bazalt\ORM\ORM_Record

getTableName()

getTableName(string  $className) : string

Повертає назву таблиці моделі

Parameters

string

$className

= null Назва моделі

Returns

string

getAllColumns()

getAllColumns(string  $tableName) : array

Повертає масив стовпців моделі - об'єктів ORMColumn {@link ORMColumn}

Parameters

string

$tableName

Назва таблиці моделі

Returns

array

getPrimaryKeys()

getPrimaryKeys(string  $tableName) : array<mixed,\Bazalt\ORM\ORM_Column>

Повертає масив первичних ключів моделі - об'єктів ORMColumn {@link ORMColumn}

Parameters

string

$tableName

Назва таблиці моделі

Returns

array<mixed,\Bazalt\ORM\ORM_Column>

getAutoIncrementColumn()

getAutoIncrementColumn(string  $tableName) : \Bazalt\ORM\ORM_Column

Повертає об'єкт автоінкрементного стовпця моделі

Parameters

string

$tableName

Назва таблиці моделі

Throws

\Bazalt\ORM\ORM_Exception_Table

Returns

\Bazalt\ORM\ORM_Column

getAutoIncrementValue()

getAutoIncrementValue() : mixed

Повертає значення автоінкрементного стовпця моделі

Throws

\Bazalt\ORM\ORM_Exception_Table

Returns

mixed

__set()

__set(string  $name, mixed  $value) : void

Встановлює $value в поле $name

Parameters

string	$name	Назва поля
mixed	$value	Значення

__get()

__get(string  $name) : mixed

Повертає значення поля $name

Parameters

string

$name

Назва поля

Returns

mixed

hasColumn()

hasColumn(string  $name, string  $options = null) : void

Додає стовпчик в загальну модель

Parameters

string	$name	Ім'я стовпчика
string	$options	Опції

Throws

\Bazalt\ORM\ORM_Exception_Table

removeColumn()

removeColumn(string  $name) : void

Видаляє стовпчик з моделі

Parameters

string

$name

Ім'я стовпця

hasRelation()

hasRelation(string  $name, \Bazalt\ORM\ORM_Relation_Abstract  $relation) : void

Додає звязок в модель

Parameters

string	$name	ім'я звязка
\Bazalt\ORM\ORM_Relation_Abstract	$relation	звязок

hasPlugin()

hasPlugin(string  $name, array  $options = array()) : void

Додає плагін в модель

Parameters

string	$name	Ім'я плагіна
array	$options	Масив опцій

getIterator()

getIterator() : \ArrayIterator

Create an iterator because private/protected vars can't be seen by json_encode

Returns

\ArrayIterator

__isset()

__isset(string  $name) : boolean

Перевіряє чи існує поле $name в об'єкті і чи було воно встановлене через __set

Parameters

string

$name

Назва поля

Returns

boolean

exists()

exists(string  $name) : boolean

Перевіряє чи існує стовпець $name в моделі

Parameters

string

$name

Назва поля

Returns

boolean

__unset()

__unset(string  $name) : void

Видаляє поле $name з об'єкта

Parameters

string

$name

Назва поля

toArray()

toArray() : array

Повертає об'єкт у вигляді масиву

Returns

array

fromArray()

fromArray(array  $data) : void

Заповнює об'єкт з масиву

Если данные ещё не заполненны - обнуляемм и заполняем их. Иначе делаем обновление по масиву данных

Parameters

array

$data

Масив даних виду array( 'назва стовпця' => 'значення' )

__call()

__call(string  $func, array  $args = array()) : void

Перехват не існуючих методів для використання механізму extend

Parameters

string	$func	Ім'я методу
array	$args	Список аргументів

Throws

\Bazalt\ORM\Exception

extend()

extend(string  $className, string  $classExtensionName) : void

Розширює методи моделі, напр. через плагіни

Parameters

string	$className	Клас, який розширяють
string	$classExtensionName	Клас, яким доповнюють

Throws

\Bazalt\ORM\InvalidArgumentException
\Bazalt\ORM\Exception

getModelName()

getModelName() : string

Повертає назву моделі

Returns

string

initFields()

initFields() : void

Ініціалізує поля

initIndexes()

initIndexes() : void

Ініціалізує плагіни