Laravel RBAC package

, _(*1)

1 Introduction

LaRbac - Package for the Laravel framework which provides management with the next data: - Roles - Permissions - Assign roles for users, _(*2)

RBAC package structure , _(*3)

2 Dependencies

laravel 8+ | 9+ | 10+ | 11+ | 12+
Bootstrap 4 for styling
JQuery
php >= 7.3.0
composer

3 Installation

Note!, _(*4)

Version 3.x is for laravel 8+, 9+, 10+, 11+, 12+., _(*5)

Version 2.x is for laravel 6 or 7. You can use branch laravel67-rbac with 2.x versions., _(*6)

3.1 General installation from remote repository

Run the composer command:, _(*7)

composer require itstructure/laravel-rbac "^3.0.18", _(*8)

3.2 Next internal installation steps

Notes:, _(*9)

Make sure that a table for the users is already existing in your project., _(*10)
Make sure that a model for the users table is already existing in your project., _(*11)

Recommendation:, _(*12)

If you don't have any layout yet, it is useful to install for example AdminLTE or you can make your special any layout template. Cause in this package there is no a layout specially. But in config it is necessary to set it (see the next point 2 about a configure)., _(*13)

Let's go:, _(*14)

Publish files., _(*15)

Note: rbac.php config file and seeders LaRbacDatabaseSeeder, PermissionSeeder, RoleSeeder must be published surely!, _(*16)
- To publish config run command:, _(*17)
  
  php artisan rbac:publish --only=config, _(*18)
  
  It stores config file to config folder., _(*19)
- To publish seeders run command:, _(*20)
  
  php artisan rbac:publish --only=seeders, _(*21)
  
  It stores seeder files to database/seeders folder., _(*22)
- To publish migrations run command:, _(*23)
  
  php artisan rbac:publish --only=migrations, _(*24)
  
  It stores migration files to database/migrations folder., _(*25)
- To publish views run command:, _(*26)
  
  php artisan rbac:publish --only=views, _(*27)
  
  It stores view files to resources/views/vendor/rbac folder., _(*28)
- To publish translations run command:, _(*29)
  
  php artisan rbac:publish --only=lang, _(*30)
  
  It stores translation files to resources/lang/vendor/rbac folder., _(*31)
- To publish all parts run command without only argument:, _(*32)
  
  php artisan rbac:publish, _(*33)
Else you can use --force argument to rewrite already published files., _(*34)
Configure published config/rbac.php file:, _(*35)
- set layout. Example: 'layout' => 'adminlte::page', _(*36)
- change userModelClass if it is needed to change, _(*37)
- set adminUserId which you wanted to be with the role of administrator. At least at the beginning stage., _(*38)
  
  It is necessary for the next time system to let you go into the Rbac control panel, after you assigned an administrator role for you (Later see point 4)., _(*39)
- Most likely you have to change memberNameAttributeKey., _(*40)
  
  It is to display the user name in control panel by getMemberNameAttribute() method of Administrable trait. It can be string or a callback:, _(*41)
```
'memberNameAttributeKey' => function ($row) {
    return $row->first_name . ' ' . $row->last_name;
}
```
Tuning your User model (as shown in 4.1 point):, _(*42)
- Implement User model from RbacUserInterface., _(*43)
- Add roles attribute to $fillable., _(*44)
- Apply Administrable trait., _(*45)
Run command to run migrations and seeders:, _(*46)

php artisan rbac:database, _(*47)

Or optional:, _(*48)

To run just migrations php artisan rbac:database --only=migrate, _(*49)

To run just seeds php artisan rbac:database --only=seed, _(*50)
- Alternative variant for seeders., _(*51)
  
  You can set published rbac LaRbacDatabaseSeeder seeder class in to a special DatabaseSeeder:, _(*52)
```
use Illuminate\Database\Seeder;
```
```
class DatabaseSeeder extends Seeder
{
    public function run()
    {
        $this->call(LaRbacDatabaseSeeder::class);
    }
}
```
  and run command: php artisan db:seed., _(*53)
Run command to set Admin role for user with identifier adminUserId, defined in 2 point:, _(*54)

php artisan rbac:admin, _(*55)

4 Usage

Notes:, _(*56)

Make sure you use a Bootstrap 4 for styling and JQuery in your application., _(*57)
Make sure that a laravel initial factory authorization is already working in your application., _(*58)

4.1 Model part

According with the Itstructure\LaRbac\Interfaces\RbacUserInterface use functions from Itstructure\LaRbac\Traits\Administrable trait as in example:, _(*59)

namespace App;

use Illuminate\Notifications\Notifiable;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Itstructure\LaRbac\Interfaces\RbacUserInterface;
use Itstructure\LaRbac\Traits\Administrable;

class User extends Authenticatable implements RbacUserInterface
{
    use Notifiable, Administrable;

    protected $fillable = [
        'name', 'email', 'password', 'roles'
    ];

    protected $hidden = [
        'password', 'remember_token',
    ];
}

4.2 Routes part

There are already integrated base RBAC routes to manage users, roles and permissions. See in routes.php package file., _(*60)

They are guarded by the next:, _(*61)

middleware auth (editable by config).
permission can:administrate (editable by config).

This routes allow you to go to the next routes:, _(*62)

Users section, _(*63)

For get request method, _(*64)
- http://example-domain.com/rbac/users
- http://example-domain.com/rbac/users/show/{id}
- http://example-domain.com/rbac/users/edit/{id}
For post request method, _(*65)
- http://example-domain.com/rbac/users/update/{id}
- http://example-domain.com/rbac/users/delete
Roles section, _(*66)

For get request method, _(*67)
- http://example-domain.com/rbac/roles
- http://example-domain.com/rbac/roles/show/{id}
- http://example-domain.com/rbac/roles/create
- http://example-domain.com/rbac/roles/edit/{role}
For post request method, _(*68)
- http://example-domain.com/rbac/roles/store
- http://example-domain.com/rbac/roles/update/{role}
- http://example-domain.com/rbac/roles/delete
Permissions section, _(*69)

For get request method, _(*70)
- http://example-domain.com/rbac/permissions
- http://example-domain.com/rbac/permissions/show/{id}
- http://example-domain.com/rbac/permissions/create
- http://example-domain.com/rbac/permissions/edit/{permission}
For post request method, _(*71)
- http://example-domain.com/rbac/permissions/store
- http://example-domain.com/rbac/permissions/update/{permission}
- http://example-domain.com/rbac/permissions/delete

4.3 Gates part

There are already integrated base RBAC gates to access control in your application to some of the resources. See provider file RbacAuthServiceProvider.php., _(*72)

It provides the next gate definitions:, _(*73)