Dynamic methods, relations or accessors for models
laravel-enso/dynamic-methods is a Laravel package for dynamic methods, relations or accessors for models.
It currently has 2 GitHub stars and 41.833 downloads on Packagist (latest version 4.0.3).
Install it with composer require laravel-enso/dynamic-methods.
Discover more Laravel packages by laravel-enso
or browse all Laravel packages to compare alternatives.
Last updated
Dynamic Methods adds runtime-bound relations, instance methods, scopes, mutators, and static methods to Laravel models and classes.
The package scans Dynamics folders from configured vendor packages and from the host application, instantiates the dynamic definitions it finds, and binds their closures onto the target classes during boot.
In the Enso ecosystem it is the mechanism used to let independent packages augment shared models like User without editing those models directly.
Install the package:
composer require laravel-enso/dynamic-methods
The service provider is auto-registered and immediately binds all discovered dynamics on boot.
If you want to customize which vendor namespaces are scanned, publish the configuration:
php artisan vendor:publish --tag=dynamics-config
Default configuration:
return [
'vendors' => ['laravel-enso'],
];
For application-level dynamics, place your classes under your app PSR-4 Dynamics folder. In a standard Laravel application this means app/Dynamics.
Dynamics classes.Dynamics classes.resolveRelationUsing().resolveMethodUsing().Abilities trait.resolveStaticMethodUsing().To receive dynamic instance methods, relations, scopes, and mutators, a model should implement LaravelEnso\DynamicMethods\Contracts\DynamicMethods and use LaravelEnso\DynamicMethods\Traits\Abilities.
Example model:
use Illuminate\Database\Eloquent\Model;
use LaravelEnso\DynamicMethods\Contracts\DynamicMethods;
use LaravelEnso\DynamicMethods\Traits\Abilities;
class User extends Model implements DynamicMethods
{
use Abilities;
}
Define a dynamic relation in a package or app Dynamics class:
use Closure;
use LaravelEnso\ActionLogger\Models\ActionLog;
use LaravelEnso\DynamicMethods\Contracts\Relation;
use LaravelEnso\Users\Models\User;
class ActionLogs implements Relation
{
public function bindTo(): array
{
return [User::class];
}
public function name(): string
{
return 'actionLogs';
}
public function closure(): Closure
{
return fn (User $user) => $user->hasMany(ActionLog::class);
}
}
Define a dynamic instance method:
use Closure;
use Illuminate\Support\Facades\Session;
use LaravelEnso\DynamicMethods\Contracts\Method;
use LaravelEnso\Users\Models\User;
class IsImpersonating implements Method
{
public function bindTo(): array
{
return [User::class];
}
public function name(): string
{
return 'isImpersonating';
}
public function closure(): Closure
{
return fn () => Session::has('impersonating');
}
}
After boot, the bound methods can be used as if they were defined on the model itself:
$user->actionLogs();
$user->isImpersonating();
::: warning Note
The binder discovers dynamics by reading package composer.json PSR-4 configuration and then scanning a Dynamics directory relative to that namespace root.
In practice, the package also relies on laravel-enso/helpers for JsonReader, even though that dependency is currently not declared in composer.json.
:::
config/dynamics.php
Keys:
vendorsThe binder scans:
vendor/<configured-vendor>/*LaravelEnso\DynamicMethods\AppServiceProvider
Responsibilities:
enso.dynamics configconfig/dynamics.phpLaravelEnso\DynamicMethods\Contracts\MethodLaravelEnso\DynamicMethods\Contracts\RelationLaravelEnso\DynamicMethods\Contracts\StaticMethodLaravelEnso\DynamicMethods\Contracts\DynamicMethodsLaravelEnso\DynamicMethods\Contracts\DynamicStaticMethodsDefinition contracts require:
name(): stringclosure(): ClosurebindTo(): arrayLaravelEnso\DynamicMethods\Traits\MethodsLaravelEnso\DynamicMethods\Traits\StaticMethodsLaravelEnso\DynamicMethods\Traits\AbilitiesAbilities extends Methods and also makes dynamic scopes, accessors, and mutators discoverable through Eloquent's standard model checks.
LaravelEnso\DynamicMethods\Services\BinderLaravelEnso\DynamicMethods\Services\DynamicsLaravelEnso\DynamicMethods\Services\MethodLaravelEnso\DynamicMethods\Services\RelationLaravelEnso\DynamicMethods\Services\StaticMethodRequired Enso packages:
Framework dependency:
are welcome. Pull requests are great, but issues are good too.
Thank you to all the people who already contributed to Enso!