SchemaColumnDefinitionEventArgs
extends SchemaEventArgs
in package
Event Arguments used when the portable column definition is generated inside {@link AbstractPlatform}.
Table of Contents
- $_emptyEventArgsInstance : EventArgs
- Single instance of EventArgs.
- $column : Column|null
- $connection : Connection
- $database : string
- $preventDefault : bool
- $table : string
- $tableColumn : array<string|int, mixed>
- Raw column data as fetched from the database.
- __construct() : mixed
- getColumn() : Column|null
- getConnection() : Connection
- getDatabase() : string
- getEmptyInstance() : EventArgs
- Gets the single, empty and immutable EventArgs instance.
- getTable() : string
- getTableColumn() : array<string|int, mixed>
- isDefaultPrevented() : bool
- preventDefault() : SchemaEventArgs
- setColumn() : SchemaColumnDefinitionEventArgs
- Allows to clear the column which means the column will be excluded from tables column list.
Properties
$_emptyEventArgsInstance
Single instance of EventArgs.
private
static EventArgs
$_emptyEventArgsInstance
$column
private
Column|null
$column
$connection
private
Connection
$connection
$database
private
string
$database
$preventDefault
private
bool
$preventDefault
= false
$table
private
string
$table
$tableColumn
Raw column data as fetched from the database.
private
array<string|int, mixed>
$tableColumn
Methods
__construct()
public
__construct(array<string|int, mixed> $tableColumn, string $table, string $database, Connection $connection) : mixed
Parameters
- $tableColumn : array<string|int, mixed>
- $table : string
- $database : string
- $connection : Connection
Return values
mixed —getColumn()
public
getColumn() : Column|null
Return values
Column|null —getConnection()
public
getConnection() : Connection
Return values
Connection —getDatabase()
public
getDatabase() : string
Return values
string —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 —getTable()
public
getTable() : string
Return values
string —getTableColumn()
public
getTableColumn() : array<string|int, mixed>
Return values
array<string|int, mixed> —isDefaultPrevented()
public
isDefaultPrevented() : bool
Return values
bool —preventDefault()
public
preventDefault() : SchemaEventArgs
Return values
SchemaEventArgs —setColumn()
Allows to clear the column which means the column will be excluded from tables column list.
public
setColumn([Column|null $column = null ]) : SchemaColumnDefinitionEventArgs
Parameters
- $column : Column|null = null