You are viewing the documentation for an older version of this package. You can check the version you are using with the following command:

composer show spatie/laravel-permission

Prerequisites

On this page

  1. Laravel Version
  2. User Model / Contract/Interface
  3. Must not have a [role] or [roles] property, nor a [roles()] method
  4. Must not have a [permission] or [permissions] property, nor a [permissions()] method
  5. Config file
  6. Schema Limitation in MySQL
  7. Note for apps using UUIDs/ULIDs/GUIDs
  8. Database foreign-key relationship support

This package can be used in Laravel 6 or higher. Check the "Installing on Laravel" page for package versions compatible with various Laravel versions.

This package uses Laravel's Gate layer to provide Authorization capabilities. The Gate/authorization layer requires that your User model implement the Illuminate\Contracts\Auth\Access\Authorizable contract. Otherwise the can() and authorize() methods will not work in your controllers, policies, templates, etc.

In the Installation instructions you'll see that the HasRoles trait must be added to the User model to enable this package's features.

Thus, a typical basic User model would have these basic minimum requirements:

use Illuminate\Foundation\Auth\User as Authenticatable;
use Spatie\Permission\Traits\HasRoles;

class User extends Authenticatable
{
    use HasRoles;

    // ...
}

Your User model/object MUST NOT have a role or roles property (or field in the database by that name), nor a roles() method on it. Those will interfere with the properties and methods added by the HasRoles trait provided by this package, thus causing unexpected outcomes when this package's methods are used to inspect roles and permissions.

Your User model/object MUST NOT have a permission or permissions property (or field in the database by that name), nor a permissions() method on it. Those will interfere with the properties and methods added by the HasPermissions trait provided by this package (which is invoked via the HasRoles trait).

This package publishes a config/permission.php file. If you already have a file by that name, you must rename or remove it, as it will conflict with this package. You could optionally merge your own values with those required by this package, as long as the keys that this package expects are present. See the source file for more details.

MySQL 8.0 limits index keys to 1000 characters. This package publishes a migration which combines multiple columns in single index. With utf8mb4 the 4-bytes-per-character requirement of mb4 means the max length of the columns in the hybrid index can only be 125 characters.

Thus in your AppServiceProvider you will need to set Schema::defaultStringLength(125). See the Laravel Docs for instructions.

This package expects the primary key of your User model to be an auto-incrementing int. If it is not, you may need to modify the create_permission_tables migration and/or modify the default configuration. See https://spatie.be/docs/laravel-permission/advanced-usage/uuid for more information.

To enforce database integrity, this package uses foreign-key relationships with cascading deletes. This prevents data mismatch situations if database records are manipulated outside of this package. If your database engine does not support foreign-key relationships, then you will have to alter the migration files accordingly.

IMPROVEMENTS TO FOREIGN KEY HANDLING WERE ADDED IN v6, SO UPGRADING IS RECOMMENDED.

Support us
Installation in Laravel
Help us improve this page