summaryrefslogtreecommitdiff
path: root/includes/api/ApiFormatYaml_spyc.php
blob: f16b2c8a665d0949f3803ef3cbd342aba7fbade7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
<?php
/**
 * Spyc -- A Simple PHP YAML Class
 * @version 0.2.3 -- 2006-02-04
 * @author Chris Wanstrath <chris@ozmm.org>
 * @see http://spyc.sourceforge.net/
 * @copyright Copyright 2005-2006 Chris Wanstrath
 * @license http://www.opensource.org/licenses/mit-license.php MIT License
 */

/**
 * The Simple PHP YAML Class.
 *
 * This class can be used to read a YAML file and convert its contents
 * into a PHP array.  It currently supports a very limited subsection of
 * the YAML spec.
 *
 * @ingroup API
 */
class Spyc {

	/**
	 * Dump YAML from PHP array statically
	 *
	 * The dump method, when supplied with an array, will do its best
	 * to convert the array into friendly YAML.  Pretty simple.  Feel free to
	 * save the returned string as nothing.yml and pass it around.
	 *
	 * Oh, and you can decide how big the indent is and what the wordwrap
	 * for folding is.  Pretty cool -- just pass in 'false' for either if
	 * you want to use the default.
	 *
	 * Indent's default is 2 spaces, wordwrap's default is 40 characters.  And
	 * you can turn off wordwrap by passing in 0.
	 *
	 * @return string
	 * @param $array Array: PHP array
	 * @param $indent Integer: Pass in false to use the default, which is 2
	 * @param $wordwrap Integer: Pass in 0 for no wordwrap, false for default (40)
	 */
	public static function YAMLDump($array,$indent = false,$wordwrap = false) {
		$spyc = new Spyc;
		return $spyc->dump($array,$indent,$wordwrap);
	}

	/**
	 * Dump PHP array to YAML
	 *
	 * The dump method, when supplied with an array, will do its best
	 * to convert the array into friendly YAML.  Pretty simple.  Feel free to
	 * save the returned string as tasteful.yml and pass it around.
	 *
	 * Oh, and you can decide how big the indent is and what the wordwrap
	 * for folding is.  Pretty cool -- just pass in 'false' for either if
	 * you want to use the default.
	 *
	 * Indent's default is 2 spaces, wordwrap's default is 40 characters.  And
	 * you can turn off wordwrap by passing in 0.
	 *
	 * @public
	 * @return string
	 * @param $array Array: PHP array
	 * @param $indent Integer: Pass in false to use the default, which is 2
	 * @param $wordwrap Integer: Pass in 0 for no wordwrap, false for default (40)
	 */
	function dump($array,$indent = false,$wordwrap = false) {
		// Dumps to some very clean YAML.  We'll have to add some more features
		// and options soon.  And better support for folding.

		// New features and options.
		if ($indent === false or !is_numeric($indent)) {
			$this->_dumpIndent = 2;
		} else {
			$this->_dumpIndent = $indent;
		}

		if ($wordwrap === false or !is_numeric($wordwrap)) {
			$this->_dumpWordWrap = 40;
		} else {
			$this->_dumpWordWrap = $wordwrap;
		}

		// New YAML document
		$string = "---\n";

		// Start at the base of the array and move through it.
		foreach ($array as $key => $value) {
			$string .= $this->_yamlize($key,$value,0);
		}
		return $string;
	}

	/**** Private Properties ****/

	private $_haveRefs;
	private $_allNodes;
	private $_lastIndent;
	private $_lastNode;
	private $_inBlock;
	private $_isInline;
	private $_dumpIndent;
	private $_dumpWordWrap;

	/**** Private Methods ****/

	/**
	 * Attempts to convert a key / value array item to YAML
	 * @return string
	 * @param $key The name of the key
	 * @param $value The value of the item
	 * @param $indent The indent of the current node
	 */
	private function _yamlize($key,$value,$indent) {
		if (is_array($value)) {
			// It has children.  What to do?
			// Make it the right kind of item
			$string = $this->_dumpNode($key,NULL,$indent);
			// Add the indent
			$indent += $this->_dumpIndent;
			// Yamlize the array
			$string .= $this->_yamlizeArray($value,$indent);
		} elseif (!is_array($value)) {
			// It doesn't have children.  Yip.
			$string = $this->_dumpNode($key,$value,$indent);
		}
		return $string;
	}

	/**
	 * Attempts to convert an array to YAML
	 * @return string
	 * @param $array The array you want to convert
	 * @param $indent The indent of the current level
	 */
	private function _yamlizeArray($array,$indent) {
		if (is_array($array)) {
			$string = '';
			foreach ($array as $key => $value) {
				$string .= $this->_yamlize($key,$value,$indent);
			}
			return $string;
		} else {
 			return false;
		}
    }

	/**
	 * Find out whether a string needs to be output as a literal rather than in plain style.
	 * Added by Roan Kattouw 13-03-2008
	 * @param $value The string to check
	 * @return bool
	 */
	function _needLiteral($value) {
		# Check whether the string contains # or : or begins with any of:
		# [ - ? , [ ] { } ! * & | > ' " % @ ` ]
		# or is a number or contains newlines
		return (bool)(gettype($value) == "string" &&
			(is_numeric($value)  ||
			strpos($value, "\n") ||
			preg_match("/[#:]/", $value) ||
			preg_match("/^[-?,[\]{}!*&|>'\"%@`]/", $value)));

	}

	/**
	 * Returns YAML from a key and a value
	 * @return string
	 * @param $key The name of the key
	 * @param $value The value of the item
	 * @param $indent The indent of the current node
	 */
	private function _dumpNode($key,$value,$indent) {
		// do some folding here, for blocks
		if ($this->_needLiteral($value)) {
			$value = $this->_doLiteralBlock($value,$indent);
		} else {
			$value  = $this->_doFolding($value,$indent);
		}

		$spaces = str_repeat(' ',$indent);

		if (is_int($key)) {
			// It's a sequence
			if ($value !== '' && !is_null($value))
				$string = $spaces.'- '.$value."\n";
			else
				$string = $spaces . "-\n";
		} else {
			// It's mapped
			if ($value !== '' && !is_null($value))
				$string = $spaces . $key . ': ' . $value . "\n";
			else
				$string = $spaces . $key . ":\n";
		}
		return $string;
	}

	/**
	 * Creates a literal block for dumping
	 * @return string
	 * @param $value
	 * @param $indent int The value of the indent
	 */
	private function _doLiteralBlock($value,$indent) {
		$exploded = explode("\n",$value);
		$newValue = '|';
		$indent  += $this->_dumpIndent;
		$spaces   = str_repeat(' ',$indent);
		foreach ($exploded as $line) {
			$newValue .= "\n" . $spaces . trim($line);
		}
		return $newValue;
	}

	/**
	 * Folds a string of text, if necessary
	 * @return string
	 * @param $value The string you wish to fold
	 */
	private function _doFolding($value,$indent) {
		// Don't do anything if wordwrap is set to 0
		if ($this->_dumpWordWrap === 0) {
			return $value;
		}

		if (strlen($value) > $this->_dumpWordWrap) {
			$indent += $this->_dumpIndent;
			$indent = str_repeat(' ',$indent);
			$wrapped = wordwrap($value,$this->_dumpWordWrap,"\n$indent");
			$value   = ">\n".$indent.$wrapped;
		}
		return $value;
	}
}