tomschlick/laravel-linkable

URL binding for Laravel models

v4.0 2021-07-15 18:07 UTC

Requires

• php: >=7.3
• laravel/framework: >=6.0

Requires (Dev)

• doctrine/dbal: ^2.9
• larapack/dd: ^1.0
• mockery/mockery: ~1.0
• orchestra/testbench: ^5.0
• phpunit/phpunit: ^7.0 || ^8.0 || ^9.0

MIT

• Tom Schlick

README

Linkable allows you to bind named routes directly to your Eloquent models. It has been tested with Laravel 5.0 and above (although it may work on older versions as well).

Making calls to route() each time you need to generate a url can be cumbersome and makes your Blade files unreadable. Instead with Linkable, you can use this syntax to generate a url:

    $model->link()

That's it! Check out the full usage below.

Install via Composer

  composer require tomschlick/laravel-linkable

Add to your model(s) and implement the interface

class User extends Model
{
    use TomSchlick\Linkable\Linkable;
    
    public function sublink(string $key, array $attr = []) : string
    {
        return route("users.$key", [
                'user_id' => $this->id, // 'user_id' is the name of the parameter in the users.* route group
                ] + $attr);
    }
}

Usage

$model->link(); // Link for the resource (example: https://your-site.com/user/7)

$model->sublink('edit'); // SubLink for the resource (example: https://your-site.com/user/7/edit)
    
$model->sublink('photos.show', ['photo_id' => 1234]); // SubLink for the resource (example: https://your-site.com/user/7/photos/1234)
    
$model->redirect(); // Generates a redirect response to the resource to use in a controller return statement.
    
$model->sublinkRedirect('edit'); // Generates a redirect response to the resource's edit page to use in a controller return statement.