SchemaCreateTableColumnEventArgs
extends SchemaEventArgs
in package
Event Arguments used when SQL queries for creating table columns are generated inside {@link AbstractPlatform}.
Table of Contents
- $_emptyEventArgsInstance : EventArgs
- Single instance of EventArgs.
- $column : Column
- $platform : AbstractPlatform
- $preventDefault : bool
- $sql : array<string|int, string>
- $table : Table
- __construct() : mixed
- addSql() : SchemaCreateTableColumnEventArgs
- Passing multiple SQL statements as an array is deprecated. Pass each statement as an individual argument instead.
- getColumn() : Column
- getEmptyInstance() : EventArgs
- Gets the single, empty and immutable EventArgs instance.
- getPlatform() : AbstractPlatform
- getSql() : array<string|int, string>
- getTable() : Table
- isDefaultPrevented() : bool
- preventDefault() : SchemaEventArgs
Properties
$_emptyEventArgsInstance
Single instance of EventArgs.
private
static EventArgs
$_emptyEventArgsInstance
$column
private
Column
$column
$platform
private
AbstractPlatform
$platform
$preventDefault
private
bool
$preventDefault
= false
$sql
private
array<string|int, string>
$sql
= []
$table
private
Table
$table
Methods
__construct()
public
__construct(Column $column, Table $table, AbstractPlatform $platform) : mixed
Parameters
- $column : Column
- $table : Table
- $platform : AbstractPlatform
Return values
mixed —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) : SchemaCreateTableColumnEventArgs
Parameters
- $sql : string|array<string|int, string>
Return values
SchemaCreateTableColumnEventArgs —getColumn()
public
getColumn() : Column
Return values
Column —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, string>
Return values
array<string|int, string> —getTable()
public
getTable() : Table
Return values
Table —isDefaultPrevented()
public
isDefaultPrevented() : bool
Return values
bool —preventDefault()
public
preventDefault() : SchemaEventArgs