Skip to content

[Config] Add NodeDefinition::docUrl() #20859

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

Merged
merged 1 commit into from
Apr 7, 2025
Merged

[Config] Add NodeDefinition::docUrl() #20859

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 24 additions & 0 deletions components/config/definition.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -546,6 +546,30 @@ and in XML:
<!-- entries-per-page: This value is only used for the search results page. -->
<config entries-per-page="25"/>

You can also provide a URL to a full documentation page::

$rootNode
->docUrl('Full documentation is available at https://example.com/docs/{version:major}.{version:minor}/reference.html')
->children()
->integerNode('entries_per_page')
->defaultValue(25)
->end()
->end()
;

A few placeholders are available to customize the URL:

* ``{version:major}``: The major version of the package currently installed
* ``{version:minor}``: The minor version of the package currently installed
* ``{package}``: The name of the package

The placeholders will be replaced when printing the configuration tree with the
``config:dump-reference`` command.

.. versionadded:: 7.3

The ``docUrl()`` method was introduced in Symfony 7.3.

Optional Sections
-----------------

Expand Down