README.md

Introduction

A simple, elagant and straight-foward user permissions package for your Laravel applications.

Installation

You can install the package via composer:

composer require starfolksoftware/persona

You can publish and run the migrations with:

php artisan vendor:publish --tag="persona-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="persona-config"

This is the contents of the published config file:

return [
    'roles' => [
        // 'owner' => [
        //     'key' => 'owner',
        //     'name' => 'Owner',
        //     'permissions' => ['*'],
        // ],
    ],
];

Usage

Add the HasRole trait to your user model:

use StarfolkSoftware\Persona\HasRole;

class User extends Authenticatable
{
    use HasRole;

    // ...
}

Register your roles and permissions in the config file:

return [
    'roles' => [
        'owner' => [
            'key' => 'owner', // must be unique
            'name' => 'Owner',
            'permissions' => ['*'],
        ],
    ],
];

You can check if a user has a particular permission as in the following:

$user->hasPermission('post:edit');

Giving the permissions key the value '*' means the hasPermission(...) method will always return true.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Faruk Nasir
• All Contributors

License

The MIT License (MIT). Please see License File for more information.