Yaml
class Yaml
Yaml offers convenience methods to load and dump YAML.
Methods
static array | parse(string $input, bool $exceptionOnInvalidType = false, bool $objectSupport = false, bool $objectForMap = false) Parses YAML into a PHP array. | |
static string | dump(array $array, int $inline = 2, int $indent = 4, bool $exceptionOnInvalidType = false, bool $objectSupport = false) Dumps a PHP array to a YAML string. |
Details
static array parse(string $input, bool $exceptionOnInvalidType = false, bool $objectSupport = false, bool $objectForMap = false)
Parses YAML into a PHP array.
The parse method, when supplied with a YAML stream (string or file), will do its best to convert YAML in a file into a PHP array.
Usage:
$array = Yaml::parse(filegetcontents('config.yml'));
print_r($array);
Parameters
string | $input | A string containing YAML |
bool | $exceptionOnInvalidType | True if an exception must be thrown on invalid types false otherwise |
bool | $objectSupport | True if object support is enabled, false otherwise |
bool | $objectForMap | True if maps should return a stdClass instead of array() |
Return Value
array | The YAML converted to a PHP array |
Exceptions
ParseException | If the YAML is not valid |
static string dump(array $array, int $inline = 2, int $indent = 4, bool $exceptionOnInvalidType = false, bool $objectSupport = false)
Dumps a PHP array to a YAML string.
The dump method, when supplied with an array, will do its best to convert the array into friendly YAML.
Parameters
array | $array | PHP array |
int | $inline | The level where you switch to inline YAML |
int | $indent | The amount of spaces to use for indentation of nested nodes. |
bool | $exceptionOnInvalidType | true if an exception must be thrown on invalid types (a PHP resource or object), false otherwise |
bool | $objectSupport | true if object support is enabled, false otherwise |
Return Value
string | A YAML string representing the original PHP array |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Yaml/Yaml.html