8000 Proofread UPGRADE guide · symfony/symfony@fcb1e40 · GitHub
[go: up one dir, main page]
Skip to content

Commit fcb1e40

Browse files
wouterjwouterj
committed
Proofread UPGRADE guide
1 parent 975b5cd commit fcb1e40

File tree

6 files changed

+74
-34
lines changed

6 files changed

+74
-34
lines changed

‎UPGRADE-7.2.md

Lines changed: 67 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,40 @@ Read more about this in the [Symfony documentation](https://symfony.com/doc/7.2/
88

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

11+
Table of Contents
12+
-----------------
13+
14+
Bundles
15+
16+
* [FrameworkBundle](#FrameworkBundle)
17+
18+
Bridges
19+
20+
* [TwigBridge](#TwigBridge)
21+
22+
Components
23+
24+
* [Cache](#Cache)
25+
* [Console](#Console)
26+
* [DependencyInjection](#DependencyInjection)
27+
* [Form](#Form)
28+
* [HttpFoundation](#HttpFoundation)
29+
* [Ldap](#Ldap)
30+
* [Lock](#Lock)
31+
* [Mailer](#Mailer)
32+
* [Notifier](#Notifier)
33+
* [Routing](#Routing)
34+
* [Security](#Security)
35+
* [Serializer](#Serializer)
36+
* [Translation](#Translation)
37+
* [Webhook](#Webhook)
38+
* [Yaml](#Yaml)
39+
1140
Cache
1241
-----
1342

14-
* `igbinary_serialize()` is not used by default when the igbinary extension is installed
43+
* `igbinary_serialize()` is no longer used instead of `serialize()` when the igbinary extension is installed, due to behavior
44+
incompatibilities between the two (performance might be impacted)
1545
* Deprecate making `cache.app` adapter taggable, use the `cache.app.taggable` adapter instead
1646

1747
Console
@@ -24,7 +54,27 @@ Console
2454
DependencyInjection
2555
-------------------
2656

27-
* Deprecate `!tagged` tag, use `!tagged_iterator` instead
57+
* Deprecate `!tagged` Yaml tag, use `!tagged_iterator` instead
58+
59+
*Before*
60+
```yaml
61+
services:
62+
App\Handler:
63+
tags: ['app.handler']
64+
65+
App\HandlerCollection:
66+
arguments: [!tagged app.handler]
67+
```
68+
69+
*After*
70+
```yaml
71+
services:
72+
App\Handler:
73+
tags: ['app.handler']
74+
75+
App\HandlerCollection:
76+
arguments: [!tagged_iterator app.handler]
77+
```
2878
2979
Form
3080
----
@@ -35,7 +85,8 @@ FrameworkBundle
3585
---------------
3686

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

4091
HttpFoundation
4192
--------------
@@ -45,8 +96,12 @@ HttpFoundation
4596
Ldap
4697
----
4798

48-
* Add methods for `saslBind()` and `whoami()` to `ConnectionInterface` and `LdapInterface`
49-
* Deprecate the `sizeLimit` option of `AbstractQuery`
99+
* Deprecate the `sizeLimit` option of `AbstractQuery`, the option is unused
100+
101+
Lock
102+
----
103+
104+
* `RedisStore` uses `EVALSHA` over `EVAL` when evaluating LUA scripts
< A92E /td>
50105

51106
Mailer
52107
------
@@ -56,11 +111,6 @@ Mailer
56111
The `testIncompleteDsnException()` test is no longer provided by default. If you make use of it by implementing the `incompleteDsnProvider()` data providers,
57112
you now need to use the `IncompleteDsnTestTrait`.
58113

59-
Messenger
60-
---------
61-
62-
* Add `getRetryDelay()` method to `RecoverableExceptionInterface`
63-
64114
Notifier
65115
--------
66116

@@ -77,26 +127,17 @@ Routing
77127
Security
78128
--------
79129

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

85134
Serializer
86135
----------
87136

88-
* Deprecate the `csv_escape_char` context option of `CsvEncoder` and the `CsvEncoder::ESCAPE_CHAR_KEY` constant
89-
* Deprecate `CsvEncoderContextBuilder::withEscapeChar()` method
137+
* Deprecate the `csv_escape_char` context option of `CsvEncoder`, the `CsvEncoder::ESCAPE_CHAR_KEY` constant
138+
and the `CsvEncoderContextBuilder::withEscapeChar()` method, following its deprecation in PHP 8.4
90139
* Deprecate `AdvancedNameConverterInterface`, use `NameConverterInterface` instead
91140

92-
String
93-
------
94-
95-
* `truncate` method now also accept `TruncateMode` enum instead of a boolean:
96-
* `TruncateMode::Char` is equivalent to `true` value ;
97-
* `TruncateMode::WordAfter` is equivalent to `false` value ;
98-
* `TruncateMode::WordBefore` is a new mode that will cut the sentence on the last word before the limit is reached.
99-
100141
Translation
101142
-----------
102143

@@ -105,7 +146,7 @@ Translation
105146
The `testIncompleteDsnException()` test is no longer provided by default. If you make use of it by implementing the `incompleteDsnProvider()` data providers,
106147
you now need to use the `IncompleteDsnTestTrait`.
107148

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

110151
TwigBridge
111152
----------
@@ -124,11 +165,9 @@ TypeInfo
124165
Webhook
125166
-------
126167

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

133172
Yaml
134173
----

‎src/Symfony/Component/Cache/CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ CHANGELOG
44
7.2
55
---
66

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

1011
7.1

‎src/Symfony/Component/Ldap/CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ CHANGELOG
55
---
66

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

1010
7.1
1111
---

‎src/Symfony/Component/Mailer/CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ CHANGELOG
1010
you now need to use the `IncompleteDsnTestTrait`.
1111

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

1515
7.1
1616
---

‎src/Symfony/Component/Serializer/CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ CHANGELOG
44
7.2
55
---
66

7-
* Deprecate the `csv_escape_char` context option of `CsvEncoder` and the `CsvEncoder::ESCAPE_CHAR_KEY` constant
8-
* Deprecate `CsvEncoderContextBuilder::withEscapeChar()` method
7+
* Deprecate the `csv_escape_char` context option of `CsvEncoder`, the `CsvEncoder::ESCAPE_CHAR_KEY` constant
8+
and the `CsvEncoderContextBuilder::withEscapeChar()` method, following its deprecation in PHP 8.4
99
* Add `SnakeCaseToCamelCaseNameConverter`
1010
* Support subclasses of `\DateTime` and `\DateTimeImmutable` for denormalization
1111
* Add the `UidNormalizer::NORMALIZATION_FORMAT_RFC9562` constant

‎src/Symfony/Component/Webhook/CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ CHANGELOG
77
* Make `AbstractRequestParserTestCase` compatible with PHPUnit 10+
88
* Add `PayloadSerializerInterface` with implementations to decouple the remote event handling from the Serializer component
99
* Add optional `$request` argument to `RequestParserInterface::createSuccessfulResponse()` and `RequestParserInterface::createRejectedResponse()`
10-
* [BC BREAK] Change return type of `RequestParserInterface::parse()` to `RemoteEvent|array<RemoteEvent>|null` (from `?RemoteEvent`)
10+
* [BC BREAK] Change return type of `RequestParserInterface::parse()` from `RemoteEvent|null` to `RemoteEvent|array<RemoteEvent>|null`
1111

1212
6.4
1313
---

0 commit comments

Comments
 (0)
0