SchemaAlterTableEventArgs
extends SchemaEventArgs
in package
Event Arguments used when SQL queries for creating tables are generated inside Doctrine\DBAL\Platform\*Platform.
Tags
Table of Contents
- $_emptyEventArgsInstance : EventArgs
- Single instance of EventArgs.
- $_platform : AbstractPlatform
- $_preventDefault : bool
- $_sql : array<string|int, mixed>
- $_tableDiff : TableDiff
- __construct() : mixed
- addSql() : SchemaAlterTableEventArgs
- getEmptyInstance() : EventArgs
- Gets the single, empty and immutable EventArgs instance.
- getPlatform() : AbstractPlatform
- getSql() : array<string|int, mixed>
- getTableDiff() : TableDiff
- isDefaultPrevented() : bool
- preventDefault() : SchemaEventArgs
Properties
$_emptyEventArgsInstance
Single instance of EventArgs.
private
static EventArgs
$_emptyEventArgsInstance
$_platform
private
AbstractPlatform
$_platform
$_preventDefault
private
bool
$_preventDefault
= false
$_sql
private
array<string|int, mixed>
$_sql
= array()
$_tableDiff
private
TableDiff
$_tableDiff
Methods
__construct()
public
__construct(TableDiff $tableDiff, AbstractPlatform $platform) : mixed
Parameters
- $tableDiff : TableDiff
- $platform : AbstractPlatform
Return values
mixed —addSql()
public
addSql(string|array<string|int, mixed> $sql) : SchemaAlterTableEventArgs
Parameters
- $sql : string|array<string|int, mixed>
Return values
SchemaAlterTableEventArgs —getEmptyInstance()
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
EventArgs —getPlatform()
public
getPlatform() : AbstractPlatform
Return values
AbstractPlatform —getSql()
public
getSql() : array<string|int, mixed>
Return values
array<string|int, mixed> —getTableDiff()
public
getTableDiff() : TableDiff
Return values
TableDiff —isDefaultPrevented()
public
isDefaultPrevented() : bool
Return values
bool —preventDefault()
public
preventDefault() : SchemaEventArgs