Skip to content

Commit ac3e653

Browse files
committed
Merge branch '5.4' into 6.0
* 5.4: Complete XML and PHP configs and added a versionadded directive Fix documentation on declaration of service deprecation in YAML format
2 parents bf72d0c + 976422a commit ac3e653

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

service_container/alias_private.rst

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -342,7 +342,10 @@ or you decided not to maintain it anymore), you can deprecate its definition:
342342
343343
# config/services.yaml
344344
App\Service\OldService:
345-
deprecated: The "%service_id%" service is deprecated since vendor-name/package-name 2.8 and will be removed in 3.0.
345+
deprecated:
346+
package: 'vendor-name/package-name'
347+
version: '2.8'
348+
message: The "%service_id%" service is deprecated since vendor-name/package-name 2.8 and will be removed in 3.0.
346349
347350
.. code-block:: xml
348351
@@ -354,7 +357,7 @@ or you decided not to maintain it anymore), you can deprecate its definition:
354357
355358
<services>
356359
<service id="App\Service\OldService">
357-
<deprecated>The "%service_id%" service is deprecated since vendor-name/package-name 2.8 and will be removed in 3.0.</deprecated>
360+
<deprecated package="vendor-name/package-name" version="2.8">The "%service_id%" service is deprecated since vendor-name/package-name 2.8 and will be removed in 3.0.</deprecated>
358361
</service>
359362
</services>
360363
</container>
@@ -370,9 +373,19 @@ or you decided not to maintain it anymore), you can deprecate its definition:
370373
$services = $configurator->services();
371374
372375
$services->set(OldService::class)
373-
->deprecate('The "%service_id%" service is deprecated since vendor-name/package-name 2.8 and will be removed in 3.0.');
376+
->deprecate(
377+
'vendor-name/package-name',
378+
'2.8',
379+
'The "%service_id%" service is deprecated since vendor-name/package-name 2.8 and will be removed in 3.0.'
380+
);
374381
};
375382
383+
.. versionadded:: 5.1
384+
385+
Starting from Symfony 5.1, the ``deprecated`` YAML option, the ``<deprecated>``
386+
XML tag and the ``deprecate()`` PHP function require three arguments (the
387+
package name, the version and the deprecation message).
388+
376389
Now, every time this service is used, a deprecation warning is triggered,
377390
advising you to stop or to change your uses of that service.
378391

0 commit comments

Comments
 (0)