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
|
|
12
|
namespace Symfony\Component\Yaml;
|
13
|
|
14
|
use Symfony\Component\Yaml\Exception\ParseException;
|
15
|
|
16
|
/**
|
17
|
* Yaml offers convenience methods to load and dump YAML.
|
18
|
*
|
19
|
* @author Fabien Potencier <fabien@symfony.com>
|
20
|
*/
|
21
|
class Yaml
|
22
|
{
|
23
|
const DUMP_OBJECT = 1;
|
24
|
const PARSE_EXCEPTION_ON_INVALID_TYPE = 2;
|
25
|
const PARSE_OBJECT = 4;
|
26
|
const PARSE_OBJECT_FOR_MAP = 8;
|
27
|
const DUMP_EXCEPTION_ON_INVALID_TYPE = 16;
|
28
|
const PARSE_DATETIME = 32;
|
29
|
const DUMP_OBJECT_AS_MAP = 64;
|
30
|
const DUMP_MULTI_LINE_LITERAL_BLOCK = 128;
|
31
|
const PARSE_CONSTANT = 256;
|
32
|
const PARSE_CUSTOM_TAGS = 512;
|
33
|
const DUMP_EMPTY_ARRAY_AS_SEQUENCE = 1024;
|
34
|
const PARSE_KEYS_AS_STRINGS = 2048;
|
35
|
|
36
|
/**
|
37
|
* Parses YAML into a PHP value.
|
38
|
*
|
39
|
* Usage:
|
40
|
* <code>
|
41
|
* $array = Yaml::parse(file_get_contents('config.yml'));
|
42
|
* print_r($array);
|
43
|
* </code>
|
44
|
*
|
45
|
* @param string $input A string containing YAML
|
46
|
* @param int $flags A bit field of PARSE_* constants to customize the YAML parser behavior
|
47
|
*
|
48
|
* @return mixed The YAML converted to a PHP value
|
49
|
*
|
50
|
* @throws ParseException If the YAML is not valid
|
51
|
*/
|
52
|
public static function parse($input, $flags = 0)
|
53
|
{
|
54
|
if (is_bool($flags)) {
|
55
|
@trigger_error('Passing a boolean flag to toggle exception handling is deprecated since Symfony 3.1 and will be removed in 4.0. Use the PARSE_EXCEPTION_ON_INVALID_TYPE flag instead.', E_USER_DEPRECATED);
|
56
|
|
57
|
if ($flags) {
|
58
|
$flags = self::PARSE_EXCEPTION_ON_INVALID_TYPE;
|
59
|
} else {
|
60
|
$flags = 0;
|
61
|
}
|
62
|
}
|
63
|
|
64
|
if (func_num_args() >= 3) {
|
65
|
@trigger_error('Passing a boolean flag to toggle object support is deprecated since Symfony 3.1 and will be removed in 4.0. Use the PARSE_OBJECT flag instead.', E_USER_DEPRECATED);
|
66
|
|
67
|
if (func_get_arg(2)) {
|
68
|
$flags |= self::PARSE_OBJECT;
|
69
|
}
|
70
|
}
|
71
|
|
72
|
if (func_num_args() >= 4) {
|
73
|
@trigger_error('Passing a boolean flag to toggle object for map support is deprecated since Symfony 3.1 and will be removed in 4.0. Use the Yaml::PARSE_OBJECT_FOR_MAP flag instead.', E_USER_DEPRECATED);
|
74
|
|
75
|
if (func_get_arg(3)) {
|
76
|
$flags |= self::PARSE_OBJECT_FOR_MAP;
|
77
|
}
|
78
|
}
|
79
|
|
80
|
$yaml = new Parser();
|
81
|
|
82
|
return $yaml->parse($input, $flags);
|
83
|
}
|
84
|
|
85
|
/**
|
86
|
* Dumps a PHP value to a YAML string.
|
87
|
*
|
88
|
* The dump method, when supplied with an array, will do its best
|
89
|
* to convert the array into friendly YAML.
|
90
|
*
|
91
|
* @param mixed $input The PHP value
|
92
|
* @param int $inline The level where you switch to inline YAML
|
93
|
* @param int $indent The amount of spaces to use for indentation of nested nodes
|
94
|
* @param int $flags A bit field of DUMP_* constants to customize the dumped YAML string
|
95
|
*
|
96
|
* @return string A YAML string representing the original PHP value
|
97
|
*/
|
98
|
public static function dump($input, $inline = 2, $indent = 4, $flags = 0)
|
99
|
{
|
100
|
if (is_bool($flags)) {
|
101
|
@trigger_error('Passing a boolean flag to toggle exception handling is deprecated since Symfony 3.1 and will be removed in 4.0. Use the DUMP_EXCEPTION_ON_INVALID_TYPE flag instead.', E_USER_DEPRECATED);
|
102
|
|
103
|
if ($flags) {
|
104
|
$flags = self::DUMP_EXCEPTION_ON_INVALID_TYPE;
|
105
|
} else {
|
106
|
$flags = 0;
|
107
|
}
|
108
|
}
|
109
|
|
110
|
if (func_num_args() >= 5) {
|
111
|
@trigger_error('Passing a boolean flag to toggle object support is deprecated since Symfony 3.1 and will be removed in 4.0. Use the DUMP_OBJECT flag instead.', E_USER_DEPRECATED);
|
112
|
|
113
|
if (func_get_arg(4)) {
|
114
|
$flags |= self::DUMP_OBJECT;
|
115
|
}
|
116
|
}
|
117
|
|
118
|
$yaml = new Dumper($indent);
|
119
|
|
120
|
return $yaml->dump($input, $inline, 0, $flags);
|
121
|
}
|
122
|
}
|