Migrator class

Framework\Database\Extra\Migrator

Class Migrator.

Defined in libraries/database-extra/src/Migrator.php

Properties #

$database
-
$table
-
$directories
-

$database

protected \Framework\Database\Database $database

$table

protected string $table

$directories

protected array $directories = array ( )

Methods #

__construct()
-
addDirectory()
-
getDatabase()
-
getDirectories()
-
getLastMigrationName()
Get current migrated version from Database.
getTable()
-
migrateDown()
-
migrateTo()
-
migrateUp()
-
setDatabase()
-
setTable()
-
deleteRow()
-
getFiles()
-
getMigrations()
-
getMigrationsAsc()
-
getMigrationsDesc()
-
insertRow()
-
prepare()
-

__construct()

public function __construct(\Framework\Database\Database $database, array $directories, string $table = 'Migrations')
Parameters
  • \Framework\Database\Database $database
  • array $directories
  • string $table

addDirectory()

public function addDirectory(string $directory): static
Parameters
  • string $directory
Returns static

getDatabase()

public function getDatabase(): \Framework\Database\Database
Returns \Framework\Database\Database

getDirectories()

public function getDirectories(): array
Returns array

getLastMigrationName()

public function getLastMigrationName(): ?string

Get current migrated version from Database.

Returns ?string

getTable()

public function getTable(): string
Returns string

migrateDown()

public function migrateDown(?int $quantity = NULL): Generator
Parameters
  • ?int $quantity
Returns Generator

migrateTo()

public function migrateTo(string $name): Generator
Parameters
  • string $name
Returns Generator

migrateUp()

public function migrateUp(?int $quantity = NULL): Generator
Parameters
  • ?int $quantity
Returns Generator

setDatabase()

public function setDatabase(\Framework\Database\Database $database): static
Parameters
  • \Framework\Database\Database $database
Returns static

setTable()

public function setTable(string $table): static
Parameters
  • string $table
Returns static

deleteRow()

protected function deleteRow(string $name): string|int
Parameters
  • string $name
Returns string|int

getFiles()

protected function getFiles(): array
Returns array

getMigrations()

protected function getMigrations(array $files): Generator
Parameters
  • array $files
Returns Generator

getMigrationsAsc()

protected function getMigrationsAsc(): Generator
Returns Generator

getMigrationsDesc()

protected function getMigrationsDesc(): Generator
Returns Generator

insertRow()

protected function insertRow(string $name): string|int
Parameters
  • string $name
Returns string|int

prepare()

protected function prepare(): void
Returns void