includes/api/ApiFormatYaml_spyc.php

   1 <?php
   2   /**
   3    * Spyc -- A Simple PHP YAML Class
   4    * @version 0.2.3 -- 2006-02-04
   5    * @author Chris Wanstrath <chris@ozmm.org>
   6    * @see http://spyc.sourceforge.net/
   7    * @copyright Copyright 2005-2006 Chris Wanstrath
   8    * @license http://www.opensource.org/licenses/mit-license.php MIT License
   9    */
  10
  11   /**
  12    * A node, used by Spyc for parsing YAML.
  13    * @addtogroup API
  14    */
  15   class YAMLNode {
  16     /**#@+
  17      * @access public
  18      * @var string
  19      */
  20     var $parent;
  21     var $id;
  22     /**#@-*/
  23     /**
  24      * @access public
  25      * @var mixed
  26      */
  27     var $data;
  28     /**
  29      * @access public
  30      * @var int
  31      */
  32     var $indent;
  33     /**
  34      * @access public
  35      * @var bool
  36      */
  37     var $children = false;
  38
  39     /**
  40      * The constructor assigns the node a unique ID.
  41      * @access public
  42      * @return void
  43      */
  44     function YAMLNode() {
  45       $this->id = uniqid('');
  46     }
  47   }
  48
  49   /**
  50    * The Simple PHP YAML Class.
  51    *
  52    * This class can be used to read a YAML file and convert its contents
  53    * into a PHP array.  It currently supports a very limited subsection of
  54    * the YAML spec.
  55    *
  56    * Usage:
  57    * <code>
  58    *   $parser = new Spyc;
  59    *   $array  = $parser->load($file);
  60    * </code>
  61    * @addtogroup API
  62    */
  63   class Spyc {
  64
  65     /**
  66      * Load YAML into a PHP array statically
  67      *
  68      * The load method, when supplied with a YAML stream (string or file),
  69      * will do its best to convert YAML in a file into a PHP array.  Pretty
  70      * simple.
  71      *  Usage:
  72      *  <code>
  73      *   $array = Spyc::YAMLLoad('lucky.yml');
  74      *   print_r($array);
  75      *  </code>
  76      * @access public
  77      * @return array
  78      * @param string $input Path of YAML file or string containing YAML
  79      */
  80     function YAMLLoad($input) {
  81       $spyc = new Spyc;
  82       return $spyc->load($input);
  83     }
  84
  85     /**
  86      * Dump YAML from PHP array statically
  87      *
  88      * The dump method, when supplied with an array, will do its best
  89      * to convert the array into friendly YAML.  Pretty simple.  Feel free to
  90      * save the returned string as nothing.yml and pass it around.
  91      *
  92      * Oh, and you can decide how big the indent is and what the wordwrap
  93      * for folding is.  Pretty cool -- just pass in 'false' for either if
  94      * you want to use the default.
  95      *
  96      * Indent's default is 2 spaces, wordwrap's default is 40 characters.  And
  97      * you can turn off wordwrap by passing in 0.
  98      *
  99      * @access public
 100      * @static
 101      * @return string
 102      * @param array $array PHP array
 103      * @param int $indent Pass in false to use the default, which is 2
 104      * @param int $wordwrap Pass in 0 for no wordwrap, false for default (40)
 105      */
 106     public static function YAMLDump($array,$indent = false,$wordwrap = false) {
 107       $spyc = new Spyc;
 108       return $spyc->dump($array,$indent,$wordwrap);
 109     }
 110
 111     /**
 112      * Load YAML into a PHP array from an instantiated object
 113      *
 114      * The load method, when supplied with a YAML stream (string or file path),
 115      * will do its best to convert the YAML into a PHP array.  Pretty simple.
 116      *  Usage:
 117      *  <code>
 118      *   $parser = new Spyc;
 119      *   $array  = $parser->load('lucky.yml');
 120      *   print_r($array);
 121      *  </code>
 122      * @access public
 123      * @return array
 124      * @param string $input Path of YAML file or string containing YAML
 125      */
 126     function load($input) {
 127       // See what type of input we're talking about
 128       // If it's not a file, assume it's a string
 129       if (!empty($input) && (strpos($input, "\n") === false)
 130           && file_exists($input)) {
 131         $yaml = file($input);
 132       } else {
 133         $yaml = explode("\n",$input);
 134       }
 135       // Initiate some objects and values
 136       $base              = new YAMLNode;
 137       $base->indent      = 0;
 138       $this->_lastIndent = 0;
 139       $this->_lastNode   = $base->id;
 140       $this->_inBlock    = false;
 141       $this->_isInline   = false;
 142
 143       foreach ($yaml as $linenum => $line) {
 144         $ifchk = trim($line);
 145
 146         // If the line starts with a tab (instead of a space), throw a fit.
 147         if (preg_match('/^(\t)+(\w+)/', $line)) {
 148           $err = 'ERROR: Line '. ($linenum + 1) .' in your input YAML begins'.
 149                  ' with a tab.  YAML only recognizes spaces.  Please reformat.';
 150           die($err);
 151         }
 152
 153         if ($this->_inBlock === false && empty($ifchk)) {
 154           continue;
 155         } elseif ($this->_inBlock == true && empty($ifchk)) {
 156           $last =& $this->_allNodes[$this->_lastNode];
 157           $last->data[key($last->data)] .= "\n";
 158         } elseif ($ifchk{0} != '#' && substr($ifchk,0,3) != '---') {
 159           // Create a new node and get its indent
 160           $node         = new YAMLNode;
 161           $node->indent = $this->_getIndent($line);
 162
 163           // Check where the node lies in the hierarchy
 164           if ($this->_lastIndent == $node->indent) {
 165             // If we're in a block, add the text to the parent's data
 166             if ($this->_inBlock === true) {
 167               $parent =& $this->_allNodes[$this->_lastNode];
 168               $parent->data[key($parent->data)] .= trim($line).$this->_blockEnd;
 169             } else {
 170               // The current node's parent is the same as the previous node's
 171               if (isset($this->_allNodes[$this->_lastNode])) {
 172                 $node->parent = $this->_allNodes[$this->_lastNode]->parent;
 173               }
 174             }
 175           } elseif ($this->_lastIndent < $node->indent) {
 176             if ($this->_inBlock === true) {
 177               $parent =& $this->_allNodes[$this->_lastNode];
 178               $parent->data[key($parent->data)] .= trim($line).$this->_blockEnd;
 179             } elseif ($this->_inBlock === false) {
 180               // The current node's parent is the previous node
 181               $node->parent = $this->_lastNode;
 182
 183               // If the value of the last node's data was > or | we need to
 184               // start blocking i.e. taking in all lines as a text value until
 185               // we drop our indent.
 186               $parent =& $this->_allNodes[$node->parent];
 187               $this->_allNodes[$node->parent]->children = true;
 188               if (is_array($parent->data)) {
 189                 $chk = $parent->data[key($parent->data)];
 190                 if ($chk === '>') {
 191                   $this->_inBlock  = true;
 192                   $this->_blockEnd = ' ';
 193                   $parent->data[key($parent->data)] =
 194                         str_replace('>','',$parent->data[key($parent->data)]);
 195                   $parent->data[key($parent->data)] .= trim($line).' ';
 196                   $this->_allNodes[$node->parent]->children = false;
 197                   $this->_lastIndent = $node->indent;
 198                 } elseif ($chk === '|') {
 199                   $this->_inBlock  = true;
 200                   $this->_blockEnd = "\n";
 201                   $parent->data[key($parent->data)] =
 202                         str_replace('|','',$parent->data[key($parent->data)]);
 203                   $parent->data[key($parent->data)] .= trim($line)."\n";
 204                   $this->_allNodes[$node->parent]->children = false;
 205                   $this->_lastIndent = $node->indent;
 206                 }
 207               }
 208             }
 209           } elseif ($this->_lastIndent > $node->indent) {
 210             // Any block we had going is dead now
 211             if ($this->_inBlock === true) {
 212               $this->_inBlock = false;
 213               if ($this->_blockEnd = "\n") {
 214                 $last =& $this->_allNodes[$this->_lastNode];
 215                 $last->data[key($last->data)] =
 216                       trim($last->data[key($last->data)]);
 217               }
 218             }
 219
 220             // We don't know the parent of the node so we have to find it
 221             // foreach ($this->_allNodes as $n) {
 222             foreach ($this->_indentSort[$node->indent] as $n) {
 223               if ($n->indent == $node->indent) {
 224                 $node->parent = $n->parent;
 225               }
 226             }
 227           }
 228
 229           if ($this->_inBlock === false) {
 230             // Set these properties with information from our current node
 231             $this->_lastIndent = $node->indent;
 232             // Set the last node
 233             $this->_lastNode = $node->id;
 234             // Parse the YAML line and return its data
 235             $node->data = $this->_parseLine($line);
 236             // Add the node to the master list
 237             $this->_allNodes[$node->id] = $node;
 238             // Add a reference to the node in an indent array
 239             $this->_indentSort[$node->indent][] =& $this->_allNodes[$node->id];
 240             // Add a reference to the node in a References array if this node
 241             // has a YAML reference in it.
 242             if (
 243               ( (is_array($node->data)) &&
 244                 isset($node->data[key($node->data)]) &&
 245                 (!is_array($node->data[key($node->data)])) )
 246               &&
 247               ( (preg_match('/^&([^ ]+)/',$node->data[key($node->data)]))
 248                 ||
 249                 (preg_match('/^\*([^ ]+)/',$node->data[key($node->data)])) )
 250             ) {
 251                 $this->_haveRefs[] =& $this->_allNodes[$node->id];
 252             } elseif (
 253               ( (is_array($node->data)) &&
 254                 isset($node->data[key($node->data)]) &&
 255                  (is_array($node->data[key($node->data)])) )
 256             ) {
 257               // Incomplete reference making code.  Ugly, needs cleaned up.
 258               foreach ($node->data[key($node->data)] as $d) {
 259                 if ( !is_array($d) &&
 260                   ( (preg_match('/^&([^ ]+)/',$d))
 261                     ||
 262                     (preg_match('/^\*([^ ]+)/',$d)) )
 263                   ) {
 264                     $this->_haveRefs[] =& $this->_allNodes[$node->id];
 265                 }
 266               }
 267             }
 268           }
 269         }
 270       }
 271       unset($node);
 272
 273       // Here we travel through node-space and pick out references (& and *)
 274       $this->_linkReferences();
 275
 276       // Build the PHP array out of node-space
 277       $trunk = $this->_buildArray();
 278       return $trunk;
 279     }
 280
 281     /**
 282      * Dump PHP array to YAML
 283      *
 284      * The dump method, when supplied with an array, will do its best
 285      * to convert the array into friendly YAML.  Pretty simple.  Feel free to
 286      * save the returned string as tasteful.yml and pass it around.
 287      *
 288      * Oh, and you can decide how big the indent is and what the wordwrap
 289      * for folding is.  Pretty cool -- just pass in 'false' for either if
 290      * you want to use the default.
 291      *
 292      * Indent's default is 2 spaces, wordwrap's default is 40 characters.  And
 293      * you can turn off wordwrap by passing in 0.
 294      *
 295      * @access public
 296      * @return string
 297      * @param array $array PHP array
 298      * @param int $indent Pass in false to use the default, which is 2
 299      * @param int $wordwrap Pass in 0 for no wordwrap, false for default (40)
 300      */
 301     function dump($array,$indent = false,$wordwrap = false) {
 302       // Dumps to some very clean YAML.  We'll have to add some more features
 303       // and options soon.  And better support for folding.
 304
 305       // New features and options.
 306       if ($indent === false or !is_numeric($indent)) {
 307         $this->_dumpIndent = 2;
 308       } else {
 309         $this->_dumpIndent = $indent;
 310       }
 311
 312       if ($wordwrap === false or !is_numeric($wordwrap)) {
 313         $this->_dumpWordWrap = 40;
 314       } else {
 315         $this->_dumpWordWrap = $wordwrap;
 316       }
 317
 318       // New YAML document
 319       $string = "---\n";
 320
 321       // Start at the base of the array and move through it.
 322       foreach ($array as $key => $value) {
 323         $string .= $this->_yamlize($key,$value,0);
 324       }
 325       return $string;
 326     }
 327
 328     /**** Private Properties ****/
 329
 330     /**#@+
 331      * @access private
 332      * @var mixed
 333      */
 334     var $_haveRefs;
 335     var $_allNodes;
 336     var $_lastIndent;
 337     var $_lastNode;
 338     var $_inBlock;
 339     var $_isInline;
 340     var $_dumpIndent;
 341     var $_dumpWordWrap;
 342     /**#@-*/
 343
 344     /**** Private Methods ****/
 345
 346     /**
 347      * Attempts to convert a key / value array item to YAML
 348      * @access private
 349      * @return string
 350      * @param $key The name of the key
 351      * @param $value The value of the item
 352      * @param $indent The indent of the current node
 353      */
 354     function _yamlize($key,$value,$indent) {
 355       if (is_array($value)) {
 356         // It has children.  What to do?
 357         // Make it the right kind of item
 358         $string = $this->_dumpNode($key,NULL,$indent);
 359         // Add the indent
 360         $indent += $this->_dumpIndent;
 361         // Yamlize the array
 362         $string .= $this->_yamlizeArray($value,$indent);
 363       } elseif (!is_array($value)) {
 364         // It doesn't have children.  Yip.
 365         $string = $this->_dumpNode($key,$value,$indent);
 366       }
 367       return $string;
 368     }
 369
 370     /**
 371      * Attempts to convert an array to YAML
 372      * @access private
 373      * @return string
 374      * @param $array The array you want to convert
 375      * @param $indent The indent of the current level
 376      */
 377     function _yamlizeArray($array,$indent) {
 378       if (is_array($array)) {
 379         $string = '';
 380         foreach ($array as $key => $value) {
 381           $string .= $this->_yamlize($key,$value,$indent);
 382         }
 383         return $string;
 384       } else {
 385         return false;
 386       }
 387     }
 388
 389     /**
 390      * Find out whether a string needs to be output as a literal rather than in plain style.
 391      * Added by Roan Kattouw 13-03-2008
 392      * @param $value The string to check
 393      * @return bool
 394      */
 395     function _needLiteral($value) {
 396       # Check whether the string contains # or : or begins with any of:
 397       # [ - ? , [ ] { } ! * & | > ' " % @ ` ]
 398       return (bool)(preg_match("/[#:]/", $value) || preg_match("/^[-?,[\]{}!*&|>'\"%@`]/", $value));
 399     }
 400
 401     /**
 402      * Returns YAML from a key and a value
 403      * @access private
 404      * @return string
 405      * @param $key The name of the key
 406      * @param $value The value of the item
 407      * @param $indent The indent of the current node
 408      */
 409     function _dumpNode($key,$value,$indent) {
 410       // do some folding here, for blocks
 411       if (strpos($value,"\n") || $this->_needLiteral($value)) {
 412         $value = $this->_doLiteralBlock($value,$indent);
 413       } else {
 414         $value  = $this->_doFolding($value,$indent);
 415       }
 416
 417       $spaces = str_repeat(' ',$indent);
 418
 419       if (is_int($key)) {
 420         // It's a sequence
 421         $string = $spaces.'- '.$value."\n";
 422       } else {
 423         // It's mapped
 424         $string = $spaces.$key.': '.$value."\n";
 425       }
 426       return $string;
 427     }
 428
 429     /**
 430      * Creates a literal block for dumping
 431      * @access private
 432      * @return string
 433      * @param $value
 434      * @param $indent int The value of the indent
 435      */
 436     function _doLiteralBlock($value,$indent) {
 437       $exploded = explode("\n",$value);
 438       $newValue = '|';
 439       $indent  += $this->_dumpIndent;
 440       $spaces   = str_repeat(' ',$indent);
 441       foreach ($exploded as $line) {
 442         $newValue .= "\n" . $spaces . trim($line);
 443       }
 444       return $newValue;
 445     }
 446
 447     /**
 448      * Folds a string of text, if necessary
 449      * @access private
 450      * @return string
 451      * @param $value The string you wish to fold
 452      */
 453     function _doFolding($value,$indent) {
 454       // Don't do anything if wordwrap is set to 0
 455       if ($this->_dumpWordWrap === 0) {
 456         return $value;
 457       }
 458
 459       if (strlen($value) > $this->_dumpWordWrap) {
 460         $indent += $this->_dumpIndent;
 461         $indent = str_repeat(' ',$indent);
 462         $wrapped = wordwrap($value,$this->_dumpWordWrap,"\n$indent");
 463         $value   = ">\n".$indent.$wrapped;
 464       }
 465       return $value;
 466     }
 467
 468     /* Methods used in loading */
 469
 470     /**
 471      * Finds and returns the indentation of a YAML line
 472      * @access private
 473      * @return int
 474      * @param string $line A line from the YAML file
 475      */
 476     function _getIndent($line) {
 477       $match = array();
 478       preg_match('/^\s{1,}/',$line,$match);
 479       if (!empty($match[0])) {
 480         $indent = substr_count($match[0],' ');
 481       } else {
 482         $indent = 0;
 483       }
 484       return $indent;
 485     }
 486
 487     /**
 488      * Parses YAML code and returns an array for a node
 489      * @access private
 490      * @return array
 491      * @param string $line A line from the YAML file
 492      */
 493     function _parseLine($line) {
 494       $line = trim($line);
 495
 496       $array = array();
 497
 498       if (preg_match('/^-(.*):$/',$line)) {
 499         // It's a mapped sequence
 500         $key         = trim(substr(substr($line,1),0,-1));
 501         $array[$key] = '';
 502       } elseif ($line[0] == '-' && substr($line,0,3) != '---') {
 503         // It's a list item but not a new stream
 504         if (strlen($line) > 1) {
 505           $value   = trim(substr($line,1));
 506           // Set the type of the value.  Int, string, etc
 507           $value   = $this->_toType($value);
 508           $array[] = $value;
 509         } else {
 510           $array[] = array();
 511         }
 512       } elseif (preg_match('/^(.+):/',$line,$key)) {
 513         // It's a key/value pair most likely
 514         // If the key is in double quotes pull it out
 515         $matches = array();
 516         if (preg_match('/^(["\'](.*)["\'](\s)*:)/',$line,$matches)) {
 517           $value = trim(str_replace($matches[1],'',$line));
 518           $key   = $matches[2];
 519         } else {
 520           // Do some guesswork as to the key and the value
 521           $explode = explode(':',$line);
 522           $key     = trim($explode[0]);
 523           array_shift($explode);
 524           $value   = trim(implode(':',$explode));
 525         }
 526
 527         // Set the type of the value.  Int, string, etc
 528         $value = $this->_toType($value);
 529         if (empty($key)) {
 530           $array[]     = $value;
 531         } else {
 532           $array[$key] = $value;
 533         }
 534       }
 535       return $array;
 536     }
 537
 538     /**
 539      * Finds the type of the passed value, returns the value as the new type.
 540      * @access private
 541      * @param string $value
 542      * @return mixed
 543      */
 544     function _toType($value) {
 545       $matches = array();
 546       if (preg_match('/^("(.*)"|\'(.*)\')/',$value,$matches)) {
 547        $value = (string)preg_replace('/(\'\'|\\\\\')/',"'",end($matches));
 548        $value = preg_replace('/\\\\"/','"',$value);
 549       } elseif (preg_match('/^\\[(.+)\\]$/',$value,$matches)) {
 550         // Inline Sequence
 551
 552         // Take out strings sequences and mappings
 553         $explode = $this->_inlineEscape($matches[1]);
 554
 555         // Propogate value array
 556         $value  = array();
 557         foreach ($explode as $v) {
 558           $value[] = $this->_toType($v);
 559         }
 560       } elseif (strpos($value,': ')!==false && !preg_match('/^{(.+)/',$value)) {
 561           // It's a map
 562           $array = explode(': ',$value);
 563           $key   = trim($array[0]);
 564           array_shift($array);
 565           $value = trim(implode(': ',$array));
 566           $value = $this->_toType($value);
 567           $value = array($key => $value);
 568       } elseif (preg_match("/{(.+)}$/",$value,$matches)) {
 569         // Inline Mapping
 570
 571         // Take out strings sequences and mappings
 572         $explode = $this->_inlineEscape($matches[1]);
 573
 574         // Propogate value array
 575         $array = array();
 576         foreach ($explode as $v) {
 577           $array = $array + $this->_toType($v);
 578         }
 579         $value = $array;
 580       } elseif (strtolower($value) == 'null' or $value == '' or $value == '~') {
 581         $value = NULL;
 582       } elseif (ctype_digit($value)) {
 583         $value = (int)$value;
 584       } elseif (in_array(strtolower($value),
 585                   array('true', 'on', '+', 'yes', 'y'))) {
 586         $value = TRUE;
 587       } elseif (in_array(strtolower($value),
 588                   array('false', 'off', '-', 'no', 'n'))) {
 589         $value = FALSE;
 590       } elseif (is_numeric($value)) {
 591         $value = (float)$value;
 592       } else {
 593         // Just a normal string, right?
 594         $value = trim(preg_replace('/#(.+)$/','',$value));
 595       }
 596
 597       return $value;
 598     }
 599
 600     /**
 601      * Used in inlines to check for more inlines or quoted strings
 602      * @access private
 603      * @return array
 604      */
 605     function _inlineEscape($inline) {
 606       // There's gotta be a cleaner way to do this...
 607       // While pure sequences seem to be nesting just fine,
 608       // pure mappings and mappings with sequences inside can't go very
 609       // deep.  This needs to be fixed.
 610
 611       // Check for strings
 612       $regex = '/(?:(")|(?:\'))((?(1)[^"]+|[^\']+))(?(1)"|\')/';
 613       $strings = array();
 614       if (preg_match_all($regex,$inline,$strings)) {
 615         $saved_strings[] = $strings[0][0];
 616         $inline  = preg_replace($regex,'YAMLString',$inline);
 617       }
 618       unset($regex);
 619
 620       // Check for sequences
 621       $seqs = array();
 622       if (preg_match_all('/\[(.+)\]/U',$inline,$seqs)) {
 623         $inline = preg_replace('/\[(.+)\]/U','YAMLSeq',$inline);
 624         $seqs   = $seqs[0];
 625       }
 626
 627       // Check for mappings
 628       $maps = array();
 629       if (preg_match_all('/{(.+)}/U',$inline,$maps)) {
 630         $inline = preg_replace('/{(.+)}/U','YAMLMap',$inline);
 631         $maps   = $maps[0];
 632       }
 633
 634       $explode = explode(', ',$inline);
 635
 636       // Re-add the strings
 637       if (!empty($saved_strings)) {
 638         $i = 0;
 639         foreach ($explode as $key => $value) {
 640           if (strpos($value,'YAMLString')) {
 641             $explode[$key] = str_replace('YAMLString',$saved_strings[$i],$value);
 642             ++$i;
 643           }
 644         }
 645       }
 646
 647       // Re-add the sequences
 648       if (!empty($seqs)) {
 649         $i = 0;
 650         foreach ($explode as $key => $value) {
 651           if (strpos($value,'YAMLSeq') !== false) {
 652             $explode[$key] = str_replace('YAMLSeq',$seqs[$i],$value);
 653             ++$i;
 654           }
 655         }
 656       }
 657
 658       // Re-add the mappings
 659       if (!empty($maps)) {
 660         $i = 0;
 661         foreach ($explode as $key => $value) {
 662           if (strpos($value,'YAMLMap') !== false) {
 663             $explode[$key] = str_replace('YAMLMap',$maps[$i],$value);
 664             ++$i;
 665           }
 666         }
 667       }
 668
 669       return $explode;
 670     }
 671
 672     /**
 673      * Builds the PHP array from all the YAML nodes we've gathered
 674      * @access private
 675      * @return array
 676      */
 677     function _buildArray() {
 678       $trunk = array();
 679
 680       if (!isset($this->_indentSort[0])) {
 681         return $trunk;
 682       }
 683
 684       foreach ($this->_indentSort[0] as $n) {
 685         if (empty($n->parent)) {
 686           $this->_nodeArrayizeData($n);
 687           // Check for references and copy the needed data to complete them.
 688           $this->_makeReferences($n);
 689           // Merge our data with the big array we're building
 690           $trunk = $this->_array_kmerge($trunk,$n->data);
 691         }
 692       }
 693
 694       return $trunk;
 695     }
 696
 697     /**
 698      * Traverses node-space and sets references (& and *) accordingly
 699      * @access private
 700      * @return bool
 701      */
 702     function _linkReferences() {
 703       if (is_array($this->_haveRefs)) {
 704         foreach ($this->_haveRefs as $node) {
 705           if (!empty($node->data)) {
 706             $key = key($node->data);
 707             // If it's an array, don't check.
 708             if (is_array($node->data[$key])) {
 709               foreach ($node->data[$key] as $k => $v) {
 710                 $this->_linkRef($node,$key,$k,$v);
 711               }
 712             } else {
 713               $this->_linkRef($node,$key);
 714             }
 715           }
 716         }
 717       }
 718       return true;
 719     }
 720
 721     function _linkRef(&$n,$key,$k = NULL,$v = NULL) {
 722       if (empty($k) && empty($v)) {
 723         // Look for &refs
 724         $matches = array();
 725         if (preg_match('/^&([^ ]+)/',$n->data[$key],$matches)) {
 726           // Flag the node so we know it's a reference
 727           $this->_allNodes[$n->id]->ref = substr($matches[0],1);
 728           $this->_allNodes[$n->id]->data[$key] =
 729                    substr($n->data[$key],strlen($matches[0])+1);
 730         // Look for *refs
 731         } elseif (preg_match('/^\*([^ ]+)/',$n->data[$key],$matches)) {
 732           $ref = substr($matches[0],1);
 733           // Flag the node as having a reference
 734           $this->_allNodes[$n->id]->refKey =  $ref;
 735         }
 736       } elseif (!empty($k) && !empty($v)) {
 737         if (preg_match('/^&([^ ]+)/',$v,$matches)) {
 738           // Flag the node so we know it's a reference
 739           $this->_allNodes[$n->id]->ref = substr($matches[0],1);
 740           $this->_allNodes[$n->id]->data[$key][$k] =
 741                               substr($v,strlen($matches[0])+1);
 742         // Look for *refs
 743         } elseif (preg_match('/^\*([^ ]+)/',$v,$matches)) {
 744           $ref = substr($matches[0],1);
 745           // Flag the node as having a reference
 746           $this->_allNodes[$n->id]->refKey =  $ref;
 747         }
 748       }
 749     }
 750
 751     /**
 752      * Finds the children of a node and aids in the building of the PHP array
 753      * @access private
 754      * @param int $nid The id of the node whose children we're gathering
 755      * @return array
 756      */
 757     function _gatherChildren($nid) {
 758       $return = array();
 759       $node   =& $this->_allNodes[$nid];
 760       foreach ($this->_allNodes as $z) {
 761         if ($z->parent == $node->id) {
 762           // We found a child
 763           $this->_nodeArrayizeData($z);
 764           // Check for references
 765           $this->_makeReferences($z);
 766           // Merge with the big array we're returning
 767           // The big array being all the data of the children of our parent node
 768           $return = $this->_array_kmerge($return,$z->data);
 769         }
 770       }
 771       return $return;
 772     }
 773
 774     /**
 775      * Turns a node's data and its children's data into a PHP array
 776      *
 777      * @access private
 778      * @param array $node The node which you want to arrayize
 779      * @return boolean
 780      */
 781     function _nodeArrayizeData(&$node) {
 782       if (is_array($node->data) && $node->children == true) {
 783         // This node has children, so we need to find them
 784         $childs = $this->_gatherChildren($node->id);
 785         // We've gathered all our children's data and are ready to use it
 786         $key = key($node->data);
 787         $key = empty($key) ? 0 : $key;
 788         // If it's an array, add to it of course
 789         if (is_array($node->data[$key])) {
 790           $node->data[$key] = $this->_array_kmerge($node->data[$key],$childs);
 791         } else {
 792           $node->data[$key] = $childs;
 793         }
 794       } elseif (!is_array($node->data) && $node->children == true) {
 795         // Same as above, find the children of this node
 796         $childs       = $this->_gatherChildren($node->id);
 797         $node->data   = array();
 798         $node->data[] = $childs;
 799       }
 800
 801       // We edited $node by reference, so just return true
 802       return true;
 803     }
 804
 805     /**
 806      * Traverses node-space and copies references to / from this object.
 807      * @access private
 808      * @param object $z A node whose references we wish to make real
 809      * @return bool
 810      */
 811     function _makeReferences(&$z) {
 812       // It is a reference
 813       if (isset($z->ref)) {
 814         $key                = key($z->data);
 815         // Copy the data to this object for easy retrieval later
 816         $this->ref[$z->ref] =& $z->data[$key];
 817       // It has a reference
 818       } elseif (isset($z->refKey)) {
 819         if (isset($this->ref[$z->refKey])) {
 820           $key           = key($z->data);
 821           // Copy the data from this object to make the node a real reference
 822           $z->data[$key] =& $this->ref[$z->refKey];
 823         }
 824       }
 825       return true;
 826     }
 827
 828
 829     /**
 830      * Merges arrays and maintains numeric keys.
 831      *
 832      * An ever-so-slightly modified version of the array_kmerge() function posted
 833      * to php.net by mail at nospam dot iaindooley dot com on 2004-04-08.
 834      *
 835      * http://us3.php.net/manual/en/function.array-merge.php#41394
 836      *
 837      * @access private
 838      * @param array $arr1
 839      * @param array $arr2
 840      * @return array
 841      */
 842     function _array_kmerge($arr1,$arr2) {
 843       if(!is_array($arr1))
 844         $arr1 = array();
 845
 846       if(!is_array($arr2))
 847         $arr2 = array();
 848
 849       $keys1 = array_keys($arr1);
 850       $keys2 = array_keys($arr2);
 851       $keys  = array_merge($keys1,$keys2);
 852       $vals1 = array_values($arr1);
 853       $vals2 = array_values($arr2);
 854       $vals  = array_merge($vals1,$vals2);
 855       $ret   = array();
 856
 857       foreach($keys as $key) {
 858         list( /* unused */ ,$val) = each($vals);
 859         // This is the good part!  If a key already exists, but it's part of a
 860         // sequence (an int), just keep addin numbers until we find a fresh one.
 861         if (isset($ret[$key]) and is_int($key)) {
 862           while (array_key_exists($key, $ret)) {
 863             $key++;
 864           }
 865         }
 866         $ret[$key] = $val;
 867       }
 868
 869       return $ret;
 870     }
 871   }
 872