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

Methods

static mixed
parse(string $input, int $flags)

Parses YAML into a PHP value.

static string
dump(array $array, int $inline = 2, int $indent = 4, int $flags)

Dumps a PHP array to a YAML string.

Details

at line line 49
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

at line line 95
static string dump(array $array, int $inline = 2, int $indent = 4, int $flags)

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.
int $flags A bit field of DUMP_* constants to customize the dumped YAML string

Return Value

string A YAML string representing the original PHP array