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
12 * A node, used by Spyc for parsing YAML.
37 var $children = false;
40 * The constructor assigns the node a unique ID.
45 $this->id
= uniqid('');
50 * The Simple PHP YAML Class.
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
59 * $array = $parser->load($file);
66 * Load YAML into a PHP array statically
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
73 * $array = Spyc::YAMLLoad('lucky.yml');
78 * @param string $input Path of YAML file or string containing YAML
80 function YAMLLoad($input) {
82 return $spyc->load($input);
86 * Dump YAML from PHP array statically
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.
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.
96 * Indent's default is 2 spaces, wordwrap's default is 40 characters. And
97 * you can turn off wordwrap by passing in 0.
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)
106 public static function YAMLDump($array,$indent = false,$wordwrap = false) {
108 return $spyc->dump($array,$indent,$wordwrap);
112 * Load YAML into a PHP array from an instantiated object
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.
118 * $parser = new Spyc;
119 * $array = $parser->load('lucky.yml');
124 * @param string $input Path of YAML file or string containing YAML
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);
133 $yaml = explode("\n",$input);
135 // Initiate some objects and values
136 $base = new YAMLNode
;
138 $this->_lastIndent
= 0;
139 $this->_lastNode
= $base->id
;
140 $this->_inBlock
= false;
141 $this->_isInline
= false;
143 foreach ($yaml as $linenum => $line) {
144 $ifchk = trim($line);
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.';
153 if ($this->_inBlock
=== false && empty($ifchk)) {
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);
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
;
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
;
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
;
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
)];
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
;
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
)]);
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
;
229 if ($this->_inBlock
=== false) {
230 // Set these properties with information from our current node
231 $this->_lastIndent
= $node->indent
;
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.
243 ( (is_array($node->data
)) &&
244 isset($node->data
[key($node->data
)]) &&
245 (!is_array($node->data
[key($node->data
)])) )
247 ( (preg_match('/^&([^ ]+)/',$node->data
[key($node->data
)]))
249 (preg_match('/^\*([^ ]+)/',$node->data
[key($node->data
)])) )
251 $this->_haveRefs
[] =& $this->_allNodes
[$node->id
];
253 ( (is_array($node->data
)) &&
254 isset($node->data
[key($node->data
)]) &&
255 (is_array($node->data
[key($node->data
)])) )
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))
262 (preg_match('/^\*([^ ]+)/',$d)) )
264 $this->_haveRefs
[] =& $this->_allNodes
[$node->id
];
273 // Here we travel through node-space and pick out references (& and *)
274 $this->_linkReferences();
276 // Build the PHP array out of node-space
277 $trunk = $this->_buildArray();
282 * Dump PHP array to YAML
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.
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.
292 * Indent's default is 2 spaces, wordwrap's default is 40 characters. And
293 * you can turn off wordwrap by passing in 0.
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)
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.
305 // New features and options.
306 if ($indent === false or !is_numeric($indent)) {
307 $this->_dumpIndent
= 2;
309 $this->_dumpIndent
= $indent;
312 if ($wordwrap === false or !is_numeric($wordwrap)) {
313 $this->_dumpWordWrap
= 40;
315 $this->_dumpWordWrap
= $wordwrap;
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);
328 /**** Private Properties ****/
344 /**** Private Methods ****/
347 * Attempts to convert a key / value array item to YAML
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
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);
360 $indent +
= $this->_dumpIndent
;
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);
371 * Attempts to convert an array to YAML
374 * @param $array The array you want to convert
375 * @param $indent The indent of the current level
377 function _yamlizeArray($array,$indent) {
378 if (is_array($array)) {
380 foreach ($array as $key => $value) {
381 $string .= $this->_yamlize($key,$value,$indent);
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
395 function _needLiteral($value) {
396 # Check whether the string contains # or : or begins with any of:
397 # [ - ? , [ ] { } ! * & | > ' " % @ ` ]
398 # or is a number or contains newlines
399 return (bool)(gettype($value) == "string" &&
400 (is_numeric($value) ||
401 strpos($value, "\n") ||
402 preg_match("/[#:]/", $value) ||
403 preg_match("/^[-?,[\]{}!*&|>'\"%@`]/", $value)));
408 * Returns YAML from a key and a value
411 * @param $key The name of the key
412 * @param $value The value of the item
413 * @param $indent The indent of the current node
415 function _dumpNode($key,$value,$indent) {
416 // do some folding here, for blocks
417 if ($this->_needLiteral($value)) {
418 $value = $this->_doLiteralBlock($value,$indent);
420 $value = $this->_doFolding($value,$indent);
423 $spaces = str_repeat(' ',$indent);
428 $string = $spaces.'- '.$value."\n";
430 $string = $spaces . "-\n";
434 $string = $spaces.$key.': '.$value."\n";
436 $string = $spaces . $key . ":\n";
442 * Creates a literal block for dumping
446 * @param $indent int The value of the indent
448 function _doLiteralBlock($value,$indent) {
449 $exploded = explode("\n",$value);
451 $indent +
= $this->_dumpIndent
;
452 $spaces = str_repeat(' ',$indent);
453 foreach ($exploded as $line) {
454 $newValue .= "\n" . $spaces . trim($line);
460 * Folds a string of text, if necessary
463 * @param $value The string you wish to fold
465 function _doFolding($value,$indent) {
466 // Don't do anything if wordwrap is set to 0
467 if ($this->_dumpWordWrap
=== 0) {
471 if (strlen($value) > $this->_dumpWordWrap
) {
472 $indent +
= $this->_dumpIndent
;
473 $indent = str_repeat(' ',$indent);
474 $wrapped = wordwrap($value,$this->_dumpWordWrap
,"\n$indent");
475 $value = ">\n".$indent.$wrapped;
480 /* Methods used in loading */
483 * Finds and returns the indentation of a YAML line
486 * @param string $line A line from the YAML file
488 function _getIndent($line) {
490 preg_match('/^\s{1,}/',$line,$match);
491 if (!empty($match[0])) {
492 $indent = substr_count($match[0],' ');
500 * Parses YAML code and returns an array for a node
503 * @param string $line A line from the YAML file
505 function _parseLine($line) {
510 if (preg_match('/^-(.*):$/',$line)) {
511 // It's a mapped sequence
512 $key = trim(substr(substr($line,1),0,-1));
514 } elseif ($line[0] == '-' && substr($line,0,3) != '---') {
515 // It's a list item but not a new stream
516 if (strlen($line) > 1) {
517 $value = trim(substr($line,1));
518 // Set the type of the value. Int, string, etc
519 $value = $this->_toType($value);
524 } elseif (preg_match('/^(.+):/',$line,$key)) {
525 // It's a key/value pair most likely
526 // If the key is in double quotes pull it out
528 if (preg_match('/^(["\'](.*)["\'](\s)*:)/',$line,$matches)) {
529 $value = trim(str_replace($matches[1],'',$line));
532 // Do some guesswork as to the key and the value
533 $explode = explode(':',$line);
534 $key = trim($explode[0]);
535 array_shift($explode);
536 $value = trim(implode(':',$explode));
539 // Set the type of the value. Int, string, etc
540 $value = $this->_toType($value);
544 $array[$key] = $value;
551 * Finds the type of the passed value, returns the value as the new type.
553 * @param string $value
556 function _toType($value) {
558 if (preg_match('/^("(.*)"|\'(.*)\')/',$value,$matches)) {
559 $value = (string)preg_replace('/(\'\'|\\\\\')/',"'",end($matches));
560 $value = preg_replace('/\\\\"/','"',$value);
561 } elseif (preg_match('/^\\[(.+)\\]$/',$value,$matches)) {
564 // Take out strings sequences and mappings
565 $explode = $this->_inlineEscape($matches[1]);
567 // Propogate value array
569 foreach ($explode as $v) {
570 $value[] = $this->_toType($v);
572 } elseif (strpos($value,': ')!==false && !preg_match('/^{(.+)/',$value)) {
574 $array = explode(': ',$value);
575 $key = trim($array[0]);
577 $value = trim(implode(': ',$array));
578 $value = $this->_toType($value);
579 $value = array($key => $value);
580 } elseif (preg_match("/{(.+)}$/",$value,$matches)) {
583 // Take out strings sequences and mappings
584 $explode = $this->_inlineEscape($matches[1]);
586 // Propogate value array
588 foreach ($explode as $v) {
589 $array = $array +
$this->_toType($v);
592 } elseif (strtolower($value) == 'null' or $value == '' or $value == '~') {
594 } elseif (ctype_digit($value)) {
595 $value = (int)$value;
596 } elseif (in_array(strtolower($value),
597 array('true', 'on', '+', 'yes', 'y'))) {
599 } elseif (in_array(strtolower($value),
600 array('false', 'off', '-', 'no', 'n'))) {
602 } elseif (is_numeric($value)) {
603 $value = (float)$value;
605 // Just a normal string, right?
606 $value = trim(preg_replace('/#(.+)$/','',$value));
613 * Used in inlines to check for more inlines or quoted strings
617 function _inlineEscape($inline) {
618 // There's gotta be a cleaner way to do this...
619 // While pure sequences seem to be nesting just fine,
620 // pure mappings and mappings with sequences inside can't go very
621 // deep. This needs to be fixed.
624 $regex = '/(?:(")|(?:\'))((?(1)[^"]+|[^\']+))(?(1)"|\')/';
626 if (preg_match_all($regex,$inline,$strings)) {
627 $saved_strings[] = $strings[0][0];
628 $inline = preg_replace($regex,'YAMLString',$inline);
632 // Check for sequences
634 if (preg_match_all('/\[(.+)\]/U',$inline,$seqs)) {
635 $inline = preg_replace('/\[(.+)\]/U','YAMLSeq',$inline);
639 // Check for mappings
641 if (preg_match_all('/{(.+)}/U',$inline,$maps)) {
642 $inline = preg_replace('/{(.+)}/U','YAMLMap',$inline);
646 $explode = explode(', ',$inline);
648 // Re-add the strings
649 if (!empty($saved_strings)) {
651 foreach ($explode as $key => $value) {
652 if (strpos($value,'YAMLString')) {
653 $explode[$key] = str_replace('YAMLString',$saved_strings[$i],$value);
659 // Re-add the sequences
662 foreach ($explode as $key => $value) {
663 if (strpos($value,'YAMLSeq') !== false) {
664 $explode[$key] = str_replace('YAMLSeq',$seqs[$i],$value);
670 // Re-add the mappings
673 foreach ($explode as $key => $value) {
674 if (strpos($value,'YAMLMap') !== false) {
675 $explode[$key] = str_replace('YAMLMap',$maps[$i],$value);
685 * Builds the PHP array from all the YAML nodes we've gathered
689 function _buildArray() {
692 if (!isset($this->_indentSort
[0])) {
696 foreach ($this->_indentSort
[0] as $n) {
697 if (empty($n->parent
)) {
698 $this->_nodeArrayizeData($n);
699 // Check for references and copy the needed data to complete them.
700 $this->_makeReferences($n);
701 // Merge our data with the big array we're building
702 $trunk = $this->_array_kmerge($trunk,$n->data
);
710 * Traverses node-space and sets references (& and *) accordingly
714 function _linkReferences() {
715 if (is_array($this->_haveRefs
)) {
716 foreach ($this->_haveRefs
as $node) {
717 if (!empty($node->data
)) {
718 $key = key($node->data
);
719 // If it's an array, don't check.
720 if (is_array($node->data
[$key])) {
721 foreach ($node->data
[$key] as $k => $v) {
722 $this->_linkRef($node,$key,$k,$v);
725 $this->_linkRef($node,$key);
733 function _linkRef(&$n,$key,$k = NULL,$v = NULL) {
734 if (empty($k) && empty($v)) {
737 if (preg_match('/^&([^ ]+)/',$n->data
[$key],$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] =
741 substr($n->data
[$key],strlen($matches[0])+
1);
743 } elseif (preg_match('/^\*([^ ]+)/',$n->data
[$key],$matches)) {
744 $ref = substr($matches[0],1);
745 // Flag the node as having a reference
746 $this->_allNodes
[$n->id
]->refKey
= $ref;
748 } elseif (!empty($k) && !empty($v)) {
749 if (preg_match('/^&([^ ]+)/',$v,$matches)) {
750 // Flag the node so we know it's a reference
751 $this->_allNodes
[$n->id
]->ref
= substr($matches[0],1);
752 $this->_allNodes
[$n->id
]->data
[$key][$k] =
753 substr($v,strlen($matches[0])+
1);
755 } elseif (preg_match('/^\*([^ ]+)/',$v,$matches)) {
756 $ref = substr($matches[0],1);
757 // Flag the node as having a reference
758 $this->_allNodes
[$n->id
]->refKey
= $ref;
764 * Finds the children of a node and aids in the building of the PHP array
766 * @param int $nid The id of the node whose children we're gathering
769 function _gatherChildren($nid) {
771 $node =& $this->_allNodes
[$nid];
772 foreach ($this->_allNodes
as $z) {
773 if ($z->parent
== $node->id
) {
775 $this->_nodeArrayizeData($z);
776 // Check for references
777 $this->_makeReferences($z);
778 // Merge with the big array we're returning
779 // The big array being all the data of the children of our parent node
780 $return = $this->_array_kmerge($return,$z->data
);
787 * Turns a node's data and its children's data into a PHP array
790 * @param array $node The node which you want to arrayize
793 function _nodeArrayizeData(&$node) {
794 if (is_array($node->data
) && $node->children
== true) {
795 // This node has children, so we need to find them
796 $childs = $this->_gatherChildren($node->id
);
797 // We've gathered all our children's data and are ready to use it
798 $key = key($node->data
);
799 $key = empty($key) ?
0 : $key;
800 // If it's an array, add to it of course
801 if (is_array($node->data
[$key])) {
802 $node->data
[$key] = $this->_array_kmerge($node->data
[$key],$childs);
804 $node->data
[$key] = $childs;
806 } elseif (!is_array($node->data
) && $node->children
== true) {
807 // Same as above, find the children of this node
808 $childs = $this->_gatherChildren($node->id
);
809 $node->data
= array();
810 $node->data
[] = $childs;
813 // We edited $node by reference, so just return true
818 * Traverses node-space and copies references to / from this object.
820 * @param object $z A node whose references we wish to make real
823 function _makeReferences(&$z) {
825 if (isset($z->ref
)) {
826 $key = key($z->data
);
827 // Copy the data to this object for easy retrieval later
828 $this->ref
[$z->ref
] =& $z->data
[$key];
829 // It has a reference
830 } elseif (isset($z->refKey
)) {
831 if (isset($this->ref
[$z->refKey
])) {
832 $key = key($z->data
);
833 // Copy the data from this object to make the node a real reference
834 $z->data
[$key] =& $this->ref
[$z->refKey
];
842 * Merges arrays and maintains numeric keys.
844 * An ever-so-slightly modified version of the array_kmerge() function posted
845 * to php.net by mail at nospam dot iaindooley dot com on 2004-04-08.
847 * http://www.php.net/manual/en/function.array-merge.php#41394
854 function _array_kmerge($arr1,$arr2) {
861 $keys1 = array_keys($arr1);
862 $keys2 = array_keys($arr2);
863 $keys = array_merge($keys1,$keys2);
864 $vals1 = array_values($arr1);
865 $vals2 = array_values($arr2);
866 $vals = array_merge($vals1,$vals2);
869 foreach($keys as $key) {
870 list( /* unused */ ,$val) = each($vals);
871 // This is the good part! If a key already exists, but it's part of a
872 // sequence (an int), just keep addin numbers until we find a fresh one.
873 if (isset($ret[$key]) and is_int($key)) {
874 while (array_key_exists($key, $ret)) {