Yaml offers convenience methods to load and dump YAML.
@author Fabien Potencier <fabien@symfony.com>
@api
Expanded class hierarchy of Yaml
class Yaml {
public static $enablePhpParsing = false;
public static function enablePhpParsing() {
self::$enablePhpParsing = true;
}
/**
* 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>
*
* @param string $input Path to a YAML file or a string containing YAML
*
* @return array The YAML converted to a PHP array
*
* @throws ParseException If the YAML is not valid
*
* @api
*/
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;
}
}
/**
* 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.
*
* @param array $array PHP array
* @param integer $inline The level where you switch to inline YAML
* @param integer $indent The amount of spaces to use for indentation of nested nodes.
*
* @return string A YAML string representing the original PHP array
*
* @api
*/
public static function dump($array, $inline = 2, $indent = 4) {
$yaml = new Dumper();
$yaml
->setIndentation($indent);
return $yaml
->dump($array, $inline);
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Yaml:: |
public static | property | ||
Yaml:: |
public static | function | Dumps a PHP array to a YAML string. | |
Yaml:: |
public static | function | ||
Yaml:: |
public static | function | Parses YAML into a PHP array. |