interface Index

A PHP representation of an index

Implemented by

Methods

string

name

( )

Returns the name of the index

Returns:
Type Details
string

Name of the index
string

kind

( )

Returns the kind of index

Returns:
Type Details
string

Kind of the index
string

target

( )

Returns the target column of the index

Returns:
Type Details
string

Target column name of the index
Dse\Value

option

( string $name )

Return a column’s option by name

Parameters:
Name Type Details
$name string

The name of the option
Returns:
Type Details
Dse\Value

Dse\Value of an option by name
array

options

( )

Returns all the index’s options

Returns:
Type Details
array

A dictionary of string and Value pairs of the index’s options.
string

className

( )

Returns the class name of the index

Returns:
Type Details
string

Class name of a custom index
bool

isCustom

( )

Determines if the index is a custom index.

Returns:
Type Details
bool

true if a custom index