Doctrine\DBAL\Schema\Index
Synopsis
class Index
extends AbstractAsset
implements
Constraint
{
- // members
- protected array $_columns;
- protected bool $_isUnique;
- protected bool $_isPrimary;
- protected array $_flags;
- // Inherited members from AbstractAsset
- protected string $_name;
- protected string $_namespace;
- protected bool $_quoted;
- // methods
- public void __construct()
- protected void _addColumn()
- public array getColumns()
- public array getUnquotedColumns()
- public bool isSimpleIndex()
- public bool isUnique()
- public bool isPrimary()
- public bool hasColumnAtPosition()
- public boolean spansColumns()
- public bool isFullfilledBy()
- public bool overrules()
- public Index addFlag()
- public bool hasFlag()
- public void removeFlag()
- // Inherited methods from AbstractAsset
- protected void _setName()
- public bool isInDefaultNamespace()
- public string getNamespaceName()
- public string getShortestName()
- public string getFullQualifiedName()
- public bool isQuoted()
- protected bool isIdentifierQuoted()
- protected string trimQuotes()
- public string getName()
- public string getQuotedName()
- protected string _generateIdentifierName()
Hierarchy
Members
protected
- $_columns — array
- $_flags
—
array
Platform specific flags for indexes. - $_isPrimary — Doctrine\DBAL\Schema\bool
- $_isUnique — Doctrine\DBAL\Schema\bool
- $_name — string
- $_namespace
—
string
Namespace of the asset. If none isset the default namespace is assumed. - $_quoted — Doctrine\DBAL\Schema\bool
Methods
protected
public
- __construct()
- addFlag() — Add Flag for an index that translates to platform specific handling.
- getColumns()
- getUnquotedColumns()
- hasColumnAtPosition()
- hasFlag() — Does this index have a specific flag?
- isFullfilledBy() — Check if the other index already fullfills all the indexing and constraint needs of the current one.
- isPrimary()
- isSimpleIndex() — Is the index neither unique nor primary key?
- isUnique()
- overrules() — Detect if the other index is a non-unique, non primary index that can be overwritten by this one.
- removeFlag() — Remove a flag
- spansColumns() — Check if this index exactly spans the given column names in the correct order.
Inherited from Doctrine\DBAL\Schema\AbstractAsset
protected
- _generateIdentifierName() — Generate an identifier from a list of column names obeying a certain string length.
- _setName() — Set name of this asset
- isIdentifierQuoted() — Check if this identifier is quoted.
- trimQuotes() — Trim quotes from the identifier.
public
- getFullQualifiedName() — The normalized name is full-qualified and lowerspaced. Lowerspacing is actually wrong, but we have to do it to keep our sanity. If you are using database objects that only differentiate in the casing (FOO vs Foo) then you will NOT be able to use Doctrine Schema abstraction.
- getName() — Return name of this schema asset.
- getNamespaceName() — Get namespace name of this asset.
- getQuotedName() — Get the quoted representation of this asset but only if it was defined with one. Otherwise return the plain unquoted value as inserted.
- getShortestName() — The shortest name is stripped of the default namespace. All other namespaced elements are returned as full-qualified names.
- isInDefaultNamespace() — Is this asset in the default namespace?
- isQuoted() — Check if this asset's name is quoted