Doctrine\DBAL\Event\SchemaIndexDefinitionEventArgs
Event Arguments used when the portable index definition is generated inside Doctrine\DBAL\Schema\AbstractSchemaManager.
- Author: Jan Sorgalla <jsorgalla@googlemail.com>
- License: http://www.opensource.org/licenses/lgpl-license.php LGPL
Synopsis
class SchemaIndexDefinitionEventArgs
extends SchemaEventArgs
{
- // members
- private Index $_index;
- private array $_tableIndex;
- private string $_table;
- private Connection $_connection;
- // methods
- public void __construct()
- public SchemaIndexDefinitionEventArgs setIndex()
- public Index getIndex()
- public array getTableIndex()
- public string getTable()
- public Connection getConnection()
- public AbstractPlatform getDatabasePlatform()
- // Inherited methods from SchemaEventArgs
- public SchemaEventArgs preventDefault()
- public boolean isDefaultPrevented()
- // Inherited methods from EventArgs
- public static EventArgs getEmptyInstance()
Hierarchy
Members
private
- $_connection — \Doctrine\DBAL\Connection
- $_index — \Doctrine\DBAL\Schema\Index
- $_table — string
- $_tableIndex
—
array
Raw index data as fetched from the database
Methods
public
- __construct()
- getConnection()
- getDatabasePlatform()
- getIndex()
- getTable()
- getTableIndex()
- setIndex() — Allows to clear the index which means the index will be excluded from tables index list.
Inherited from Doctrine\DBAL\Event\SchemaEventArgs
public
Inherited from Doctrine\Common\EventArgs
public
- getEmptyInstance() — Gets the single, empty and immutable EventArgs instance.