Class Symfony\Component\Yaml\Yaml

Yaml offers convenience methods to load and dump YAML.

Located at class\libraries\vendor\symfony\yaml\Yaml.php

Methods


					
	public
					static

parse(
	string $input,
	bool $exceptionOnInvalidType = false,
	bool $objectSupport = false,
	bool $objectForMap = false,
): mixed

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

`$input`	Path to a YAML file or a string containing YAML
`$exceptionOnInvalidType`	True if an exception must be thrown on invalid types false otherwise
`$objectSupport`	True if object support is enabled, false otherwise
`$objectForMap`	True if maps should return a stdClass instead of array()

Returns

The YAML converted to a PHP value

Throws

Symfony\Component\Yaml\Exception\ParseException

If the YAML is not valid


					
	public
					static

dump(
	mixed $input,
	int $inline = 2,
	int $indent = 4,
	bool $exceptionOnInvalidType = false,
	bool $objectSupport = false,
): 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`	The PHP value
`$inline`	The level where you switch to inline YAML
`$indent`	The amount of spaces to use for indentation of nested nodes
`$exceptionOnInvalidType`	True if an exception must be thrown on invalid types (a PHP resource or object), false otherwise
`$objectSupport`	True if object support is enabled, false otherwise

Returns

A YAML string representing the original PHP value

Namespaces

Classes

Class Symfony\Component\Yaml\Yaml

Parameters

Returns

Throws

Parameters

Returns