starfolksoftware / persona
A simple and straightforward Laravel user permissions package.
Installs: 2 686
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 1
Forks: 0
Open Issues: 3
Requires
- php: ^8.1
- spatie/laravel-package-tools: ^1.9.2
Requires (Dev)
- nunomaduro/collision: ^6.0|^7.0
- nunomaduro/larastan: ^2.0.1
- orchestra/testbench: ^7.0|^8.0
- pestphp/pest: ^1.21
- pestphp/pest-plugin-laravel: ^1.1
- phpstan/extension-installer: ^1.1
- phpstan/phpstan-deprecation-rules: ^1.0
- phpstan/phpstan-phpunit: ^1.0
- phpunit/phpunit: ^9.5
- spatie/laravel-ray: ^1.26
This package is auto-updated.
Last update: 2024-10-10 00:38:27 UTC
README
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
License
The MIT License (MIT). Please see License File for more information.