Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
|
Public Member Functions | |
__construct ($path) | |
Constructor of the xmldb_file. | |
arr2xmldb_structure ($xmlarr) | |
This function takes an xmlized array and put it into one xmldb_structure. | |
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. | |
fileExists () | |
Determine if the XML file exists. | |
fileWriteable () | |
Determine if the XML is writeable. | |
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. | |
getHash () | |
This function returns the hash of one xmldb_object. | |
getName () | |
This function will return the name of the xmldb_object. | |
getNext () | |
This function will return the name of the next xmldb_object. | |
getPrevious () | |
This function will return the name of the previous xmldb_object. | |
getStructure () | |
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. | |
loadXMLStructure () | |
Load and the XMLDB structure from file. | |
orderElements ($arr) | |
This function will order all the elements in one array, following the previous/next rules. | |
readableInfo () | |
This function will display a readable info about the xmldb_object (should be implemented inside each XMLDBxxx object) | |
saveXMLFile () | |
This function saves the whole xmldb_structure to its file. | |
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. | |
setDTD ($path) | |
This function sets the DTD of the XML file. | |
setHash ($hash) | |
This function will set the hash of the xmldb_object. | |
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. | |
setSchema ($path) | |
This function sets the schema of the XML file. | |
validateDefinition (xmldb_table $xmldb_table=null) | |
Validates the definition of objects and returns error message. | |
validateXMLStructure () | |
This function will check/validate the XML file for correctness Dynamically if will use the best available checker/validator (expat syntax checker or DOM schema validator. | |
Protected Attributes | |
bool | $changed |
was object changed | |
string | $comment |
comment on object | |
string | $dtd |
document dtd | |
string | $errormsg |
error message | |
string | $hash |
hash of object | |
bool | $loaded |
is it loaded yet | |
string | $name |
name of obejct | |
string | $next |
string | $path |
path to file | |
string | $previous |
string | $schema |
path to schema | |
xmldb_structure | $xmldb_structure |
the structure stored in file | |
xmldb_file::__construct | ( | $path | ) |
xmldb_file::arr2xmldb_structure | ( | $xmlarr | ) |
This function takes an xmlized array and put it into one xmldb_structure.
array | $xmlarr |
xmldb_structure |
|
inherited |
This function will check if one key name is ok or no (true/false) only lowercase a-z, 0-9 and _ are allowed.
bool |
|
inherited |
This function will check that all the elements in one array have a correct name [a-z0-9_].
array | $arr |
bool |
|
inherited |
Returns one array of elements from one comma separated string, supporting quoted strings containing commas and concat function calls.
string | $string |
array |
|
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
string | $message |
xmldb_file::fileExists | ( | ) |
Determine if the XML file exists.
bool |
xmldb_file::fileWriteable | ( | ) |
Determine if the XML is writeable.
bool |
|
inherited |
Returns the position of one object in the array.
string | $objectname | |
array | $arr |
mixed |
|
inherited |
Reconstruct previous/next attributes.
array | $arr |
bool | true if $arr modified |
|
inherited |
This function returns the comment of one xmldb_object.
string |
|
inherited |
This function will return the error detected in the object.
string |
|
inherited |
This function returns the hash of one xmldb_object.
string |
|
inherited |
This function will return the name of the xmldb_object.
string |
|
inherited |
This function will return the name of the next xmldb_object.
string |
|
inherited |
This function will return the name of the previous xmldb_object.
string |
|
inherited |
This function returns true/false, if the xmldb_object has changed.
bool |
|
inherited |
This function returns true/false, if the xmldb_object has been loaded.
bool |
xmldb_file::loadXMLStructure | ( | ) |
Load and the XMLDB structure from file.
true |
|
inherited |
This function will order all the elements in one array, following the previous/next rules.
array | $arr |
array|bool |
|
inherited |
This function will display a readable info about the xmldb_object (should be implemented inside each XMLDBxxx object)
string |
Reimplemented in xmldb_field, xmldb_index, and xmldb_key.
xmldb_file::saveXMLFile | ( | ) |
This function saves the whole xmldb_structure to its file.
int|bool | false on failure, number of written bytes on success |
|
inherited |
This function will set the changed field of the xmldb_object.
bool | $changed |
|
inherited |
This function will set the comment of the xmldb_object.
string | $comment |
xmldb_file::setDTD | ( | $path | ) |
This function sets the DTD of the XML file.
string |
|
inherited |
This function will set the hash of the xmldb_object.
string | $hash |
|
inherited |
This function will set the loaded field of the xmldb_object.
bool | $loaded |
|
inherited |
This function will set the name field of the xmldb_object.
string | $name |
|
inherited |
This function will set the next of the xmldb_object.
string | $next |
|
inherited |
This function will set the previous of the xmldb_object.
string | $previous |
xmldb_file::setSchema | ( | $path | ) |
This function sets the schema of the XML file.
string |
|
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!
xmldb_table | $xmldb_table | optional when object is table |
string | null if ok, error message if problem found |
Reimplemented in xmldb_field, xmldb_index, and xmldb_table.
xmldb_file::validateXMLStructure | ( | ) |
This function will check/validate the XML file for correctness Dynamically if will use the best available checker/validator (expat syntax checker or DOM schema validator.
true |