8000 Documented the default_uri routing option by javiereguiluz · Pull Request #13657 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content

Documented the default_uri routing option #13657

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
May 14, 2020
Merged

Documented the default_uri routing option #13657

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
69 changes: 39 additions & 30 deletions routing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2031,49 +2031,57 @@ Generating URLs in Commands

Generating URLs in commands works the same as
:ref:`generating URLs in services <routing-generating-urls-in-services>`. The
only difference is that commands are not executed in the HTTP context, so they
don't have access to HTTP requests. In practice, this means that if you generate
absolute URLs, you'll get ``http://localhost/`` as the host name instead of your
real host name.
only difference is that commands are not executed in the HTTP context. Therefore,
if you generate absolute URLs, you'll get ``http://localhost/`` as the host name
instead of your real host name.

The solution is to configure the "request context" used by commands when they
generate URLs. This context can be configured globally for all commands:
The solution is to configure the ``default_uri`` option to define the
"request context" used by commands when they generate URLs:

.. configuration-block::

.. code-block:: yaml

# config/services.yaml
parameters:
router.request_context.host: 'example.org'
router.request_context.base_url: 'my/path'
asset.request_context.base_path: '%router.request_context.base_url%'
# config/packages/routing.yaml
framework:
router:
# ...
default_uri: 'https://example.org/my/path/'

.. code-block:: xml

<!-- config/services.xml -->
<?xml version="1.0" encoding="UTF-8"?>
<!-- config/packages/routing.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">

<parameters>
<parameter key="router.request_context.host">example.org</parameter>
<parameter key="router.request_context.base_url">my/path</parameter>
<parameter key="asset.request_context.base_path">%router.request_context.base_url%</parameter>
</parameters>
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 default-uri="https://example.org/my/path/">
<!-- ... -->
</framework:router>
</framework:config>
</container>

.. code-block:: php

// config/services.php
$container->setParameter('router.request_context.host', 'example.org');
$container->setParameter('router.request_context.base_url', 'my/path');
$container->setParameter('asset.request_context.base_path', $container->getParameter('router.request_context.base_url'));
// config/packages/routing.php
$container->loadFromExtension('framework', [
'router' => [
// ...
'default_uri' => "https://example.org/my/path/",
],
]);

.. versionadded:: 5.1

The ``default_uri`` option was introduced in Symfony 5.1.

This information can be configured per command too::
Now you'll get the expected results when generating URLs in your commands::

// src/Command/SomeCommand.php
namespace App\Command;
Expand All @@ -2098,11 +2106,6 @@ This information can be configured per command too::

protected function execute(InputInterface $input, OutputInterface $output)
{
// these values override any global configuration
$context = $this->router->getContext();
$context->setHost('example.com');
$context->setBaseUrl('my/path');

// generate a URL with no route arguments
$signUpPage = $this->router->generate('sign_up');

Expand All @@ -2123,6 +2126,12 @@ This information can be configured per command too::
}
}

.. note::

By default, the URLs generated for web assets use the same ``default_uri``
value, but you can change it with the ``asset.request_context.base_path``
and ``asset.request_context.secure`` container parameters.

Checking if a Route Exists
~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
0