Yaml
class Yaml
Yaml offers convenience methods to load and dump YAML.
Constants
DUMP_OBJECT | |
PARSE_EXCEPTION_ON_INVALID_TYPE | |
PARSE_OBJECT | |
PARSE_OBJECT_FOR_MAP | |
DUMP_EXCEPTION_ON_INVALID_TYPE | |
PARSE_DATETIME | |
DUMP_OBJECT_AS_MAP | |
DUMP_MULTI_LINE_LITERAL_BLOCK | |
PARSE_CONSTANT | |
PARSE_CUSTOM_TAGS | |
DUMP_EMPTY_ARRAY_AS_SEQUENCE | |
PARSE_KEYS_AS_STRINGS |
Methods
static mixed | parse(string $input, int $flags) Parses YAML into a PHP value. | |
static string | dump(mixed $input, int $inline = 2, int $indent = 4, int $flags) Dumps a PHP value to a YAML string. |
Details
static mixed parse(string $input, int $flags)
Parses YAML into a PHP value.
Usage:
$array = Yaml::parse(filegetcontents('config.yml'));
print_r($array);
Parameters
string | $input | A string containing YAML |
int | $flags | A bit field of PARSE_* constants to customize the YAML parser behavior |
Return Value
mixed | The YAML converted to a PHP value |
Exceptions
ParseException | If the YAML is not valid |
static string dump(mixed $input, int $inline = 2, int $indent = 4, int $flags)
Dumps a PHP value to a YAML string.
The dump method, when supplied with an array, will do its best to convert the array into friendly YAML.
Parameters
mixed | $input | The PHP value |
int | $inline | The level where you switch to inline YAML |
int | $indent | The amount of spaces to use for indentation of nested nodes |
int | $flags | A bit field of DUMP_* constants to customize the dumped YAML string |
Return Value
string | A YAML string representing the original PHP value |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.3/Symfony/Component/Yaml/Yaml.html