@@ -95,16 +95,20 @@ acts as a thin wrapper that simplifies common uses.
9595Reading YAML Files
9696~~~~~~~~~~~~~~~~~~
9797
98- The :method: `Symfony\\ Component\\ Yaml\\ Parser ::parse ` method parses a YAML
98+ The :method: `Symfony\\ Component\\ Yaml\\ Yaml ::parse ` method parses a YAML
9999string and converts it to a PHP array:
100100
101101.. code-block :: php
102102
103- use Symfony\Component\Yaml\Parser;
103+ use Symfony\Component\Yaml\Yaml;
104+
105+ $value = Yaml::parse(file_get_contents('/path/to/file.yml'));
104106
105- $yaml = new Parser();
107+ .. caution ::
106108
107- $value = $yaml->parse(file_get_contents('/path/to/file.yml'));
109+ Because it is currently possible to pass a filename to this method, you
110+ must validate the input first. Passing a filename is deprecated in
111+ Symfony 2.2, and was removed in Symfony 3.0.
108112
109113If an error occurs during parsing, the parser throws a
110114:class: `Symfony\\ Component\\ Yaml\\ Exception\\ ParseException ` exception
@@ -116,36 +120,11 @@ error occurred:
116120 use Symfony\Component\Yaml\Exception\ParseException;
117121
118122 try {
119- $value = $yaml-> parse(file_get_contents('/path/to/file.yml'));
123+ $value = Yaml:: parse(file_get_contents('/path/to/file.yml'));
120124 } catch (ParseException $e) {
121125 printf("Unable to parse the YAML string: %s", $e->getMessage());
122126 }
123127
124- .. tip ::
125-
126- As the parser is re-entrant, you can use the same parser object to load
127- different YAML strings.
128-
129- It may also be convenient to use the
130- :method: `Symfony\\ Component\\ Yaml\\ Yaml::parse ` wrapper method:
131-
132- .. code-block :: php
133-
134- use Symfony\Component\Yaml\Yaml;
135-
136- $yaml = Yaml::parse(file_get_contents('/path/to/file.yml'));
137-
138- The :method: `Symfony\\ Component\\ Yaml\\ Yaml::parse ` static method takes a YAML
139- string or a file containing YAML. Internally, it calls the
140- :method: `Symfony\\ Component\\ Yaml\\ Parser::parse ` method, but enhances the
141- error if something goes wrong by adding the filename to the message.
142-
143- .. caution ::
144-
145- Because it is currently possible to pass a filename to this method, you
146- must validate the input first. Passing a filename is deprecated in
147- Symfony 2.2, and will be removed in Symfony 3.0.
148-
149128 .. _components-yaml-dump :
150129
151130Objects for Mappings
@@ -165,36 +144,25 @@ arrays. You can instruct the parser to return mappings as objects (i.e.
165144Writing YAML Files
166145~~~~~~~~~~~~~~~~~~
167146
168- The :method: `Symfony\\ Component\\ Yaml\\ Dumper ::dump ` method dumps any PHP
147+ The :method: `Symfony\\ Component\\ Yaml\\ Yaml ::dump ` method dumps any PHP
169148array to its YAML representation:
170149
171150.. code-block :: php
172151
173- use Symfony\Component\Yaml\Dumper ;
152+ use Symfony\Component\Yaml\Yaml ;
174153
175154 $array = array(
176155 'foo' => 'bar',
177156 'bar' => array('foo' => 'bar', 'bar' => 'baz'),
178157 );
179158
180- $dumper = new Dumper();
181-
182- $yaml = $dumper->dump($array);
159+ $yaml = Yaml::dump($array);
183160
184161 file_put_contents('/path/to/file.yml', $yaml);
185162
186163 If an error occurs during the dump, the parser throws a
187164:class: `Symfony\\ Component\\ Yaml\\ Exception\\ DumpException ` exception.
188165
189- If you only need to dump one array, you can use the
190- :method: `Symfony\\ Component\\ Yaml\\ Yaml::dump ` static method shortcut:
191-
192- .. code-block :: php
193-
194- use Symfony\Component\Yaml\Yaml;
195-
196- $yaml = Yaml::dump($array);
197-
198166Array Expansion and Inlining
199167............................
200168
@@ -206,7 +174,7 @@ representation:
206174
207175 { foo: bar, bar: { foo: bar, bar: baz } }
208176
209- The second argument of the :method: `Symfony\\ Component\\ Yaml\\ Dumper ::dump `
177+ The second argument of the :method: `Symfony\\ Component\\ Yaml\\ Yaml ::dump `
210178method customizes the level at which the output switches from the expanded
211179representation to the inline one:
212180
0 commit comments