/usr/share/php/Horde/Kolab/Format/Xml/Helper.php is in php-horde-kolab-format 2.0.9-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 | <?php
/**
* Provides DOM utility methods.
*
* PHP version 5
*
* @category Kolab
* @package Kolab_Format
* @author Gunnar Wrobel <wrobel@pardus.de>
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
/**
* Provides DOM utility methods.
*
* Copyright 2011-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you did not
* receive this file, see
* http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Format
* @author Gunnar Wrobel <wrobel@pardus.de>
* @license http://www.horde.org/licenses/lgpl21 LGPL
* @link http://www.horde.org/libraries/Horde_Kolab_Format
*/
class Horde_Kolab_Format_Xml_Helper
{
/**
* The XML document this object works with.
*
* @var DOMDocument
*/
protected $_xmldoc;
/**
* The XPath query handler.
*
* @var DOMXpath
*/
private $_xpath;
/**
* Constructor
*
* @param DOMDocument $xmldoc The XML document this object works with.
*/
public function __construct($xmldoc)
{
$this->_xmldoc = $xmldoc;
$this->_xpath = new DOMXpath($this->_xmldoc);
}
/**
* Fetch the value of a node.
*
* @param DOMNode $node Retrieve the text value for this node.
*
* @return string|null The text value or null if no value was identified.
*/
public function fetchNodeValue($node)
{
if (($child = $this->_fetchFirstTextNode($node)) !== null) {
return $child->nodeValue;
}
return null;
}
/**
* Fetch the the first text node.
*
* @param DOMNode $node Retrieve the text value for this node.
*
* @return DOMNode|null The first text node or null if no such node was
* found.
*/
private function _fetchFirstTextNode($node)
{
foreach ($node->childNodes as $child) {
if ($child->nodeType === XML_TEXT_NODE) {
return $child;
}
}
}
/**
* Store a value as a new text node.
*
* @param DOMNode $parent_node Attach the new node to this parent.
* @param string $name Name of the new child node.
* @param string $value Text value of the new child node.
*
* @return DOMNode The new child node.
*/
public function storeNewNodeValue($parent_node, $name, $value)
{
$node = $this->createNewNode($parent_node, $name);
$this->createNodeValue($node, $name, $value);
return $node;
}
/**
* Store a value as a new text node.
*
* @param DOMNode $parent_node Attach the new node to this parent.
* @param string $name Name of the new child node.
* @param string $value Text value of the new child node.
*
* @return DOMNode The new child node.
*/
public function createNodeValue($parent_node, $name, $value)
{
$node = $this->_xmldoc->createTextNode($value);
$parent_node->appendChild($node);
return $node;
}
/**
* Append an XML snippet.
*
* @param DOMNode $parent_node Attach the XML below this parent.
* @param string $xml The XML to append.
*
* @return DOMNode The new child node.
*/
public function appendXml($parent_node, $xml)
{
$node = $this->_xmldoc->createDocumentFragment();
$node->appendXML($xml);
$parent_node->appendChild($node);
return $node;
}
/**
* Create a new node.
*
* @param DOMNode $parent_node Attach the new node to this parent.
* @param string $name Name of the new child node.
*
* @return DOMNode The new child node.
*/
public function createNewNode($parent_node, $name)
{
$node = $this->_xmldoc->createElement($name);
$parent_node->appendChild($node);
return $node;
}
/**
* Store a value as a new text node.
*
* @param DOMNode $node Replace the text value of this node.
* @param string $value Text value of the new child node.
*
* @return NULL
*/
public function replaceFirstNodeTextValue($node, $value)
{
if (($child = $this->_fetchFirstTextNode($node)) !== null) {
$node->removeChild($child);
}
$new_node = $this->_xmldoc->createTextNode($value);
if (empty($node->childNodes)) {
$node->appendChild($new_node);
} else {
$node->insertBefore($new_node, $node->childNodes->item(0));
}
}
/**
* Return a single named node matching the given XPath query.
*
* @param string $query The query.
*
* @return DOMNode|false The named DOMNode or empty if no node was found.
*/
public function findNode($query)
{
$result = $this->_xpath->query($query);
if ($result->length) {
return $result->item(0);
}
return false;
}
/**
* Return a single named node below the given context matching the given
* XPath query.
*
* @param string $query The query.
* @param DOMNode $context Search below this node.
*
* @return DOMNode|false The named DOMNode or empty if no node was found.
*/
public function findNodeRelativeTo($query, DOMNode $context)
{
$result = $this->_xpath->query($query, $context);
if ($result->length) {
return $result->item(0);
}
return false;
}
/**
* Return all nodes matching the given XPath query.
*
* @param string $query The query.
*
* @return DOMNodeList The list of DOMNodes.
*/
public function findNodes($query)
{
return $this->_xpath->query($query);
}
/**
* Return all nodes matching the given XPath query.
*
* @param string $query The query.
* @param DOMNode $context Search below this node.
*
* @return DOMNodeList The list of DOMNodes.
*/
public function findNodesRelativeTo($query, DOMNode $context)
{
return $this->_xpath->query($query, $context);
}
/**
* Remove named nodes from a parent node.
*
* @param DOMNode $parent_node The parent node.
* @param string $name The name of the children to be removed.
*
* @return NULL
*/
public function removeNodes($parent_node, $name)
{
foreach ($this->findNodesRelativeTo('./' . $name, $parent_node) as $child) {
$parent_node->removeChild($child);
}
}
/**
* Output the document as XML string.
*
* @return string The XML output.
*/
public function __toString()
{
return $this->_xmldoc->saveXML();
}
}
|