Inheritance diagram for xmldb_structure:

Public Member Functions
	__construct ($name)
	Creates one new xmldb_structure. More...

	addTable ($table, $after=null)
	Add one table to the structure, allowing to specify the desired order If it's not specified, then the table is added at the end. More...

	arr2xmldb_structure ($xmlarr)
	Load data from XML to the structure. More...

	calculateHash ($recursive=false)
	This function calculate and set the hash of one xmldb_structure. More...

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

	checkNameValues ($arr)
	This function will check that all the elements in one array have a correct name [a-z0-9_]. More...

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

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

	deleteTable ($tablename)
	Delete one table from the Structure. More...

	findObjectInArray ($objectname, $arr)
	Returns the position of one object in the array. More...

	findTableInArray ($tablename)
	Returns the position of one table in the array. More...

	fixPrevNext (&$arr)
	Reconstruct previous/next attributes. More...

	getAllErrors ()
	This function will return all the errors found in one structure looking recursively inside each table. More...

	getComment ()
	This function returns the comment of one xmldb_object. More...

	getError ()
	This function will return the error detected in the object. More...

	getFieldUses ($tablename, $fieldname)
	This function returns the number of uses of one field inside a whole xmldb_structure. More...

	getHash ()
	This function returns the hash of one xmldb_object. More...

	getIndexUses ($tablename, $indexname)
	This function returns the number of uses of one index inside a whole xmldb_structure. More...

	getKeyUses ($tablename, $keyname)
	This function returns the number of uses of one key inside a whole xmldb_structure. More...

	getName ()
	This function will return the name of the xmldb_object. More...

	getNext ()
	This function will return the name of the next xmldb_object. More...

	getPath ()
	Returns the path of the structure. More...

	getPrevious ()
	This function will return the name of the previous xmldb_object. More...

	getTable ($tablename)
	Returns one xmldb_table. More...

	getTables ()
	Returns the tables of the structure. More...

	getTableUses ($tablename)
	This function returns the number of uses of one table inside a whole XMLDStructure. More...

	getVersion ()
	Returns the version of the structure. More...

	hasChanged ()
	This function returns true/false, if the xmldb_object has changed. More...

	isLoaded ()
	This function returns true/false, if the xmldb_object has been loaded. More...

	orderElements ($arr)
	This function will order all the elements in one array, following the previous/next rules. More...

	orderTables ()
	This function will reorder the array of tables. More...

	readableInfo ()
	This function will display a readable info about the xmldb_object (should be implemented inside each XMLDBxxx object) More...

	setChanged ($changed=true)
	This function will set the changed field of the xmldb_object. More...

	setComment ($comment)
	This function will set the comment of the xmldb_object. More...

	setHash ($hash)
	This function will set the hash of the xmldb_object. More...

	setLoaded ($loaded=true)
	This function will set the loaded field of the xmldb_object. More...

	setName ($name)
	This function will set the name field of the xmldb_object. More...

	setNext ($next)
	This function will set the next of the xmldb_object. More...

	setPrevious ($previous)
	This function will set the previous of the xmldb_object. More...

	setTables ($tables)
	Set the tables. More...

	setVersion ($version)
	Set the structure version. More...

	validateDefinition (xmldb_table $xmldb_table=null)
	Validates the definition of objects and returns error message. More...

	xmlOutput ()
	This function will output the XML text for one structure. More...

Protected Attributes
bool	$changed
	was object changed

string	$comment
	comment on object

string	$errormsg
	error message

string	$hash
	hash of object

bool	$loaded
	is it loaded yet

string	$name
	name of obejct

xmldb_object	$next

string	$path

xmldb_object	$previous

array	$tables
	tables

string	$version

Constructor & Destructor Documentation

◆ __construct()

xmldb_structure::__construct ( $name )

Creates one new xmldb_structure.

Parameters

string $name

Reimplemented from xmldb_object.

Member Function Documentation

◆ addTable()

xmldb_structure::addTable	(	$table,
		$after = `null`
	)

Add one table to the structure, allowing to specify the desired order If it's not specified, then the table is added at the end.

Parameters

xmldb_table	$table
mixed	$after

◆ arr2xmldb_structure()

xmldb_structure::arr2xmldb_structure ( $xmlarr )

Load data from XML to the structure.

Parameters

array $xmlarr

Return values

bool

◆ calculateHash()

xmldb_structure::calculateHash ( $recursive = false )

This function calculate and set the hash of one xmldb_structure.

Parameters

bool $recursive

◆ 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

◆ deleteTable()

xmldb_structure::deleteTable ( $tablename )

Delete one table from the Structure.

Parameters

string $tablename

◆ findObjectInArray()

xmldb_object::findObjectInArray	(	$objectname,
		$arr
	)

inherited

Returns the position of one object in the array.

Parameters

string	$objectname
array	$arr

Return values

mixed

◆ findTableInArray()

xmldb_structure::findTableInArray ( $tablename )

Returns the position of one table in the array.

Parameters

string $tablename

Return values

mixed

◆ fixPrevNext()

xmldb_object::fixPrevNext ( & $arr )

inherited

Reconstruct previous/next attributes.

Parameters

array $arr

Return values

bool	true if $arr modified

◆ getAllErrors()

xmldb_structure::getAllErrors ( )

This function will return all the errors found in one structure looking recursively inside each table.

Returns an array of errors or false

Return values

mixed

◆ 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

◆ getFieldUses()

xmldb_structure::getFieldUses	(	$tablename,
		$fieldname
	)

This function returns the number of uses of one field inside a whole xmldb_structure.

Useful to detect if the field must be locked. Return false if no uses are found.

Parameters

string	$tablename
string	$fieldname

Return values

mixed

◆ getHash()

xmldb_object::getHash ( )

inherited

This function returns the hash of one xmldb_object.

Return values

string

◆ getIndexUses()

xmldb_structure::getIndexUses	(	$tablename,
		$indexname
	)

This function returns the number of uses of one index inside a whole xmldb_structure.

Useful to detect if the index must be locked. Return false if no uses are found.

Parameters

string	$tablename
string	$indexname

Return values

mixed

◆ getKeyUses()

xmldb_structure::getKeyUses	(	$tablename,
		$keyname
	)

This function returns the number of uses of one key inside a whole xmldb_structure.

Useful to detect if the key must be locked. Return false if no uses are found.

Parameters

string	$tablename
string	$keyname

Return values

mixed

◆ 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

xmldb_object

◆ getPath()

xmldb_structure::getPath ( )

Returns the path of the structure.

Return values

string

◆ getPrevious()

xmldb_object::getPrevious ( )

inherited

This function will return the name of the previous xmldb_object.

Return values

xmldb_object

◆ getTable()

xmldb_structure::getTable ( $tablename )

Returns one xmldb_table.

Parameters

string $tablename

Return values

xmldb_table

◆ getTables()

xmldb_structure::getTables ( )

Returns the tables of the structure.

Return values

array

◆ getTableUses()

xmldb_structure::getTableUses ( $tablename )

This function returns the number of uses of one table inside a whole XMLDStructure.

Useful to detect if the table must be locked. Return false if no uses are found.

Parameters

string $tablename

Return values

mixed

◆ getVersion()

xmldb_structure::getVersion ( )

Returns the version of the structure.

Return values

string

◆ 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

◆ orderTables()

xmldb_structure::orderTables ( )

This function will reorder the array of tables.

Return values

bool success

◆ readableInfo()

xmldb_object::readableInfo ( )

inherited

This function will display a readable info about the xmldb_object (should be implemented inside each XMLDBxxx object)

Return values

string

Reimplemented in xmldb_field, xmldb_index, and xmldb_key.

◆ 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

◆ setHash()

xmldb_object::setHash ( $hash )

inherited

This function will set the hash of the xmldb_object.

Parameters

string $hash

◆ 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

xmldb_object $next

◆ setPrevious()

xmldb_object::setPrevious ( $previous )

inherited

This function will set the previous of the xmldb_object.

Parameters

xmldb_object $previous

◆ setTables()

xmldb_structure::setTables ( $tables )

Set the tables.

Parameters

array $tables

◆ setVersion()

xmldb_structure::setVersion ( $version )

Set the structure version.

Parameters

string version

◆ validateDefinition()

xmldb_object::validateDefinition ( xmldb_table $xmldb_table = null )

inherited

Validates the definition of objects and returns error message.

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 in xmldb_field, xmldb_index, and xmldb_table.

◆ xmlOutput()

xmldb_structure::xmlOutput ( )

This function will output the XML text for one structure.

Return values

string

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

lib/xmldb/xmldb_structure.php

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addTable()

◆ arr2xmldb_structure()

◆ calculateHash()

◆ checkName()

◆ checkNameValues()

◆ comma2array()

◆ debug()

◆ deleteTable()

◆ findObjectInArray()

◆ findTableInArray()

◆ fixPrevNext()

◆ getAllErrors()

◆ getComment()

◆ getError()

◆ getFieldUses()

◆ getHash()

◆ getIndexUses()

◆ getKeyUses()

◆ getName()

◆ getNext()

◆ getPath()

◆ getPrevious()

◆ getTable()

◆ getTables()

◆ getTableUses()

◆ getVersion()

◆ hasChanged()

◆ isLoaded()

◆ orderElements()

◆ orderTables()

◆ readableInfo()

◆ setChanged()

◆ setComment()

◆ setHash()

◆ setLoaded()

◆ setName()

◆ setNext()

◆ setPrevious()

◆ setTables()

◆ setVersion()

◆ validateDefinition()

◆ xmlOutput()