[ Index ]

PHP Cross Reference of phpBB-3.2.11-deutsch

title

Body

[close]

/vendor/symfony/yaml/ -> Yaml.php (summary)

(no description)

File Size: 99 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Yaml:: (2 methods):
  parse()
  dump()


Class: Yaml  - X-Ref

Yaml offers convenience methods to load and dump YAML.

parse($input, $exceptionOnInvalidType = false, $objectSupport = false, $objectForMap = false)   X-Ref
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.

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

dump($input, $inline = 2, $indent = 4, $exceptionOnInvalidType = false, $objectSupport = false)   X-Ref
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.

param: mixed $input                  The PHP value
param: int   $inline                 The level where you switch to inline YAML
param: int   $indent                 The amount of spaces to use for indentation of nested nodes
param: bool  $exceptionOnInvalidType True if an exception must be thrown on invalid types (a PHP resource or object), false otherwise
param: bool  $objectSupport          True if object support is enabled, false otherwise
return: string A YAML string representing the original PHP value



Generated: Wed Nov 11 20:33:01 2020 Cross-referenced by PHPXref 0.7.1