Laravel DB redirector
Manage HTTP redirections in Laravel using database
Manage redirects using database rules. Rules are intended to be very similar to Laravel default routes, so syntax is pretty easy to comprehend.
Compatibility
The package is compatible with Laravel versions 5.5, 5.6, 5.7 and 5.8 and PHP versions 7.1 and 7.2
Installation
Install the package via composer:
composer require vkovic/laravel-db-redirector
Database redirector middleware needs to be added to middleware array:
// File: app/Http/Kernel.php
// ...
protected $middleware = [
// ...
\Vkovic\LaravelDbRedirector\Http\Middleware\DbRedirectorMiddleware::class
];
Run migrations to create table which will store redirect rules:
php artisan migrate
Usage: Simple Examples
Creating a redirect is easy. You just have to add db record via provided RedirectRule model. Default status code for redirections will be 301 (Moved Permanently).
use Vkovic\LaravelDbRedirector\Models\RedirectRule;
// ...
RedirectRule::create([
'origin' => '/one/two',
'destination' => '/three'
]);
You can also specify another redirection status code:
RedirectRule::create([
'origin' => '/one/two',
'destination' => '/three',
'status_code' => 307 // Temporary Redirect
]);
You may use route parameters just like in native Laravel routes, they'll be passed down the road - from origin to destination:
RedirectRule::create([
'origin' => '/one/{param}',
'destination' => '/two/{param}'
]);
// If we visit: "/one/foo" we will end up at "two/foo"
Optional parameters can also be used:
RedirectRule::create([
'origin' => '/one/{param1?}/{param2?}',
'destination' => '/four/{param1}/{param2}'
]);
// If we visit: "/one" we'll end up at "/four
// If we visit: "/one/two" we'll end up at "/four/two"
// If we visit: "/one/two/three" we'll end up at "/four/two/three"
Chained redirects will also work:
RedirectRule::create([
'origin' => '/one',
'destination' => '/two'
]);
RedirectRule::create([
'origin' => '/two',
'destination' => '/three'
]);
RedirectRule::create([
'origin' => '/three',
'destination' => '/four'
]);
// If we visit: "/one" we'll end up at "/four"
We also can delete the whole chain at once (3 previous redirect records in this example):
RedirectRule::deleteChainedRecursively('/four');
Sometimes it's possible that you'll have more than one redirection with the same destination. So it's smart to surround code with try catch block, because exception will be raised in this case:
RedirectRule::create(['origin' => '/one/two', 'destination' => '/three/four']);
RedirectRule::create(['origin' => '/three/four', 'destination' => '/five/six']);
// One more with same destination ("/five/six") as the previous one.
RedirectRule::create(['origin' => '/ten/eleven', 'destination' => '/five/six']);
try {
RedirectRule::deleteChainedRecursively('five/six');
} catch (\Exception $e) {
// ... handle exception
}
Usage: Advanced
What about order of rules execution when given url corresponds to multiple rules. Let's find out in this simple example:
RedirectRule::create(['origin' => '/one/{param}/three', 'destination' => '/four']);
RedirectRule::create(['origin' => '/{param}/two/three', 'destination' => '/five']);
// If we visit: "/one/two/three" it corresponds to both of rules above,
// so, where should we end up: "/four" or "/five" ?
// ...
// It does not have anything to do with rule order in our rules table!
To solve this problem, we need to agree on simple (and logical) rule prioritizing:
Priority 1: Rules without named parameters have top priority:
Priority 2: If rule origin have named parameters, those with less named parameters will have higher priority
Priority 3: If rule origin have same number of named parameters, those where named parameters are nearer the end of the rule string will have priority
So lets examine our previous case, we have:
- "/one/{param}/three" => "/four"
- "/{param}/two/three" => "/five"
In this case both rules have the same number of named params, but in the first rule "{param}" is nearer the end of the rule, so it will have priority and we'll end up at "/four".
Contributing
If you plan to modify this Laravel package you should run tests that comes with it. Easiest way to accomplish this would be with Docker, docker-compose and phpunit.
First, we need to initialize Docker containers:
docker-compose up -d
After that, we can run tests and watch the output:
docker-compose exec app vendor/bin/phpunit
201 Jan 1, 2023
6 Dec 9, 2021
9 Oct 10, 2022
630 Dec 30, 2022
644 Dec 15, 2022
6 Nov 7, 2022
51 Sep 21, 2022
61 Nov 21, 2022
136 Dec 30, 2022
13 Dec 27, 2022
2.3k Dec 30, 2022
95 Oct 26, 2022
13 Dec 29, 2022
27 Oct 24, 2020
3 Jun 20, 2022
2 Mar 29, 2022
17 Jun 26, 2022
![[sCRiPTz-TEAM]](https://avatars.githubusercontent.com/u/533180?v=4&s=60)
3 Dec 31, 2021
3 Jan 5, 2023
6 Nov 16, 2022
151 Jan 5, 2023
152 Dec 28, 2022
0 Apr 4, 2022
16 Nov 1, 2022
472 Jan 4, 2023
4 Oct 20, 2022
22 Nov 25, 2022
6 Jan 16, 2022