diogo/symfony
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

minor #12727 [DEPRECATION] Add a deprecation note about Yaml::parse() file support #12701 (h4cc)

Browse Source 
This PR was merged into the 2.7 branch.

Discussion
----------

[DEPRECATION] Add a deprecation note about Yaml::parse() file support #12701

| Q             | A
| ------------- | ---
| Bug fix?      | no
| New feature?  | no
| BC breaks?    | no
| Deprecations? | yes
| Tests pass?   | yes
| Fixed tickets | #12701
| License       | MIT
| Doc PR        |

Commits
-------

4ef4c2c Add a deprecation note about Yaml::parse() file support #12701
This commit is contained in:
Fabien Potencier 2014-11-29 15:13:01 +01:00
commit 57e97ba665
2 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/Symfony/Component/Yaml/Tests/YamlTest.php
View File

@ -21,7 +21,10 @@ class YamlTest extends \PHPUnit_Framework_TestCase
$yml = Yaml::dump($data);
$parsed = Yaml::parse($yml);
$this->assertEquals($data, $parsed);
}
public function testParseFromFile()
{
$filename = __DIR__.'/Fixtures/index.yml';
$contents = file_get_contents($filename);
$parsedByFilename = Yaml::parse($filename);

6
src/Symfony/Component/Yaml/Yaml.php
View File

@ -30,7 +30,7 @@ class Yaml
*
* Usage:
* <code>
* $array = Yaml::parse('config.yml');
* $array = Yaml::parse(file_get_contents('config.yml'));
* print_r($array);
* </code>
*
@ -46,6 +46,8 @@ class Yaml
*
* @throws ParseException If the YAML is not valid
*
* @deprecated The ability to pass file names to Yaml::parse() was deprecated in 2.7 and will be removed in 3.0. Please, pass the contents of the file instead.
*
* @api
*/
public static function parse($input, $exceptionOnInvalidType = false, $objectSupport = false)
@ -53,6 +55,8 @@ class Yaml
// if input is a file, process it
$file = '';
if (strpos($input, "\n") === false && is_file($input)) {
trigger_error('The ability to pass file names to Yaml::parse() was deprecated in 2.7 and will be removed in 3.0. Please, pass the contents of the file instead.', E_USER_DEPRECATED);
if (false === is_readable($input)) {
throw new ParseException(sprintf('Unable to parse "%s" as the file is not readable.', $input));
}