Skip to content

Commit 2765567

Browse files
ivanvermeyenivanvermeyen
committed
Add localized redirect methods
1 parent 4da17f0 commit 2765567

File tree

4 files changed

+206
-4
lines changed

4 files changed

+206
-4
lines changed

‎README.md

+17-4
Original file line numberDiff line numberDiff line change
@@ -639,19 +639,32 @@ Check out the [Laravel docs](https://laravel.com/docs/urls#signed-urls) for more
639639

640640
## 🚌 Redirect to Routes
641641

642-
You can redirect to routes, just like you would in a normal Laravel app.
642+
You can redirect to routes, just like you would in a normal Laravel app, using the `redirect()` helper or the `Redirect` facade.
643643

644644
If you register an `about` route that is not localized, then `about` is an existing route name and its URL will be redirected to.
645-
Otherwise, this will try to redirect to the `about` route for the active locale, e.g. `en.about`.
645+
Otherwise, this will try to redirect to the `about` route for the active locale, e.g. `en.about`:
646646

647647
```php
648648
return redirect()->route('about');
649649
```
650650

651-
You can't redirect to URL's in a specific locale this way, but you can of course just use the `route()` function.
651+
You can also redirect to URLs in a specific locale:
652652

653653
```php
654-
return redirect(route('about', [], true, 'nl')); // this redirects to nl.about
654+
// Redirects to 'nl.about'
655+
return redirect()->route('about', [], 302, [], 'nl');
656+
```
657+
658+
A localized version of the `signedRoute` and `temporarySignedRoute` redirects are included as well:
659+
660+
```php
661+
// Redirects to the active locale
662+
return redirect()->signedRoute('signed.route', ['user' => $id]);
663+
return redirect()->temporarySignedRoute('signed.route', now()->addMinutes(30), ['user' => $id]);
664+
665+
// Redirects to 'nl.signed.route'
666+
return redirect()->signedRoute('signed.route', ['user' => $id], null, 302, [], 'nl');
667+
return redirect()->temporarySignedRoute('signed.route', now()->addMinutes(30), ['user' => $id], 302, [], 'nl');
655668
```
656669

657670
## 🪧 Automatically Redirect to Localized URLs

‎src/Illuminate/Routing/Redirector.php

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
<?php
2+
3+
namespace CodeZero\LocalizedRoutes\Illuminate\Routing;
4+
5+
use Illuminate\Routing\Redirector as BaseRedirector;
6+
7+
class Redirector extends BaseRedirector
8+
{
9+
/**
10+
* Create a new redirect response to a named route.
11+
*
12+
* @param string $route
13+
* @param mixed $parameters
14+
* @param int $status
15+
* @param array $headers
16+
* @param string|null $locale
17+
*
18+
* @return \Illuminate\Http\RedirectResponse
19+
*/
20+
public function route($route, $parameters = [], $status = 302, $headers = [], $locale = null)
21+
{
22+
return $this->to($this->generator->route($route, $parameters, true, $locale), $status, $headers);
23+
}
24+
25+
/**
26+
* Create a new redirect response to a signed named route.
27+
*
28+
* @param string $route
29+
* @param mixed $parameters
30+
* @param \DateTimeInterface|\DateInterval|int|null $expiration
31+
* @param int $status
32+
* @param array $headers
33+
* @param string|null $locale
34+
*
35+
* @return \Illuminate\Http\RedirectResponse
36+
*/
37+
public function signedRoute($route, $parameters = [], $expiration = null, $status = 302, $headers = [], $locale = null)
38+
{
39+
return $this->to($this->generator->signedRoute($route, $parameters, $expiration, true, $locale), $status, $headers);
40+
}
41+
42+
/**
43+
* Create a new redirect response to a signed named route.
44+
*
45+
* @param string $route
46+
* @param \DateTimeInterface|\DateInterval|int|null $expiration
47+
* @param mixed $parameters
48+
* @param int $status
49+
* @param array $headers
50+
* @param string|null $locale
51+
*
52+
* @return \Illuminate\Http\RedirectResponse
53+
*/
54+
public function temporarySignedRoute($route, $expiration, $parameters = [], $status = 302, $headers = [], $locale = null)
55+
{
56+
return $this->to($this->generator->temporarySignedRoute($route, $expiration, $parameters, true, $locale), $status, $headers);
57+
}
58+
}

‎src/LocalizedRoutesServiceProvider.php

+27
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
namespace CodeZero\LocalizedRoutes;
44

55
use CodeZero\BrowserLocale\Laravel\BrowserLocaleServiceProvider;
6+
use CodeZero\LocalizedRoutes\Illuminate\Routing\Redirector;
67
use CodeZero\LocalizedRoutes\Illuminate\Routing\UrlGenerator;
78
use CodeZero\LocalizedRoutes\Macros\Route\HasLocalizedMacro;
89
use CodeZero\LocalizedRoutes\Macros\Route\IsFallbackMacro;
@@ -45,6 +46,7 @@ public function register()
4546
$this->registerLocaleConfig();
4647
$this->registerLocaleHandler();
4748
$this->registerUrlGenerator();
49+
$this->registerRedirector();
4850
$this->registerProviders();
4951
}
5052

@@ -190,4 +192,29 @@ protected function requestRebinder()
190192
$app['url']->setRequest($request);
191193
};
192194
}
195+
196+
/**
197+
* Register a custom URL redirector that extends the one that comes with Laravel.
198+
* This will override a few methods that enables us to redirect to localized URLs.
199+
*
200+
* This method is an exact copy from:
201+
* \Illuminate\Routing\RoutingServiceProvider
202+
*
203+
* @return void
204+
*/
205+
protected function registerRedirector()
206+
{
207+
$this->app->singleton('redirect', function ($app) {
208+
$redirector = new Redirector($app['url']);
209+
210+
// If the session is set on the application instance, we'll inject it into
211+
// the redirector instance. This allows the redirect responses to allow
212+
// for the quite convenient "with" methods that flash to the session.
213+
if (isset($app['session.store'])) {
214+
$redirector->setSession($app['session.store']);
215+
}
216+
217+
return $redirector;
218+
});
219+
}
193220
}

‎tests/Unit/Illuminate/Routing/RedirectorTest.php

+104
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
<?php
2+
3+
namespace CodeZero\LocalizedRoutes\Tests\Unit\Illuminate\Routing;
4+
5+
use CodeZero\LocalizedRoutes\Tests\TestCase;
6+
use Illuminate\Support\Facades\Redirect;
7+
use Illuminate\Support\Facades\Route;
8+
use Illuminate\Support\Facades\URL;
9+
10+
class RedirectorTest extends TestCase
11+
{
12+
/** @test */
13+
public function it_redirects_to_a_named_route_in_the_current_locale()
14+
{
15+
$this->setAppLocale('en');
16+
17+
Route::get('en/target/route')->name('en.target.route');
18+
Route::get('redirect', function () {
19+
return Redirect::route('target.route');
20+
});
21+
22+
$response = $this->get('/redirect');
23+
24+
$response->assertRedirect('/en/target/route');
25+
}
26+
27+
/** @test */
28+
public function it_redirects_to_a_named_route_in_a_specific_locale()
29+
{
30+
$this->setAppLocale('en');
31+
32+
Route::get('en/target/route')->name('en.target.route');
33+
Route::get('nl/target/route')->name('nl.target.route');
34+
Route::get('redirect', function () {
35+
return Redirect::route('target.route', [], 302, [], 'nl');
36+
});
37+
38+
$response = $this->get('/redirect');
39+
40+
$response->assertRedirect('/nl/target/route');
41+
}
42+
43+
/** @test */
44+
public function it_redirects_to_a_signed_route_in_the_current_locale()
45+
{
46+
$this->setAppLocale('en');
47+
48+
Route::get('en/target/route')->name('en.target.route');
49+
Route::get('redirect', function () {
50+
return Redirect::signedRoute('target.route');
51+
});
52+
53+
$response = $this->get('/redirect');
54+
55+
$response->assertRedirect(URL::signedRoute('target.route'));
56+
}
57+
58+
/** @test */
59+
public function it_redirects_to_a_signed_route_in_a_specific_locale()
60+
{
61+
$this->setAppLocale('en');
62+
63+
Route::get('en/target/route')->name('en.target.route');
64+
Route::get('nl/target/route')->name('nl.target.route');
65+
Route::get('redirect', function () {
66+
return Redirect::signedRoute('target.route', [], null, 302, [], 'nl');
67+
});
68+
69+
$response = $this->get('/redirect');
70+
71+
$response->assertRedirect(URL::signedRoute('target.route', [], null, true, 'nl'));
72+
}
73+
74+
/** @test */
75+
public function it_redirects_to_a_temporary_signed_route_in_the_current_locale()
76+
{
77+
$this->setAppLocale('en');
78+
79+
Route::get('en/target/route')->name('en.target.route');
80+
Route::get('redirect', function () {
81+
return Redirect::temporarySignedRoute('target.route', now()->addMinutes(30));
82+
});
83+
84+
$response = $this->get('/redirect');
85+
86+
$response->assertRedirect(URL::temporarySignedRoute('target.route', now()->addMinutes(30)));
87+
}
88+
89+
/** @test */
90+
public function it_redirects_to_a_temporary_signed_route_in_a_specific_locale()
91+
{
92+
$this->setAppLocale('en');
93+
94+
Route::get('en/target/route')->name('en.target.route');
95+
Route::get('nl/target/route')->name('nl.target.route');
96+
Route::get('redirect', function () {
97+
return Redirect::temporarySignedRoute('target.route', now()->addMinutes(30), [], 302, [], 'nl');
98+
});
99+
100+
$response = $this->get('/redirect');
101+
102+
$response->assertRedirect(URL::temporarySignedRoute('target.route', now()->addMinutes(30), [], true, 'nl'));
103+
}
104+
}

0 commit comments

Comments
 (0)