Yaml Class Reference

Static Public Member Functions
static	parse ($input, $exceptionOnInvalidType=false, $objectSupport=false, $objectForMap=false)
static	dump ($input, $inline=2, $indent=4, $exceptionOnInvalidType=false, $objectSupport=false)

Detailed Description

Yaml offers convenience methods to load and dump YAML.

Author

Fabien Potencier fabie.nosp@m.n@sy.nosp@m.mfony.nosp@m..com

Member Function Documentation

dump()

static dump (   $input,   $inline = 2,   $indent = 4,   $exceptionOnInvalidType = false,   $objectSupport = false  )

static

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
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

Returns

string A YAML string representing the original PHP value

Here is the caller graph for this function:

parse()

static parse (   $input,   $exceptionOnInvalidType = false,   $objectSupport = false,   $objectForMap = false  )

static

Parses YAML into a PHP value.

Usage:

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

Note: the ability to pass file names to the Yaml::parse method is deprecated since Symfony 2.2 and will be removed in 3.0. Pass the YAML contents of the file instead.

Parameters

string	$input	Path to a YAML file or 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()

Returns

mixed The YAML converted to a PHP value

Exceptions

ParseException

If the YAML is not valid

Here is the call graph for this function:

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• C:/xoops2511b2/htdocs/class/libraries/vendor/symfony/yaml/Yaml.php