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

Commit 3235b29

Browse files
wouterjwouterj
committed
Proofread UPGRADE guide
1 parent 141d64a commit 3235b29

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

1646
Console
1747
-------
@@ -23,7 +53,27 @@ Console
2353
DependencyInjection
2454
-------------------
2555

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

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

3990
HttpFoundation
4091
--------------
@@ -44,8 +95,12 @@ HttpFoundation
4495
Ldap
4596
----
4697

47-
* Add methods for `saslBind()` and `whoami()` to `ConnectionInterface` and `LdapInterface`
48-
* Deprecate the `sizeLimit` option of `AbstractQuery`
98+
* Deprecate the `sizeLimit` option of `AbstractQuery`, the option is unused
99+
100+
Lock
101+
----
102+
103+
* `RedisStore` uses `EVALSHA` over `EVAL` when evaluating LUA scripts
49104

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

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

@@ -76,26 +126,17 @@ Routing
76126
Security
77127
--------
78128

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

84133
Serializer
85134
----------
86135

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

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

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

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

109150
TwigBridge
110151
----------
@@ -123,11 +164,9 @@ TypeInfo
123164
Webhook
124165
-------
125166

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

132171
Yaml
133172
----

‎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