public static function Yaml::parse in Zircon Profile 8

Same name and namespace in other branches

8.0 vendor/symfony/yaml/Yaml.php \Symfony\Component\Yaml\Yaml::parse()

Parses YAML into a PHP array.

The parse method, when supplied with a YAML stream (string or file), will do its best to convert YAML in a file into a PHP array.

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

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 version 2.2 and will be removed in 3.0. Pass the YAML contents of the file instead.

Parameters

string $input Path to a YAML file or a string containing YAML:

bool $exceptionOnInvalidType True if an exception must be thrown on invalid types false otherwise:

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

bool $objectForMap True if maps should return a stdClass instead of array():

Return value

array The YAML converted to a PHP array

Throws

ParseException If the YAML is not valid

16 calls to Yaml::parse()

DefaultConfigTest::testConfigIsEmpty in core/tests/Drupal/Tests/Core/Extension/DefaultConfigTest.php: Tests that core.extension.yml is empty by default.
drupal-8.block-test-enabled.php in core/modules/system/tests/fixtures/update/drupal-8.block-test-enabled.php: Partial database to mimic the installation of the block_test module.
drupal-8.language-enabled.php in core/modules/system/tests/fixtures/update/drupal-8.language-enabled.php
ParserTest::testEmptyValue in vendor/symfony/yaml/Tests/ParserTest.php
ParserTest::testFoldedStringBlockWithComments in vendor/symfony/yaml/Tests/ParserTest.php

... See full list

File

vendor/symfony/yaml/Yaml.php, line 50

Class

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

Namespace

Symfony\Component\Yaml

Code

public static function parse($input, $exceptionOnInvalidType = false, $objectSupport = false, $objectForMap = false) {

  // if input is a file, process it
  $file = '';
  if (strpos($input, "\n") === false && is_file($input)) {
    @trigger_error('The ability to pass file names to the ' . __METHOD__ . ' method is deprecated since version 2.2 and will be removed in 3.0. Pass the YAML contents of the file instead.', E_USER_DEPRECATED);
    if (false === is_readable($input)) {
      throw new ParseException(sprintf('Unable to parse "%s" as the file is not readable.', $input));
    }
    $file = $input;
    $input = file_get_contents($file);
  }
  $yaml = new Parser();
  try {
    return $yaml
      ->parse($input, $exceptionOnInvalidType, $objectSupport, $objectForMap);
  } catch (ParseException $e) {
    if ($file) {
      $e
        ->setParsedFile($file);
    }
    throw $e;
  }
}

You are here