Download the PHP package cybercog/laravel-ownership without Composer
On this page you can find all versions of the php package cybercog/laravel-ownership. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download cybercog/laravel-ownership
More information about cybercog/laravel-ownership
Files in cybercog/laravel-ownership
Package laravel-ownership
Short Description Laravel Ownership simplify management of Eloquent model's owner.
License MIT
Homepage https://komarev.com/sources/laravel-ownership
Informations about the package laravel-ownership
Introduction
Laravel Ownership simplify management of Eloquent model's owner. Group can be an owner of event, user can be an owner of chat room, organization can own licenses. It can be used for many cases not limited by authorship. Make any model as owner and create ownable models in a minutes!
Contents
- Features
- Installation
- Usage
- Prepare ownable model with strict ownership
- Prepare ownable model with polymorphic ownership
- Available methods
- Scopes
- Set authenticated user as owner automatically
- Changelog
- Upgrading
- Contributing
- Testing
- Security
- Credits
- Alternatives
- License
- About CyberCog
Features
- Designed to work with Laravel Eloquent models
- Using contracts to keep high customization capabilities
- Each model can has owners of one type or use polymorphism
- Option to auto-assigning current authenticated user on model creation as owner
- Configurable auto-owner resolve strategy on model creation
- Option to manually assign owner on model creation
- Option to manually skip auto-assigning current user
- Transfer ownership (change owner)
- Make model orphaned (abandon owner)
- Various ownership checks and query scopes
- Following PHP Standard Recommendations:
- Covered with unit tests
Installation
First, pull in the package through Composer.
Register Package Manually (optional)
If you disabled package auto-discovery you can register it manually.
Include the service provider within app/config/app.php
.
Usage
Laravel Ownership allows model to have strict owner model type (HasOwner
trait) or use polymorphic relation (HasMorphOwner
trait).
Strict ownership is useful when model can belong to only one model type. Attempt to set owner of not defined model type will throw an exception InvalidOwnerType
.
Example: Only users allowed to create posts.
Polymorphic ownership is useful when model can belong to owners of different types. Example: Users and Organizations can upload applications to marketplace.
Prepare owner model
At the owner model use CanBeOwner
contract and implement it:
Prepare ownable model with strict ownership
Use Ownable
contract in model which will get ownership behavior and implement it or just use HasOwner
trait.
Ownable model with strict ownership must have in database additional nullable column to store owner relation:
Overwrite strict ownership owner's foreign key
By default, owner model will be the same as config('auth.providers.users.model')
provides.
To override default owner model in strict ownership, it's primary key or foreign key extend your ownable model with additional attributes:
Prepare ownable model with polymorphic ownership
Use Ownable
contract in model which will get polymorphic ownership behavior and implement it or just use HasMorphOwner
trait.
Ownable model with polymorphic ownership must have in database additional nullable columns to store owner relation:
Available methods
Get owner relation
Get model owner
Change (set) owner
Abandon (unset) owner
Check if has owner
Check if owned by owner
Check not owned by owner
Manually define default owner on model creation
Will use resolveDefaultOwner()
method under the hood.
Or provide concrete owner:
Skip defining default owner on model creation
Scopes
Scope models by owner
Scope models by not owned by owner
Set authenticated user as owner automatically
To set currently authenticated user as owner for ownable model create - extend it with attribute withDefaultOwnerOnCreate
. It works for both strict and polymorphic ownership behavior.
To override strategy of getting default owner extend ownable model with resolveDefaultOwner
method:
Changelog
Please see CHANGELOG for more information on what has changed recently.
Upgrading
Please see UPGRADING for detailed upgrade instructions.
Contributing
Please see CONTRIBUTING for details.
Testing
Run the tests with:
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
Anton Komarev |
Prasit Gebsaap |
---|
Laravel Ownership contributors list
Alternatives
Feel free to add more alternatives as Pull Request.
License
Laravel Ownership
package is open-sourced software licensed under the Anton Komarev.Intellectual Property
image licensed under Creative Commons 3.0 by Arthur Shlain.Fat Boss
image licensed under Creative Commons 3.0 by Gan Khoon Lay.
About CyberCog
CyberCog is a Social Unity of enthusiasts. Research the best solutions in product & software development is our passion.
All versions of laravel-ownership with dependencies
illuminate/database Version ^9.0|^10.0|^11.0
illuminate/support Version ^9.0|^10.0|^11.0