attributesToString (line 292)

create string representation of an attribute list

 require_once 'XML/Util.php';
 
 // build an attribute string
 $att = array(
              "foo"   =>  "bar",
              "argh"  =>  "tomato"
            );
 
 $attList = XML_Util::attributesToString($att);

• return: string representation of the attributes
• usedby: XML_Util::getXMLDeclaration() - to serialize the attributes of the XML declaration
• usedby: XML_Util::createTagFromArray() - to serialize the attributes of the tag
• todo: allow sort also to be an options array
• uses: XML_Util::replaceEntities() - to replace XML entities in attribute values
• static:
• access: public

• array $attributes: attribute array
• boolean|array $sort: sort attribute list alphabetically, may also be an assoc array containing the keys 'sort', 'multiline', 'indent', 'linebreak' and 'entities'
• boolean $multiline: use linebreaks, if more than one attribute is given
• string $indent: string used for indentation of multiline attributes
• string $linebreak: string used for linebreaks of multiline attributes
• integer $entities: setting for entities in attribute values (one of XML_UTIL_ENTITIES_NONE, XML_UTIL_ENTITIES_XML, XML_UTIL_ENTITIES_XML_REQUIRED, XML_UTIL_ENTITIES_HTML)

createCDataSection (line 642)

create a CData section

 require_once 'XML/Util.php';
 
 // create a CData section
 $tag = XML_Util::createCDataSection("I am content.");

• return: CData section with content
• static:
• access: public

• string $data: data of the CData section

createEndElement (line 600)

create an end element

 require_once 'XML/Util.php';
 
 // create an XML start element:
 $tag = XML_Util::createEndElement("myNs:myTag");

• return: XML end element
• see: XML_Util::createStartElement(), XML_Util::createTag()
• static:
• access: public

• string $qname: qualified tagname (including namespace)

createTag (line 401)

create a tag

This method will call XML_Util::createTagFromArray(), which is more flexible.

 require_once 'XML/Util.php';
 
 // create an XML tag:
 $tag = XML_Util::createTag("myNs:myTag", array("foo" => "bar"), "This is inside the tag", "http://www.w3c.org/myNs#");

• return: XML tag
• uses: XML_Util::createTagFromArray() - to create the tag
• see: XML_Util::createTagFromArray()
• static:
• access: public

• string $qname: qualified tagname (including namespace)
• array $attributes: array containg attributes
• mixed $content
• string $namespaceUri: URI of the namespace
• integer $replaceEntities: whether to replace XML special chars in content, embedd it in a CData section or none of both
• boolean $multiline: whether to create a multiline tag where each attribute gets written to a single line
• string $indent: string used to indent attributes (_auto indents attributes so they start at the same column)
• string $linebreak: string used for linebreaks

getDocTypeDeclaration (line 248)

build a document type declaration

 require_once 'XML/Util.php';
 
 // get a doctype declaration:
 $xmlDecl = XML_Util::getDocTypeDeclaration("rootTag","myDocType.dtd");

• return: doctype declaration
• since: 0.2
• static:
• access: public

• string $root: name of the root tag
• string $uri: uri of the doctype definition (or array with uri and public id)
• string $internalDtd: internal dtd entries

isValidName (line 711)

check, whether string is valid XML name

XML names are used for tagname, attribute names and various other, lesser known entities.

An XML name may only consist of alphanumeric characters, dashes, undescores and periods, and has to start with a letter or an underscore.

 require_once 'XML/Util.php';
 
 // verify tag name
 $result = XML_Util::isValidName("invalidTag?");
 if (XML_Util::isError($result)) {
    print "Invalid XML name: " . $result->getMessage();
 }

• return: true, if string is a valid XML name, PEAR error otherwise
• todo: support for other charsets
• static:
• access: public

• string $string: string that should be checked

replaceEntities (line 126)

replace XML entities

With the optional second parameter, you may select, which entities should be replaced.

 require_once 'XML/Util.php';
 
 // replace XML entites:
 $string = XML_Util::replaceEntities("This string contains < & >.");

• return: string with replaced chars
• usedby: XML_Util::attributesToString() - to replace XML entities in attribute values
• see: XML_Util::reverseEntities()
• static:
• access: public

• string $string: string where XML special chars should be replaced
• integer $replaceEntities: setting for entities in attribute values (one of XML_UTIL_ENTITIES_XML, XML_UTIL_ENTITIES_XML_REQUIRED, XML_UTIL_ENTITIES_HTML)

splitQualifiedName (line 670)

split qualified name and return namespace and local part

 require_once 'XML/Util.php';
 
 // split qualified tag
 $parts = XML_Util::splitQualifiedName("xslt:stylesheet");

 array(
       "namespace" => "xslt",
       "localPart" => "stylesheet"
      );

• return: array containing namespace and local part
• usedby: XML_Util::createTagFromArray() - to get local part and namespace of a qualified name
• static:
• access: public

• string $qname: qualified tag name
• string $defaultNs: default namespace (optional)