Chris@0: CHANGELOG
Chris@0: =========
Chris@0: 
Chris@14: 3.4.0
Chris@14: -----
Chris@14: 
Chris@14:  * added support for parsing YAML files using the `Yaml::parseFile()` or `Parser::parseFile()` method
Chris@14: 
Chris@14:  * the `Dumper`, `Parser`, and `Yaml` classes are marked as final
Chris@14: 
Chris@14:  * Deprecated the `!php/object:` tag which will be replaced by the
Chris@14:    `!php/object` tag (without the colon) in 4.0.
Chris@14: 
Chris@14:  * Deprecated the `!php/const:` tag which will be replaced by the
Chris@14:    `!php/const` tag (without the colon) in 4.0.
Chris@14: 
Chris@14:  * Support for the `!str` tag is deprecated, use the `!!str` tag instead.
Chris@14: 
Chris@14:  * Deprecated using the non-specific tag `!` as its behavior will change in 4.0.
Chris@14:    It will force non-evaluating your values in 4.0. Use plain integers or `!!float` instead.
Chris@14: 
Chris@14: 3.3.0
Chris@14: -----
Chris@14: 
Chris@14:  * Starting an unquoted string with a question mark followed by a space is
Chris@14:    deprecated and will throw a `ParseException` in Symfony 4.0.
Chris@14: 
Chris@14:  * Deprecated support for implicitly parsing non-string mapping keys as strings.
Chris@14:    Mapping keys that are no strings will lead to a `ParseException` in Symfony
Chris@14:    4.0. Use quotes to opt-in for keys to be parsed as strings.
Chris@14: 
Chris@14:    Before:
Chris@14: 
Chris@14:    ```php
Chris@14:    $yaml = <<<YAML
Chris@14:    null: null key
Chris@14:    true: boolean true
Chris@14:    2.0: float key
Chris@14:    YAML;
Chris@14: 
Chris@14:    Yaml::parse($yaml);
Chris@14:    ```
Chris@14: 
Chris@14:    After:
Chris@14: 
Chris@14:    ```php
Chris@14: 
Chris@14:    $yaml = <<<YAML
Chris@14:    "null": null key
Chris@14:    "true": boolean true
Chris@14:    "2.0": float key
Chris@14:    YAML;
Chris@14: 
Chris@14:    Yaml::parse($yaml);
Chris@14:    ```
Chris@14: 
Chris@14:  * Omitted mapping values will be parsed as `null`.
Chris@14: 
Chris@14:  * Omitting the key of a mapping is deprecated and will throw a `ParseException` in Symfony 4.0.
Chris@14: 
Chris@14:  * Added support for dumping empty PHP arrays as YAML sequences:
Chris@14: 
Chris@14:    ```php
Chris@14:    Yaml::dump([], 0, 0, Yaml::DUMP_EMPTY_ARRAY_AS_SEQUENCE);
Chris@14:    ```
Chris@14: 
Chris@0: 3.2.0
Chris@0: -----
Chris@0: 
Chris@0:  * Mappings with a colon (`:`) that is not followed by a whitespace are deprecated
Chris@12:    when the mapping key is not quoted and will lead to a `ParseException` in
Chris@12:    Symfony 4.0 (e.g. `foo:bar` must be `foo: bar`).
Chris@0: 
Chris@0:  * Added support for parsing PHP constants:
Chris@0: 
Chris@0:    ```php
Chris@0:    Yaml::parse('!php/const:PHP_INT_MAX', Yaml::PARSE_CONSTANT);
Chris@0:    ```
Chris@0: 
Chris@0:  * Support for silently ignoring duplicate mapping keys in YAML has been
Chris@0:    deprecated and will lead to a `ParseException` in Symfony 4.0.
Chris@0: 
Chris@0: 3.1.0
Chris@0: -----
Chris@0: 
Chris@0:  * Added support to dump `stdClass` and `ArrayAccess` objects as YAML mappings
Chris@0:    through the `Yaml::DUMP_OBJECT_AS_MAP` flag.
Chris@0: 
Chris@0:  * Strings that are not UTF-8 encoded will be dumped as base64 encoded binary
Chris@0:    data.
Chris@0: 
Chris@0:  * Added support for dumping multi line strings as literal blocks.
Chris@0: 
Chris@0:  * Added support for parsing base64 encoded binary data when they are tagged
Chris@0:    with the `!!binary` tag.
Chris@0: 
Chris@0:  * Added support for parsing timestamps as `\DateTime` objects:
Chris@0: 
Chris@0:    ```php
Chris@0:    Yaml::parse('2001-12-15 21:59:43.10 -5', Yaml::PARSE_DATETIME);
Chris@0:    ```
Chris@0: 
Chris@0:  * `\DateTime` and `\DateTimeImmutable` objects are dumped as YAML timestamps.
Chris@0: 
Chris@0:  * Deprecated usage of `%` at the beginning of an unquoted string.
Chris@0: 
Chris@0:  * Added support for customizing the YAML parser behavior through an optional bit field:
Chris@0: 
Chris@0:    ```php
Chris@0:    Yaml::parse('{ "foo": "bar", "fiz": "cat" }', Yaml::PARSE_EXCEPTION_ON_INVALID_TYPE | Yaml::PARSE_OBJECT | Yaml::PARSE_OBJECT_FOR_MAP);
Chris@0:    ```
Chris@0: 
Chris@0:  * Added support for customizing the dumped YAML string through an optional bit field:
Chris@0: 
Chris@0:    ```php
Chris@17:    Yaml::dump(['foo' => new A(), 'bar' => 1], 0, 0, Yaml::DUMP_EXCEPTION_ON_INVALID_TYPE | Yaml::DUMP_OBJECT);
Chris@0:    ```
Chris@0: 
Chris@0: 3.0.0
Chris@0: -----
Chris@0: 
Chris@0:  * Yaml::parse() now throws an exception when a blackslash is not escaped
Chris@0:    in double-quoted strings
Chris@0: 
Chris@0: 2.8.0
Chris@0: -----
Chris@0: 
Chris@0:  * Deprecated usage of a colon in an unquoted mapping value
Chris@0:  * Deprecated usage of @, \`, | and > at the beginning of an unquoted string
Chris@0:  * When surrounding strings with double-quotes, you must now escape `\` characters. Not
Chris@0:    escaping those characters (when surrounded by double-quotes) is deprecated.
Chris@0: 
Chris@0:    Before:
Chris@0: 
Chris@0:    ```yml
Chris@0:    class: "Foo\Var"
Chris@0:    ```
Chris@0: 
Chris@0:    After:
Chris@0: 
Chris@0:    ```yml
Chris@0:    class: "Foo\\Var"
Chris@0:    ```
Chris@0: 
Chris@0: 2.1.0
Chris@0: -----
Chris@0: 
Chris@0:  * Yaml::parse() does not evaluate loaded files as PHP files by default
Chris@0:    anymore (call Yaml::enablePhpParsing() to get back the old behavior)