Symfony2 API
Class

Symfony\Component\Yaml\Yaml

class Yaml

Yaml offers convenience methods to load and dump YAML.

Methods

static array parse(string $input, Boolean $exceptionOnInvalidType = false, Boolean $objectSupport = false)

Parses YAML into a PHP array.
static string dump(array $array, integer $inline = 2, integer $indent = 4, Boolean $exceptionOnInvalidType = false, Boolean $objectSupport = false)

Dumps a PHP array to a YAML string.

Details

at line 51
static public array parse(string $input, Boolean $exceptionOnInvalidType = false, Boolean $objectSupport = 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('config.yml'); print_r($array);

As this method accepts both plain strings and file names as an input, you must validate the input before calling this method. Passing a file as an input is a deprecated feature and will be removed in 3.0.

Parameters

string $input Path to a YAML file or a string containing YAML
Boolean $exceptionOnInvalidType True if an exception must be thrown on invalid types false otherwise
Boolean $objectSupport True if object support is enabled, false otherwise

Return Value

array The YAML converted to a PHP array

Exceptions

ParseException If the YAML is not valid

at line 93
static public string dump(array $array, integer $inline = 2, integer $indent = 4, Boolean $exceptionOnInvalidType = false, Boolean $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
integer $inline The level where you switch to inline YAML
integer $indent The amount of spaces to use for indentation of nested nodes.
Boolean $exceptionOnInvalidType true if an exception must be thrown on invalid types (a PHP resource or object), false otherwise
Boolean $objectSupport true if object support is enabled, false otherwise

Return Value

string A YAML string representing the original PHP array