Класс Index

Граф наследования:Index:

Открытые члены
	__construct ($name='', $unique, $fulltext=false)
	addColumn ($name)
	getCreateDdl ($dbType='')
	getDropDdl ($dbType='')
	getModifyDdl (BaseObject $target, $dbType='')
Открытые члены унаследованные от BaseObject
	__construct ($name='')
	setBody ($body)
	setParent (BaseObject $parent=null)
	getUnquotedName ($name=null)
	getLowercasedName ()
	compareName ($name)

Открытые статические члены
static	create (Tokenizer $tokenizer, $unique=false, $fulltext=false, $indexName='')
static	searchTableName (Tokenizer $tokenizer)
Открытые статические члены унаследованные от BaseObject
static	getCompareName ($name)

Открытые атрибуты
	$unique = false
	$fulltext = false
	$using = ''
	$columns = []
Открытые атрибуты унаследованные от BaseObject
	$parent = null
	$name = ''
	$body = ''

Дополнительные унаследованные члены
Защищенные данные унаследованные от BaseObject
	$ciName = ''

Подробное описание

См. определение в файле index.php строка 6

Конструктор(ы)

__construct()

__construct	(		$name = '',
			$unique,
			$fulltext = false )

Аргументы

string	$name	Index name.
bool	$unique	Uniqueness flag.
bool	$fulltext	Fulltext flag.

См. определение в файле index.php строка 18

Методы

addColumn()

addColumn

(

$name

)

Adds column to the index definition.

Аргументы

string

$name

Column name.

Возвращает

Index

См. определение в файле index.php строка 32

create()

static create ( Tokenizer $tokenizer, $unique = false, $fulltext = false, $indexName = '' )

static

Creates index object from tokens.

If parameter $indexName is not passed then current position should point to the name of the index.

Аргументы

Tokenizer	$tokenizer	Tokens collection.
bool	$unique	Uniqueness flag.
bool	$fulltext	Fulltext flag.
string	$indexName	Optional name of the index.

Возвращает

Index

Исключения

NotSupportedException

См. определение в файле index.php строка 52

getCreateDdl()

getCreateDdl

(

$dbType = ''

)

Return DDL for index creation.

Аргументы

string

$dbType

Database type (MYSQL, ORACLE or MSSQL).

Возвращает

array|string

Переопределяет метод предка BaseObject.

См. определение в файле index.php строка 167

getDropDdl()

getDropDdl

(

$dbType = ''

)

Return DDL for index destruction.

Аргументы

string

$dbType

Database type (MYSQL, ORACLE or MSSQL).

Возвращает

array|string

Переопределяет метод предка BaseObject.

См. определение в файле index.php строка 187

getModifyDdl()

getModifyDdl	(	BaseObject	$target,
			$dbType = '' )

Return DDL for index modification.

Аргументы

BaseObject	$target	Target object.
string	$dbType	Database type (MYSQL, ORACLE or MSSQL).

Возвращает

array|string

Переопределяет метод предка BaseObject.

См. определение в файле index.php строка 210

searchTableName()

static searchTableName ( Tokenizer $tokenizer )

static

Searches token collection for 'ON' keyword.

Advances current position on to next token skipping whitespace.

Аргументы

Tokenizer

$tokenizer

Tokens collection.

Возвращает

void

Исключения

NotSupportedException

См. определение в файле index.php строка 144

Данные класса

$columns

$columns = []

См. определение в файле index.php строка 11

$fulltext

$fulltext = false

См. определение в файле index.php строка 9

$unique

$unique = false

См. определение в файле index.php строка 8

$using

$using = ''

См. определение в файле index.php строка 10