AbstractMigration
in package
The AbstractMigration class is for end users to extend from when creating migrations. Extend this class and implement the required up() and down() methods.
Table of Contents
- $connection : Connection
- $platform : AbstractPlatform
- $sm : AbstractSchemaManager
- $logger : LoggerInterface
- $plannedSql : array<string|int, Query>
- __construct() : mixed
- abortIf() : void
- down() : void
- getDescription() : string
- getSql() : array<string|int, Query>
- isTransactional() : bool
- Indicates the transactional mode of this migration.
- postDown() : void
- postUp() : void
- preDown() : void
- preUp() : void
- skipIf() : void
- up() : void
- warnIf() : void
- addSql() : void
- throwIrreversibleMigrationException() : void
- write() : void
Properties
$connection
protected
Connection
$connection
$platform
protected
AbstractPlatform
$platform
$sm
protected
AbstractSchemaManager
$sm
$logger
private
LoggerInterface
$logger
$plannedSql
private
array<string|int, Query>
$plannedSql
= []
Methods
__construct()
public
__construct(Connection $connection, LoggerInterface $logger) : mixed
Parameters
- $connection : Connection
- $logger : LoggerInterface
Return values
mixed —abortIf()
public
abortIf(bool $condition[, string $message = 'Unknown Reason' ]) : void
Parameters
- $condition : bool
- $message : string = 'Unknown Reason'
Tags
Return values
void —down()
public
down(Schema $schema) : void
Parameters
- $schema : Schema
Tags
Return values
void —getDescription()
public
getDescription() : string
Return values
string —getSql()
public
getSql() : array<string|int, Query>
Return values
array<string|int, Query> —isTransactional()
Indicates the transactional mode of this migration.
public
isTransactional() : bool
If this function returns true (default) the migration will be executed in one transaction, otherwise non-transactional state will be used to execute each of the migration SQLs.
Extending class should override this function to alter the return value.
Return values
bool —postDown()
public
postDown(Schema $schema) : void
Parameters
- $schema : Schema
Tags
Return values
void —postUp()
public
postUp(Schema $schema) : void
Parameters
- $schema : Schema
Tags
Return values
void —preDown()
public
preDown(Schema $schema) : void
Parameters
- $schema : Schema
Tags
Return values
void —preUp()
public
preUp(Schema $schema) : void
Parameters
- $schema : Schema
Tags
Return values
void —skipIf()
public
skipIf(bool $condition[, string $message = 'Unknown Reason' ]) : void
Parameters
- $condition : bool
- $message : string = 'Unknown Reason'
Tags
Return values
void —up()
public
abstract up(Schema $schema) : void
Parameters
- $schema : Schema
Tags
Return values
void —warnIf()
public
warnIf(bool $condition[, string $message = 'Unknown Reason' ]) : void
Parameters
- $condition : bool
- $message : string = 'Unknown Reason'
Return values
void —addSql()
protected
addSql(string $sql[, array<string|int, mixed> $params = [] ][, array<string|int, mixed> $types = [] ]) : void
Parameters
- $sql : string
- $params : array<string|int, mixed> = []
- $types : array<string|int, mixed> = []
Return values
void —throwIrreversibleMigrationException()
protected
throwIrreversibleMigrationException([string|null $message = null ]) : void
Parameters
- $message : string|null = null
Tags
Return values
void —write()
protected
write(string $message) : void
Parameters
- $message : string