MigrationCreator

class MigrationCreator (View source)

Properties

protected Filesystem $files The filesystem instance.
protected string $customStubPath The custom app stubs directory.
protected array $postCreate The registered post create hooks.

Methods

void __construct(Filesystem $files, string $customStubPath)

Create a new migration creator instance.
string create(string $name, string $path, string|null $table = null, bool $create = false)

Create a new migration at the given path.
void ensureMigrationDoesntAlreadyExist(string $name, string $migrationPath = null)

Ensure that a migration with the given name doesn't already exist.
string getStub(string|null $table, bool $create)

Get the migration stub file.
string populateStub(string $name, string $stub, string|null $table)

Populate the place-holders in the migration stub.
string getClassName(string $name)

Get the class name of a migration name.
string getPath(string $name, string $path)

Get the full path to the migration.
void firePostCreateHooks(string|null $table)

Fire the registered post create hooks.
void afterCreate(Closure $callback)

Register a post migration create hook.
string getDatePrefix()

Get the date prefix for the migration.
string stubPath()

Get the path to the stubs.
Filesystem getFilesystem()

Get the filesystem instance.

Details

void __construct(Filesystem $files, string $customStubPath)

Create a new migration creator instance.

Parameters

Filesystem $files
string $customStubPath

Return Value

void

string create(string $name, string $path, string|null $table = null, bool $create = false)

Create a new migration at the given path.

Parameters

string $name
string $path
string|null $table
bool $create

Return Value

string

Exceptions

Exception

protected void ensureMigrationDoesntAlreadyExist(string $name, string $migrationPath = null)

Ensure that a migration with the given name doesn't already exist.

Parameters

string $name
string $migrationPath

Return Value

void

Exceptions

InvalidArgumentException

protected string getStub(string|null $table, bool $create)

Get the migration stub file.

Parameters

string|null $table
bool $create

Return Value

string

protected string populateStub(string $name, string $stub, string|null $table)

Populate the place-holders in the migration stub.

Parameters

string $name
string $stub
string|null $table

Return Value

string

protected string getClassName(string $name)

Get the class name of a migration name.

Parameters

string $name

Return Value

string

protected string getPath(string $name, string $path)

Get the full path to the migration.

Parameters

string $name
string $path

Return Value

string

protected void firePostCreateHooks(string|null $table)

Fire the registered post create hooks.

Parameters

string|null $table

Return Value

void

void afterCreate(Closure $callback)

Register a post migration create hook.

Parameters

Closure $callback

Return Value

void

protected string getDatePrefix()

Get the date prefix for the migration.

Return Value

string

string stubPath()

Get the path to the stubs.

Return Value

string

Filesystem getFilesystem()

Get the filesystem instance.

Return Value

Filesystem

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Database/Migrations/MigrationCreator.html