Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sourceboat/laravel-static-permission
Manage user permissions and roles in your Laravel application by domain driven rules.
https://github.com/sourceboat/laravel-static-permission
laravel laravel-framework laravel-permission laravel-permissions permission
Last synced: 7 days ago
JSON representation
Manage user permissions and roles in your Laravel application by domain driven rules.
- Host: GitHub
- URL: https://github.com/sourceboat/laravel-static-permission
- Owner: sourceboat
- License: mit
- Created: 2018-11-28T11:33:58.000Z (almost 6 years ago)
- Default Branch: develop
- Last Pushed: 2023-01-10T03:01:56.000Z (over 1 year ago)
- Last Synced: 2024-08-20T16:24:43.123Z (about 1 month ago)
- Topics: laravel, laravel-framework, laravel-permission, laravel-permissions, permission
- Language: PHP
- Homepage:
- Size: 167 KB
- Stars: 10
- Watchers: 6
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# laravel-static-permission
[](https://github.com/sourceboat/laravel-static-permission/actions/workflows/test.yaml)
[](https://packagist.org/packages/sourceboat/laravel-static-permission)
[](https://packagist.org/packages/sourceboat/laravel-static-permission)
Manage user permissions and roles in your Laravel application by domain driven rules.
* [Installation](#installation)
* [Usage](#usage)
* [Using roles](#using-roles)
* [Using permissions](#using-permissions)
* [Using Blade directives](#using-blade-directives)
* [Config](#config)
## Example
```php
$user->assignRole('admin');
$user->hasRole('admin'); // true
```
Define roles and permissions in `config/permission.php`.
```php
'role' => [
'admin' => [
'news/#', // Allow all paths beginning with news/
],
'editor' => [
'news/#',
'!news/delete', // Explicitly forbid news/delete
],
'user' => [
'news/show', // Explicitly allow news/show
],
]
```
Check permissions by
```php
$admin->hasPermission('news/delete'); // true
$editor->hasPermission('news/delete'); // false
$user->hasPermission('news/delete'); // false
```
## Installation
```bash
composer require sourceboat/laravel-static-permission
```
## Usage
### Add trait to model
```php
use HasRoles;
```
### Using roles
Define roles in `config/permission.php`.
```php
// config/permission.php
'roles' => [
'role_name' => [],
'admin' => [],
],
```
#### Assign role
Add a role to a model.
```php
$model->assignRole('admin');
```
#### Check role
Check role via:
```php
$model->hasRole('admin');
$model->getRoleName(); // return admin
```
### Using permissions
Permissions are based on the MQTT syntax and specified as path. Thus, individual security levels can be mapped and generally released via wildcards.
#### Check permissions
```php
$model->hasPermission('users/show/email');
```
```php
$model->hasPermission(['users/show', 'users/edit']);
```
```php
$model->hasAnyPermission('users/show/email');
```
```php
$model->hasAnyPermission(['users/show', 'users/edit']);
```
#### Configuration
- `+` Wildcard for one level
- `#` Wildcard for everything following
- `!` Before the permission - prohibits permission
Define roles and permissions in `config/permission.php`.
```php
// config/permission.php
'roles' => [
'role_name' => [
'users/+/foo'
],
'admin' => [
'users/#',
'!users/create',
],
],
```
### Using Blade directives
Use Blade directives in your views.
#### Role
```blade
@role('admin')
Show if user is admin
@endrole
```
```blade
@unlessrole('admin')
Show if user is not admin
@endunlessrole
```
#### Permission
```blade
@permission('user/edit')
Show if user has rights to user/edit
@endpermission
```
Use several permissions.
```blade
@permission('user/edit|user/create')
Show if user has rights to user/edit AND user/create
@endpermission
```
```blade
@anypermission('user/edit|user/create')
Show if user has rights to user/edit OR user/create
@endanypermission
```
#### Middleware
Add the middleware to your `src/Http/Kernel.php`
```php
use Sourceboat\Permission\Middlewares\RoleMiddleware;
class Kernel extends HttpKernel
{
...
protected $routeMiddleware = [
...
'role' => RoleMiddleware::class
]
}
```
And use it like
```php
Route::group(['middleware' => ['role:admin']], function () {
//
})
```
## Config
Example Config
```php
'role',
/**
* Roles with permissions
*
* - `+` Wildcard one level
* - `#` Wildcard everything following
* - `!` Before the permission - prohibits permission
*
* 'admin' => [
* 'users/#',
* 'users/+/field',
* '!users/create'
* ]
*/
'roles' => [],
];
```
## Testing
```bash
composer test
```
## Changelog
See [releases](https://github.com/sourceboat/laravel-static-permission/releases) for details.
## Contributing
```bash
composer lint:phpcs
composer lint:phpmd
```
## Credits
This package is heavily inspired by [Spatie / laravel-permission](https://github.com/spatie/laravel-permission).
- [Philipp Kübler](https://github.com/pkuebler)
- [Tristan Damm](tristansb1)
- [All Contributors](https://github.com/sourceboat/laravel-static-permission/graphs/contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.