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

   1 <?php
   2
   3 function XML_Template_process_file($filename, $obj, $clean = 1)
   4 {
   5         $doc = domxml_open_file($filename);
   6         XML_Template_process($doc, $obj, $clean);
   7         return $doc;
   8 }
   9
  10 function XML_Template_process($node, $obj, $clean = 1)
  11 {
  12         if (is_a($obj, 'domnode')) {                          # overwrite
  13                 foreach ($node->child_nodes() as $child) {
  14                         $node->remove_child($child);
  15                 }
  16
  17                 if (is_a($obj, 'domdocument')) {
  18                         $obj = $obj->document_element();
  19                 }
  20
  21                 $newobj = own_clone_node($obj, $node->owner_document());
  22                 $node->append_child($newobj);
  23
  24                 XML_Template_process($newobj, array(), $clean);
  25         } else if (!is_array($obj)) {                         # overwrite
  26                 foreach ($node->child_nodes() as $child) {
  27                         $node->remove_child($child);
  28                 }
  29                 $doc = $node->owner_document();
  30                 $node->add_child($doc->create_text_node($obj));
  31         } else if (is_associative_array($obj)) {              # substitute
  32                 foreach ($node->child_nodes() as $child) {
  33                         $processed = false;
  34
  35                         if ($child->node_type() == XML_ELEMENT_NODE) {
  36                                 unset($id);
  37
  38                                 $tag = $child->node_name();
  39                                 $attrs = $child->attributes();
  40                                 if (isset($attrs)) {
  41                                         foreach ($child->attributes() as $attr) {
  42                                                 if ($attr->namespace_uri() == 'http://template.sesse.net/' && $attr->name() == 'id') {
  43                                                         $id = $attr->value();
  44                                                         if ($clean) {
  45                                                                 $attr->unlink_node();
  46                                                         }
  47                                                 }
  48                                         }
  49                                 }
  50
  51                                 # check all substitutions to see if we found anything
  52                                 # appropriate
  53                                 foreach (array_keys($obj) as $key) {
  54                                         # FIXME: we would want something like \Q and \E here...
  55                                         if (preg_match('/^' . $tag . '\/(.*)$/', $key, $matches) ||
  56                                             (isset($id) && preg_match('/^#' . $id . '\/(.*)$/', $key, $matches))) {
  57                                                 $child->set_attribute($matches[1], $obj[$key]);
  58                                         }
  59
  60                                         if ($processed) {
  61                                                 continue;
  62                                         }
  63                                         if ($key == $tag || (isset($id) && $key == ('#'.$id))) {
  64                                                 XML_Template_process($child, $obj[$key], $clean);
  65                                                 $processed = true;
  66                                         }
  67                                 }
  68                         }
  69
  70                         if (!$processed) {
  71                                 XML_Template_process($child, $obj, $clean);
  72                         }
  73                 }
  74         } else {                                                # repeat
  75                 $doc = $node->owner_document();
  76                 $frag = $doc->create_element("temporary-fragment");    # ugh
  77
  78                 foreach ($node->child_nodes() as $child) {
  79                         $frag->append_child($child);
  80                         $node->remove_child($child);
  81                 }
  82
  83                 foreach ($obj as $instance) {
  84                         $newnode = own_clone_node($frag, $frag->owner_document());
  85                         $node->append_child($newnode);
  86                         XML_Template_process($newnode, $instance, $clean);
  87                         if ($clean) {
  88                                 XML_Template_clean($newnode);
  89                         }
  90                 }
  91
  92                 # remove all the <fragment> tags
  93
  94                 foreach ($node->child_nodes() as $child) {
  95                         if ($child->name() != 'temporary-fragment') {
  96                                 continue;
  97                         }
  98                         foreach ($child->child_nodes() as $child2) {
  99                                 $node->append_child($child2);
 100                         }
 101                         $node->remove_child($child);
 102                 }
 103         }
 104
 105         if ($clean) {
 106                 XML_Template_clean($node);
 107         }
 108 }
 109
 110 function XML_Template_clean($node)
 111 {
 112         if ($node->node_type() == XML_ELEMENT_NODE) {
 113                 if ($node->namespace_uri() != 'http://template.sesse.net/') {
 114                         return;
 115                 }
 116
 117                 # as this is a dummy node, we want to remove it and move everything further up
 118                 # after we've done any required replacements
 119                 $doc = $node->owner_document();
 120                 $parent = $node->parent_node();
 121                 foreach ($node->child_nodes() as $child) {
 122                         $node->remove_child($child);
 123                         $node->insert_before($child, $node);
 124                 }
 125                 $parent->remove_child($node);
 126         }
 127 }
 128
 129 # FIXME: use varargs here
 130 function XML_Template_alternate($tag, $array, $elems)
 131 {
 132         $i = 0;
 133         $num = count($elems);
 134
 135         for ($i = 0; $i < count($array); $i++) {
 136                 $array[$i][$tag] = $elems[$i % $num];
 137         }
 138
 139         return $array;
 140 }
 141
 142 # Ideally, this would be "return $obj->clone_node(true)". But surprise, surprise,
 143 # PHP is buggy (at least PHP4); it removes the prefix information from all attributes
 144 # during a clone. IOW, we'll have to clone evverything ourselves.
 145 function own_clone_node($node, $doc)
 146 {
 147         // we only need these two
 148         if ($node->node_type() == XML_ELEMENT_NODE) {
 149                 $nsuri = $node->namespace_uri();
 150                 if (isset($nsuri)) {
 151                         $newnode = $doc->create_element_ns($node->namespace_uri(), $node->node_name(), $node->prefix());
 152                 } else {
 153                         $newnode = $doc->create_element($node->node_name());
 154                 }
 155
 156                 $attrs = $node->attributes();
 157                 if (isset($attrs)) {
 158                         foreach ($node->attributes() as $attr) {
 159                                 $attr2 = $doc->create_attribute($attr->name(), $attr->value());
 160                                 $nsuri = $attr->namespace_uri();
 161                                 if (isset($nsuri)) {
 162                                         $attr2->set_namespace($nsuri, $attr->prefix());
 163                                 }
 164                                 $newnode->append_child($attr2);
 165                         }
 166                 }
 167                 foreach ($node->child_nodes() as $child) {
 168                         $newnode->append_child(own_clone_node($child, $doc));
 169                 }
 170                 return $newnode;
 171         } else {
 172                 return $node->clone_node(true);
 173         }
 174 }
 175
 176 function is_associative_array($arr)
 177 {
 178         if (!is_array($arr)) {
 179                 return false;
 180         }
 181         $diff = array_diff(range(0, count($arr) - 1), array_keys($arr));
 182         return (count($diff) > 0);
 183 }
 184 ?>