Throw error if required route params missing (#3118)

Co-authored-by: Daniël Klabbers <daniel@klabbers.email>
Co-authored-by: luceos <luceos@users.noreply.github.com>
Co-authored-by: David Wheatley <hi@davwheat.dev>
Co-authored-by: Sami Mazouz <sychocouldy@gmail.com>
This commit is contained in:
Alexander Skvortsov 2021-10-23 14:05:47 -04:00 committed by GitHub
parent 4add23a984
commit 87f67744a8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 50 additions and 5 deletions

View File

@ -121,11 +121,17 @@ class RouteCollection
return $this->dataGenerator->getData();
}
protected function fixPathPart(&$part, $key, array $parameters)
protected function fixPathPart($part, array $parameters, string $routeName)
{
if (is_array($part) && array_key_exists($part[0], $parameters)) {
$part = $parameters[$part[0]];
if (! is_array($part)) {
return $part;
}
if (! array_key_exists($part[0], $parameters)) {
throw new \InvalidArgumentException("Could not generate URL for route '$routeName': no value provided for required part '$part[0]'.");
}
return $parameters[$part[0]];
}
public function getPath($name, array $parameters = [])
@ -151,9 +157,11 @@ class RouteCollection
}
}
array_walk($matchingParts, [$this, 'fixPathPart'], $parameters);
$fixedParts = array_map(function ($part) use ($parameters, $name) {
return $this->fixPathPart($part, $parameters, $name);
}, $matchingParts);
return '/'.ltrim(implode('', $matchingParts), '/');
return '/'.ltrim(implode('', $fixedParts), '/');
}
throw new \RuntimeException("Route $name not found");

View File

@ -44,4 +44,41 @@ class RouteCollectionTest extends TestCase
$this->assertEquals('/posts', $routeCollection->getPath('forum.posts.delete'));
}
/** @test */
public function must_provide_required_parameters()
{
$this->expectException(\InvalidArgumentException::class);
$this->expectExceptionMessage("Could not generate URL for route 'user': no value provided for required part 'user'.");
$routeCollection = (new RouteCollection)->addRoute('GET', '/user/{user}', 'user', function () {
echo 'user';
});
$routeCollection->getPath('user', []);
}
/** @test */
public function dont_need_to_provide_optional_parameters()
{
$routeCollection = (new RouteCollection)->addRoute('GET', '/user/{user}[/{test}]', 'user', function () {
echo 'user';
});
$path = $routeCollection->getPath('user', ['user' => 'SomeUser']);
$this->assertEquals('/user/SomeUser', $path);
}
/** @test */
public function can_provide_optional_parameters()
{
$routeCollection = (new RouteCollection)->addRoute('GET', '/user/{user}[/{test}]', 'user', function () {
echo 'user';
});
$path = $routeCollection->getPath('user', ['user' => 'SomeUser', 'test' => 'Flarum']);
$this->assertEquals('/user/SomeUser/Flarum', $path);
}
}