public static function Yaml::parse in Service Container 7

Same name and namespace in other branches

1. 7.2 modules/providers/service_container_symfony/lib/Symfony/Component/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.

@api

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

12 calls to Yaml::parse()

ParserTest::testEmptyValue in modules/providers/service_container_symfony/lib/Symfony/Component/Yaml/Tests/ParserTest.php

ParserTest::testFoldedStringBlockWithComments in modules/providers/service_container_symfony/lib/Symfony/Component/Yaml/Tests/ParserTest.php

ParserTest::testMappingDuplicateKeyBlock in modules/providers/service_container_symfony/lib/Symfony/Component/Yaml/Tests/ParserTest.php

> It is an error for two equal keys to appear in the same mapping node. > In such a case the YAML processor may continue, ignoring the second > `key: value` pair and issuing an appropriate warning. This strategy > preserves a consistent…

ParserTest::testMappingDuplicateKeyFlow in modules/providers/service_container_symfony/lib/Symfony/Component/Yaml/Tests/ParserTest.php

@covers \Symfony\Component\Yaml\Inline::parseMapping

ParserTest::testMappingInASequence in modules/providers/service_container_symfony/lib/Symfony/Component/Yaml/Tests/ParserTest.php

@expectedException \Symfony\Component\Yaml\Exception\ParseException

... See full list

File

modules/providers/service_container_symfony/lib/Symfony/Component/Yaml/Yaml.php, line 56

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;
  }
}