Index
in package
Tags
Table of Contents
- $columns : array<string|int, mixed>
- The columns this index covers.
- $name : string
- The index's name.
- $primary : bool
- Is this a primary key?
- $table : string
- The table the index is on.
- $unique : mixed
- __construct() : mixed
- Constructor.
- __toString() : string
- Comma-separated list of the columns in the primary key
- getName() : string
Properties
$columns
The columns this index covers.
public
array<string|int, mixed>
$columns
$name
The index's name.
public
string
$name
$primary
Is this a primary key?
public
bool
$primary
$table
The table the index is on.
public
string
$table
$unique
public
mixed
$unique
Methods
__construct()
Constructor.
public
__construct(string $table, string $name, bool $primary, bool $unique, array<string|int, mixed> $columns) : mixed
Parameters
- $table : string
-
The table the index is on.
- $name : string
-
The index's name.
- $primary : bool
-
Is this a primary key?
- $unique : bool
-
Is this a unique index?
- $columns : array<string|int, mixed>
-
The columns this index covers.
Return values
mixed —__toString()
Comma-separated list of the columns in the primary key
public
__toString() : string
Return values
string —getName()
public
getName() : string