rockbuzz/lara-memberships

Account member management

0.1.0 2021-05-22 15:25 UTC

Requires

• php: >=7.2

Requires (Dev)

• orchestra/testbench: ^4.0
• phpunit/phpunit: ^8.0
• squizlabs/php_codesniffer: ^3.2

MIT

• TiagoDevWeb

• laravel
• accounts
• memberships

README

Account member management

Requirements

PHP >=7.2

Install

$ composer require rockbuzz/lara-memberships

$ php artisan vendor:publish --provider="Rockbuzz\LaraMemberships\ServiceProvider"

$ php artisan migrate

config/memberships.php

...
'rbac' => [
    /* 'admin' => [
        '*'
    ],
    'editor' => [
        '*.create',
        '*.update',
        'posts.delete'
    ] */
]

Add the HasMemberships attribute to the user model

Usage

use Rockbuzz\LaraMemberships\Account;

class User
{
    use HasMemberships
}

$user->ownedAccounts(): HasMany;
$user->accounts(): BelongsToMany;
$user->allAccounts(): Collection;
$user->accountRole(Account $account): Role;
$user->hasAccountRole(Account $account, string $role): bool;
$user->accountPermissions($account): string[];
$user->hasAccountPermission(Account $account, string $permission): bool;
$user->ownsAccount(Account $account): bool;

$account->owner(): User;
$account->members(): BelongsToMany;
$account->findMemberById(int $id): User;
$account->addMember(User $user, Role $role = null): self;

Development environment

Requirements

• Docker
• Docker Compose

Usage

docker-compose up -d --build

docker-compose exec app composer ...

Style Code

composer cs

Testing

composer test

License

The Lara Memberships is open-sourced software licensed under the MIT license.