Table

Класс для преобразования таблицы и её колонок

Метод подключения

1

include_once DLEPlugins::Check(ENGINE_DIR . '/inc/maharder/_includes/classes/Table.php');

Свойства

model

Название модели / плагина / приложения * Может принимать значение null

1

private ?string $model

name

Название таблицы * Может принимать значение null

1

private ?string $name

id

Название колонки / ячейки с идентификатором * Может принимать значение null

1

private ?string $id

migrations_path

Путь, куда будут сохраняться описания миграций * Может принимать значение null

1

private ?string $migrations_path

columns

Массив колонок / ячеек таблицы с их описанием и параметрами

1

private array $columns

col_keys

Ключи таблицы (Primary / Unique / Foreign)

1

private array $col_keys

now

Текущие дата и время

1

private ?string $now

Методы

__construct

Конструктор

1

public __construct(string $id, string $name, string $model, array $vars, array $col_keys, string|null $now = null): mixed

Параметры:

Пример:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

'cron_id',
'telegram_con',
'TelegramPosting',
[
    [
        'name'  => 'news_id',
        'type'  => 'int',
    ],
    [
        'name'  => 'time',
        'type'  => 'int',
    ],
    [
        'name'  => 'type',
        'type'  => 'string',
        'limit' => 255
    ],
],
[
    [
        'name' => 'foreign',
        [
            'type' => 'after',
            'column' => 'news_id',
            'target_table' => 'post',
            'target_column' => 'id',
            'on_delete' => 'CASCADE'
        ]
    ]
]

getMigrationsPath

Возвращает путь до папки с миграциями

1

public getMigrationsPath(): string|null

setMigrationsPath

Устанавливает путь для миграций в базу данных

1

public setMigrationsPath(string|null $migrations_path = null): void

Параметры:

prepare_table_attributes

Функция подготавливает и проверяет тип колонки, добавляет необходимые значения и удаляет ненужные или пустые значения

1

private prepare_table_attributes(array $attributes): array

Параметры:

setKey

Устанавливает ключи для таблицы

1

private setKey(string $name, array $vars): string

Параметры:

Параметры $vars:

Параметры $vars[type]:

keyAction

Вспомогательная функция для подготовки создания ключей для таблицы

1

private keyAction(string $type, bool $exists, string $table, string $key_type, string $key_name, string $keys, array $vars): string

Параметры:

prepareTable

Готовим установленные данные для миграции * Добавляет колонку с создателем объекта * Добавляет колонку с редактором объекта * Добавляет колонку с датой создания объекта * Добавляет колонку с датой изменения объекта * Возвращает массив с данными таблицы

1

private prepareTable(): array[]

checkMigrations

Проверка миграций * Если миграций нет или были найдены изменения в модели, то создаёт миграцию * Изменения можно просмотреть в файлах, которые создаются при миграции.

1

public checkMigrations( ?string $path = null): void

Параметры:

generateMigration

Создаём файл миграции * Подготавливает таблицу к миграции * Сохраняет все изменения в sql файл в папку с миграциями

1

private generateMigration(string $file): array

Параметры:

generate_column_sql

Генерирует строку колонки по параметрам * Возвращает sql команду

1

private generate_column_sql(array $columns): string

Параметры:

getId

Возвращает название колонки с ID

1

public getId(): string

setId

Устанавливает название колонки с ID

1

public setId(string $id): void

Параметры:

getName

Возвращает название таблицы

1

public getName(): string

setName

Устанавливает название таблицы

1

public setName(string $name): void

Параметры:

getModel

Возвращает название модели

1

public getModel(): string

setModel

Устанавливает название модели

1

public setModel(string $model): void

Параметры:

getColumns

Возвращает все колонки таблицы в виде массива

1

public getColumns(): array

setColumns

Устанавливает колонки таблицы

1

public setColumns(array|string $vars): void

getColKeys

Возвращает ключи в виде массива

1

public getColKeys(string $type = null): array

Параметры:

setColKeys

Добавляет ключи (Primary, Foreign Key, Unique) к базе данных

1

public setColKeys(string|array $col_keys, string $type = "after"): void

Параметры:

getNow

Возвращает временной штамп

1

public getNow(): string

setNow

Устанавливает текущую дату в формате цифрового штампа * Если передаётся пустой параметр, то берутся текущие дата и время

1

public setNow(string|null $now = null): void

Параметры:

Унаследованные методы

DataLoader

Документация: DataLoader

LogGenerator

Документация: LogGenerator