PHP Класс dbIndex, pkp-lib

This class stores information about a database index. As charactaristics of the index are loaded from the external source, methods and properties of this class are used to build up the index description in ADOdb's datadict format.
Показать файл Открыть проект

Открытые свойства

Свойство Тип Описание
$columns Indexed fields: Table columns included in this index
$drop Mark index for destruction
$name Index name
$opts Index options: Index-level options

Открытые методы

Метод Описание
_tag_cdata ( &$parser, $cdata ) XML Callback to process CDATA elements
_tag_close ( &$parser, $tag ) XML Callback to process end elements
_tag_open ( &$parser, $tag, $attributes ) XML Callback to process start elements
addField ( string $name ) : string Adds a field to the index
addIndexOpt ( string $opt ) : string Adds options to the index
create ( object &$xmls ) : array Generates the SQL that will create the index in the database
dbIndex ( object &$parent, array $attributes = NULL ) Initializes the new dbIndex object.
drop ( ) Marks an index for destruction

Описание методов

_tag_cdata() публичный Метод

Processes XML cdata.
public _tag_cdata ( &$parser, $cdata )

_tag_close() публичный Метод

XML Callback to process end elements
public _tag_close ( &$parser, $tag )

_tag_open() публичный Метод

Processes XML opening tags. Elements currently processed are: DROP, CLUSTERED, BITMAP, UNIQUE, FULLTEXT & HASH.
public _tag_open ( &$parser, $tag, $attributes )

addField() публичный Метод

Adds a field to the index
public addField ( string $name ) : string
$name string Field name
Результат string Field list

addIndexOpt() публичный Метод

Adds options to the index
public addIndexOpt ( string $opt ) : string
$opt string Comma-separated list of index options.
Результат string Option list

create() публичный Метод

Generates the SQL that will create the index in the database
public create ( object &$xmls ) : array
$xmls object adoSchema object
Результат array Array containing index creation SQL

dbIndex() публичный Метод

Initializes the new dbIndex object.
public dbIndex ( object &$parent, array $attributes = NULL )
$parent object Parent object
$attributes array Attributes

drop() публичный Метод

Marks an index for destruction
public drop ( )

Описание свойств

$columns публичное свойство

Indexed fields: Table columns included in this index
public $columns

$drop публичное свойство

Mark index for destruction
public $drop

$name публичное свойство

Index name
public $name

$opts публичное свойство

Index options: Index-level options
public $opts