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