\A
and \z
as regex start and end for route requirement#[Route]
attributesPhpFileLoader::callConfigurator()
as extension point to ease custom routing configurationRouteCollectionBuilder
in favor of RoutingConfigurator
.$priority
to RouteCollection::add()
RouteCompiler::REGEX_DELIMITER
constantExpressionLanguageProvider
to expose extra functions to route conditionsstateless
keyword for configuring route stateless in PHP, YAML and XML configurations.RequestContext::fromUri()
to ease building the default contextPhpGeneratorDumper
and PhpMatcherDumper
generator_base_class
, generator_cache_class
, matcher_base_class
and matcher_cache_class
router optionsSerializable
implementing methods for Route
and CompiledRoute
are finalServiceRouterLoader
and ObjectRouteLoader
.ServiceRouterLoader
in favor of ContainerLoader
.ObjectRouteLoader
in favor of ObjectLoader
.import()
methodCompiledUrlMatcher
and CompiledUrlMatcherDumper
CompiledUrlGenerator
and CompiledUrlGeneratorDumper
PhpGeneratorDumper
and PhpMatcherDumper
generator_base_class
, generator_cache_class
, matcher_base_class
and matcher_cache_class
router optionsSerializable
implementing methods for Route
and CompiledRoute
are marked as @internal
and @final
.
Instead of overwriting them, use __serialize
and __unserialize
as extension points which are forward compatible
with the new serialization methods in PHP 7.4.utf8
Route option, defaults "locale" and "format" in configuration loaders and configuratorsutf8
optionutf8
optionNoConfigurationException
.controller
keyword for configuring route controllers in YAML and XML configurations.bool
, int
, float
, string
, list
and map
defaults in XML configurations.$referenceType
argument of the UrlGeneratorInterface::generate
method.
Use the constants defined in the UrlGeneratorInterface
instead.Before:
$router->generate('blog_show', ['slug' => 'my-blog-post'], true);
After:
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
$router->generate('blog_show', ['slug' => 'my-blog-post'], UrlGeneratorInterface::ABSOLUTE_URL);
ApacheMatcherDumper
and ApacheUrlMatcher
were deprecated and
will be removed in Symfony 3.0, since the performance gains were minimal and
it's hard to replicate the behavior of PHP implementation.[DEPRECATION] Several route settings have been renamed (the old ones will be removed in 3.0):
pattern
setting for a route has been deprecated in favor of path
_scheme
and _method
requirements have been moved to the schemes
and methods
settingsBefore:
article_edit:
pattern: /article/{id}
requirements: { '_method': 'POST|PUT', '_scheme': 'https', 'id': '\d+' }
<route id="article_edit" pattern="/article/{id}">
<requirement key="_method">POST|PUT</requirement>
<requirement key="_scheme">https</requirement>
<requirement key="id">\d+</requirement>
</route>
$route = new Route();
$route->setPattern('/article/{id}');
$route->setRequirement('_method', 'POST|PUT');
$route->setRequirement('_scheme', 'https');
After:
article_edit:
path: /article/{id}
methods: [POST, PUT]
schemes: https
requirements: { 'id': '\d+' }
<route id="article_edit" pattern="/article/{id}" methods="POST PUT" schemes="https">
<requirement key="id">\d+</requirement>
</route>
$route = new Route();
$route->setPath('/article/{id}');
$route->setMethods(['POST', 'PUT']);
$route->setSchemes('https');
Before:
$rootCollection = new RouteCollection();
$subCollection = new RouteCollection();
$rootCollection->addCollection($subCollection);
$subCollection->add('foo', new Route('/foo'));
After:
$rootCollection = new RouteCollection();
$subCollection = new RouteCollection();
$subCollection->add('foo', new Route('/foo'));
$rootCollection->addCollection($subCollection);
Also one must call addCollection
from the bottom to the top hierarchy.
So the correct sequence is the following (and not the reverse):
$childCollection->addCollection($grandchildCollection);
$rootCollection->addCollection($childCollection);
RouteCollection::getParent()
and RouteCollection::getRoot()
have been deprecated and will be removed in Symfony 2.3.RouteCollection::addPrefix
method to add defaults, requirements
or options without adding a prefix is not supported anymore. So if you called addPrefix
with an empty prefix or /
only (both have no relevance), like
addPrefix('', $defaultsArray, $requirementsArray, $optionsArray)
you need to use the new dedicated methods addDefaults($defaultsArray)
,
addRequirements($requirementsArray)
or addOptions($optionsArray)
instead.$options
parameter to RouteCollection::addPrefix()
has been deprecated
because adding options has nothing to do with adding a path prefix. If you want to add options
to all child routes of a RouteCollection, you can use addOptions()
.RouteCollection::getPrefix()
has been deprecated
because it suggested that all routes in the collection would have this prefix, which is
not necessarily true. On top of that, since there is no tree structure anymore, this method
is also useless. Don't worry about performance, prefix optimization for matching is still done
in the dumper, which was also improved in 2.2.0 to find even more grouping possibilities.RouteCollection::addCollection(RouteCollection $collection)
should now only be
used with a single parameter. The other params $prefix
, $default
, $requirements
and $options
will still work, but have been deprecated. The addPrefix
method should be used for this
use-case instead.
Before: $parentCollection->addCollection($collection, '/prefix', [...], [...])
After:
php
$collection->addPrefix('/prefix', [...], [...]);
$parentCollection->addCollection($collection);
* added support for the method default argument values when defining a @Route
* Adjacent placeholders without separator work now, e.g. /{x}{y}{z}.{_format}
.
* Characters that function as separator between placeholders are now whitelisted
to fix routes with normal text around a variable, e.g. /prefix{var}suffix
.
* [BC BREAK] The default requirement of a variable has been changed slightly.
Previously it disallowed the previous and the next char around a variable. Now
it disallows the slash (/
) and the next char. Using the previous char added
no value and was problematic because the route /index.{_format}
would be
matched by /index.ht/ml
.
* The default requirement now uses possessive quantifiers when possible which
improves matching performance by up to 20% because it prevents backtracking
when it's not needed.
* The ConfigurableRequirementsInterface can now also be used to disable the requirements
check on URL generation completely by calling setStrictRequirements(null)
. It
improves performance in production environment as you should know that params always
pass the requirements (otherwise it would break your link anyway).
* There is no restriction on the route name anymore. So non-alphanumeric characters
are now also allowed.
* [BC BREAK] RouteCompilerInterface::compile(Route $route)
was made static
(only relevant if you implemented your own RouteCompiler).
* Added possibility to generate relative paths and network paths in the UrlGenerator, e.g.
"../parent-file" and "//example.com/dir/file". The third parameter in
UrlGeneratorInterface::generate($name, $parameters = [], $referenceType = self::ABSOLUTE_PATH)
now accepts more values and you should use the constants defined in UrlGeneratorInterface
for
claritiy. The old method calls with a Boolean parameter will continue to work because they
equal the signature using the constants.
2.1.0
-----
* added RequestMatcherInterface
* added RequestContext::fromRequest()
* the UrlMatcher does not throw a \LogicException anymore when the required
scheme is not the current one
* added TraceableUrlMatcher
* added the possibility to define options, default values and requirements
for placeholders in prefix, including imported routes
* added RouterInterface::getRouteCollection
* [BC BREAK] the UrlMatcher urldecodes the route parameters only once, they
were decoded twice before. Note that the urldecode()
calls have been
changed for a single rawurldecode()
in order to support +
for input
paths.
* added RouteCollection::getRoot method to retrieve the root of a
RouteCollection tree
* [BC BREAK] made RouteCollection::setParent private which could not have
been used anyway without creating inconsistencies
* [BC BREAK] RouteCollection::remove also removes a route from parent
collections (not only from its children)
* added ConfigurableRequirementsInterface that allows to disable exceptions
(and generate empty URLs instead) when generating a route with an invalid
parameter value