xmlutils.php File Reference

---

Detailed Description

XML helper utilities.

If you need to output elements, never do simple string replacement and then <xsl:value-of disable-output-escaping='yes' ... /> ! It's evil and you will definitely at least once forget to properly escape it. Used these routines instead and then <xsl:copy-of ... />.

Note that code in this file is real WTF, but I was not able to create anything simpler without loosing flexibility. Tell me if you have some good idea how to make this code shorter or more readable. Otherwise you can try to send this code to http://www.thedailywtf.com :-)

Definition in file xmlutils.php.

Go to the source code of this file.

Functions
	regex_splitter ($doc, $text, $regex, $elemcreator)
	Helper function for the xml_convert_any2elem() function.
	str_splitter ($doc, $text, $str, $elemcreator)
	Helper function for the xml_convert_any2elem() function.
	xml_convert_any2elem ($doc, $text, $str, $elemcreator, $splitter, $recurse=FALSE)
	Converts string to an array of DOMNode descendants.
	xml_convert_regex2elem ($doc, $text, $regex, $elemcreator, $recurse=FALSE)
	Shortcut for calling xml_convert_any2elem() with regex_splitter().
	xml_convert_str2elem ($doc, $text, $str, $elemcreator, $recurse=FALSE)
	Shortcut for calling xml_convert_any2elem() with str_splitter().

---

Function Documentation

regex_splitter (  $  doc, $  text, $  regex, $  elemcreator )

Helper function for the xml_convert_any2elem() function. It splits the string into an array of DOMText and DOMElement (or other DOMNode descendant) instances. Parameters: [in]  $doc  DOMDocument instance. [in]  $text  String which is going to be converted. [in]  $regex  Regular expression used for splitting the string. Note that if you need to use rounding brackets inside of the regex you should mark them non-capturing (?:) otherwise strange things will happen. [in]  $elemcreator  Instance of ElementCreator class. Returns: Array of DOMNodes, there is always at least one DOMText instance. Definition at line 183 of file xmlutils.php. Referenced by xml_convert_regex2elem(). { $text_parts = preg_split($regex, $text, -1, PREG_SPLIT_NO_EMPTY | PREG_SPLIT_DELIM_CAPTURE); $result = array(); foreach ($text_parts as $text_part): if (preg_match($regex, $text_part)): $result[] = $elemcreator->create_element($doc, $text_part); else: $result[] = $doc->createTextNode($text_part); endif; endforeach; return $result; }

str_splitter (  $  doc, $  text, $  str, $  elemcreator )

Helper function for the xml_convert_any2elem() function. It splits the string into an array of DOMText and DOMElement (or other DOMNode descendant) instances. Parameters: [in]  $doc  DOMDocument instance. [in]  $text  String which is going to be converted. [in]  $str  Separator. [in]  $elemcreator  Instance of ElementCreator class. Returns: Array of DOMNodes, there is always at least one DOMText instance. Definition at line 150 of file xmlutils.php. Referenced by xml_convert_str2elem(). { $text_parts = explode($str, $text); $first = TRUE; $result = array(); foreach ($text_parts as $text_part): if ($first): $first = FALSE; else: $result[] = $elemcreator->create_element($doc); endif; if(strlen($text_part) > 0): $result[] = $doc->createTextNode($text_part); endif; endforeach; return $result; }

xml_convert_any2elem (  $  doc, $  text, $  str, $  elemcreator, $  splitter, $  recurse = FALSE )

Converts string to an array of DOMNode descendants. Parameters: [in]  $doc  DOMDocument instance. [in]  $text  String which is going to be converted. It can be also array of DOMNode instances (so you can call this function on a value returned by another call to this function). [in]  $str  Anything (e.g. plain string or regex) which will be used for splitting the text. This value will be passed to the splitter function. [in]  $elemcreator  Instance of ElementCreator class or string which will be wrapped into a ElementCreator instance (the string will be used as an elements name). [in]  $splitter  Function which will be used to split the string. See str_splitter() and regex_splitter(). [in]  $recurse  If is set to true than also text nodes which are children of existing elements are processed. Defaults to false. Returns: Array of DOMNodes, there is always at least one DOMText instance. Definition at line 218 of file xmlutils.php. Referenced by xml_convert_regex2elem(), and xml_convert_str2elem(). { if (is_string($elemcreator)): $elemcreator = new ElementCreator($elemcreator); endif; if (is_array($text)): $result = array(); foreach ($text as $part): $result = array_merge($result, xml_convert_any2elem($doc, $part, $str, $elemcreator, $splitter, $recurse)); endforeach; return $result; endif; if ($text instanceof DomText): return xml_convert_any2elem($doc, $text->wholeText, $str, $elemcreator, $splitter, $recurse); endif; if ($text instanceof DomElement): // recursion means that we are converting also content of already // created elements // we will convert childnodes, result of their conversion put into // an array and then replace childnodes with it if ($recurse): $result = array(); foreach ($text->childNodes as $childNode): // text nodes convert if ($childNode instanceof DomText): $result = array_merge($result, xml_convert_any2elem($doc, $childNode, $str, $elemcreator, $splitter, $recurse)); // element nodes recurse elseif ($childNode instanceof DomElement): xml_convert_any2elem($doc, $childNode, $str, $elemcreator, $splitter, $recurse); $result[] = $childNode; // other nodes (e.g. attributes) copy else: assert($childNode instanceof DomNode); $result[] = $childNode; endif; endforeach; // now remove existing childnodes ... $node_list = clone $text->childNodes; foreach ($node_list as $childNode): $text->removeChild($childNode); endforeach; // ... and add new ones foreach ($result as $newChild): assert($newChild instanceof DomNode); $text->appendChild($newChild); endforeach; endif; // we have to return ourselves for a case that DomElement // is in the array. see the "if (is_array($text))" part to know why // is this needed return array($text); endif; assert(is_string($text)); if (strlen($text) == 0): return array($doc->createTextNode('')); endif; return $splitter($doc, $text, $str, $elemcreator); }

xml_convert_regex2elem (  $  doc, $  text, $  regex, $  elemcreator, $  recurse = FALSE )

Shortcut for calling xml_convert_any2elem() with regex_splitter(). Definition at line 301 of file xmlutils.php. References regex_splitter(), and xml_convert_any2elem(). Referenced by link2aXML(). { return xml_convert_any2elem($doc, $text, $regex, $elemcreator, 'regex_splitter', $recurse); }

xml_convert_str2elem (  $  doc, $  text, $  str, $  elemcreator, $  recurse = FALSE )

Shortcut for calling xml_convert_any2elem() with str_splitter(). Definition at line 294 of file xmlutils.php. References str_splitter(), and xml_convert_any2elem(). Referenced by email(), and nl2brXML(). { return xml_convert_any2elem($doc, $text, $str, $elemcreator, 'str_splitter', $recurse); }

---