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

[Yaml] Fix PHPDoc of the Yaml class

Browse Source
This commit is contained in:
Kévin Dunglas 2016-07-10 11:48:49 +02:00 committed by Christian Flothmann
parent 500c2cd694
commit a3fd991c4b
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -73,20 +73,20 @@ class Yaml
} }
/** /**
* Dumps a PHP array to a YAML string. * Dumps a PHP value to a YAML string.
* *
* The dump method, when supplied with an array, will do its best * The dump method, when supplied with an array, will do its best
* to convert the array into friendly YAML. * to convert the array into friendly YAML.
* *
* @param array $array PHP array * @param mixed $input The PHP value
* @param int $inline The level where you switch to inline YAML * @param int $inline The level where you switch to inline YAML
* @param int $indent The amount of spaces to use for indentation of nested nodes * @param int $indent The amount of spaces to use for indentation of nested nodes
* @param bool $exceptionOnInvalidType true if an exception must be thrown on invalid types (a PHP resource or object), false otherwise * @param bool $exceptionOnInvalidType true if an exception must be thrown on invalid types (a PHP resource or object), false otherwise
* @param bool $objectSupport true if object support is enabled, false otherwise * @param bool $objectSupport true if object support is enabled, false otherwise
* *
* @return string A YAML string representing the original PHP array * @return string A YAML string representing the original PHP value
*/ */
public static function dump($array, $inline = 2, $indent = 4, $exceptionOnInvalidType = false, $objectSupport = false) public static function dump($input, $inline = 2, $indent = 4, $exceptionOnInvalidType = false, $objectSupport = false)
{ {
if ($indent < 1) { if ($indent < 1) {
throw new \InvalidArgumentException('The indentation must be greater than zero.'); throw new \InvalidArgumentException('The indentation must be greater than zero.');
@ -95,6 +95,6 @@ class Yaml
$yaml = new Dumper(); $yaml = new Dumper();
$yaml->setIndentation($indent); $yaml->setIndentation($indent);
return $yaml->dump($array, $inline, 0, $exceptionOnInvalidType, $objectSupport); return $yaml->dump($input, $inline, 0, $exceptionOnInvalidType, $objectSupport);
} }
} }