git.sesse.net Git - xml-template/blob - php5/xml-template.php

   1 <?php
   2
   3 function XML_Template_process_file($filename, $obj, $clean = 1)
   4 {
   5         $doc = new DOMDocument;
   6         $doc->load($filename);
   7         XML_Template_process($doc, $obj, $clean);
   8         return $doc;
   9 }
  10
  11 function XML_Template_process($node, $obj, $clean = 1)
  12 {
  13         if (is_a($obj, 'DOMNode')) {                          # overwrite
  14                 while ($node->childNodes->length > 0) {
  15                         $child = $node->childNodes->item(0);
  16                         $node->removeChild($child);
  17                 }
  18
  19                 if (is_a($obj, 'DOMDocument')) {
  20                         $obj = $obj->documentElement;
  21                 }
  22
  23                 $frag = $node->ownerDocument->createDocumentFragment();
  24                 $frag->appendChild($node->ownerDocument->importNode($obj, true));
  25                 XML_Template_process($frag, array(), $clean);
  26                 $node->appendChild($frag);
  27         } else if (!is_array($obj)) {                         # overwrite
  28                 while ($node->childNodes->length > 0) {
  29                         $node->removeChild($node->firstChild);
  30                 }
  31                 $doc = $node->ownerDocument;
  32                 $node->appendChild($doc->createTextNode($obj));
  33         } else if (is_associative_array($obj)) {              # substitute
  34                 $num_children = ($node->childNodes == null) ? 0 : $node->childNodes->length;
  35                 $children = array();
  36                 for ($i = 0; $i < $num_children; ++$i) {
  37                         $children[] = $node->childNodes->item($i);
  38                 }
  39
  40                 for ($i = 0; $i < $num_children; ++$i) {
  41                         $child = $children[$i];
  42                         $processed = false;
  43
  44                         if ($child->nodeType == XML_ELEMENT_NODE) {
  45                                 unset($id);
  46
  47                                 $tag = $child->localName;
  48                                 $attrs = $child->attributes;
  49
  50                                 if (isset($attrs)) {
  51                                         $replace_child = 0;
  52                                         foreach ($child->attributes as $attr) {
  53                                                 if ($attr->namespaceURI == 'http://template.sesse.net/' && $attr->name == 'id') {
  54                                                         $id = $attr->value;
  55                                                         if ($clean) {
  56                                                                 $child->removeAttributeNode($attr);
  57                                                                 $replace_child = 1;
  58                                                         }
  59                                                 }
  60                                         }
  61
  62                                         # This seems to be the only way to reliably get rid of the excess
  63                                         # XML namespace declarations.
  64                                         if ($replace_child == 1) {
  65                                                 $newchild = own_clone_element($child, $child->ownerDocument);
  66                                                 while ($child->childNodes->length > 0) {
  67                                                         $newchild->appendChild($child->firstChild);
  68                                                 }
  69                                                 $node->replaceChild($newchild, $child);
  70                                                 $child = $newchild;
  71                                         }
  72                                 }
  73
  74                                 # check all substitutions to see if we found anything
  75                                 # appropriate
  76                                 foreach (array_keys($obj) as $key) {
  77                                         # FIXME: we would want something like \Q and \E here...
  78                                         if (preg_match('/^' . $tag . '\/(.*)$/', $key, $matches) ||
  79                                             (isset($id) && preg_match('/^#' . $id . '\/(.*)$/', $key, $matches))) {
  80                                                 $child->setAttribute($matches[1], $obj[$key]);
  81                                         }
  82
  83                                         if ($processed) {
  84                                                 continue;
  85                                         }
  86                                         if ($key == $tag || (isset($id) && $key == ('#'.$id))) {
  87                                                 XML_Template_process($child, $obj[$key], $clean);
  88                                                 $processed = true;
  89                                         }
  90                                 }
  91                         }
  92
  93                         if (!$processed) {
  94                                 XML_Template_process($child, $obj, $clean);
  95                         }
  96                 }
  97         } else {                                                # repeat
  98                 $doc = $node->ownerDocument;
  99                 $frag = $doc->createDocumentFragment();
 100
 101                 while ($node->childNodes->length > 0) {
 102                         $child = $node->childNodes->item(0);
 103                         $node->removeChild($child);
 104                         $frag->appendChild($child);
 105                 }
 106
 107                 foreach ($obj as $instance) {
 108                         if (!isset($instance)) {
 109                                 continue;
 110                         }
 111
 112                         $newnode = own_clone_node($frag, $frag->ownerDocument);
 113                         XML_Template_process($newnode, $instance, $clean);
 114
 115                         $node->appendChild($newnode);
 116                         if ($clean) {
 117                                 XML_Template_clean($newnode);
 118                         }
 119                 }
 120         }
 121
 122         if ($clean) {
 123                 XML_Template_clean($node);
 124         }
 125 }
 126
 127 function XML_Template_clean($node)
 128 {
 129         if ($node->nodeType == XML_ELEMENT_NODE) {
 130                 if ($node->namespaceURI != 'http://template.sesse.net/') {
 131                         return;
 132                 }
 133
 134                 # as this is a dummy node, we want to remove it and move everything further up
 135                 # after we've done any required replacements
 136                 $doc = $node->ownerDocument;
 137                 $parent = $node->parentNode;
 138
 139                 while ($node->childNodes->length > 0) {
 140                         $child = $node->childNodes->item(0);
 141                         $node->removeChild($child);
 142                         $parent->insertBefore(own_clone_node($child, $doc), $node);
 143                 }
 144                 $parent->removeChild($node);
 145         }
 146 }
 147
 148 # FIXME: use varargs here
 149 function XML_Template_alternate($tag, $array, $elems)
 150 {
 151         $num = count($elems);
 152
 153         for ($i = 0, $j = 0; $i < count($array); $i++) {
 154                 if (isset($array[$i])) {
 155                         $array[$i][$tag] = $elems[$j++ % $num];
 156                 }
 157         }
 158
 159         return $array;
 160 }
 161
 162 # Ideally, this would be "return $obj->clone_node(true)". But surprise,
 163 # surprise, PHP is buggy; it does not preserve the prefix information on
 164 # attributes properly during a clone. (PHP4 and PHP5 are broken in different
 165 # ways here...) IOW, we'll have to clone everything ourselves.
 166 function own_clone_node($node, $doc)
 167 {
 168         // we only need these two
 169         if ($node->nodeType == XML_DOCUMENT_FRAG_NODE) {
 170                 $newnode = $doc->createDocumentFragment();
 171
 172                 for ($i = 0; $i < $node->childNodes->length; ++$i) {
 173                         $child = $node->childNodes->item($i);
 174                         $newnode->appendChild(own_clone_node($child, $doc));
 175                 }
 176                 return $newnode;
 177         } else if ($node->nodeType == XML_ELEMENT_NODE) {
 178                 $newnode = own_clone_element($node, $doc);
 179                 for ($i = 0; $i < $node->childNodes->length; ++$i) {
 180                         $child = $node->childNodes->item($i);
 181                         $newnode->appendChild(own_clone_node($child, $doc));
 182                 }
 183                 return $newnode;
 184         } else {
 185                 return $node->cloneNode(true);
 186         }
 187 }
 188
 189 function own_clone_element($node, $doc)
 190 {
 191         $nsuri = $node->namespaceURI;
 192         if (isset($nsuri) && $node->prefix != "default") {
 193                 $newnode = $doc->createElementNS($node->namespaceURI, $node->nodeName, $node->prefix);
 194
 195                 // remove useless empty text child
 196                 $newnode->removeChild($newnode->firstChild);
 197         } else {
 198                 $newnode = $doc->createElement($node->localName);
 199         }
 200
 201         $attrs = $node->attributes;
 202         if (isset($attrs)) {
 203                 foreach ($node->attributes as $attr) {
 204                         $nsuri = $attr->namespaceURI;
 205                         if (isset($nsuri) && $attr->prefix != "default") {
 206                                 $attr2 = $doc->createAttributeNS($nsuri, $attr->prefix . ":" . $attr->name);
 207                         } else {
 208                                 $attr2 = $doc->createAttribute($attr->localName);
 209                         }
 210
 211                         # You've got to be kidding me...
 212                         $attr2->value = preg_replace("/&/", "&amp;", $attr->value);
 213                         $newnode->appendChild($attr2);
 214                 }
 215         }
 216         return $newnode;
 217 }
 218
 219 function is_associative_array($arr)
 220 {
 221         if (!is_array($arr)) {
 222                 return false;
 223         }
 224         $diff = array_diff(range(0, count($arr) - 1), array_keys($arr));
 225         return (count($diff) > 0);
 226 }
 227 ?>