|
2 | 2 | single: Yaml
|
3 | 3 | single: Components; Yaml
|
4 | 4 |
|
5 |
| -The YAML Component |
| 5 | +The Yaml Component |
6 | 6 | ==================
|
7 | 7 |
|
8 |
| - The YAML Component loads and dumps YAML files. |
| 8 | + The Yaml Component loads and dumps YAML files. |
9 | 9 |
|
10 | 10 | What is It?
|
11 | 11 | -----------
|
12 | 12 |
|
13 |
| -The Symfony2 YAML Component parses YAML strings to convert them to PHP arrays. |
| 13 | +The Symfony2 Yaml Component parses YAML strings to convert them to PHP arrays. |
14 | 14 | It is also able to convert PHP arrays to YAML strings.
|
15 | 15 |
|
16 | 16 | `YAML`_, *YAML Ain't Markup Language*, is a human friendly data serialization
|
17 | 17 | standard for all programming languages. YAML is a great format for your
|
18 | 18 | configuration files. YAML files are as expressive as XML files and as readable
|
19 | 19 | as INI files.
|
20 | 20 |
|
21 |
| -The Symfony2 YAML Component implements the YAML 1.2 version of the |
22 |
| -specification. |
| 21 | +The Symfony2 Yaml Component implements a selected subset of features defined in |
| 22 | +the `YAML 1.2 version specification`_. |
23 | 23 |
|
24 | 24 | .. tip::
|
25 | 25 |
|
|
40 | 40 | Fast
|
41 | 41 | ~~~~
|
42 | 42 |
|
43 |
| -One of the goal of Symfony YAML is to find the right balance between speed and |
44 |
| -features. It supports just the needed feature to handle configuration files. |
| 43 | +One of the goals of Symfony Yaml is to find the right balance between speed and |
| 44 | +features. It supports just the needed features to handle configuration files. |
| 45 | +Notable lacking features are: document directives, multi-line quoted messages, |
| 46 | +compact block collections and multi-document files. |
45 | 47 |
|
46 | 48 | Real Parser
|
47 | 49 | ~~~~~~~~~~~
|
@@ -78,7 +80,7 @@ yourself by referencing common configuration bits.
|
78 | 80 | Using the Symfony2 YAML Component
|
79 | 81 | ---------------------------------
|
80 | 82 |
|
81 |
| -The Symfony2 YAML Component is very simple and consists of two main classes: |
| 83 | +The Symfony2 Yaml Component is very simple and consists of two main classes: |
82 | 84 | one parses YAML strings (:class:`Symfony\\Component\\Yaml\\Parser`), and the
|
83 | 85 | other dumps a PHP array to a YAML string
|
84 | 86 | (:class:`Symfony\\Component\\Yaml\\Dumper`).
|
@@ -163,7 +165,7 @@ array to its YAML representation:
|
163 | 165 |
|
164 | 166 | .. note::
|
165 | 167 |
|
166 |
| - Of course, the Symfony2 YAML dumper is not able to dump resources. Also, |
| 168 | + Of course, the Symfony2 Yaml dumper is not able to dump resources. Also, |
167 | 169 | even if the dumper is able to dump PHP objects, it is considered to be a
|
168 | 170 | not supported feature.
|
169 | 171 |
|
@@ -213,3 +215,4 @@ representation to the inline one:
|
213 | 215 |
|
214 | 216 | .. _YAML: http://yaml.org/
|
215 | 217 | .. _Packagist: https://packagist.org/packages/symfony/yaml
|
| 218 | +.. _`YAML 1.2 version specification`: http://yaml.org/spec/1.2/spec.html |
0 commit comments