API Documentation
\
Bazalt
ORM
Adapter
Connection
Exception
Generator
Plugin
Query
Relation

\Bazalt\ORM\GeneratorModels

Генератор файлів моделей бази даних

Summary

Methods
Properties
Constants
__construct()
generateFromDb()
generateBaseFileContent()
getFileDocComment()
getClassDocComment()
No public properties found
BASECLASSES_DIR
getPrefix()
createFolders()
generateFileContent()
getColumnsMeta()
getFieldOptionsText()
generateRelations()
isUnique()
parseColumnType()
$shema
$relations
$connection
$prefix
N/A
No private methods found
No private properties found
N/A

Constants

BASECLASSES_DIR

BASECLASSES_DIR

Properties

$shema

$shema :

Type

$relations

$relations :

Type

$connection

$connection : \Bazalt\ORM\Generator\ORM_Connection_Abstract

Об'єкт з'єднання з БД

Type

\Bazalt\ORM\Generator\ORM_Connection_Abstract

$prefix

$prefix : string

Префікс, який буде додано до моделі (напр. ComArticle)

Type

string

Methods

__construct()

__construct() : void

Constructor

generateFromDb()

generateFromDb(\Bazalt\ORM\Generator\ORM_Connection_Abstract  $connection, string  $path, string  $table,   $modelName, string  $prefix) : void

Генерує моделі з БД для заданого з'єднання

Parameters

\Bazalt\ORM\Generator\ORM_Connection_Abstract $connection

Об'єкт з'єднання
string $path

Шлях для збереження згенерованих моделей
string $table

Назва таблиці для якої необхідно згенерувати модель, якщо не вказано - генерує для всіх
$modelName
string $prefix

Префікс, який буде додано до моделі (напр. ComArticle), якщо не вказано, генератор спробує підібрати префікс самостійно

generateBaseFileContent()

generateBaseFileContent(string  $className, string  $tableName, string  $fields, array  $keys) : string

Генерує контент базового класу моделі

Parameters

string $className

Назва моделі
string $tableName

Назва таблиці
string $fields

Масив розпарсених совпців таблиці
array $keys

Масив розпарсених ключів таблиці

Returns

string —

Контент базового класу моделі

getFileDocComment()

getFileDocComment(string  $className) : string

Генерація коментарів для файлу моделі

Parameters

string $className

Назва моделі

Returns

string —

Коментарі для файлу моделі

getClassDocComment()

getClassDocComment(string  $tableName, array  $fields) : string

Генерація коментарів для класу моделі

Parameters

string $tableName

Назва таблиці
array $fields

Масив розпарсених совпців таблиці

Returns

string —

Коментарі для класу моделі

getPrefix()

getPrefix(  $tableName) : string

Повертає префікс, який буде додано до моделі (напр. ComArticle), якщо не задано $this->prefix, генератор спробує підібрати префікс самостійно

Parameters

$tableName

Returns

string —

Префікс

createFolders()

createFolders(  $path) : void

Створює структуру папок, необхідну для моделей

Parameters

$path

generateFileContent()

generateFileContent(string  $className, string  $tableName, array  $fields) : string

Генерує контент класу моделі

Parameters

string $className

Назва моделі
string $tableName

Назва таблиці
array $fields

Масив розпарсених совпців таблиці

Returns

string —

Контент класу моделі

getColumnsMeta()

getColumnsMeta(  $columns)

Розпарсює масив стовпців

Parameters

$columns

getFieldOptionsText()

getFieldOptionsText(  $field,   $primary)

Повертає набір параметрів, які описують поле в БД

Parameters

$field
$primary

generateRelations()

generateRelations(  $modelName,   $fields)

Генерує код функції для ініціалізації звязків

Parameters

$modelName
$fields

isUnique()

isUnique(  $tableName,   $column)

Перевіряє унікальність ключа

Parameters

$tableName
$column

parseColumnType()

parseColumnType(  $colType)

Parse PDO-produced column type

Parameters

$colType