1. class
  2. Symfony
  3. \
  4. Component
  5. \
  6. Yaml
  7. \
  8. Yaml

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

DUMP_NULL_AS_TILDE

DUMP_NUMERIC_KEY_AS_STRING

Methods

static mixed
parseFile(string$filename,int$flags =0)

Parses a YAML file into a PHP value.

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

Parses YAML into a PHP value.

static string
dump(mixed$input,int$inline =2,int$indent =4,int$flags =0)

Dumps a PHP value to a YAML string.

Details

staticmixed parseFile(string$filename,int$flags =0)

Parses a YAML file into a PHP value.

Usage:

$array = Yaml::parseFile('config.yml');
print_r($array);

Parameters

string $filename The path to the YAML file to be parsed
int $flags A bit field of PARSE_* constants to customize the YAML parser behavior

Return Value

mixed

Exceptions

ParseException If the file could not be read or the YAML is not valid

staticmixed parse(string$input,int$flags =0)

Parses YAML into a PHP value.

Usage: $array = Yaml::parse(file_get_contents('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

Exceptions

ParseException If the YAML is not valid

staticstring dump(mixed$input,int$inline =2,int$indent =4,int$flags =0)

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