Yaml.php 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\Yaml;
  11. use Symfony\Component\Yaml\Exception\ParseException;
  12. /**
  13. * Yaml offers convenience methods to load and dump YAML.
  14. *
  15. * @author Fabien Potencier <fabien@symfony.com>
  16. *
  17. * @api
  18. */
  19. class Yaml
  20. {
  21. /**
  22. * Parses YAML into a PHP array.
  23. *
  24. * The parse method, when supplied with a YAML stream (string or file),
  25. * will do its best to convert YAML in a file into a PHP array.
  26. *
  27. * Usage:
  28. * <code>
  29. * $array = Yaml::parse(file_get_contents('config.yml'));
  30. * print_r($array);
  31. * </code>
  32. *
  33. * As this method accepts both plain strings and file names as an input,
  34. * you must validate the input before calling this method. Passing a file
  35. * as an input is a deprecated feature and will be removed in 3.0.
  36. *
  37. * 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.
  38. *
  39. * @param string $input Path to a YAML file or a string containing YAML
  40. * @param bool $exceptionOnInvalidType True if an exception must be thrown on invalid types false otherwise
  41. * @param bool $objectSupport True if object support is enabled, false otherwise
  42. * @param bool $objectForMap True if maps should return a stdClass instead of array()
  43. *
  44. * @return array The YAML converted to a PHP array
  45. *
  46. * @throws ParseException If the YAML is not valid
  47. *
  48. * @api
  49. */
  50. public static function parse($input, $exceptionOnInvalidType = false, $objectSupport = false, $objectForMap = false)
  51. {
  52. // if input is a file, process it
  53. $file = '';
  54. if (strpos($input, "\n") === false && is_file($input)) {
  55. @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);
  56. if (false === is_readable($input)) {
  57. throw new ParseException(sprintf('Unable to parse "%s" as the file is not readable.', $input));
  58. }
  59. $file = $input;
  60. $input = file_get_contents($file);
  61. }
  62. $yaml = new Parser();
  63. try {
  64. return $yaml->parse($input, $exceptionOnInvalidType, $objectSupport, $objectForMap);
  65. } catch (ParseException $e) {
  66. if ($file) {
  67. $e->setParsedFile($file);
  68. }
  69. throw $e;
  70. }
  71. }
  72. /**
  73. * Dumps a PHP array to a YAML string.
  74. *
  75. * The dump method, when supplied with an array, will do its best
  76. * to convert the array into friendly YAML.
  77. *
  78. * @param array $array PHP array
  79. * @param int $inline The level where you switch to inline YAML
  80. * @param int $indent The amount of spaces to use for indentation of nested nodes.
  81. * @param bool $exceptionOnInvalidType true if an exception must be thrown on invalid types (a PHP resource or object), false otherwise
  82. * @param bool $objectSupport true if object support is enabled, false otherwise
  83. *
  84. * @return string A YAML string representing the original PHP array
  85. *
  86. * @api
  87. */
  88. public static function dump($array, $inline = 2, $indent = 4, $exceptionOnInvalidType = false, $objectSupport = false)
  89. {
  90. $yaml = new Dumper();
  91. $yaml->setIndentation($indent);
  92. return $yaml->dump($array, $inline, 0, $exceptionOnInvalidType, $objectSupport);
  93. }
  94. }