Download the PHP package mannikj/laravel-sti without Composer
On this page you can find all versions of the php package mannikj/laravel-sti. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download mannikj/laravel-sti
More information about mannikj/laravel-sti
Files in mannikj/laravel-sti
Package laravel-sti
Short Description A single table inheritance trait for you eloquent models
License MIT
Homepage https://github.com/mannikj/laravel-sti
Informations about the package laravel-sti
A single table inheritance trait for Eloquent
This package provides a trait that makes your eloquent models capable of single table inheritance. If configured properly, queries will automatically return instances of the correct model subclasses according to the type column.
Installation
You can install the package via composer:
Basic Usage
Migration
The table you want to apply single table inheritance to must incorporate a type column.
The package's service provider adds a macro to the Blueprint class to create the type column.
Using the Trait
You need to add the SingleTableInheritance
trait to your root model class.
The sub models need to extend the root class.
For the default usage no other configuration is needed. The trait will use the class name of the subclasses as the type, scope the queries accordingly and return the correct instances of subclasses automatically.
Nested
If you have multiple levels of subclasses and you want the automatic scoping to include all sub types, you need to define the direct subclasses for each model by setting the stiSubClasses
array property:
Advanced Usage
Types without fully-qualified classnames
Without any tweaking, the trait assumes that there is a type column storing the fully qualified names of the subclasses. However, if you want to use some other string not directly referencing a class as the type identifier, you can do so by overwriting two functions of the trait:
Resolving the type based on a related model
You can also tweak the behavior even further so that the type will be determined based on a related model:
Testing
Changelog
Please see CHANGELOG for more information about what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Jannik Malken
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
Laravel Package Boilerplate
This package was generated using the Laravel Package Boilerplate.