Yaml.php 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118
  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. class Yaml
  18. {
  19. const DUMP_OBJECT = 1;
  20. const PARSE_EXCEPTION_ON_INVALID_TYPE = 2;
  21. const PARSE_OBJECT = 4;
  22. const PARSE_OBJECT_FOR_MAP = 8;
  23. const DUMP_EXCEPTION_ON_INVALID_TYPE = 16;
  24. const PARSE_DATETIME = 32;
  25. const DUMP_OBJECT_AS_MAP = 64;
  26. const DUMP_MULTI_LINE_LITERAL_BLOCK = 128;
  27. /**
  28. * Parses YAML into a PHP value.
  29. *
  30. * Usage:
  31. * <code>
  32. * $array = Yaml::parse(file_get_contents('config.yml'));
  33. * print_r($array);
  34. * </code>
  35. *
  36. * @param string $input A string containing YAML
  37. * @param int $flags A bit field of PARSE_* constants to customize the YAML parser behavior
  38. *
  39. * @return mixed The YAML converted to a PHP value
  40. *
  41. * @throws ParseException If the YAML is not valid
  42. */
  43. public static function parse($input, $flags = 0)
  44. {
  45. if (is_bool($flags)) {
  46. @trigger_error('Passing a boolean flag to toggle exception handling is deprecated since version 3.1 and will be removed in 4.0. Use the PARSE_EXCEPTION_ON_INVALID_TYPE flag instead.', E_USER_DEPRECATED);
  47. if ($flags) {
  48. $flags = self::PARSE_EXCEPTION_ON_INVALID_TYPE;
  49. } else {
  50. $flags = 0;
  51. }
  52. }
  53. if (func_num_args() >= 3) {
  54. @trigger_error('Passing a boolean flag to toggle object support is deprecated since version 3.1 and will be removed in 4.0. Use the PARSE_OBJECT flag instead.', E_USER_DEPRECATED);
  55. if (func_get_arg(2)) {
  56. $flags |= self::PARSE_OBJECT;
  57. }
  58. }
  59. if (func_num_args() >= 4) {
  60. @trigger_error('Passing a boolean flag to toggle object for map support is deprecated since version 3.1 and will be removed in 4.0. Use the Yaml::PARSE_OBJECT_FOR_MAP flag instead.', E_USER_DEPRECATED);
  61. if (func_get_arg(3)) {
  62. $flags |= self::PARSE_OBJECT_FOR_MAP;
  63. }
  64. }
  65. $yaml = new Parser();
  66. return $yaml->parse($input, $flags);
  67. }
  68. /**
  69. * Dumps a PHP value to a YAML string.
  70. *
  71. * The dump method, when supplied with an array, will do its best
  72. * to convert the array into friendly YAML.
  73. *
  74. * @param mixed $input The PHP value
  75. * @param int $inline The level where you switch to inline YAML
  76. * @param int $indent The amount of spaces to use for indentation of nested nodes
  77. * @param int $flags A bit field of DUMP_* constants to customize the dumped YAML string
  78. *
  79. * @return string A YAML string representing the original PHP value
  80. */
  81. public static function dump($input, $inline = 2, $indent = 4, $flags = 0)
  82. {
  83. if (is_bool($flags)) {
  84. @trigger_error('Passing a boolean flag to toggle exception handling is deprecated since version 3.1 and will be removed in 4.0. Use the DUMP_EXCEPTION_ON_INVALID_TYPE flag instead.', E_USER_DEPRECATED);
  85. if ($flags) {
  86. $flags = self::DUMP_EXCEPTION_ON_INVALID_TYPE;
  87. } else {
  88. $flags = 0;
  89. }
  90. }
  91. if (func_num_args() >= 5) {
  92. @trigger_error('Passing a boolean flag to toggle object support is deprecated since version 3.1 and will be removed in 4.0. Use the DUMP_OBJECT flag instead.', E_USER_DEPRECATED);
  93. if (func_get_arg(4)) {
  94. $flags |= self::DUMP_OBJECT;
  95. }
  96. }
  97. $yaml = new Dumper($indent);
  98. return $yaml->dump($input, $inline, 0, $flags);
  99. }
  100. }