public static function 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('config.yml'); print_r($array); </code>

@api

Parameters

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

Return value

array The YAML converted to a PHP array

Throws

ParseException If the YAML is not valid

7 calls to Yaml::parse()
FileStorageTest::read in drupal/core/modules/config/lib/Drupal/config/Tests/Storage/FileStorageTest.php
ParserTest::testMappingInASequence in drupal/core/vendor/symfony/yaml/Symfony/Component/Yaml/Tests/ParserTest.php
@expectedException Symfony\Component\Yaml\Exception\ParseException
ParserTest::testSequenceInAMapping in drupal/core/vendor/symfony/yaml/Symfony/Component/Yaml/Tests/ParserTest.php
@expectedException Symfony\Component\Yaml\Exception\ParseException
YamlFileLoader::load in drupal/core/vendor/symfony/routing/Symfony/Component/Routing/Loader/YamlFileLoader.php
Loads a Yaml file.
YamlFileLoader::loadFile in drupal/core/vendor/symfony/dependency-injection/Symfony/Component/DependencyInjection/Loader/YamlFileLoader.php
Loads a YAML file.

... See full list

File

drupal/core/vendor/symfony/yaml/Symfony/Component/Yaml/Yaml.php, line 52

Class

Yaml
Yaml offers convenience methods to load and dump YAML.

Namespace

Symfony\Component\Yaml

Code

public static function parse($input) {

  // if input is a file, process it
  $file = '';
  if (strpos($input, "\n") === false && is_file($input)) {
    if (false === is_readable($input)) {
      throw new ParseException(sprintf('Unable to parse "%s" as the file is not readable.', $input));
    }
    $file = $input;
    if (self::$enablePhpParsing) {
      ob_start();
      $retval = (include $file);
      $content = ob_get_clean();

      // if an array is returned by the config file assume it's in plain php form else in YAML
      $input = is_array($retval) ? $retval : $content;

      // if an array is returned by the config file assume it's in plain php form else in YAML
      if (is_array($input)) {
        return $input;
      }
    }
    else {
      $input = file_get_contents($file);
    }
  }
  $yaml = new Parser();
  try {
    return $yaml
      ->parse($input);
  } catch (ParseException $e) {
    if ($file) {
      $e
        ->setParsedFile($file);
    }
    throw $e;
  }
}