novius / laravel-linkable
A Laravel Eloquent model trait for linkable resource
1.0.1
2024-08-07 14:13 UTC
Requires
- php: >=8.2
- illuminate/database: ^10.0|^11.0
- laravel/framework: ^10.0|^11.0
Requires (Dev)
- laravel/nova: ^4.0
- laravel/pint: ^1.7
- orchestra/testbench: ^9.0
- pestphp/pest: ^2.34.9
README
Introduction
A package to manage Laravel Eloquent models linkable.
Provide a Linkable Nova Field.
Requirements
- PHP >= 8.2
- Laravel 10.0
Installation
You can install the package via composer:
composer require novius/laravel-linkable
Optionally you can also:
php artisan vendor:publish --provider="Novius\LaravelLinkable\LaravelLinkableServiceProvider" --tag=config php artisan vendor:publish --provider="Novius\LaravelLinkable\LaravelLinkableServiceProvider" --tag=lang
Usage
Eloquent Model Trait
namespace App\Models; use \Illuminate\Database\Eloquent\Model; use Novius\LaravelLinkable\Traits\Linkable; class Post extends Model { use Linkable; ... public function getLinkableConfig(): LinkableModelConfig { if (! isset($this->linkableConfig)) { $this->linkableConfig = new LinkableModelConfig( routeName: 'post_route', routeParameterName: 'post', optionLabel: 'title', // Required. A field of your model or a closure (taking the model instance as parameter) returning a label. Use to display a model instance in the Linkable Nova field optionGroup: 'My model', // Required. The name of the group of the model in the Linkable Nova field optionsQuery: function (Builder|Page $query) { // Optional. To modify the default query to populate the Linkable Nova field $query->published(); }, resolveQuery: function (Builder|Page $query) { // Optional. The base query to resolve the model binding $query->where('locale', app()->currentLocale()); }, resolveNotPreviewQuery: function (Builder|Page $query) { // Optional. The query to resolve the model binding when not in preview mode $query->published(); }, previewTokenField: 'preview_token' // Optional. The field that contains the preview token of the model ); } return $this->linkableConfig; }
Now you can do that:
// In your routes file Route::get('post/{post}', function (Post $post) { // ... })->name('post_route'); $post = Post::first(); $post->url(); $post->previewUrl();
Nova
If you use Laravel Nova, you can now use the Linkable field :
<?php use Novius\LaravelLinkable\Nova\Fields\Linkable; class MyResource extends Resource { public static $model = \App\Models\MyResource::class; public function fields(NovaRequest $request) { return [ // ... Linkable::make('Link', 'link'), ]; } }
Now you can do that:
use Novius\LaravelLinkable\Facades\Linkable; $model = MyResource::first(); echo Linkable::getLink($model->link);
Configuration
return [ // Laravel Linkable will autoload all Model using Linkable trait in this directory 'autoload_models_in' => app_path('Models'), // The guard name to preview model, without using the preview token 'guard_preview' => null, /* * Sometimes you need to link items that are not objects. * * This config allows you to link routes. * For instance: 'contact' => 'page.contact' * * "contact" will be the parameter of the laravel function route(). * "page.contact" will be the parameter of the laravel function trans(). */ 'linkable_routes' => [ 'my_route' => 'My route', ], /* * If you want to add specifics models using the Linkable trait that are not in your autoload directory */ 'linkable_models' => [ Provider\Package\Models\Model::class, ], ];
Testing
composer run test
CS Fixer
Lint your code with Laravel Pint using:
composer run cs-fix
Licence
This package is under GNU Affero General Public License v3 or (at your option) any later version.