8000 [2.2] [Routing] add support for path-relative URL generation by Tobion · Pull Request #3958 · symfony/symfony · GitHub
[go: up one dir, main page]
Skip to content

[2.2] [Routing] add support for path-relative URL generation #3958

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

Closed
wants to merge 5 commits into from
Closed

[2.2] [Routing] add support for path-relative URL generation #3958

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ef2d91b
[Routing] add support for path-relative and scheme-relative URL gener…
Tobion Apr 16, 2012
9b86853
[Routing] added tests for generating relative paths and network paths
Tobion Dec 13, 2012
2114972
[Routing] made reference type fully BC and improved phpdoc considerably
Tobion Dec 13, 2012
52da98e
fix phpdoc of UrlGeneratorInterface that missed some exceptions and i…
Tobion Dec 13, 2012
65aadb8
added changelog entries
Tobion Jan 2, 2013
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
Prev Previous commit
Next Next commit
fix phpdoc of UrlGeneratorInterface that missed some exceptions and i… 
…mprove language of exception message
  • Loading branch information
@Tobion
Tobion committed Jan 9, 2013
commit 52da98e205936a2bab9ce576343ac6732fa51b58
11 changes: 6 additions & 5 deletions src/Symfony/Component/Routing/Generator/UrlGenerator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,8 +141,9 @@ public function generate($name, $parameters = array(), $referenceType = self::AB
}

/**
* @throws MissingMandatoryParametersException When route has some missing mandatory parameters
* @throws InvalidParameterException When a parameter value is not correct
* @throws MissingMandatoryParametersException When some parameters are missing that mandatory for the route
* @throws InvalidParameterException When a parameter value for a placeholder is not correct because
* it does not match the requirement
*/
protected function doGenerate($variables, $defaults, $requirements, $tokens, $parameters, $name, $referenceType, $hostnameTokens)
{
Expand All @@ -151,7 +152,7 @@ protected function doGenerate($variables, $defaults, $requirements, $tokens, $pa

// all params must be given
if ($diff = array_diff_key($variables, $mergedParams)) {
throw new MissingMandatoryParametersException(sprintf('The "%s" route has some missing mandatory parameters ("%s").', $name, implode('", "', array_keys($diff))));
throw new MissingMandatoryParametersException(sprintf('Some mandatory parameters are missing ("%s") to generate a URL for route "%s".', implode('", "', array_keys($diff)), $name));
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The description was bad because the route itself does not miss mandatory params which misleadingly sounds like the route definition was wrong.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shouldn't the parameter names be placed after Some mandatory parameters instead of after are missing ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I dont think so because it only lists the params that are missing. If its after mandatory params it would suggest that it list all required params.

}

$url = '';
Expand All @@ -161,7 +162,7 @@ protected function doGenerate($variables, $defaults, $requirements, $tokens, $pa
if (!$optional || !array_key_exists($token[3], $defaults) || (string) $mergedParams[$token[3]] !== (string) $defaults[$token[3]]) {
// check requirement
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) to generate a corresponding URL.', $token[3], $name, $token[2], $mergedParams[$token[3]]);
if ($this->strictRequirements) {
throw new InvalidParameterException($message);
}
Expand Down Expand Up @@ -213,7 +214,7 @@ protected function doGenerate($variables, $defaults, $requirements, $tokens, $pa
foreach ($hostnameTokens as $token) {
if ('variable' === $token[0]) {
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) to generate a corresponding URL.', $token[3], $name, $token[2], $mergedParams[$token[3]]);

if ($this->strictRequirements) {
throw new InvalidParameterException($message);
Expand Down
9 changes: 7 additions & 2 deletions src/Symfony/Component/Routing/Generator/UrlGeneratorInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,10 @@

namespace Symfony\Component\Routing\Generator;

use Symfony\Component\Routing\RequestContextAwareInterface;
use Symfony\Component\Routing\Exception\InvalidParameterException;
use Symfony\Component\Routing\Exception\MissingMandatoryParametersException;
use Symfony\Component\Routing\Exception\RouteNotFoundException;
use Symfony\Component\Routing\RequestContextAwareInterface;

/**
* UrlGeneratorInterface is the interface that all URL generator classes must implement.
Expand Down Expand Up @@ -74,7 +76,10 @@ interface UrlGeneratorInterface extends RequestContextAwareInterface
*
* @return string The generated URL
*
* @throws RouteNotFoundException if route doesn't exist
* @throws RouteNotFoundException If the named route doesn't exist
* @throws MissingMandatoryParametersException When some parameters are missing that are mandatory for the route
* @throws InvalidParameterException When a parameter value for a placeholder is not correct because
* it does not match the requirement
*
* @api
*/
Expand Down
0