print dbMapperIndexSet

Holds a set of Index definitions. This is used by the dbMapper when building a map of the database properties. It can be used standalone to simulate a tables indexes.

$oIndexSet = new dbMapperIndexSet();
$oIndexSet->addIndexDefinition(new dbMapperIndexDefinition());
$oIndexSet->addIndexDefinition(new dbMapperIndexDefinition());

Methods

public static getInstance()

Returns a single instance of the base set

public addIndexDefinition($oIndex)

Adds a Index definition to the set

public setIndexes($inIndexes)

Sets an array of indexes

public getIndexDefinition($inIndexName, [$inColumnName = null], [$inSequenceNum = 1])

Returns an Index definition from $inIndexName specifically for $inColumnName or $inSequenceNum

public removeIndexDefinition($oIndex)

Removes a Index definition

public removeIndexes()

Removes all Indexs

public countIndexes()

Returns number of Indexs in set

public isFieldInIndex($inFieldName)

Returns true if $inFieldName is contained in any index

public getFieldsInKey([$inKeyName = 'PRIMARY'])

Returns the names of the fields that make the primary key as an array(SequenceInKey => dbMapperIndexDefinition)

public getFieldsInUniqueKey()

Returns an array indexed by name of all dbIndexDefinition in the unique index(es) array[KEY_NAME][SEQ_ID] = dbMapperIndexDefinition

public getDistinctUniqueFields()

Returns an array of distinct fields that make up unique indexes

Inherited Methods

<  1  >

Posted by: Scorpio Documentor (Writer), in Db on 19 Nov 2009 @ 20:30

Tags: baseset, countable, db, dbmapperindexset, iteratoraggregate, traversable,

Creative Commons License
This work is licenced under a Creative Commons Licence.

Prev Next
November 2009
Su Mo Tu We Th Fr Sa
1 2 3 4 5 6 7
8 9 10 11 12 13 14
15 16 17 18 19 20 21
22 23 24 25 26 27 28
29 30