cerbero / eloquent-inspector
Inspect Laravel Eloquent models to collect properties, relationships and more.
Fund package maintenance!
cerbero90
Installs: 5 962
Dependents: 0
Suggesters: 0
Security: 0
Stars: 114
Watchers: 3
Forks: 5
Open Issues: 0
Requires
- php: ^8.0
- doctrine/dbal: ^3.0||^4.0
- illuminate/database: >=8.0
Requires (Dev)
- orchestra/testbench: >=6.0
- pestphp/pest: ^1.21
- scrutinizer/ocular: ^1.8
- squizlabs/php_codesniffer: ^3.0
This package is auto-updated.
Last update: 2024-11-18 08:36:38 UTC
README
Inspect Laravel Eloquent models to collect properties, relationships and more.
Install
Via Composer
composer require cerbero/eloquent-inspector
Usage
To inspect an Eloquent model, we can simply pass its class name to the inspect()
method:
use App\Models\User; use Cerbero\EloquentInspector\Inspector; $inspector = Inspector::inspect(User::class);
An Inspector
singleton is created every time a new model is inspected, this lets us inspect the same model multiple times while running the inspection logic only once.
If we need to free memory or cleanup some inspected model information, we can either flush all model inspections, flush only one model inspection or tell an inspection to forget its data:
// flush information of all inspected models Inspector::flush(); // flush information of an inspected model Inspector::flush(User::class); // forget information of the current inspection Inspector::inspect(User::class)->forget();
To retrieve the class of the inspected model from an Inspector
, we can call getModel()
:
$model = Inspector::inspect(User::class)->getModel(); // App\Models\User
The method getUseStatements()
returns an array with all the use
statements of a model, keyed by either the class name or the alias:
use Illuminate\Database\Eloquent\Model; use Foo\Bar as Baz; class User extends Model { // ... } $useStatements = Inspector::inspect(User::class)->getUseStatements(); /* [ 'Model' => 'Illuminate\Database\Eloquent\Model', 'Baz' => 'Foo\Bar', ] */
Calling getProperties()
performs a scan of the model database table and returns an array of Property
instances containing the properties information. The array is keyed by the properties name:
$properties = Inspector::inspect(User::class)->getProperties(); /* [ 'id' => <Cerbero\EloquentInspector\Dtos\Property>, 'name' => <Cerbero\EloquentInspector\Dtos\Property>, ... ] */ $properties['id']->name; // id $properties['id']->type; // int $properties['id']->dbType; // integer $properties['id']->nullable; // false $properties['id']->default; // null
To inspect the relationships of a model, we can call the method getRelationships()
. The result is an array of Relationship
instances, keyed by the relationship name, containing all the relationships information:
$relationships = Inspector::inspect(User::class)->getRelationships(); /* [ 'posts' => <Cerbero\EloquentInspector\Dtos\Relationship>, 'tags' => <Cerbero\EloquentInspector\Dtos\Relationship>, ... ] */ $relationships['posts']->name; // posts $relationships['posts']->type; // hasMany $relationships['posts']->class; // Illuminate\Database\Eloquent\Relations\HasMany $relationships['posts']->model; // App\Models\Post $relationships['posts']->relatesToMany; // true
Change log
Please see CHANGELOG for more information on what has changed recently.
Testing
composer test
Contributing
Please see CONTRIBUTING and CODE_OF_CONDUCT for details.
Security
If you discover any security related issues, please email andrea.marco.sartori@gmail.com instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.