public static function Yaml::dump in Plug 7

Dumps a PHP array to a YAML string.

The dump method, when supplied with an array, will do its best to convert the array into friendly YAML.

@api

Parameters

array $array PHP array:

int $inline The level where you switch to inline YAML:

int $indent The amount of spaces to use for indentation of nested nodes.:

bool $exceptionOnInvalidType true if an exception must be thrown on invalid types (a PHP resource or object), false otherwise:

bool $objectSupport true if object support is enabled, false otherwise:

Return value

string A YAML string representing the original PHP array

2 calls to Yaml::dump()

YamlFileDumper::formatCatalogue in lib/Symfony/translation/Dumper/YamlFileDumper.php

Transforms a domain of a message catalogue to its string representation.

YamlTest::testParseAndDump in lib/Symfony/yaml/Symfony/Component/Yaml/Tests/YamlTest.php

File

lib/Symfony/yaml/Symfony/Component/Yaml/Yaml.php, line 95

Class

Yaml

Yaml offers convenience methods to load and dump YAML.

Namespace

Symfony\Component\Yaml

Code

public static function dump($array, $inline = 2, $indent = 4, $exceptionOnInvalidType = false, $objectSupport = false) {
  $yaml = new Dumper();
  $yaml
    ->setIndentation($indent);
  return $yaml
    ->dump($array, $inline, 0, $exceptionOnInvalidType, $objectSupport);
}