8000 [config] Add a note about deprecated a node by sanpii · Pull Request #7794 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content

[config] Add a note about deprecated a node #7794

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.

Sign up for GitHub

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

Closed
wants to merge 2 commits into from
Closed

[config] Add a note about deprecated a node #7794

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c717211
[config] Add a note about deprecated a node
sanpii Apr 11, 2017
985376d
Explained the possibility of defining custom deprecation messages
javiereguiluz Oct 9, 2017
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
Next Next commit
[config] Add a note about deprecated a node
  • Loading branch information
@sanpii
sanpii committed Apr 12, 2017
commit c71721113e061217449e05168ad7676acfdf0581
20 changes: 20 additions & 0 deletions components/config/definition.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -423,6 +423,26 @@ has a certain value:
->end()
;

Deprecated the Option
---------------------

You can depreciate an option by using the
:method:`Symfony\\Component\\Config\\Definition\\Builder\\NodeDefinition::setDeprecated`
method.

.. code-block:: php

$rootNode
->children()
->integerNode('old_option')
->setDeprecated()
->end()
->end()
;

If you use the Web Debug Toolbar, the deprecation notice will be showed when the
configuration is rebuilt.

Documenting the Option
----------------------

Expand Down
0