xmldb_index Class Reference

Inheritance diagram for xmldb_index:

Public Member Functions
	__construct ($name, $type=null, $fields=array(), $hints=array())
	Creates one new xmldb_index.
	arr2xmldb_index ($xmlarr)
	Load data from XML to the index.
	calculateHash ($recursive=false)
	This function calculate and set the hash of one xmldb_index @retur nvoid, changes $this->hash.
	checkName ()
	This function will check if one key name is ok or no (true/false) only lowercase a-z, 0-9 and _ are allowed.
	checkNameValues ($arr)
	This function will check that all the elements in one array have a correct name [a-z0-9_].
	comma2array ($string)
	Returns one array of elements from one comma separated string, supporting quoted strings containing commas and concat function calls.
	debug ($message)
	This function will perform the central debug of all the XMLDB classes being called automatically every time one error is found.
	findObjectInArray ($objectname, $arr)
	Returns the position of one object in the array.
	fixPrevNext (&$arr)
	Reconstruct previous/next attributes.
	getComment ()
	This function returns the comment of one xmldb_object.
	getError ()
	This function will return the error detected in the object.
	getFields ()
	Get the index fields.
	getHash ()
	This function returns the hash of one xmldb_object.
	getHints ()
	Returns optional index hints.
	getName ()
	This function will return the name of the xmldb_object.
	getNext ()
	This function will return the name of the next xmldb_object.
	getPHP ()
	Returns the PHP code needed to define one xmldb_index.
	getPrevious ()
	This function will return the name of the previous xmldb_object.
	getUnique ()
	Get the index unique.
	hasChanged ()
	This function returns true/false, if the xmldb_object has changed.
	isLoaded ()
	This function returns true/false, if the xmldb_object has been loaded.
	orderElements ($arr)
	This function will order all the elements in one array, following the previous/next rules.
	readableInfo ()
	Shows info in a readable format.
	set_attributes ($type, $fields, $hints=array())
	Set all the attributes of one xmldb_index.
	setChanged ($changed=true)
	This function will set the changed field of the xmldb_object.
	setComment ($comment)
	This function will set the comment of the xmldb_object.
	setFields ($fields)
	Set the index fields.
	setFromADOIndex ($adoindex)
	This function will set all the attributes of the xmldb_index object based on information passed in one ADOindex.
	setHash ($hash)
	This function will set the hash of the xmldb_object.
	setHints ($hints)
	Set optional index hints.
	setLoaded ($loaded=true)
	This function will set the loaded field of the xmldb_object.
	setName ($name)
	This function will set the name field of the xmldb_object.
	setNext ($next)
	This function will set the next of the xmldb_object.
	setPrevious ($previous)
	This function will set the previous of the xmldb_object.
	setUnique ($unique=true)
	Set the index unique.
	validateDefinition (xmldb_table $xmldb_table=null)
	Validates the index restrictions.
	xmlOutput ()
	This function will output the XML text for one index.

Public Attributes
const	INDEX_COMPOSED_MAX_BYTES = 999
	Note:
const	INDEX_MAX_BYTES = 765
	Note:

Protected Attributes
bool	$changed
	was object changed
string	$comment
	comment on object
string	$errormsg
	error message
array	$fields
	index fields
string	$hash
	hash of object
array	$hints
	index hints
bool	$loaded
	is it loaded yet
string	$name
	name of obejct
string	$next
string	$previous
bool	$unique
	is unique?

Constructor & Destructor Documentation

__construct()

xmldb_index::__construct	(		$name,
			$type = null,
			$fields = array(),
			$hints = array() )

Creates one new xmldb_index.

Parameters

string	$name
string	$type	XMLDB_INDEX_UNIQUE, XMLDB_INDEX_NOTUNIQUE
array	$fields	an array of fieldnames to build the index over
array	$hints	an array of optional hints

Member Function Documentation

arr2xmldb_index()

xmldb_index::arr2xmldb_index

(

$xmlarr

)

Load data from XML to the index.

Parameters

$xmlarr

array

Return values

bool

checkName()

xmldb_object::checkName ( )

inherited

This function will check if one key name is ok or no (true/false) only lowercase a-z, 0-9 and _ are allowed.

Return values

bool

checkNameValues()

xmldb_object::checkNameValues ( $arr )

inherited

This function will check that all the elements in one array have a correct name [a-z0-9_].

Parameters

array

$arr

Return values

bool

comma2array()

xmldb_object::comma2array ( $string )

inherited

Returns one array of elements from one comma separated string, supporting quoted strings containing commas and concat function calls.

Parameters

string

$string

Return values

array

debug()

xmldb_object::debug ( $message )

inherited

This function will perform the central debug of all the XMLDB classes being called automatically every time one error is found.

Apart from the main actions performed in it (XMLDB agnostic) it looks for one function called xmldb_debug() and invokes it, passing both the message code and the whole object. So, to perform custom debugging just add such function to your libs.

Call to the external hook function can be disabled by request by defining XMLDB_SKIP_DEBUG_HOOK

Parameters

string

$message

findObjectInArray()

xmldb_object::findObjectInArray ( $objectname, $arr )

inherited

Returns the position of one object in the array.

Parameters

string	$objectname
array	$arr

Return values

mixed

fixPrevNext()

xmldb_object::fixPrevNext ( & $arr )

inherited

Reconstruct previous/next attributes.

Parameters

array

$arr

Return values

bool	true if $arr modified

getComment()

xmldb_object::getComment ( )

inherited

This function returns the comment of one xmldb_object.

Return values

string

getError()

xmldb_object::getError ( )

inherited

This function will return the error detected in the object.

Return values

string

getFields()

xmldb_index::getFields

(

)

Get the index fields.

Return values

array

getHash()

xmldb_object::getHash ( )

inherited

This function returns the hash of one xmldb_object.

Return values

string

getHints()

xmldb_index::getHints

(

)

Returns optional index hints.

Return values

array

getName()

xmldb_object::getName ( )

inherited

This function will return the name of the xmldb_object.

Return values

string

getNext()

xmldb_object::getNext ( )

inherited

This function will return the name of the next xmldb_object.

Return values

string

getPHP()

xmldb_index::getPHP

(

)

Returns the PHP code needed to define one xmldb_index.

Return values

string

getPrevious()

xmldb_object::getPrevious ( )

inherited

This function will return the name of the previous xmldb_object.

Return values

string

getUnique()

xmldb_index::getUnique

(

)

Get the index unique.

Return values

bool

hasChanged()

xmldb_object::hasChanged ( )

inherited

This function returns true/false, if the xmldb_object has changed.

Return values

bool

isLoaded()

xmldb_object::isLoaded ( )

inherited

This function returns true/false, if the xmldb_object has been loaded.

Return values

bool

orderElements()

xmldb_object::orderElements ( $arr )

inherited

This function will order all the elements in one array, following the previous/next rules.

Parameters

array

$arr

Return values

array|bool

readableInfo()

xmldb_index::readableInfo

(

)

Shows info in a readable format.

Return values

string

Reimplemented from xmldb_object.

set_attributes()

xmldb_index::set_attributes	(		$type,
			$fields,
			$hints = array() )

Set all the attributes of one xmldb_index.

Parameters

	string	type XMLDB_INDEX_UNIQUE, XMLDB_INDEX_NOTUNIQUE
	array	fields an array of fieldnames to build the index over
array	$hints	array of optional hints

setChanged()

xmldb_object::setChanged ( $changed = true )

inherited

This function will set the changed field of the xmldb_object.

Parameters

bool

$changed

setComment()

xmldb_object::setComment ( $comment )

inherited

This function will set the comment of the xmldb_object.

Parameters

string

$comment

setFields()

xmldb_index::setFields

(

$fields

)

Set the index fields.

Parameters

array

$fields

setFromADOIndex()

xmldb_index::setFromADOIndex

(

$adoindex

)

This function will set all the attributes of the xmldb_index object based on information passed in one ADOindex.

Parameters

array

Return values

void

setHash()

xmldb_object::setHash ( $hash )

inherited

This function will set the hash of the xmldb_object.

Parameters

string

$hash

setHints()

xmldb_index::setHints

(

$hints

)

Set optional index hints.

Parameters

array

$hints

setLoaded()

xmldb_object::setLoaded ( $loaded = true )

inherited

This function will set the loaded field of the xmldb_object.

Parameters

bool

$loaded

setName()

xmldb_object::setName ( $name )

inherited

This function will set the name field of the xmldb_object.

Parameters

string

$name

setNext()

xmldb_object::setNext ( $next )

inherited

This function will set the next of the xmldb_object.

Parameters

string

$next

setPrevious()

xmldb_object::setPrevious ( $previous )

inherited

This function will set the previous of the xmldb_object.

Parameters

string

$previous

setUnique()

xmldb_index::setUnique

(

$unique = true

)

Set the index unique.

Parameters

bool

$unique

validateDefinition()

xmldb_index::validateDefinition

(

xmldb_table

$xmldb_table = null

)

Validates the index restrictions.

The error message should not be localised because it is intended for developers, end users and admins should never see these problems!

Parameters

xmldb_table

$xmldb_table

optional when object is table

Return values

string

null if ok, error message if problem found

Reimplemented from xmldb_object.

xmlOutput()

xmldb_index::xmlOutput

(

)

This function will output the XML text for one index.

Return values

string

Member Data Documentation

INDEX_COMPOSED_MAX_BYTES

const xmldb_index::INDEX_COMPOSED_MAX_BYTES = 999

Note:

• MySQL: MyISAM has a limit of 1000 bytes for any key including composed, InnoDB has limit 3500 bytes.

@const max length of composed indexes, one utf-8 char is 3 bytes in the worst case

INDEX_MAX_BYTES

const xmldb_index::INDEX_MAX_BYTES = 765

Note:

• MySQL: InnoDB limits size of index on single column to 767bytes (256 chars)

@const single column index length limit, one utf-8 char is 3 bytes in the worst case

---

The documentation for this class was generated from the following file:

• lib/xmldb/xmldb_index.php