Migrator  

class Migrator

Properties

protected OutputInterface|null $output

Methods

__construct(MigrationRepositoryInterface $repository, ConnectionInterface $connection, Filesystem $files)

No description

void
run(string $path, Extension|null $extension = null)

Run the outstanding migrations at a given path.

void
runMigrationList(string $path, array $migrations, Extension|null $extension = null)

No description

void
runUpMigrations(array $migrations, string $path, Extension|null $extension = null)

No description

void
runDownMigrations(array $migrations, string $path, Extension|null $extension = null)

No description

void
runUp(string $path, string $file, Extension|null $extension = null)

Run "up" a migration instance.

int
reset(string $path, Extension|null $extension = null)

Rolls all the currently applied migrations back.

void
runDown(string $path, string $file, Extension|null $extension = null)

Run "down" a migration instance.

void
runClosureMigration(array $migration, string $direction = 'up')

Runs a closure migration based on the migrate direction.

void
resolveAndRunClosureMigration(string $path, string $file, string $direction = 'up')

Resolves and run a migration and assign the filename to the exception if needed.

array
getMigrationFiles(string $path)

Get all of the migration files in a given path.

array
resolve(string $path, string $file)

Resolve a migration instance from a file.

bool
installFromSchema(string $path, DatabaseConfig $dbConfig)

Initialize the Flarum database from a schema dump.

Migrator
setOutput(OutputInterface $output)

No description

void
note(string $message)

No description

MigrationRepositoryInterface
getRepository()

Get the migration repository instance.

bool
repositoryExists()

No description

Details

at line 28
__construct(MigrationRepositoryInterface $repository, ConnectionInterface $connection, Filesystem $files)

Parameters

MigrationRepositoryInterface $repository
ConnectionInterface $connection
Filesystem $files

at line 38
void run(string $path, Extension|null $extension = null)

Run the outstanding migrations at a given path.

Parameters

string $path
Extension|null $extension

Return Value

void

at line 49
void runMigrationList(string $path, array $migrations, Extension|null $extension = null)

Parameters

string $path
array $migrations
Extension|null $extension

Return Value

void

at line 66
protected void runUpMigrations(array $migrations, string $path, Extension|null $extension = null)

Parameters

array $migrations
string $path
Extension|null $extension

Return Value

void

at line 82
protected void runDownMigrations(array $migrations, string $path, Extension|null $extension = null)

Parameters

array $migrations
string $path
Extension|null $extension

Return Value

void

at line 101
protected void runUp(string $path, string $file, Extension|null $extension = null)

Run "up" a migration instance.

Parameters

string $path
string $file
Extension|null $extension

Return Value

void

at line 116
int reset(string $path, Extension|null $extension = null)

Rolls all the currently applied migrations back.

Parameters

string $path
Extension|null $extension

Return Value

int

at line 136
protected void runDown(string $path, string $file, Extension|null $extension = null)

Run "down" a migration instance.

Parameters

string $path
string $file
Extension|null $extension

Return Value

void

at line 153
protected void runClosureMigration(array $migration, string $direction = 'up')

Runs a closure migration based on the migrate direction.

Parameters

array $migration
string $direction

Return Value

void

Exceptions

MigrationKeyMissing

at line 167
protected void resolveAndRunClosureMigration(string $path, string $file, string $direction = 'up')

Resolves and run a migration and assign the filename to the exception if needed.

Parameters

string $path
string $file
string $direction

Return Value

void

Exceptions

FileNotFoundException

at line 181
array getMigrationFiles(string $path)

Get all of the migration files in a given path.

Parameters

string $path

Return Value

array

at line 206
array resolve(string $path, string $file)

Resolve a migration instance from a file.

Parameters

string $path
string $file

Return Value

array

Exceptions

RuntimeException

at line 228
bool installFromSchema(string $path, DatabaseConfig $dbConfig)

Initialize the Flarum database from a schema dump.

Parameters

string $path to the directory containing the dump.
DatabaseConfig $dbConfig

Return Value

bool

at line 279
Migrator setOutput(OutputInterface $output)

Parameters

OutputInterface $output

Return Value

Migrator

at line 286
protected void note(string $message)

Parameters

string $message

Return Value

void

at line 294
MigrationRepositoryInterface getRepository()

Get the migration repository instance.

Return Value

MigrationRepositoryInterface

at line 299
bool repositoryExists()

Return Value

bool