Added documentation

This commit is contained in:
Michael Vogel 2016-03-20 16:16:15 +01:00 committed by Roland Haeder
parent debc6a86c6
commit 3981ed4cda
No known key found for this signature in database
GPG key ID: B72F8185C6C7BD78

View file

@ -4,6 +4,16 @@
* *
*/ */
class xml { class xml {
/**
* @brief Creates an XML structure out of a given array
*
* @param array $array The array of the XML structure that will be generated
* @param object $xml The createdXML will be returned by reference
* @param bool $remove_header Should the XML header be removed or not?
* @param array $namespaces List of namespaces
*
* @return string The created XML
*/
function from_array($array, &$xml, $remove_header = false, $namespaces = array(), $root = true) { function from_array($array, &$xml, $remove_header = false, $namespaces = array(), $root = true) {
if ($root) { if ($root) {
@ -60,6 +70,13 @@ class xml {
} }
} }
/**
* @brief Copies an XML object
*
* @param object $source The XML source
* @param object $target The XML target
* @param string $elementname Name of the XML element of the target
*/
function copy(&$source, &$target, $elementname) { function copy(&$source, &$target, $elementname) {
if (count($source->children()) == 0) if (count($source->children()) == 0)
$target->addChild($elementname, xmlify($source)); $target->addChild($elementname, xmlify($source));