SchemaAlterTableEventArgs
extends SchemaEventArgs
in package
Event Arguments used when SQL queries for creating tables are generated inside {@see AbstractPlatform}.
Tags
Table of Contents
Properties
- $_emptyEventArgsInstance : EventArgs|null
- Single instance of EventArgs.
- $platform : AbstractPlatform
- $preventDefault : bool
- $sql : array<string|int, string>
- $tableDiff : TableDiff
Methods
- __construct() : mixed
- addSql() : SchemaAlterTableEventArgs
- Passing multiple SQL statements as an array is deprecated. Pass each statement as an individual argument instead.
- getEmptyInstance() : EventArgs
- Gets the single, empty and immutable EventArgs instance.
- getPlatform() : AbstractPlatform
- getSql() : array<string|int, string>
- getTableDiff() : TableDiff
- isDefaultPrevented() : bool
- preventDefault() : SchemaEventArgs
Properties
$_emptyEventArgsInstance
Single instance of EventArgs.
private
static EventArgs|null
$_emptyEventArgsInstance
$platform
private
AbstractPlatform
$platform
$preventDefault
private
bool
$preventDefault
= false
$sql
private
array<string|int, string>
$sql
= []
$tableDiff
private
TableDiff
$tableDiff
Methods
__construct()
public
__construct(TableDiff $tableDiff, AbstractPlatform $platform) : mixed
Parameters
- $tableDiff : TableDiff
- $platform : AbstractPlatform
addSql()
Passing multiple SQL statements as an array is deprecated. Pass each statement as an individual argument instead.
public
addSql(string|array<string|int, string> $sql) : SchemaAlterTableEventArgs
Parameters
- $sql : string|array<string|int, string>
Return values
SchemaAlterTableEventArgsgetEmptyInstance()
Gets the single, empty and immutable EventArgs instance.
public
static getEmptyInstance() : EventArgs
This instance will be used when events are dispatched without any parameter, like this: EventManager::dispatchEvent('eventname');
The benefit from this is that only one empty instance is instantiated and shared (otherwise there would be instances for every dispatched in the abovementioned form).
Tags
Return values
EventArgsgetPlatform()
public
getPlatform() : AbstractPlatform
Return values
AbstractPlatformgetSql()
public
getSql() : array<string|int, string>
Return values
array<string|int, string>getTableDiff()
public
getTableDiff() : TableDiff
Return values
TableDiffisDefaultPrevented()
public
isDefaultPrevented() : bool
Return values
boolpreventDefault()
public
preventDefault() : SchemaEventArgs