Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Remove mentions of XML and Config Builders in Getting started guides#21516

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.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
Show file tree
Hide file tree
Changes fromall commits
Commits
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
96 changes: 13 additions & 83 deletionsconfiguration.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,7 +53,7 @@ Configuration Formats
~~~~~~~~~~~~~~~~~~~~~

Unlike other frameworks, Symfony doesn't impose a specific format on you to
configure your applications, but lets you choose between YAML, XML and PHP.
configure your applications, but lets you choose between YAML and PHP.
Throughout the Symfony documentation, all configuration examples will be
shown in these three formats.

Expand All@@ -66,20 +66,18 @@ readable. These are the main advantages and disadvantages of each format:

* **YAML**: simple, clean and readable, but not all IDEs support autocompletion
and validation for it. :doc:`Learn the YAML syntax </reference/formats/yaml>`;
* **XML**: autocompleted/validated by most IDEs and is parsed natively by PHP,
but sometimes it generates configuration considered too verbose. `Learn the XML syntax`_;
* **PHP**: very powerful and it allows you to create dynamic configuration with
arrays or a :ref:`ConfigBuilder <config-config-builder>`.
arrays, and benefits from auto completion and static analysis using
array shapes.

.. note::
.. deprecated:: 7.4

The XML and Config Builder formats are deprecated in Symfony 7.4 and
will be removed in Symfony 8.0.

By default Symfony loads the configuration files defined in YAML and PHP
formats. If you define configuration in XML format, update the
:method:`Symfony\\Bundle\\FrameworkBundle\\Kernel\\MicroKernelTrait::configureContainer`
and/or
:method:`Symfony\\Bundle\\FrameworkBundle\\Kernel\\MicroKernelTrait::configureRoutes`
methods in the ``src/Kernel.php`` file to add support for the ``.xml`` file
extension.
.. versionadded:: 7.4

Array shapes were introduced in Symfony 7.4.

Importing Configuration Files
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All@@ -100,9 +98,9 @@ configuration files, even if they use a different format:
- { resource: '/etc/myapp/*.yaml' }

# ignore_errors: not_found silently discards errors if the loaded file doesn't exist
- { resource: 'my_config_file.xml', ignore_errors: not_found }
- { resource: 'my_config_file.php', ignore_errors: not_found }
# ignore_errors: true silently discards all errors (including invalid code and not found)
- { resource: 'my_other_config_file.xml', ignore_errors: true }
- { resource: 'my_other_config_file.php', ignore_errors: true }

# ...

Expand DownExpand Up@@ -267,27 +265,6 @@ reusable configuration value. By convention, parameters are defined under the

// ...

.. warning::

By default and when using XML configuration, the values between ``<parameter>``
tags are not trimmed. This means that the value of the following parameter will be
``'\n something@example.com\n'``:

.. code-block:: xml

<parameter key="app.admin_email">
something@example.com
</parameter>

If you want to trim the value of your parameter, use the ``trim`` attribute.
When using it, the value of the following parameter will be ``something@example.com``:

.. code-block:: xml

<parameter key="app.admin_email" trim="true">
something@example.com
</parameter>

Once defined, you can reference this parameter value from any other
configuration file using a special syntax: wrap the parameter name in two ``%``
(e.g. ``%app.admin_email%``):
Expand DownExpand Up@@ -331,7 +308,7 @@ configuration file using a special syntax: wrap the parameter name in two ``%``
'email_address' => param('app.admin_email'),

// ... but if you prefer it, you can also pass the name as a string
// surrounded by two % (same as in YAMLand XML formats) and Symfony will
// surrounded by two % (same as intheYAMLformat) and Symfony will
// replace it by that parameter value
'email_address' => '%app.admin_email%',
]);
Expand DownExpand Up@@ -1302,52 +1279,6 @@ parameters at once by type-hinting any of its constructor arguments with the
}
}

.. _config-config-builder:

Using PHP ConfigBuilders
------------------------

Writing PHP config is sometimes difficult because you end up with large nested
arrays and you have no autocompletion help from your favorite IDE. A way to
address this is to use "ConfigBuilders". They are objects that will help you
build these arrays.

Symfony generates the ConfigBuilder classes automatically in the
:ref:`kernel build directory <configuration-kernel-build-directory>` for all the
bundles installed in your application. By convention they all live in the
namespace ``Symfony\Config``::

// config/packages/security.php
use Symfony\Config\SecurityConfig;

return static function (SecurityConfig $security): void {
$security->firewall('main')
->pattern('^/*')
->lazy(true)
->security(false);

$security
->roleHierarchy('ROLE_ADMIN', ['ROLE_USER'])
->roleHierarchy('ROLE_SUPER_ADMIN', ['ROLE_ADMIN', 'ROLE_ALLOWED_TO_SWITCH'])
->accessControl()
->path('^/user')
->roles('ROLE_USER');

$security->accessControl(['path' => '^/admin', 'roles' => 'ROLE_ADMIN']);
};

.. note::

Only root classes in the namespace ``Symfony\Config`` are ConfigBuilders.
Nested configs (e.g. ``\Symfony\Config\Framework\CacheConfig``) are regular
PHP objects which aren't autowired when using them as an argument type.

.. note::

In order to get ConfigBuilders autocompletion in your IDE/editor, make sure
to not exclude the directory where these classes are generated (by default,
in ``var/cache/dev/Symfony/Config/``).

Keep Going!
-----------

Expand All@@ -1369,7 +1300,6 @@ And all the other topics related to configuration:

configuration/*

.. _`Learn the XML syntax`: https://en.wikipedia.org/wiki/XML
.. _`environment variables`: https://en.wikipedia.org/wiki/Environment_variable
.. _`symbolic links`: https://en.wikipedia.org/wiki/Symbolic_link
.. _`utilities to manage env vars`: https://symfony.com/doc/current/cloud/env.html
2 changes: 1 addition & 1 deletionpage_creation.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -87,7 +87,7 @@ try it out by going to: http://localhost:8000/lucky/number

Symfony recommends defining routes as attributes to have the controller code
and its route configuration at the same location. However, if you prefer, you can
:doc:`define routes in separate files </routing>` using YAML, XML and PHP formats.
:doc:`define routes in separate files </routing>` usingtheYAML or PHP formats.

If you see a lucky number being printed back to you, congratulations! But before
you run off to play the lottery, check out how this works. Remember the two steps
Expand Down
23 changes: 0 additions & 23 deletionsquick_tour/the_architecture.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -243,29 +243,6 @@ using the special ``when@`` keyword:
router:
strict_requirements: null

.. code-block:: xml

<!-- config/packages/framework.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:framework="http://symfony.com/schema/dic/symfony"
xsi:schemaLocation="http://symfony.com/schema/dic/services
https://symfony.com/schema/dic/services/services-1.0.xsd
http://symfony.com/schema/dic/symfony
https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

<framework:config>
<framework:router utf8="true"/>
</framework:config>

<when env="prod">
<framework:config>
<framework:router strict-requirements="null"/>
</framework:config>
</when>
</container>

.. code-block:: php

// config/packages/framework.php
Expand Down
10 changes: 7 additions & 3 deletionsrouting.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,12 +12,16 @@ provides other useful features, like generating SEO-friendly URLs (e.g.
Creating Routes
---------------

Routes can be configured in YAML, XML, PHP or using attributes.
All formats provide the same features and performance, so choose
your favorite.
Routes can be configured in YAML, PHP or using attributes. All formats
provide the same features and performance, so choose your favorite.
:ref:`Symfony recommends attributes <best-practice-controller-attributes>`
because it's convenient to put the route and controller in the same place.

.. deprecated:: 7.4

The XML format to configure routes is deprecated in Symfony 7.4 and
will be removed in Symfony 8.0.

.. _routing-route-attributes:

Creating Routes as Attributes
Expand Down
3 changes: 1 addition & 2 deletionsservice_container.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -704,8 +704,7 @@ all their types (string, boolean, array, binary and PHP constant parameters).

However, there is another type of parameter related to services. In YAML config,
any string which starts with ``@`` is considered as the ID of a service, instead
of a regular string. In XML config, use the ``type="service"`` type for the
parameter and in PHP config use the ``service()`` function:
of a regular string. In PHP config use the ``service()`` function:

.. configuration-block::

Expand Down
[8]ページ先頭
©2009-2025 Movatter.jp