sebastiaanluca / laravel-auto-morph-map
Automatically alias and map the polymorphic types of Eloquent models.
Installs: 28 762
Dependents: 1
Suggesters: 0
Security: 0
Stars: 55
Watchers: 1
Forks: 8
Open Issues: 1
Requires
- php: ^8.0
- laravel/framework: ^8.0
Requires (Dev)
- kint-php/kint: ^3.3
- mockery/mockery: ^1.4.3
- orchestra/testbench: ^6.0
- phpunit/phpunit: ^9.3
README
Decouple your internal application namespace structure from your database by automatically aliasing and mapping your Eloquent models as short, uniform class names instead of full class namespaces.
By default, Laravel will use the fully qualified class name to store the type of the related model. For instance, given the example above where a
Comment
may belong to aPost
or aVideo
, the defaultcommentable_type
would be eitherApp\Post
orApp\Video
, respectively. However, you may wish to decouple your database from your application's internal structure. In that case, you may define a relationship "morph map" to instruct Eloquent to use a custom name for each model instead of the class name.
See Custom Polymorphic Types in the Laravel documentation for more information.
Laravel auto morph map improves upon that by scanning all your Eloquent models, automatically aliasing them as uniform singular table names, and registering them as a polymorphic type. No more need for dozens of manual Relation::morphMap()
calls to register model morph types and no need to maintain that pesky morph map list when you add, change, or remove a model.
Table of contents
- Requirements
- How to install
- How to use
- License
- Change log
- Testing
- Contributing
- Security
- Credits
- About
Requirements
- PHP 8 or higher
- Laravel 8 or higher
How to install
Via Composer:
composer require sebastiaanluca/laravel-auto-morph-map
How to use
After installing this package, you're immediately good to go! The package will scan all your models and automatically register their polymorphic types on-the-fly.
Besides scanning and aliasing your models for you, this package alters no native Laravel functionality. Therefore, see the Laravel documentation on how to use custom polymorphic types.
If you wish to customize some behavior, read further.
Defining model namespaces
Laravel auto morph map uses your composer.json
PSR-4 autoload section to know which namespaces and paths to scan. In any new Laravel project, the default App\\
namespace is already in place, so for most projects no additional setup required. If you have other namespaces registered like local modules or (dev) packages, those will be scanned too.
{ "autoload": { "psr-4": { "App\\": "app/", "MyModule\\": "modules/MyModule/", "MyPackage\\": "MyPackage/src/" } } }
Furthermore it filters out traits, abstract classes, helper files, and other unusable items to only bind valid Eloquent models.
Overriding existing aliases
If you wish, you can still override already aliased morph types in your service provider's boot
method like you would normally:
use Illuminate\Database\Eloquent\Relations\Relation; Relation::morphMap([ 'posts' => \App\Post::class, 'videos' => \App\Video::class, ]);
These will always have priority over the already defined ones.
Caching morph types in production
To cache all aliases and speed up your application in production, add the cache command to your deploy scripts:
php artisan morphmap:cache
This scans all your current models and writes a static cache file to the bootstrap/cache
directory. Upon subsequent framework booting, it reads the cache file instead of scanning and aliasing on-the-fly.
Note that this thus disables runtime scanning, meaning new models will not be recognized and changes to existing models will not be reflected (not very handy during development).
To clear the cache file, run:
php artisan morphmap:clear
Configuration
Run
php artisan vendor:publish
and select
laravel-auto-morph-map (configuration)
to publish the configuration file.
Naming
The naming scheme to use when determining the model's morph type base value. Defaults to the singular table name (automatically determined by Laravel or overridden in the model using the $table
variable).
You can change this to use the singular table name, table name, or class basename. See \SebastiaanLuca\AutoMorphMap\Constants\NamingSchemes
for possible options.
Singular table name (default):
Relation::morphMap([ 'collection_item' => 'App\CollectionItem', ]);
Table name:
Relation::morphMap([ 'collection_items' => 'App\CollectionItem', ]);
Class basename:
Relation::morphMap([ 'CollectionItem' => 'App\CollectionItem', ]);
Casing
Converts your model name (after having passed the naming scheme conversion) to a more uniform string. By default, the model's name (based on your naming scheme) is converted to snake case.
You can change this to use snake, slug, camel, studly or no casing. See \SebastiaanLuca\AutoMorphMap\Constants\CaseTypes
for possible options.
Snake case (default):
Relation::morphMap([ 'collection_item' => 'App\CollectionItem', ]);
Slug case:
Relation::morphMap([ 'collection-item' => 'App\CollectionItem', ]);
Camel case:
Relation::morphMap([ 'collectionItem' => 'App\CollectionItem', ]);
Studly case:
Relation::morphMap([ 'CollectionItem' => 'App\CollectionItem', ]);
None (determined by your naming scheme and Laravel's class-to-table conversion method):
Relation::morphMap([ 'collection_item' => 'App\CollectionItem', ]);
License
This package operates under the MIT License (MIT). Please see LICENSE for more information.
Change log
Please see CHANGELOG for more information what has changed recently.
Testing
composer install
composer test
Contributing
Please see CONTRIBUTING and CODE OF CONDUCT for details.
Security
If you discover any security related issues, please email hello@sebastiaanluca.com instead of using the issue tracker.
Credits
About
My name is Sebastiaan and I'm a freelance back-end developer specializing in building custom Laravel applications. Check out my portfolio for more information, my blog for the latest tips and tricks, and my other packages to kick-start your next project.
Have a project that could use some guidance? Send me an e-mail at hello@sebastiaanluca.com!