Aplus Framework Docs
IndexDefinition
extends DefinitionPart
in package
Class IndexDefinition.
Tags
Table of Contents
- $database : Database
- $index : Index|null
- $name : string|null
- __call() : mixed
- __construct() : mixed
- foreignKey() : ForeignKey
- fulltextKey() : FulltextKey
- key() : Key
- primaryKey() : PrimaryKey
- spatialKey() : SpatialKey
- uniqueKey() : UniqueKey
- sql() : string
Properties
$database
protected
Database
$database
$index
protected
Index|null
$index
= null
$name
protected
string|null
$name
Methods
__call()
public
__call(string $method, array<int, mixed> $arguments) : mixed
Parameters
- $method : string
- $arguments : array<int, mixed>
Return values
mixed —__construct()
public
__construct(Database $database[, string $name = null ]) : mixed
Parameters
- $database : Database
- $name : string = null
Return values
mixed —foreignKey()
public
foreignKey(string $column, string ...$columns) : ForeignKey
Parameters
- $column : string
- $columns : string
Return values
ForeignKey —fulltextKey()
public
fulltextKey(string $column, string ...$columns) : FulltextKey
Parameters
- $column : string
- $columns : string
Return values
FulltextKey —key()
public
key(string $column, string ...$columns) : Key
Parameters
- $column : string
- $columns : string
Return values
Key —primaryKey()
public
primaryKey(string $column, string ...$columns) : PrimaryKey
Parameters
- $column : string
- $columns : string
Return values
PrimaryKey —spatialKey()
public
spatialKey(string $column, string ...$columns) : SpatialKey
Parameters
- $column : string
- $columns : string
Return values
SpatialKey —uniqueKey()
public
uniqueKey(string $column, string ...$columns) : UniqueKey
Parameters
- $column : string
- $columns : string
Return values
UniqueKey —sql()
protected
sql() : string