\Phinx\Db\TableIndex

Summary

Methods
Properties
Constants
setColumns()
getColumns()
setType()
getType()
setName()
getName()
setLimit()
getLimit()
setOptions()
No public properties found
UNIQUE
INDEX
FULLTEXT
No protected methods found
$columns
$type
$name
$limit
N/A
No private methods found
No private properties found
N/A

Constants

UNIQUE

UNIQUE = 'unique' : string

INDEX

INDEX = 'index' : string

FULLTEXT

FULLTEXT = 'fulltext' : string

Properties

$columns

$columns : array

Type

array

$type

$type : string

Type

string

$name

$name : string

Type

string

$limit

$limit : integer

Type

integer

Methods

setColumns()

setColumns(array  $columns) : \Phinx\Db\Table\Index

Sets the index columns.

Parameters

array $columns

Returns

\Phinx\Db\Table\Index

getColumns()

getColumns() : array

Gets the index columns.

Returns

array

setType()

setType(string  $type) : \Phinx\Db\Table\Index

Sets the index type.

Parameters

string $type

Returns

\Phinx\Db\Table\Index

getType()

getType() : string

Gets the index type.

Returns

string

setName()

setName(string  $name) : \Phinx\Db\Table\Index

Sets the index name.

Parameters

string $name

Returns

\Phinx\Db\Table\Index

getName()

getName() : string

Gets the index name.

Returns

string

setLimit()

setLimit(integer  $limit) : \Phinx\Db\Table\Index

Sets the index limit.

Parameters

integer $limit

Returns

\Phinx\Db\Table\Index

getLimit()

getLimit() : integer

Gets the index limit.

Returns

integer

setOptions()

setOptions(array  $options) : \Phinx\Db\Table\Index

Utility method that maps an array of index options to this objects methods.

Parameters

array $options

Options

Throws

\RuntimeException

Returns

\Phinx\Db\Table\Index