Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Protected Attributes | List of all members
xmldb_object Class Reference
Inheritance diagram for xmldb_object:
xmldb_field xmldb_file xmldb_index xmldb_key xmldb_structure xmldb_table

Public Member Functions

 __construct ($name)
 Creates one new xmldb_object. 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...
 
 findObjectInArray ($objectname, $arr)
 Returns the position of one object in the array. More...
 
 fixPrevNext (&$arr)
 Reconstruct previous/next attributes. More...
 
 getComment ()
 This function returns the comment of one xmldb_object. More...
 
 getError ()
 This function will return the error detected in the object. More...
 
 getHash ()
 This function returns the hash of one xmldb_object. 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...
 
 getPrevious ()
 This function will return the name of the previous xmldb_object. 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...
 
 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...
 
 validateDefinition (xmldb_table $xmldb_table=null)
 Validates the definition of objects and returns error message. 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
 
xmldb_object $previous
 

Constructor & Destructor Documentation

◆ __construct()

xmldb_object::__construct (   $name)

Creates one new xmldb_object.

Parameters
string$name

Reimplemented in xmldb_structure, xmldb_table, and xmldb_file.

Member Function Documentation

◆ checkName()

xmldb_object::checkName ( )

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)

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)

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)

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 
)

Returns the position of one object in the array.

Parameters
string$objectname
array$arr
Return values
mixed

◆ fixPrevNext()

xmldb_object::fixPrevNext ( $arr)

Reconstruct previous/next attributes.

Parameters
array$arr
Return values
booltrue if $arr modified

◆ getComment()

xmldb_object::getComment ( )

This function returns the comment of one xmldb_object.

Return values
string

◆ getError()

xmldb_object::getError ( )

This function will return the error detected in the object.

Return values
string

◆ getHash()

xmldb_object::getHash ( )

This function returns the hash of one xmldb_object.

Return values
string

◆ getName()

xmldb_object::getName ( )

This function will return the name of the xmldb_object.

Return values
string

◆ getNext()

xmldb_object::getNext ( )

This function will return the name of the next xmldb_object.

Return values
xmldb_object

◆ getPrevious()

xmldb_object::getPrevious ( )

This function will return the name of the previous xmldb_object.

Return values
xmldb_object

◆ hasChanged()

xmldb_object::hasChanged ( )

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

Return values
bool

◆ isLoaded()

xmldb_object::isLoaded ( )

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

Return values
bool

◆ orderElements()

xmldb_object::orderElements (   $arr)

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

Parameters
array$arr
Return values
array|bool

◆ readableInfo()

xmldb_object::readableInfo ( )

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)

This function will set the changed field of the xmldb_object.

Parameters
bool$changed

◆ setComment()

xmldb_object::setComment (   $comment)

This function will set the comment of the xmldb_object.

Parameters
string$comment

◆ setHash()

xmldb_object::setHash (   $hash)

This function will set the hash of the xmldb_object.

Parameters
string$hash

◆ setLoaded()

xmldb_object::setLoaded (   $loaded = true)

This function will set the loaded field of the xmldb_object.

Parameters
bool$loaded

◆ setName()

xmldb_object::setName (   $name)

This function will set the name field of the xmldb_object.

Parameters
string$name

◆ setNext()

xmldb_object::setNext (   $next)

This function will set the next of the xmldb_object.

Parameters
xmldb_object$next

◆ setPrevious()

xmldb_object::setPrevious (   $previous)

This function will set the previous of the xmldb_object.

Parameters
xmldb_object$previous

◆ validateDefinition()

xmldb_object::validateDefinition ( xmldb_table  $xmldb_table = null)

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_tableoptional when object is table
Return values
stringnull if ok, error message if problem found

Reimplemented in xmldb_field, xmldb_index, and xmldb_table.


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