**THIS PACKAGE IS NOT MAINTAINED ANYMORE**
## 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](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Prepare ownable model with strict ownership](#prepare-ownable-model-with-strict-ownership)
- [Prepare ownable model with polymorphic ownership](#prepare-ownable-model-with-polymorphic-ownership)
- [Available methods](#available-methods)
- [Scopes](#scopes)
- [Set authenticated user as owner automatically](#set-authenticated-user-as-owner-automatically)
- [Change log](#change-log)
- [Upgrading](#upgrading)
- [Contributing](#contributing)
- [Testing](#testing)
- [Security](#security)
- [Credits](#credits)
- [Alternatives](#alternatives)
- [License](#license)
- [About CyberCog](#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:
- [PSR-2 (Coding Style Guide)](http://www.php-fig.org/psr/psr-2/).
- [PSR-4 (Autoloading Standard)](http://www.php-fig.org/psr/psr-4/).
- Covered with unit tests
## Installation
First, pull in the package through Composer.
```shell script
$ composer require cybercog/laravel-ownership
```
And then include the service provider within `app/config/app.php`.
```php
'providers' => [
Cog\Laravel\Ownership\Providers\OwnershipServiceProvider::class,
];
```
## 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 belongs 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 belongs 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:
```php
use Cog\Contracts\Ownership\CanBeOwner;
use Illuminate\Foundation\Auth\User as Authenticatable;
class User extends Authenticatable implements CanBeOwner
{
// ...
}
```
### Prepare ownable model with strict ownership
Use `Ownable` contract in model which will get ownership behavior and implement it or just use `HasOwner` trait.
```php
use Cog\Contracts\Ownership\Ownable as OwnableContract;
use Cog\Laravel\Ownership\Traits\HasOwner;
use Illuminate\Database\Eloquent\Model;
class Article extends Model implements OwnableContract
{
use HasOwner;
}
```
Ownable model with strict ownership must have in database additional nullable column to store owner relation:
```php
Schema::table('articles', function (Blueprint $table) {
$table->integer('owned_by_id')->unsigned()->nullable();
$table->index('owned_by_id');
});
```
#### 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:
```php
use Cog\Contracts\Ownership\Ownable as OwnableContract;
use Cog\Laravel\Ownership\Traits\HasOwner;
use Illuminate\Database\Eloquent\Model;
class Article extends Model implements OwnableContract
{
use HasOwner;
protected $ownerModel = Group::class;
protected $ownerPrimaryKey = 'gid';
protected $ownerForeignKey = 'group_id';
}
```
### 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.
```php
use Cog\Contracts\Ownership\Ownable as OwnableContract;
use Cog\Laravel\Ownership\Traits\HasMorphOwner;
use Illuminate\Database\Eloquent\Model;
class Article extends Model implements OwnableContract
{
use HasMorphOwner;
}
```
Ownable model with polymorphic ownership must have in database additional nullable columns to store owner relation:
#### Laravel 5.3.29 and newer
```php
Schema::table('articles', function (Blueprint $table) {
$table->nullableMorphs('owned_by');
});
```
#### Laravel 5.3.28 and older
```php
Schema::table('articles', function (Blueprint $table) {
$table->integer('owned_by_id')->unsigned()->nullable();
$table->string('owned_by_type')->nullable();
$table->index([
'owned_by_id',
'owned_by_type',
]);
});
```
### Available methods
#### Get owner relation
```php
$article->ownedBy();
$article->owner();
```
#### Get model owner
```php
$article->getOwner();
$article->ownedBy;
$article->owner;
```
#### Change (set) owner
```php
$article->changeOwnerTo($owner);
```
#### Abandon (unset) owner
```php
$article->abandonOwner();
```
#### Check if has owner
```php
$article->hasOwner();
```
#### Check if owned by owner
```php
$article->isOwnedBy($owner);
```
#### Check not owned by owner
```php
$article->isNotOwnedBy($owner);
```
#### Manually define default owner on model creation
```php
$article = new Article;
$article->withDefaultOwner()->save();
```
*Will use `resolveDefaultOwner()` method under the hood.*
Or provide concrete owner:
```php
$user = User::where('name', 'admin')->first();
$article = new Article;
$article->withDefaultOwner($user)->save();
```
#### Skip defining default owner on model creation
```php
$article = new Article;
$article->withoutDefaultOwner()->save();
```
### Scopes
#### Scope models by owner
```php
Article::whereOwnedBy($owner)->get();
```
#### Scope models by not owned by owner
```php
Article::whereNotOwnedBy($owner)->get();
```
### 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.
```php
use Cog\Contracts\Ownership\Ownable as OwnableContract;
use Cog\Laravel\Ownership\Traits\HasOwner;
use Illuminate\Database\Eloquent\Model;
class Article extends Model implements OwnableContract
{
use HasOwner;
protected $withDefaultOwnerOnCreate = true;
}
```
To override strategy of getting default owner extend ownable model with `resolveDefaultOwner` method:
```php
use Cog\Contracts\Ownership\Ownable as OwnableContract;
use Cog\Laravel\Ownership\Traits\HasOwner;
use Illuminate\Database\Eloquent\Model;
class Article extends Model implements OwnableContract
{
use HasOwner;
public $withDefaultOwnerOnCreate = true;
/**
* Resolve entity default owner.
*
* @return null|\Cog\Contracts\Ownership\CanBeOwner
*/
public function resolveDefaultOwner()
{
return \App\User::where('name', 'admin')->first();
}
}
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Upgrading
Please see [UPGRADING](UPGRADING.md) for detailed upgrade instructions.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Testing
Run the tests with:
```shell script
$ vendor/bin/phpunit
```
## Security
If you discover any security related issues, please email open@cybercog.su instead of using the issue tracker.
## Credits
| 
Anton Komarev |
| :---: |
[Laravel Ownership contributors list](../../contributors)
## Alternatives
- [kenarkose/Ownable](https://github.com/kenarkose/Ownable)
*Feel free to add more alternatives as Pull Request.*
## License
- `Laravel Ownership` package is open-sourced software licensed under the [MIT license](LICENSE) by [Anton Komarev].
- `Intellectual Property` image licensed under [Creative Commons 3.0](https://creativecommons.org/licenses/by/3.0/us/) by Arthur Shlain.
- `Fat Boss` image licensed under [Creative Commons 3.0](https://creativecommons.org/licenses/by/3.0/us/) by Gan Khoon Lay.
## About CyberCog
[CyberCog](https://cybercog.su) is a Social Unity of enthusiasts. Research best solutions in product & software development is our passion.
- [Follow us on Twitter](https://twitter.com/cybercog)
- [Read our articles on Medium](https://medium.com/cybercog)
[Anton Komarev]: https://komarev.com