Documented the new parseFile() method #8523
Conversation
|
|
||
| Because it is currently possible to pass a filename to this method, you | ||
| must validate the input first. Passing a filename is deprecated in | ||
| Symfony 2.2, and was removed in Symfony 3.0. |
There was a problem hiding this comment.
we should already remove this block in the 3.3 docs
components/yaml.rst
Outdated
| Because it is currently possible to pass a filename to this method, you | ||
| must validate the input first. Passing a filename is deprecated in | ||
| Symfony 2.2, and was removed in Symfony 3.0. | ||
| $value = Yaml::parse("foo:\n 'bar'"); |
There was a problem hiding this comment.
having the newline here looks wrong to me, I would just use $value = Yaml::parse('foo: bar');
components/yaml.rst
Outdated
| ~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| The :method:`Symfony\\Component\\Yaml\\Yaml::parseFile` method parses the YAML | ||
| contents of the given file path and converts them to a PHP array: |
There was a problem hiding this comment.
the result must not necessarily be an array
components/yaml.rst
Outdated
| The :method:`Symfony\\Component\\Yaml\\Yaml::parseFile` method parses the YAML | ||
| contents of the given file path and converts them to a PHP array: | ||
|
|
||
| .. code-block:: php |
There was a problem hiding this comment.
can be omitted when terminating the previous paragraph with two colons
components/yaml.rst
Outdated
|
|
||
| use Symfony\Component\Yaml\Yaml; | ||
|
|
||
| $value = Yaml::parseFile(file_get_contents('/path/to/file.yml')); |
There was a problem hiding this comment.
file_get_contents() must be omitted here
|
Thank you @javiereguiluz. |
|
|
||
| use Symfony\Component\Yaml\Yaml; | ||
|
|
||
| $value = Yaml::parseFile('/path/to/file.yml'); |
There was a problem hiding this comment.
The method is not static https://github.com/symfony/symfony/blob/master/src/Symfony/Component/Yaml/Parser.php#L49
There was a problem hiding this comment.
but it is static in the Yaml class (which is used here): https://github.com/symfony/symfony/blob/master/src/Symfony/Component/Yaml/Yaml.php#L53 :)
This fixes #8424.