-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
Documented the trailing_slash_on_root option #9490
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from 1 commit
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -147,6 +147,65 @@ suppose you want to prefix all application routes with ``/site`` (e.g. | |
The path of each route being loaded from the new routing resource will now | ||
be prefixed with the string ``/site``. | ||
|
||
.. note:: | ||
|
||
If any of the prefixed routes defines an empty path, Symfony adds a trailing | ||
slash to it. In the previous example, an empty path prefixed with ``/site`` | ||
will result in the ``/site/`` URL. If you want to avoid this behavior, set | ||
the ``trailing_slash_on_root`` option to ``false``: | ||
|
||
.. configuration-block:: | ||
|
||
.. code-block:: php-annotations | ||
|
||
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route; | ||
|
||
/** | ||
* @Route("/site", "trailing_slash_on_root"="false") | ||
*/ | ||
class DefaultController | ||
{ | ||
// ... | ||
} | ||
|
||
.. code-block:: yaml | ||
|
||
# config/routes.yaml | ||
controllers: | ||
resource: '../src/Controller/' | ||
type: annotation | ||
prefix: /site | ||
trailing_slash_on_root: false | ||
|
||
.. code-block:: xml | ||
|
||
<!-- config/routes.xml --> | ||
<?xml version="1.0" encoding="UTF-8" ?> | ||
<routes xmlns="http://symfony.com/schema/routing" | ||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
xsi:schemaLocation="http://symfony.com/schema/routing | ||
http://symfony.com/schema/routing/routing-1.0.xsd"> | ||
|
||
<import | ||
resource="../src/Controller/" | ||
type="annotation" | ||
prefix="/site" | ||
trailing-slash-on-root="false" /> | ||
</routes> | ||
|
||
.. code-block:: php | ||
|
||
// config/routes.php | ||
use Symfony\Component\Routing\RouteCollection; | ||
|
||
$app = $loader->import('../src/Controller/', 'annotation'); | ||
// the second argument is the $trailing_slash_on_root option | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. the argument is named |
||
$app->addPrefix('/site', false); | ||
// ... | ||
|
||
.. versionadded:: 4.1 | ||
The ``trailing_slash_on_root`` option was introduced in Symfony 4.1. | ||
|
||
Prefixing the Names of Imported Routes | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this does not work on annotations:
trailing_slash_on_root
works only as an import option.