Migrator
in package
Класс для управления миграциями базы данных.
Обеспечивает применение и откат миграций.
Table of Contents
Properties
- $migrationsPath : string
- $pdo : PDO
Methods
- __construct() : mixed
- migrate() : void
- Применяет указанные миграции.
- rollback() : void
- Откатывает указанные миграции.
- findMigrationFile() : string
- Находит файл миграции по имени.
- getMigrationFiles() : array<string|int, mixed>
- Возвращает все файлы миграций из директории.
- getTargetFiles() : array<string|int, mixed>
- Возвращает список файлов миграций для обработки.
- loadMigration() : Migration
- Загружает миграцию из файла.
Properties
$migrationsPath
private
string
$migrationsPath
$pdo
private
PDO
$pdo
Methods
__construct()
public
__construct(string $migrationsPath, PDO $pdo) : mixed
Parameters
- $migrationsPath : string
-
Путь к директории с файлами миграций
- $pdo : PDO
-
Объект PDO для работы с базой данных
migrate()
Применяет указанные миграции.
public
migrate([string|null $migrationName = null ]) : void
Parameters
- $migrationName : string|null = null
-
Имя конкретной миграции (если null - применяются все)
rollback()
Откатывает указанные миграции.
public
rollback([string|null $migrationName = null ]) : void
Parameters
- $migrationName : string|null = null
-
Имя конкретной миграции (если null - откатываются все)
findMigrationFile()
Находит файл миграции по имени.
private
findMigrationFile(string $name) : string
Parameters
- $name : string
-
Часть имени файла миграции
Tags
Return values
string —Полный путь к файлу
getMigrationFiles()
Возвращает все файлы миграций из директории.
private
getMigrationFiles() : array<string|int, mixed>
Return values
array<string|int, mixed> —Массив путей к файлам
getTargetFiles()
Возвращает список файлов миграций для обработки.
private
getTargetFiles(string|null $name[, bool $reverse = false ]) : array<string|int, mixed>
Parameters
- $name : string|null
-
Имя миграции (если нужна конкретная)
- $reverse : bool = false
-
Нужно ли обратить порядок файлов (для отката)
Return values
array<string|int, mixed> —Массив путей к файлам
loadMigration()
Загружает миграцию из файла.
private
loadMigration(string $file) : Migration
Parameters
- $file : string
-
Путь к файлу миграции
Tags
Return values
Migration —Объект миграции