Yaml.php 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101
  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. * @final
  18. */
  19. class Yaml
  20. {
  21. const DUMP_OBJECT = 1;
  22. const PARSE_EXCEPTION_ON_INVALID_TYPE = 2;
  23. const PARSE_OBJECT = 4;
  24. const PARSE_OBJECT_FOR_MAP = 8;
  25. const DUMP_EXCEPTION_ON_INVALID_TYPE = 16;
  26. const PARSE_DATETIME = 32;
  27. const DUMP_OBJECT_AS_MAP = 64;
  28. const DUMP_MULTI_LINE_LITERAL_BLOCK = 128;
  29. const PARSE_CONSTANT = 256;
  30. const PARSE_CUSTOM_TAGS = 512;
  31. const DUMP_EMPTY_ARRAY_AS_SEQUENCE = 1024;
  32. /**
  33. * Parses a YAML file into a PHP value.
  34. *
  35. * Usage:
  36. *
  37. * $array = Yaml::parseFile('config.yml');
  38. * print_r($array);
  39. *
  40. * @param string $filename The path to the YAML file to be parsed
  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 file could not be read or the YAML is not valid
  46. */
  47. public static function parseFile(string $filename, int $flags = 0)
  48. {
  49. $yaml = new Parser();
  50. return $yaml->parseFile($filename, $flags);
  51. }
  52. /**
  53. * Parses YAML into a PHP value.
  54. *
  55. * Usage:
  56. * <code>
  57. * $array = Yaml::parse(file_get_contents('config.yml'));
  58. * print_r($array);
  59. * </code>
  60. *
  61. * @param string $input A string containing YAML
  62. * @param int $flags A bit field of PARSE_* constants to customize the YAML parser behavior
  63. *
  64. * @return mixed The YAML converted to a PHP value
  65. *
  66. * @throws ParseException If the YAML is not valid
  67. */
  68. public static function parse(string $input, int $flags = 0)
  69. {
  70. $yaml = new Parser();
  71. return $yaml->parse($input, $flags);
  72. }
  73. /**
  74. * Dumps a PHP value to a YAML string.
  75. *
  76. * The dump method, when supplied with an array, will do its best
  77. * to convert the array into friendly YAML.
  78. *
  79. * @param mixed $input The PHP value
  80. * @param int $inline The level where you switch to inline YAML
  81. * @param int $indent The amount of spaces to use for indentation of nested nodes
  82. * @param int $flags A bit field of DUMP_* constants to customize the dumped YAML string
  83. *
  84. * @return string A YAML string representing the original PHP value
  85. */
  86. public static function dump($input, int $inline = 2, int $indent = 4, int $flags = 0): string
  87. {
  88. $yaml = new Dumper($indent);
  89. return $yaml->dump($input, $inline, 0, $flags);
  90. }
  91. }