merged branch Tobion/requirementscheck2 (PR #5446)
This PR was merged into the master branch. Commits -------faee47c
added note in changelog about disabling requirements check5fbed36
extended phpdoc of ConfigurableRequirementsInterface1964d43
[Routing] added test for disabled requirements check98fb915
[Routing] allow disabling the requirements check on URL generation Discussion ---------- [Routing] allow disabling the requirements check on URL generation Reopened version of #5187 Requires #5445 first --------------------------------------------------------------------------- by fabpot at 2012-10-03T19:03:25Z Can you rebase on master and add a note in the CHANGELOG? Also, I think the doc should be updated accordingly. Thanks. --------------------------------------------------------------------------- by Tobion at 2012-10-03T19:04:07Z @fabpot ping. The config for this feature is already present in master in symfony-standard. See [config_prod.yml](https://github.com/symfony/symfony-standard/blob/master/app/config/config_prod.yml) --------------------------------------------------------------------------- by Tobion at 2012-10-03T19:06:53Z Hehe, I already rebased while you wrote that. You mean I should add a tip to the routing component documentation? Sure, I have alread planned to adjust the symfony doc for the recent routing PRs. --------------------------------------------------------------------------- by fabpot at 2012-10-03T19:12:36Z Just adding a note about the new possibility in the CHANGELOG. --------------------------------------------------------------------------- by Tobion at 2012-10-03T19:53:19Z @fabpot done
This commit is contained in:
commit
78dcfe598b
@ -15,6 +15,10 @@ CHANGELOG
|
|||||||
* The default requirement now uses possesive quantifiers when possible which
|
* The default requirement now uses possesive quantifiers when possible which
|
||||||
improves matching performance by up to 20% because it prevents backtracking
|
improves matching performance by up to 20% because it prevents backtracking
|
||||||
when it's not needed.
|
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).
|
||||||
|
|
||||||
2.1.0
|
2.1.0
|
||||||
-----
|
-----
|
||||||
@ -37,5 +41,6 @@ CHANGELOG
|
|||||||
been used anyway without creating inconsistencies
|
been used anyway without creating inconsistencies
|
||||||
* [BC BREAK] RouteCollection::remove also removes a route from parent
|
* [BC BREAK] RouteCollection::remove also removes a route from parent
|
||||||
collections (not only from its children)
|
collections (not only from its children)
|
||||||
* added strict_requirements option to disable exceptions (and generate empty
|
* added ConfigurableRequirementsInterface that allows to disable exceptions
|
||||||
URLs instead) when generating a route with an invalid parameter value
|
(and generate empty URLs instead) when generating a route with an invalid
|
||||||
|
parameter value
|
||||||
|
@ -12,25 +12,44 @@
|
|||||||
namespace Symfony\Component\Routing\Generator;
|
namespace Symfony\Component\Routing\Generator;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* ConfigurableRequirementsInterface must be implemented by URL generators in order
|
* ConfigurableRequirementsInterface must be implemented by URL generators that
|
||||||
* to be able to configure whether an exception should be generated when the
|
* can be configured whether an exception should be generated when the parameters
|
||||||
* parameters do not match the requirements.
|
* do not match the requirements. It is also possible to disable the requirements
|
||||||
|
* check for URL generation completely.
|
||||||
|
*
|
||||||
|
* The possible configurations and use-cases:
|
||||||
|
* - setStrictRequirements(true): Throw an exception for mismatching requirements. This
|
||||||
|
* is mostly useful in development environment.
|
||||||
|
* - setStrictRequirements(false): Don't throw an exception but return null as URL for
|
||||||
|
* mismatching requirements and log the problem. Useful when you cannot control all
|
||||||
|
* params because they come from third party libs but don't want to have a 404 in
|
||||||
|
* production environment. It should log the mismatch so one can review it.
|
||||||
|
* - setStrictRequirements(null): Return the URL with the given parameters without
|
||||||
|
* checking the requirements at all. When generating an URL you should either trust
|
||||||
|
* your params or you validated them beforehand because otherwise it would break your
|
||||||
|
* link anyway. So in production environment you should know that params always pass
|
||||||
|
* the requirements. Thus this option allows to disable the check on URL generation for
|
||||||
|
* performance reasons (saving a preg_match for each requirement every time a URL is
|
||||||
|
* generated).
|
||||||
*
|
*
|
||||||
* @author Fabien Potencier <fabien@symfony.com>
|
* @author Fabien Potencier <fabien@symfony.com>
|
||||||
|
* @author Tobias Schultze <http://tobion.de>
|
||||||
*/
|
*/
|
||||||
interface ConfigurableRequirementsInterface
|
interface ConfigurableRequirementsInterface
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* Enables or disables the exception on incorrect parameters.
|
* Enables or disables the exception on incorrect parameters.
|
||||||
|
* Passing null will deactivate the requirements check completely.
|
||||||
*
|
*
|
||||||
* @param Boolean $enabled
|
* @param Boolean|null $enabled
|
||||||
*/
|
*/
|
||||||
public function setStrictRequirements($enabled);
|
public function setStrictRequirements($enabled);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets the strict check of incorrect parameters.
|
* Returns whether to throw an exception on incorrect parameters.
|
||||||
|
* Null means the requirements check is deactivated completely.
|
||||||
*
|
*
|
||||||
* @return Boolean
|
* @return Boolean|null
|
||||||
*/
|
*/
|
||||||
public function isStrictRequirements();
|
public function isStrictRequirements();
|
||||||
}
|
}
|
||||||
|
@ -100,7 +100,7 @@ class UrlGenerator implements UrlGeneratorInterface, ConfigurableRequirementsInt
|
|||||||
*/
|
*/
|
||||||
public function setStrictRequirements($enabled)
|
public function setStrictRequirements($enabled)
|
||||||
{
|
{
|
||||||
$this->strictRequirements = (Boolean) $enabled;
|
$this->strictRequirements = null === $enabled ? null : (Boolean) $enabled;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -146,7 +146,7 @@ class UrlGenerator implements UrlGeneratorInterface, ConfigurableRequirementsInt
|
|||||||
if ('variable' === $token[0]) {
|
if ('variable' === $token[0]) {
|
||||||
if (!$optional || !array_key_exists($token[3], $defaults) || (string) $mergedParams[$token[3]] !== (string) $defaults[$token[3]]) {
|
if (!$optional || !array_key_exists($token[3], $defaults) || (string) $mergedParams[$token[3]] !== (string) $defaults[$token[3]]) {
|
||||||
// check requirement
|
// check requirement
|
||||||
if (!preg_match('#^'.$token[2].'$#', $mergedParams[$token[3]])) {
|
if (null !== $this->strictRequirements && !preg_match('#^'.$token[2].'$#', $mergedParams[$token[3]])) {
|
||||||
$message = sprintf('Parameter "%s" for route "%s" must match "%s" ("%s" given).', $token[3], $name, $token[2], $mergedParams[$token[3]]);
|
$message = sprintf('Parameter "%s" for route "%s" must match "%s" ("%s" given).', $token[3], $name, $token[2], $mergedParams[$token[3]]);
|
||||||
if ($this->strictRequirements) {
|
if ($this->strictRequirements) {
|
||||||
throw new InvalidParameterException($message);
|
throw new InvalidParameterException($message);
|
||||||
|
@ -219,6 +219,14 @@ class UrlGeneratorTest extends \PHPUnit_Framework_TestCase
|
|||||||
$this->assertNull($generator->generate('test', array('foo' => 'bar'), true));
|
$this->assertNull($generator->generate('test', array('foo' => 'bar'), true));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public function testGenerateForRouteWithInvalidParameterButDisabledRequirementsCheck()
|
||||||
|
{
|
||||||
|
$routes = $this->getRoutes('test', new Route('/testing/{foo}', array('foo' => '1'), array('foo' => 'd+')));
|
||||||
|
$generator = $this->getGenerator($routes);
|
||||||
|
$generator->setStrictRequirements(null);
|
||||||
|
$this->assertSame('/app.php/testing/bar', $generator->generate('test', array('foo' => 'bar')));
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @expectedException Symfony\Component\Routing\Exception\InvalidParameterException
|
* @expectedException Symfony\Component\Routing\Exception\InvalidParameterException
|
||||||
*/
|
*/
|
||||||
|
Reference in New Issue
Block a user