inventive/laravel-owner

Allow Eloquent models to own each other. Supports many to many relationships.

, _(*1)

Laravel Owner

A simple package that allows Eloquent models to "own" each other, or "be owned" by another model. Supports many to many relationships., _(*2)

Examples could include:, _(*3)

1. a user owning a blog post
2. a user and a team owning multiple files
3. record being owned by many organisations

Installation

Install using composer:, _(*4)

composer require inventive/laravel-owner=dev-master

Add the following to config/app.php:, _(*5)

Inventive\LaravelOwner\OwnerServiceProvider::class,

Publish the migrations and config files:, _(*6)

php artisan vendor:publish

Run the migrations:, _(*7)

php artisan migrate

Add necessary traits your Eloquent models:

If the model can be an owner:, _(*8)

use Inventive\LaravelOwner\Traits\Owns;

class User extends Model
{
    use Owns;
}

If the model can be owned by another model:, _(*9)

use Inventive\LaravelOwner\Traits\HasOwner;

class Resource extends Model
{
    use HasOwner;
}

Usage

"Owner" model:

Create an ownership:, _(*10)

$user->own($model);

Remove an ownership:, _(*11)

$user->disown($model);

Return a collection of all the models owned by the parent model:, _(*12)

$user->owns();

Does the user own this model?, _(*13)

$user->ownsModel($model);

Which models of this type does the parent model own? This method either takes a child model, or a name-spaced class name., _(*14)

$user->ownsModelType($model); // Use a model
$user->ownsModelType(‘App\Resource’); // Use class name

"Owned" model:

Return a collection of all the model's owners:, _(*15)

$model->owners();

Is the model is owned by another model?, _(*16)

$model->isOwnedBy($owner);

Add an owner to the model:, _(*17)

$model->addOwner($owner);

Remove an owner from the model, _(*18)

$model->removeOwner($owner);

License

MIT, _(*19)