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                 for ($i = 0; $i < $node->childNodes->length; ++$i) {
  15                         $child = $node->childNodes->item($i);
  16                         $node->removeChild($child);
  17                 }
  18
  19                 if (is_a($obj, 'DOMDocument')) {
  20                         $obj = $obj->document_element();
  21                 }
  22
  23                 $newobj = own_clone_node($obj, $node->ownerDocument);
  24                 $node->appendChild($newobj);
  25
  26                 XML_Template_process($newobj, array(), $clean);
  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->createElement("temporary-fragment");    # ugh
  82
  83                 while ($node->childNodes->length > 0) {
  84                         $child = $node->childNodes->item(0);
  85                         $frag->appendChild($child);
  86                 }
  87
  88                 foreach ($obj as $instance) {
  89                         if (!isset($instance)) {
  90                                 continue;
  91                         }
  92
  93                         $newnode = own_clone_node($frag, $frag->ownerDocument);
  94                         $node->appendChild($newnode);
  95                         XML_Template_process($newnode, $instance, $clean);
  96                         if ($clean) {
  97                                 XML_Template_clean($newnode);
  98                         }
  99                 }
 100
 101                 # remove all the <fragment> tags
 102                 for ($i = 0; $i < $node->childNodes->length; ++$i) {
 103                         $child = $node->childNodes->item($i);
 104                         if ($child->localName != 'temporary-fragment') {
 105                                 continue;
 106                         }
 107                         while ($child->childNodes->length > 0) {
 108                                 $child2 = $child->childNodes->item(0);
 109                                 $node->appendChild($child2);
 110                         }
 111                         --$i;
 112                         $node->removeChild($child);
 113                 }
 114         }
 115
 116         if ($clean) {
 117                 XML_Template_clean($node);
 118         }
 119 }
 120
 121 function XML_Template_clean($node)
 122 {
 123         if ($node->nodeType == XML_ELEMENT_NODE) {
 124                 if ($node->namespaceURI != 'http://template.sesse.net/') {
 125                         return;
 126                 }
 127
 128                 # as this is a dummy node, we want to remove it and move everything further up
 129                 # after we've done any required replacements
 130                 $doc = $node->ownerDocument;
 131                 $parent = $node->parentNode;
 132
 133                 while ($node->childNodes->length > 0) {
 134                         $child = $node->childNodes->item(0);
 135                         $node->removeChild($child);
 136                         $parent->insertBefore($child, $node);
 137                 }
 138                 $parent->removeChild($node);
 139         }
 140 }
 141
 142 # FIXME: use varargs here
 143 function XML_Template_alternate($tag, $array, $elems)
 144 {
 145         $num = count($elems);
 146
 147         for ($i = 0, $j = 0; $i < count($array); $i++) {
 148                 if (isset($array[$i])) {
 149                         $array[$i][$tag] = $elems[$j++ % $num];
 150                 }
 151         }
 152
 153         return $array;
 154 }
 155
 156 # Ideally, this would be "return $obj->clone_node(true)". But surprise, surprise,
 157 # PHP is buggy (at least both PHP4 and PHP5); it removes the prefix information
 158 # from all attributes during a clone. IOW, we'll have to clone evverything
 159 # ourselves.
 160 function own_clone_node($node, $doc)
 161 {
 162         // we only need these two
 163         if ($node->nodeType == XML_ELEMENT_NODE) {
 164                 $nsuri = $node->namespaceURI;
 165                 if (isset($nsuri)) {
 166                         $newnode = $doc->createElementNS($node->namespaceURI, $node->nodeName, $node->prefix);
 167                 } else {
 168                         $newnode = $doc->createElement($node->nodeName);
 169                 }
 170
 171                 $attrs = $node->attributes;
 172                 if (isset($attrs)) {
 173                         foreach ($node->attributes as $attr) {
 174                                 $nsuri = $attr->namespaceURI;
 175                                 if (isset($nsuri)) {
 176                                         $attr2 = $doc->createAttribute($attr->name);
 177                                 } else {
 178                                         $attr2 = $doc->createAttributeNS($nsuri, $attr->prefix . ":" . $attr->name);
 179                                 }
 180                                 $attr2->value = $attr->value;
 181                                 $newnode->appendChild($attr2);
 182                         }
 183                 }
 184                 for ($i = 0; $i < $node->childNodes->length; ++$i) {
 185                         $child = $node->childNodes->item($i);
 186                         $newnode->appendChild(own_clone_node($child, $doc));
 187                 }
 188                 return $newnode;
 189         } else {
 190                 return $node->cloneNode(true);
 191         }
 192 }
 193
 194 function is_associative_array($arr)
 195 {
 196         if (!is_array($arr)) {
 197                 return false;
 198         }
 199         $diff = array_diff(range(0, count($arr) - 1), array_keys($arr));
 200         return (count($diff) > 0);
 201 }
 202 ?>