askaoru/routable

Easily create routable models in laravel 5 projects

Friday, February 23, 2018
by askaoru
Repository
1 Watchers
5 Stars
36 Installations

PHP
0 Dependents
0 Suggesters
0 Forks
0 Open issues
11 Versions
3 % Grown

The README.md

:zap:Package Archived and Abandoned :zap:

This package is abandoned and no longer maintained. This package no longer have much value for the open source community and it is severely outdated. I'm sorry for any inconveniences caused., _(*1)

Laravel 5 Routable

Simple laravel 5 routable models package, _(*2)

Creating a slugged model is not really that hard in laravel even without any package, however when you have multiple models that need the same feature, it can get a bit spaghetti-ish, repeated and tedious. If you have encountered this, this package will be perfect for you., _(*3)

Using this package, any of your model can have their own route easily!, _(*4)

P/S : This package also have basic supports for multilingual route. I am planning to expand more this feature later., _(*5)

Installation

Add it to your composer to json simply by running, _(*6)

$ composer require askaoru/routable

Then add the service provider to your config/app.php under the providers array, _(*7)

'providers' => [
    // Other laravel packages ...

    Askaoru\Routable\RoutableServiceProvider::class,
],

Publish the config and migration, _(*8)

$ php artisan vendor:publish --provider="Askaoru\Routable\RoutableServiceProvider"

That will create 2 files which you can edit if you want to change the database name, _(*9)

config\routable.php
database\migrations\2017_01_28_041412_create_routes_table.php

Finally run, _(*10)

$ php artisan migrate

That's it!, _(*11)

Usage

Attach the trait to any of your model which you want it to be routable, _(*12)

<?php

namespace App;

use Askaoru\Routable\Traits\Routable; # Import the routable trait
use Illuminate\Database\Eloquent\Model;

class Post extends Model
{
    use Routable; # Use the trait

  // Other codes
}

Create route

$model->route()->make($url, $controller, $controller_parameter = [], $locale = null);
# $url = the url for this route, example 'post/awesome-first-post'
# $controller = controller method which will be called when the url is hit
# $controller_parameter = array of parameter that the controller need to accept, optional
# $locale = locale which the route is for, optional, will use the current app locale when it is not set

# Example
$post = Post::find(1); # Model item that was attached with the trait
$post->route()->make('post-title', 'App\Http\Controllers\PostController@view', [$post->id]);

# Will return the route object if created successfully, false if the url already exist

# Note : The controller need to be in full namespace with the method name, omit leading slash.

Update route

$model->route()->change($url, $controller, $controller_parameter = [], $locale = null);
# Same parameters and requirements with the create method

# Example
$post = Post::find(1); # Model item that was attached with the trait
$post->route()->change('updated-post-title', 'App\Http\Controllers\PostController@view', [$post->id]);

# Will return false if no route was found, return the route object if updated successfully

# Note : The controller need to be in full namespace with the method name, omit leading slash.

Delete route

$model->route()->clear($locale = null);
# $locale = locale which the route is for, optional, will use the current app locale when it is not set

$post = Post::find(1); # Model item that was attached with the trait
$post->route()->clear(); # Will return false if model have no route, return true if deleted successfully

Return route

$model->route()->getUrl($locale = null);
$model->route()->getRoute($locale = null);
# $locale = locale which the route is for, optional, will use the current app locale when it is not set

# Example
$post = Post::find(1); # Model item that was attached with the trait
$post->route()->getUrl(); # Will return the full url, http://project.dev/post/awesome-first-post
$post->route()->getRoute(); # Will return the full route object

Main Route

For the routing to work, you will need a main entry point with a catch all route., _(*13)

So in your app\Http\route.php (or routes\web.php depending on your laravel version), insert, _(*14)

Route::any('{any}', function ($any) {
    $routable = new \Askaoru\Routable\RoutableController;
    $exist = $routable->exist($any);

    if (! $exist) {
        abort(404); # If you want to handle the not found differently, replace here with your code
    }

    return $routable->go($any);
})->where('any', '.*');