Revert "merged branch Tobion/requirementscheck (PR #5187)"
This reverts commit2cf50b7801
, reversing changes made to569e29d91f
.
This commit is contained in:
parent
fdf25289f8
commit
aae4ceea56
|
@ -12,44 +12,25 @@
|
||||||
namespace Symfony\Component\Routing\Generator;
|
namespace Symfony\Component\Routing\Generator;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* ConfigurableRequirementsInterface must be implemented by URL generators that
|
* ConfigurableRequirementsInterface must be implemented by URL generators in order
|
||||||
* can be configured whether an exception should be generated when the parameters
|
* to be able to configure whether an exception should be generated when the
|
||||||
* do not match the requirements. It is also possible to disable the requirements
|
* parameters do not match 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|null $enabled
|
* @param Boolean $enabled
|
||||||
*/
|
*/
|
||||||
public function setStrictRequirements($enabled);
|
public function setStrictRequirements($enabled);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns whether to throw an exception on incorrect parameters.
|
* Gets the strict check of incorrect parameters.
|
||||||
* Null means the requirements check is deactivated completely.
|
|
||||||
*
|
*
|
||||||
* @return Boolean|null
|
* @return Boolean
|
||||||
*/
|
*/
|
||||||
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 = null === $enabled ? null : (Boolean) $enabled;
|
$this->strictRequirements = (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 (null !== $this->strictRequirements && !preg_match('#^'.$token[2].'$#', $mergedParams[$token[3]])) {
|
if (!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);
|
||||||
|
|
|
@ -207,14 +207,6 @@ 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