4 * This file is part of the Symfony package.
6 * (c) Fabien Potencier <fabien@symfony.com>
8 * For the full copyright and license information, please view the LICENSE
9 * file that was distributed with this source code.
12 namespace Symfony\Component\Yaml;
15 * Escaper encapsulates escaping rules for single and double-quoted
18 * @author Matthew Lewinski <matthew@lewinski.org>
24 // Characters that would cause a dumped string to require double quoting.
25 const REGEX_CHARACTER_TO_ESCAPE = "[\\x00-\\x1f]|\xc2\x85|\xc2\xa0|\xe2\x80\xa8|\xe2\x80\xa9";
27 // Mapping arrays for escaping a double quoted string. The backslash is
28 // first to ensure proper escaping because str_replace operates iteratively
29 // on the input arrays. This ordering of the characters avoids the use of strtr,
30 // which performs more slowly.
31 private static $escapees = array('\\', '\\\\', '\\"', '"',
32 "\x00", "\x01", "\x02", "\x03", "\x04", "\x05", "\x06", "\x07",
33 "\x08", "\x09", "\x0a", "\x0b", "\x0c", "\x0d", "\x0e", "\x0f",
34 "\x10", "\x11", "\x12", "\x13", "\x14", "\x15", "\x16", "\x17",
35 "\x18", "\x19", "\x1a", "\x1b", "\x1c", "\x1d", "\x1e", "\x1f",
36 "\xc2\x85", "\xc2\xa0", "\xe2\x80\xa8", "\xe2\x80\xa9",
38 private static $escaped = array('\\\\', '\\"', '\\\\', '\\"',
39 '\\0', '\\x01', '\\x02', '\\x03', '\\x04', '\\x05', '\\x06', '\\a',
40 '\\b', '\\t', '\\n', '\\v', '\\f', '\\r', '\\x0e', '\\x0f',
41 '\\x10', '\\x11', '\\x12', '\\x13', '\\x14', '\\x15', '\\x16', '\\x17',
42 '\\x18', '\\x19', '\\x1a', '\\e', '\\x1c', '\\x1d', '\\x1e', '\\x1f',
43 '\\N', '\\_', '\\L', '\\P',
47 * Determines if a PHP value would require double quoting in YAML.
49 * @param string $value A PHP value
51 * @return bool True if the value would require double quotes
53 public static function requiresDoubleQuoting($value)
55 return 0 < preg_match('/'.self::REGEX_CHARACTER_TO_ESCAPE.'/u', $value);
59 * Escapes and surrounds a PHP value with double quotes.
61 * @param string $value A PHP value
63 * @return string The quoted, escaped string
65 public static function escapeWithDoubleQuotes($value)
67 return sprintf('"%s"', str_replace(self::$escapees, self::$escaped, $value));
71 * Determines if a PHP value would require single quoting in YAML.
73 * @param string $value A PHP value
75 * @return bool True if the value would require single quotes
77 public static function requiresSingleQuoting($value)
79 // Determines if a PHP value is entirely composed of a value that would
80 // require single quoting in YAML.
81 if (in_array(strtolower($value), array('null', '~', 'true', 'false', 'y', 'n', 'yes', 'no', 'on', 'off'))) {
85 // Determines if the PHP value contains any single characters that would
86 // cause it to require single quoting in YAML.
87 return 0 < preg_match('/[ \s \' " \: \{ \} \[ \] , & \* \# \?] | \A[ \- ? | < > = ! % @ ` ]/x', $value);
91 * Escapes and surrounds a PHP value with single quotes.
93 * @param string $value A PHP value
95 * @return string The quoted, escaped string
97 public static function escapeWithSingleQuotes($value)
99 return sprintf("'%s'", str_replace('\'', '\'\'', $value));