docs, middleware, license

Author: kmlpandey77

LICENSE.md

@@ -0,0 +1,10 @@
+MIT License
+
+Copyright (c) 2021 Kamal Pandey <kml.pandey77@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

README.md

@@ -1,2 +1,79 @@
 # Laravel Redirection
-This package design for redirect 404 page to new links e.g. `example.com/old-link` to `example.com/new-link` 
+
+This package design for redirects missing (404) URLs to new URLs.
+
+When redesigning an old site into a new one your URLs may change. If your old site URLs were popular you probably want to retain your SEO worth. One way of doing this is by providing permanent redirects from your old URLs to your new URLs.
+
+A package for handling redirects via database.
+
+
+### Example
+From `example.com/non-existing-page` to `example.com/existing-page`
+From `example.com/old-page` to `example.com/new-page`
+From `example.com/old/about-us` to `example.com/new/about-us`
+
+
+## Installation
+You can install the package via composer.
+
+`composer require kmlpandey77/laravel-redirection`
+
+The package will automatically register itself.
+
+Next you must register the `\Kmlpandey77\Redirection\Http\Middleware\Redirector` middleware:
+
+
+```php
+// app/Http/Kernel.php
+
+protected $middleware = [
+    ...
+    \Kmlpandey77\Redirection\Http\Middleware\Redirector::class,
+];
+```
+
+Publish the config file with:
+
+`php artisan vendor:publish --provider="Kmlpandey77\Redirection\RedirectionServiceProvider" --tag="config"`
+
+You can create the `redirections` table by running:
+
+php artisan migrate
+
+## Usage
+You just have to add an entry to the redirects links in the database by using `example.com\admin\redirects`. And you can change route link, prifix, and middleware in config
+
+```php
+
+return [
+    /**
+     * By defult route is `admin`
+     *
+     */
+    'prefix' => 'admin',
+
+    /**
+     * Defining middleware for route
+     */
+
+    'middleware' => [
+        'web',
+        // 'auth' // or admin
+    ],
+
+    /**
+     *
+     */
+    'route_link' => 'redirects'
+];
+
+```
+
+## Changelog
+
+## Credits
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
+

config/redirection.php

@@ -1,6 +1,23 @@
 <?php
 
 return [
+    /**
+     * By defult route is `admin`
+     *
+     */
     'prefix' => 'admin',
-    'middleware' => ['web'],
+
+    /**
+     * Defining middleware for route
+     */
+
+    'middleware' => [
+        'web',
+        // 'auth' // or admin
+    ],
+
+    /**
+     *
+     */
+    'route_link' => 'redirects'
 ];

resources/views/index.blade.php

@@ -1,16 +1,16 @@
 <h1>Redirections</h1>
 
 @forelse ($redirections as $key=>$redirect)
-<form action="{{ route('redirection.destroy', $redirect->id) }}" method="POST" onsubmit="confirm('Are you sure?');">
+<form action="{{ route(config('redirection.route_link').'.destroy', $redirect->id) }}" method="POST" onsubmit="confirm('Are you sure?');">
     {!! method_field('DELETE') !!}
     {!! csrf_field() !!}
-    <a href="{{ route('redirection.edit', $redirect) }}">Edit </a> |
+    <a href="{{ route(config('redirection.route_link').'.edit', $redirect) }}">Edit </a> |
     <button type="submit">Delete</button>
     {{ $key+1 }}. {{ $redirect->from_url }} => {{ $redirect->to_url }}
 </form>
 @empty
     <p>No records found</p>
 @endforelse
 
-<a href="{{ route('redirection.create') }}">Create</a>
+<a href="{{ route(config('redirection.route_link').'.create') }}">Create</a>
 

routes/web.php

@@ -3,4 +3,4 @@
 use Illuminate\Support\Facades\Route;
 use Kmlpandey77\Redirection\Http\Controllers\RedirectionController;
 
-Route::resource('redirection', RedirectionController::class);
+Route::resource(config('redirection.route_link'), RedirectionController::class);

src/Http/Controllers/RedirectionController.php

@@ -50,7 +50,7 @@ public function store(Request $request)
         $redirection->to_url = ltrim($to_url, '/');
         $redirection->save();
 
-        return redirect()->route('redirection.index')->with('success', 'Redirect added.');
+        return redirect()->route(config('redirection.route_link') .'.index')->with('success', 'Redirect added.');
     }
 
     /**
@@ -91,7 +91,7 @@ public function update(Request $request, Redirection $redirection)
         $redirection->to_url = ltrim($to_url, '/');
         $redirection->save();
 
-        return redirect()->route('redirection.index')->with('success', 'Redirect saved.');
+        return redirect()->route(config('redirection.route_link') .'.index')->with('success', 'Redirect saved.');
     }
 
     /**
@@ -103,6 +103,6 @@ public function destroy(Redirection $redirection)
     {
         $redirection->delete();
 
-        return redirect()->route('redirection.index')->with('success', 'Redirect deleted.');
+        return redirect()->route(config('redirection.route_link') .'.index')->with('success', 'Redirect deleted.');
     }
 }

src/Http/Middleware/Redirector.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Kmlpandey77\Redirection\Http\Middleware;
+
+use Closure;
+use Illuminate\Http\Request;
+use Kmlpandey77\Redirection\Facades\Redirection;
+
+class Redirector
+{
+    /**
+     * Handle an incoming request.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @param  \Closure  $next
+     * @return mixed
+     */
+    public function handle(Request $request, Closure $next)
+    {
+
+        if($redirect_path = Redirection::check($request->path()))
+            return redirect($redirect_path);
+
+        return $next($request);
+    }
+}

src/Redirection.php

@@ -10,7 +10,9 @@ public function check($url)
     {
         $redirect = RedirectionModel::where('from_url',$url)->first();
         if($redirect){
-            return redirect($redirect->to_url);
+            return $redirect->to_url;
         }
+
+        return false;
     }
 }

src/RedirectionServiceProvider.php

@@ -16,6 +16,11 @@ public function boot()
         $this->publishes([
             __DIR__.'/../config/redirection.php' => config_path('redirection.php'),
         ], 'config');
+
+        $this->publishes([
+            __DIR__.'/../resources/views' => resource_path('views/vendor/redirection'),
+        ], 'views');
+
     }
 
     public function register()