SchemaDropTableEventArgs
extends SchemaEventArgs
in package
Event Arguments used when the SQL query for dropping tables are generated inside {@link AbstractPlatform}.
Table of Contents
- $_emptyEventArgsInstance : EventArgs
- Single instance of EventArgs.
- $platform : AbstractPlatform
- $preventDefault : bool
- $sql : string|null
- $table : string|Table
- __construct() : mixed
- getEmptyInstance() : EventArgs
- Gets the single, empty and immutable EventArgs instance.
- getPlatform() : AbstractPlatform
- getSql() : string|null
- getTable() : string|Table
- isDefaultPrevented() : bool
- preventDefault() : SchemaEventArgs
- setSql() : SchemaDropTableEventArgs
Properties
$_emptyEventArgsInstance
Single instance of EventArgs.
private
static EventArgs
$_emptyEventArgsInstance
$platform
private
AbstractPlatform
$platform
$preventDefault
private
bool
$preventDefault
= false
$sql
private
string|null
$sql
$table
private
string|Table
$table
Methods
__construct()
public
__construct(string|Table $table, AbstractPlatform $platform) : mixed
Parameters
- $table : string|Table
- $platform : AbstractPlatform
Tags
Return values
mixed —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() : string|null
Return values
string|null —getTable()
public
getTable() : string|Table
Return values
string|Table —isDefaultPrevented()
public
isDefaultPrevented() : bool
Return values
bool —preventDefault()
public
preventDefault() : SchemaEventArgs
Return values
SchemaEventArgs —setSql()
public
setSql(string $sql) : SchemaDropTableEventArgs
Parameters
- $sql : string