Skip to content
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.

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

Add a redirect route shortcut #2425

Merged
merged 2 commits into from
Apr 19, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
19 changes: 19 additions & 0 deletions Slim/App.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\UriInterface;
use Slim\Http\Headers;
use Slim\Http\Request;
use Slim\Http\Response;
Expand Down Expand Up @@ -345,6 +346,24 @@ public function map(array $methods, $pattern, $callable)
return $route;
}

/**
* Add a route that sends an HTTP redirect
*
* @param string $from
* @param string|UriInterface $to
* @param int $status
*
* @return RouteInterface
*/
public function redirect($from, $to, $status = 302)
{
$handler = function ($request, ResponseInterface $response) use ($to, $status) {
return $response->withHeader('Location', (string)$to)->withStatus($status);
};

return $this->get($from, $handler);
}

/**
* Route Groups
*
Expand Down
28 changes: 28 additions & 0 deletions tests/AppTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
use Pimple\Container as Pimple;
use Pimple\Psr11\Container as Psr11Container;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\UriInterface;
use Slim\App;
use Slim\CallableResolver;
use Slim\Error\Renderers\HtmlErrorRenderer;
Expand Down Expand Up @@ -253,6 +254,33 @@ public function testMapRoute()
$this->assertAttributeContains('POST', 'methods', $route);
}

public function testRedirectRoute()
{
$source = '/foo';
$destination = '/bar';

$app = new App();
$route = $app->redirect($source, $destination, 301);

$this->assertInstanceOf('\Slim\Route', $route);
$this->assertAttributeContains('GET', 'methods', $route);

$response = $route->run($this->requestFactory($source), new Response());
$this->assertEquals(301, $response->getStatusCode());
$this->assertEquals($destination, $response->getHeaderLine('Location'));

$routeWithDefaultStatus = $app->redirect($source, $destination);
$response = $routeWithDefaultStatus->run($this->requestFactory($source), new Response());
$this->assertEquals(302, $response->getStatusCode());

$uri = $this->getMockBuilder(UriInterface::class)->getMock();
$uri->expects($this->once())->method('__toString')->willReturn($destination);

$routeToUri = $app->redirect($source, $uri);
$response = $routeToUri->run($this->requestFactory($source), new Response());
$this->assertEquals($destination, $response->getHeaderLine('Location'));
}

/********************************************************************************
* Route Patterns
*******************************************************************************/
Expand Down