PHPXRef 0.7.1 : Joomla 4.2.2 documentation : Detail view of Yaml.php

(no description)

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

Defines 1 class

Yaml:: (3 methods):
  parseFile()
  parse()
  dump()

Class: Yaml - X-Ref

Yaml offers convenience methods to load and dump YAML.

parseFile(string $filename, int $flags = 0) X-Ref

Parses a YAML file into a PHP value.

Usage:

$array = Yaml::parseFile('config.yml');
print_r($array);

param: string $filename The path to the YAML file to be parsed
param: int $flags A bit field of PARSE_* constants to customize the YAML parser behavior
return: mixed

parse(string $input, int $flags = 0) X-Ref

Parses YAML into a PHP value.

Usage:
<code>
$array = Yaml::parse(file_get_contents('config.yml'));
print_r($array);
</code>

param: string $input A string containing YAML
param: int $flags A bit field of PARSE_* constants to customize the YAML parser behavior
return: mixed

dump($input, int $inline = 2, int $indent = 4, int $flags = 0) 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: int   $flags  A bit field of DUMP_* constants to customize the dumped YAML string

PHP Cross Reference of Joomla 4.2.2 documentation

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

Defines 1 class