perfect-drive / referable
Automatically create routes for Models and Enums to make them referable in your Laravel backed SPA frontend
Fund package maintenance!
Perfect Drive
Requires
- php: ^8.2
- illuminate/contracts: ^10.0||^11.0||^12.0
- spatie/laravel-package-tools: ^1.16
Requires (Dev)
- larastan/larastan: ^2.9||^3.0
- laravel/pint: ^1.14
- nunomaduro/collision: ^8.1.1||^7.10.0
- orchestra/testbench: ^10.0.0||^9.0.0||^8.22.0
- pestphp/pest: ^2.36||^3.0
- pestphp/pest-plugin-arch: ^2.7.0||^3.0
- pestphp/pest-plugin-laravel: ^2.4.0||^3.0
- phpstan/extension-installer: ^1.3||^2.0
- phpstan/phpstan-deprecation-rules: ^1.1||^2.0
- phpstan/phpstan-phpunit: ^1.3||^2.0
This package is auto-updated.
Last update: 2025-05-31 00:35:25 UTC
README
To populate drowdowns (or other ways of reference) in an SPA form a separate endpoint can be used to create the array of name/value pairs. This package allows you to automatically create routes for your Models and Enums to make them referable in your Laravel backed SPA frontend.
Installation
You can install the package via composer:
composer require perfect-drive/referable
You can publish the config file with:
php artisan vendor:publish --tag="referable-config"
This is the contents of the published config file:
return [ /* * The directories to search for Referable classes. */ 'directories' => [ app_path('Enums'), app_path('Models'), ], /* * The middleware array to use for the Referable routes. */ 'middleware' => ['api', 'auth:sanctum'], /* * The key name to use for the referable key in the json response. */ 'key_name' => 'value', /* * The value name to use for the referable value in the json response. */ 'value_name' => 'title', /* * The base url for the referable routes. */ 'base_url' => 'spa/referable/', ];
Usage
On a Model:
<?php declare(strict_types=1); namespace App\Models; use App\Interfaces\ReferableInterface; use App\Traits\ReferableModel; use Illuminate\Database\Eloquent\Model; class ProjectType extends Model implements ReferableInterface { use ReferableModel;
This will register the following route:
GET /spa/referable/project_type
On an Enum:
<?php declare(strict_types=1); namespace App\Enums\User; use App\Interfaces\ReferableInterface; use App\Traits\ReferableEnum; enum UserStatus: string implements ReferableInterface { use ReferableEnum;
This will register the following route:
GET /spa/referable/user_status
Model Scopes
The 'ReferableScope' attribute can be used to define a custom scope (on a Model) to filter the referable items and create an additional route for it.
#[ReferableScope]
public function scopeActive(Builder $query): Builder
{
return $query->where('active', true);
}
This will register the following route:
GET /spa/referable/project_type/active
Enum Scopes
You can use the 'ReferableScope' attribute to define a custom scope method (on an Enum) to filter the referable items and create an additional route for it.
#[ReferableScope]
public function active(): bool
{
return in_array($this, [
self::FIRST,
self::SECOND,
], true);
}
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Security Vulnerabilities
If you discover any security related issues, please email carl.klein@perfect-drive.nl.
Credits
License
The MIT License (MIT). Please see License File for more information.