Class Yaml
Yaml offers convenience methods to load and dump YAML.
Methods summary
public static
mixed
|
#
parse( string $input, boolean $exceptionOnInvalidType = false, boolean $objectSupport = false, boolean $objectForMap = false )
Parses YAML into a PHP value.
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 version 2.2 and will be removed in 3.0. Pass the YAML contents of the file
instead.
Parameters
- $input
string - $input Path to a YAML file or a string containing YAML
- $exceptionOnInvalidType
boolean - $exceptionOnInvalidType True if an exception must be thrown on invalid types
false otherwise
- $objectSupport
boolean - $objectSupport True if object support is enabled, false otherwise
- $objectForMap
boolean - $objectForMap True if maps should return a stdClass instead of array()
Returns
mixed - The YAML converted to a PHP value
Throws
|
public static
string
|
#
dump( mixed $input, integer $inline = 2, integer $indent = 4, boolean $exceptionOnInvalidType = false, boolean $objectSupport = false )
Dumps a PHP value to a YAML string.
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
- $input
mixed - $input The PHP value
- $inline
integer - $inline The level where you switch to inline YAML
- $indent
integer - $indent The amount of spaces to use for indentation of nested nodes
- $exceptionOnInvalidType
boolean - $exceptionOnInvalidType true if an exception must be thrown on invalid types (a
PHP resource or object), false otherwise
- $objectSupport
boolean - $objectSupport true if object support is enabled, false otherwise
Returns
string - A YAML string representing the original PHP value
|
Magic methods summary