Yaml.php 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123
  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. const PARSE_CONSTANT = 256;
  28. const PARSE_CUSTOM_TAGS = 512;
  29. const DUMP_EMPTY_ARRAY_AS_SEQUENCE = 1024;
  30. const PARSE_KEYS_AS_STRINGS = 2048;
  31. /**
  32. * Parses YAML into a PHP value.
  33. *
  34. * Usage:
  35. * <code>
  36. * $array = Yaml::parse(file_get_contents('config.yml'));
  37. * print_r($array);
  38. * </code>
  39. *
  40. * @param string $input A string containing YAML
  41. * @param int $flags A bit field of PARSE_* constants to customize the YAML parser behavior
  42. *
  43. * @return mixed The YAML converted to a PHP value
  44. *
  45. * @throws ParseException If the YAML is not valid
  46. */
  47. public static function parse($input, $flags = 0)
  48. {
  49. if (is_bool($flags)) {
  50. @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);
  51. if ($flags) {
  52. $flags = self::PARSE_EXCEPTION_ON_INVALID_TYPE;
  53. } else {
  54. $flags = 0;
  55. }
  56. }
  57. if (func_num_args() >= 3) {
  58. @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);
  59. if (func_get_arg(2)) {
  60. $flags |= self::PARSE_OBJECT;
  61. }
  62. }
  63. if (func_num_args() >= 4) {
  64. @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);
  65. if (func_get_arg(3)) {
  66. $flags |= self::PARSE_OBJECT_FOR_MAP;
  67. }
  68. }
  69. $yaml = new Parser();
  70. return $yaml->parse($input, $flags);
  71. }
  72. /**
  73. * Dumps a PHP value 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 mixed $input The PHP value
  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 int $flags A bit field of DUMP_* constants to customize the dumped YAML string
  82. *
  83. * @return string A YAML string representing the original PHP value
  84. */
  85. public static function dump($input, $inline = 2, $indent = 4, $flags = 0)
  86. {
  87. if (is_bool($flags)) {
  88. @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);
  89. if ($flags) {
  90. $flags = self::DUMP_EXCEPTION_ON_INVALID_TYPE;
  91. } else {
  92. $flags = 0;
  93. }
  94. }
  95. if (func_num_args() >= 5) {
  96. @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);
  97. if (func_get_arg(4)) {
  98. $flags |= self::DUMP_OBJECT;
  99. }
  100. }
  101. $yaml = new Dumper($indent);
  102. return $yaml->dump($input, $inline, 0, $flags);
  103. }
  104. }