source: spip-zone/_plugins_/yaml/trunk/vendor/symfony/yaml/Escaper.php @ 110467

Last change on this file since 110467 was 110467, checked in by eric@…, 16 months ago

Premiers tests de mise à jour.

  • Property svn:eol-style set to native
File size: 3.9 KB
Line 
1<?php
2
3/*
4 * This file is part of the Symfony package.
5 *
6 * (c) Fabien Potencier <fabien@symfony.com>
7 *
8 * For the full copyright and license information, please view the LICENSE
9 * file that was distributed with this source code.
10 */
11
12namespace Symfony\Component\Yaml;
13
14/**
15 * Escaper encapsulates escaping rules for single and double-quoted
16 * YAML strings.
17 *
18 * @author Matthew Lewinski <matthew@lewinski.org>
19 *
20 * @internal
21 */
22class Escaper
23{
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";
26
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",
37                               );
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',
44                              );
45
46    /**
47     * Determines if a PHP value would require double quoting in YAML.
48     *
49     * @param string $value A PHP value
50     *
51     * @return bool True if the value would require double quotes
52     */
53    public static function requiresDoubleQuoting(string $value): bool
54    {
55        return 0 < preg_match('/'.self::REGEX_CHARACTER_TO_ESCAPE.'/u', $value);
56    }
57
58    /**
59     * Escapes and surrounds a PHP value with double quotes.
60     *
61     * @param string $value A PHP value
62     *
63     * @return string The quoted, escaped string
64     */
65    public static function escapeWithDoubleQuotes(string $value): string
66    {
67        return sprintf('"%s"', str_replace(self::$escapees, self::$escaped, $value));
68    }
69
70    /**
71     * Determines if a PHP value would require single quoting in YAML.
72     *
73     * @param string $value A PHP value
74     *
75     * @return bool True if the value would require single quotes
76     */
77    public static function requiresSingleQuoting(string $value): bool
78    {
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'))) {
82            return true;
83        }
84
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);
88    }
89
90    /**
91     * Escapes and surrounds a PHP value with single quotes.
92     *
93     * @param string $value A PHP value
94     *
95     * @return string The quoted, escaped string
96     */
97    public static function escapeWithSingleQuotes(string $value): string
98    {
99        return sprintf("'%s'", str_replace('\'', '\'\'', $value));
100    }
101}
Note: See TracBrowser for help on using the repository browser.