SchemaIndexDefinitionEventArgs
extends SchemaEventArgs
in package
Event Arguments used when the portable index definition is generated inside Doctrine\DBAL\Schema\AbstractSchemaManager.
Tags
Table of Contents
- $_connection : Connection
- $_emptyEventArgsInstance : EventArgs
- Single instance of EventArgs.
- $_index : Index|null
- $_preventDefault : bool
- $_table : string
- $_tableIndex : array<string|int, mixed>
- Raw index data as fetched from the database.
- __construct() : mixed
- getConnection() : Connection
- getDatabasePlatform() : AbstractPlatform
- getEmptyInstance() : EventArgs
- Gets the single, empty and immutable EventArgs instance.
- getIndex() : Index|null
- getTable() : string
- getTableIndex() : array<string|int, mixed>
- isDefaultPrevented() : bool
- preventDefault() : SchemaEventArgs
- setIndex() : SchemaIndexDefinitionEventArgs
- Allows to clear the index which means the index will be excluded from tables index list.
Properties
$_connection
private
Connection
$_connection
$_emptyEventArgsInstance
Single instance of EventArgs.
private
static EventArgs
$_emptyEventArgsInstance
$_index
private
Index|null
$_index
= null
$_preventDefault
private
bool
$_preventDefault
= false
$_table
private
string
$_table
$_tableIndex
Raw index data as fetched from the database.
private
array<string|int, mixed>
$_tableIndex
Methods
__construct()
public
__construct(array<string|int, mixed> $tableIndex, string $table, Connection $connection) : mixed
Parameters
- $tableIndex : array<string|int, mixed>
- $table : string
- $connection : Connection
Return values
mixed —getConnection()
public
getConnection() : Connection
Return values
Connection —getDatabasePlatform()
public
getDatabasePlatform() : AbstractPlatform
Return values
AbstractPlatform —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 —getIndex()
public
getIndex() : Index|null
Return values
Index|null —getTable()
public
getTable() : string
Return values
string —getTableIndex()
public
getTableIndex() : array<string|int, mixed>
Return values
array<string|int, mixed> —isDefaultPrevented()
public
isDefaultPrevented() : bool
Return values
bool —preventDefault()
public
preventDefault() : SchemaEventArgs
Return values
SchemaEventArgs —setIndex()
Allows to clear the index which means the index will be excluded from tables index list.
public
setIndex([null|Index $index = null ]) : SchemaIndexDefinitionEventArgs
Parameters
- $index : null|Index = null