Skip to content

Proofread UPGRADE guide #58899

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 67 additions & 28 deletions UPGRADE-7.2.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,40 @@ Read more about this in the [Symfony documentation](https://symfony.com/doc/7.2/

If you're upgrading from a version below 7.1, follow the [7.1 upgrade guide](UPGRADE-7.1.md) first.

Table of Contents
-----------------

Bundles

* [FrameworkBundle](#FrameworkBundle)

Bridges

* [TwigBridge](#TwigBridge)

Components

* [Cache](#Cache)
* [Console](#Console)
* [DependencyInjection](#DependencyInjection)
* [Form](#Form)
* [HttpFoundation](#HttpFoundation)
* [Ldap](#Ldap)
* [Lock](#Lock)
* [Mailer](#Mailer)
* [Notifier](#Notifier)
* [Routing](#Routing)
* [Security](#Security)
* [Serializer](#Serializer)
* [Translation](#Translation)
* [Webhook](#Webhook)
* [Yaml](#Yaml)

Cache
-----

* `igbinary_serialize()` is not used by default when the igbinary extension is installed
* `igbinary_serialize()` is no longer used instead of `serialize()` when the igbinary extension is installed, due to behavior
incompatibilities between the two (performance might be impacted)

Console
-------
Expand All @@ -23,7 +53,27 @@ Console
DependencyInjection
-------------------

* Deprecate `!tagged` tag, use `!tagged_iterator` instead
* Deprecate `!tagged` Yaml tag, use `!tagged_iterator` instead

*Before*
```yaml
services:
App\Handler:
tags: ['app.handler']

App\HandlerCollection:
arguments: [!tagged app.handler]
```

*After*
```yaml
services:
App\Handler:
tags: ['app.handler']

App\HandlerCollection:
arguments: [!tagged_iterator app.handler]
```

Form
----
Expand All @@ -34,7 +84,8 @@ FrameworkBundle
---------------

* [BC BREAK] The `secrets:decrypt-to-local` command terminates with a non-zero exit code when a secret could not be read
* Deprecate `session.sid_length` and `session.sid_bits_per_character` config options
* Deprecate making `cache.app` adapter taggable, use the `cache.app.taggable` adapter instead
* Deprecate `session.sid_length` and `session.sid_bits_per_character` config options, following the deprecation of these options in PHP 8.4.

HttpFoundation
--------------
Expand All @@ -44,8 +95,12 @@ HttpFoundation
Ldap
----

* Add methods for `saslBind()` and `whoami()` to `ConnectionInterface` and `LdapInterface`
* Deprecate the `sizeLimit` option of `AbstractQuery`
* Deprecate the `sizeLimit` option of `AbstractQuery`, the option is unused

Lock
----

* `RedisStore` uses `EVALSHA` over `EVAL` when evaluating LUA scripts

Mailer
------
Expand All @@ -55,11 +110,6 @@ Mailer
The `testIncompleteDsnException()` test is no longer provided by default. If you make use of it by implementing the `incompleteDsnProvider()` data providers,
you now need to use the `IncompleteDsnTestTrait`.

Messenger
---------

* Add `getRetryDelay()` method to `RecoverableExceptionInterface`

Notifier
--------

Expand All @@ -76,26 +126,17 @@ Routing
Security
--------

* Add `$token` argument to `UserCheckerInterface::checkPostAuth()`
* Deprecate argument `$secret` of `RememberMeToken` and `RememberMeAuthenticator`
* Deprecate argument `$secret` of `RememberMeToken` and `RememberMeAuthenticator`, the argument is unused
* Deprecate passing an empty string as `$userIdentifier` argument to `UserBadge` constructor
* Deprecate returning an empty string in `UserInterface::getUserIdentifier()`

Serializer
----------

* Deprecate the `csv_escape_char` context option of `CsvEncoder` and the `CsvEncoder::ESCAPE_CHAR_KEY` constant
* Deprecate `CsvEncoderContextBuilder::withEscapeChar()` method
* Deprecate the `csv_escape_char` context option of `CsvEncoder`, the `CsvEncoder::ESCAPE_CHAR_KEY` constant
and the `CsvEncoderContextBuilder::withEscapeChar()` method, following its deprecation in PHP 8.4
* Deprecate `AdvancedNameConverterInterface`, use `NameConverterInterface` instead

String
------

* `truncate` method now also accept `TruncateMode` enum instead of a boolean:
* `TruncateMode::Char` is equivalent to `true` value ;
* `TruncateMode::WordAfter` is equivalent to `false` value ;
* `TruncateMode::WordBefore` is a new mode that will cut the sentence on the last word before the limit is reached.

Translation
-----------

Expand All @@ -104,7 +145,7 @@ Translation
The `testIncompleteDsnException()` test is no longer provided by default. If you make use of it by implementing the `incompleteDsnProvider()` data providers,
you now need to use the `IncompleteDsnTestTrait`.

* Deprecate passing an escape character to `CsvFileLoader::setCsvControl()`
* Deprecate passing an escape character to `CsvFileLoader::setCsvControl()`, following its deprecation in PHP 8.4

TwigBridge
----------
Expand All @@ -123,11 +164,9 @@ TypeInfo
Webhook
-------

* [BC BREAK] `RequestParserInterface::parse()` return type changed from
`?RemoteEvent` to `RemoteEvent|array<RemoteEvent>|null`. Classes already
implementing this interface are unaffected but consumers of this method
will need to be updated to handle the new return type. Projects relying on
the `WebhookController` of the component are not affected by the BC break
* [BC BREAK] `RequestParserInterface::parse()` return type changed from `RemoteEvent|null` to `RemoteEvent|array<RemoteEvent>|null`.
Projects relying on the `WebhookController` of the component are not affected by the BC break. Classes already implementing
this interface are unaffected. Custom callers of this method will need to be updated to handle the extra array return type.

Yaml
----
Expand Down
3 changes: 2 additions & 1 deletion src/Symfony/Component/Cache/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ CHANGELOG
7.2
---

* `igbinary_serialize()` is not used by default when the igbinary extension is installed
* `igbinary_serialize()` is no longer used instead of `serialize()` by default when the igbinary extension is installed,
due to behavior compatibilities between the two
* Add optional `Psr\Clock\ClockInterface` parameter to `ArrayAdapter`

7.1
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Component/Ldap/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ CHANGELOG
---

* Add methods for `saslBind()` and `whoami()` to `ConnectionInterface` and `LdapInterface`
* Deprecate the `sizeLimit` option of `AbstractQuery`
* Deprecate the `sizeLimit` option of `AbstractQuery`, the option is unused

7.1
---
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Component/Mailer/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ CHANGELOG
you now need to use the `IncompleteDsnTestTrait`.

* Make `TransportFactoryTestCase` compatible with PHPUnit 10+
* Support unicode email addresses such as "dømi@dømi.fo"
* Support unicode email addresses such as "dømi@dømi.example"

7.1
---
Expand Down
4 changes: 2 additions & 2 deletions src/Symfony/Component/Serializer/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ CHANGELOG
7.2
---

* Deprecate the `csv_escape_char` context option of `CsvEncoder` and the `CsvEncoder::ESCAPE_CHAR_KEY` constant
* Deprecate `CsvEncoderContextBuilder::withEscapeChar()` method
* Deprecate the `csv_escape_char` context option of `CsvEncoder`, the `CsvEncoder::ESCAPE_CHAR_KEY` constant
and the `CsvEncoderContextBuilder::withEscapeChar()` method, following its deprecation in PHP 8.4
* Add `SnakeCaseToCamelCaseNameConverter`
* Support subclasses of `\DateTime` and `\DateTimeImmutable` for denormalization
* Add the `UidNormalizer::NORMALIZATION_FORMAT_RFC9562` constant
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Component/Webhook/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ CHANGELOG
* Make `AbstractRequestParserTestCase` compatible with PHPUnit 10+
* Add `PayloadSerializerInterface` with implementations to decouple the remote event handling from the Serializer component
* Add optional `$request` argument to `RequestParserInterface::createSuccessfulResponse()` and `RequestParserInterface::createRejectedResponse()`
* [BC BREAK] Change return type of `RequestParserInterface::parse()` to `RemoteEvent|array<RemoteEvent>|null` (from `?RemoteEvent`)
* [BC BREAK] Change return type of `RequestParserInterface::parse()` from `RemoteEvent|null` to `RemoteEvent|array<RemoteEvent>|null`

6.4
---
Expand Down
Loading