class IndexColumn

Index column wrapper

Methods

__construct(array $params = [])

Constructor

void
set(array $params)

Sets parameters of the index column

string
getName()

Returns the column name

string
getCollation()

Return the column collation

int
getCardinality()

Returns the cardinality of the column

mixed
getNull(boolean $as_text = false)

Returns whether the column is nullable

int
getSeqInIndex()

Returns the sequence number of the column in the index

int
getSubPart()

Returns the number of indexed characters if the column is only partly indexed

array
getCompareData()

Gets the properties in an array for comparison purposes

Details

at line 66
__construct(array $params = [])

Constructor

Parameters

array $params an array containing the parameters of the index column

at line 78
void set(array $params)

Sets parameters of the index column

Parameters

array $params an array containing the parameters of the index column

Return Value

void

at line 105
string getName()

Returns the column name

Return Value

string column name

at line 115
string getCollation()

Return the column collation

Return Value

string column collation

at line 125
int getCardinality()

Returns the cardinality of the column

Return Value

int cardinality of the column

at line 138
mixed getNull(boolean $as_text = false)

Returns whether the column is nullable

Parameters

boolean $as_text whether to returned the string representation

Return Value

mixed nullability of the column. True/false or Yes/No depending on the value of the $as_text parameter

at line 156
int getSeqInIndex()

Returns the sequence number of the column in the index

Return Value

int sequence number of the column in the index

at line 167
int getSubPart()

Returns the number of indexed characters if the column is only partly indexed

Return Value

int the number of indexed characters

at line 177
array getCompareData()

Gets the properties in an array for comparison purposes

Return Value

array an array containing the properties of the index column