@@ -218,3 +218,59 @@ You can change the inner service name if you want to:
218218 ->addArgument(new Reference('bar.wooz'))
219219 ->setPublic(false)
220220 ->setDecoratedService('foo', 'bar.wooz');
221+
222+ Deprecating Services
223+ --------------------
224+
225+ Once you have decided to deprecate the use of a service (because it is outdated,
226+ or you decided not to use and maintain it anymore), you can deprecate its
227+ definition:
228+
229+ .. configuration-block ::
230+
231+ .. code-block :: yaml
232+
233+ bar :
234+ class : stdClass
235+ deprecated : The "%service_id%" service is deprecated since 2.8 and will be removed in 3.0.
236+
237+ .. code-block :: xml
238+
239+ <service id =" bar" class =" stdClass" >
240+ <deprecated >The "%service_id%" service is deprecated since 2.8 and will be removed in 3.0.</deprecated >
241+ </service >
242+
243+ .. code-block :: php
244+
245+ use Symfony\Component\DependencyInjection\Reference;
246+
247+ $container
248+ ->register('bar', 'stdClass')
249+ ->setDeprecated(true, 'The "%service_id%" service is deprecated since 2.8 and will be removed in 3.0.');
250+
251+ Now, every time a service is created using this deprecated definition, a
252+ deprecation warning will be triggered, advising you to stop or to change your
253+ uses of that service.
254+
255+ .. note ::
256+
257+ The deprecation message is optional. If not set, Symfony will show a default
258+ message ``The "%service_id%" service is deprecated. You should stop using it,
259+ as it will soon be removed. ``.
260+
261+ The message is actually a message template, which will replace occurrences
262+ of the ``%service_id% `` by the service's id. You **must ** have at least one
263+ occurrence of the ``%service_id% `` placeholder in your template.
264+
265+ It is strongly recommended that you fill the message template, to avoid a
266+ message that could be too generic such as the default one. A good message
267+ informs when this service was deprecated, and until when it will be
268+ maintained (look at the examples above).
269+
270+ For service decorators (see above), if the definition does not modify the
271+ deprecated status, it will inherit the status from the definition that is
272+ decorated.
273+
274+ .. warning ::
275+
276+ This is possible only when declaring the definition in PHP.
0 commit comments