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