Yaml offers convenience methods to load and dump YAML. More...

Collaboration diagram for Symfony\Component\Yaml\Yaml:

Static Public Member Functions
static	parse ($input, $flags=0)
	Parses YAML into a PHP value. More...

static	dump ($input, $inline=2, $indent=4, $flags=0)
	Dumps a PHP value to a YAML string. More...

Data Fields
const	DUMP_OBJECT = 1

const	PARSE_EXCEPTION_ON_INVALID_TYPE = 2

const	PARSE_OBJECT = 4

const	PARSE_OBJECT_FOR_MAP = 8

const	DUMP_EXCEPTION_ON_INVALID_TYPE = 16

const	PARSE_DATETIME = 32

const	DUMP_OBJECT_AS_MAP = 64

const	DUMP_MULTI_LINE_LITERAL_BLOCK = 128

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

Definition at line 21 of file Yaml.php.

Member Function Documentation

◆ dump()

static Symfony\Component\Yaml\Yaml::dump	(	$input,
		$inline = `2`,
		$indent = `4`,
		$flags = `0`
	)

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

Returns: string A YAML string representing the original PHP value

Definition at line 94 of file Yaml.php.

Referenced by Symfony\Component\Yaml\Tests\YamlTest\testNegativeIndentationThrowsException(), Symfony\Component\Yaml\Tests\YamlTest\testParseAndDump(), and Symfony\Component\Yaml\Tests\YamlTest\testZeroIndentationThrowsException().

     {
         if (is_bool($flags)) {
             @trigger_error('Passing a boolean flag to toggle exception handling is deprecated since version 3.1 and will be removed in 4.0. Use the DUMP_EXCEPTION_ON_INVALID_TYPE flag instead.', E_USER_DEPRECATED);
 
             if ($flags) {
                 $flags = self::DUMP_EXCEPTION_ON_INVALID_TYPE;
             } else {
                 $flags = 0;
             }
         }
 
         if (func_num_args() >= 5) {
             @trigger_error('Passing a boolean flag to toggle object support is deprecated since version 3.1 and will be removed in 4.0. Use the DUMP_OBJECT flag instead.', E_USER_DEPRECATED);
 
             if (func_get_arg(4)) {
                 $flags |= self::DUMP_OBJECT;
             }
         }
 
         $yaml = new Dumper($indent);
 
         return $yaml->dump($input, $inline, 0, $flags);
     }

Here is the caller graph for this function:

◆ parse()

static Symfony\Component\Yaml\Yaml::parse	(	$input,
		$flags = `0`
	)

static

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

Returns: mixed The YAML converted to a PHP value

Exceptions

ParseException If the YAML is not valid

Definition at line 48 of file Yaml.php.

     {
         if (is_bool($flags)) {
             @trigger_error('Passing a boolean flag to toggle exception handling is deprecated since version 3.1 and will be removed in 4.0. Use the PARSE_EXCEPTION_ON_INVALID_TYPE flag instead.', E_USER_DEPRECATED);
 
             if ($flags) {
                 $flags = self::PARSE_EXCEPTION_ON_INVALID_TYPE;
             } else {
                 $flags = 0;
             }
         }
 
         if (func_num_args() >= 3) {
             @trigger_error('Passing a boolean flag to toggle object support is deprecated since version 3.1 and will be removed in 4.0. Use the PARSE_OBJECT flag instead.', E_USER_DEPRECATED);
 
             if (func_get_arg(2)) {
                 $flags |= self::PARSE_OBJECT;
             }
         }
 
         if (func_num_args() >= 4) {
             @trigger_error('Passing a boolean flag to toggle object for map support is deprecated since version 3.1 and will be removed in 4.0. Use the Yaml::PARSE_OBJECT_FOR_MAP flag instead.', E_USER_DEPRECATED);
 
             if (func_get_arg(3)) {
                 $flags |= self::PARSE_OBJECT_FOR_MAP;
             }
         }
 
         $yaml = new Parser();
 
         return $yaml->parse($input, $flags);
     }