Anindya Akhdan
3 years ago
4 changed files with 387 additions and 2 deletions
@ -0,0 +1,161 @@ |
|||||||
|
<?php |
||||||
|
|
||||||
|
return [ |
||||||
|
|
||||||
|
'models' => [ |
||||||
|
|
||||||
|
/* |
||||||
|
* When using the "HasPermissions" trait from this package, we need to know which |
||||||
|
* Eloquent model should be used to retrieve your permissions. Of course, it |
||||||
|
* is often just the "Permission" model but you may use whatever you like. |
||||||
|
* |
||||||
|
* The model you want to use as a Permission model needs to implement the |
||||||
|
* `Spatie\Permission\Contracts\Permission` contract. |
||||||
|
*/ |
||||||
|
|
||||||
|
'permission' => Spatie\Permission\Models\Permission::class, |
||||||
|
|
||||||
|
/* |
||||||
|
* When using the "HasRoles" trait from this package, we need to know which |
||||||
|
* Eloquent model should be used to retrieve your roles. Of course, it |
||||||
|
* is often just the "Role" model but you may use whatever you like. |
||||||
|
* |
||||||
|
* The model you want to use as a Role model needs to implement the |
||||||
|
* `Spatie\Permission\Contracts\Role` contract. |
||||||
|
*/ |
||||||
|
|
||||||
|
'role' => Spatie\Permission\Models\Role::class, |
||||||
|
|
||||||
|
], |
||||||
|
|
||||||
|
'table_names' => [ |
||||||
|
|
||||||
|
/* |
||||||
|
* When using the "HasRoles" trait from this package, we need to know which |
||||||
|
* table should be used to retrieve your roles. We have chosen a basic |
||||||
|
* default value but you may easily change it to any table you like. |
||||||
|
*/ |
||||||
|
|
||||||
|
'roles' => 'roles', |
||||||
|
|
||||||
|
/* |
||||||
|
* When using the "HasPermissions" trait from this package, we need to know which |
||||||
|
* table should be used to retrieve your permissions. We have chosen a basic |
||||||
|
* default value but you may easily change it to any table you like. |
||||||
|
*/ |
||||||
|
|
||||||
|
'permissions' => 'permissions', |
||||||
|
|
||||||
|
/* |
||||||
|
* When using the "HasPermissions" trait from this package, we need to know which |
||||||
|
* table should be used to retrieve your models permissions. We have chosen a |
||||||
|
* basic default value but you may easily change it to any table you like. |
||||||
|
*/ |
||||||
|
|
||||||
|
'model_has_permissions' => 'model_has_permissions', |
||||||
|
|
||||||
|
/* |
||||||
|
* When using the "HasRoles" trait from this package, we need to know which |
||||||
|
* table should be used to retrieve your models roles. We have chosen a |
||||||
|
* basic default value but you may easily change it to any table you like. |
||||||
|
*/ |
||||||
|
|
||||||
|
'model_has_roles' => 'model_has_roles', |
||||||
|
|
||||||
|
/* |
||||||
|
* When using the "HasRoles" trait from this package, we need to know which |
||||||
|
* table should be used to retrieve your roles permissions. We have chosen a |
||||||
|
* basic default value but you may easily change it to any table you like. |
||||||
|
*/ |
||||||
|
|
||||||
|
'role_has_permissions' => 'role_has_permissions', |
||||||
|
], |
||||||
|
|
||||||
|
'column_names' => [ |
||||||
|
/* |
||||||
|
* Change this if you want to name the related pivots other than defaults |
||||||
|
*/ |
||||||
|
'role_pivot_key' => null, //default 'role_id', |
||||||
|
'permission_pivot_key' => null, //default 'permission_id', |
||||||
|
|
||||||
|
/* |
||||||
|
* Change this if you want to name the related model primary key other than |
||||||
|
* `model_id`. |
||||||
|
* |
||||||
|
* For example, this would be nice if your primary keys are all UUIDs. In |
||||||
|
* that case, name this `model_uuid`. |
||||||
|
*/ |
||||||
|
|
||||||
|
'model_morph_key' => 'model_id', |
||||||
|
|
||||||
|
/* |
||||||
|
* Change this if you want to use the teams feature and your related model's |
||||||
|
* foreign key is other than `team_id`. |
||||||
|
*/ |
||||||
|
|
||||||
|
'team_foreign_key' => 'team_id', |
||||||
|
], |
||||||
|
|
||||||
|
/* |
||||||
|
* When set to true, the method for checking permissions will be registered on the gate. |
||||||
|
* Set this to false, if you want to implement custom logic for checking permissions. |
||||||
|
*/ |
||||||
|
|
||||||
|
'register_permission_check_method' => true, |
||||||
|
|
||||||
|
/* |
||||||
|
* When set to true the package implements teams using the 'team_foreign_key'. If you want |
||||||
|
* the migrations to register the 'team_foreign_key', you must set this to true |
||||||
|
* before doing the migration. If you already did the migration then you must make a new |
||||||
|
* migration to also add 'team_foreign_key' to 'roles', 'model_has_roles', and |
||||||
|
* 'model_has_permissions'(view the latest version of package's migration file) |
||||||
|
*/ |
||||||
|
|
||||||
|
'teams' => false, |
||||||
|
|
||||||
|
/* |
||||||
|
* When set to true, the required permission names are added to the exception |
||||||
|
* message. This could be considered an information leak in some contexts, so |
||||||
|
* the default setting is false here for optimum safety. |
||||||
|
*/ |
||||||
|
|
||||||
|
'display_permission_in_exception' => false, |
||||||
|
|
||||||
|
/* |
||||||
|
* When set to true, the required role names are added to the exception |
||||||
|
* message. This could be considered an information leak in some contexts, so |
||||||
|
* the default setting is false here for optimum safety. |
||||||
|
*/ |
||||||
|
|
||||||
|
'display_role_in_exception' => false, |
||||||
|
|
||||||
|
/* |
||||||
|
* By default wildcard permission lookups are disabled. |
||||||
|
*/ |
||||||
|
|
||||||
|
'enable_wildcard_permission' => false, |
||||||
|
|
||||||
|
'cache' => [ |
||||||
|
|
||||||
|
/* |
||||||
|
* By default all permissions are cached for 24 hours to speed up performance. |
||||||
|
* When permissions or roles are updated the cache is flushed automatically. |
||||||
|
*/ |
||||||
|
|
||||||
|
'expiration_time' => \DateInterval::createFromDateString('24 hours'), |
||||||
|
|
||||||
|
/* |
||||||
|
* The cache key used to store all permissions. |
||||||
|
*/ |
||||||
|
|
||||||
|
'key' => 'spatie.permission.cache', |
||||||
|
|
||||||
|
/* |
||||||
|
* You may optionally indicate a specific cache driver to use for permission and |
||||||
|
* role caching using any of the `store` drivers listed in the cache.php config |
||||||
|
* file. Using 'default' here means to use the `default` set in cache.php. |
||||||
|
*/ |
||||||
|
|
||||||
|
'store' => 'default', |
||||||
|
], |
||||||
|
]; |
||||||
@ -0,0 +1,141 @@ |
|||||||
|
<?php |
||||||
|
|
||||||
|
use Illuminate\Support\Facades\Schema; |
||||||
|
use Illuminate\Database\Schema\Blueprint; |
||||||
|
use Illuminate\Database\Migrations\Migration; |
||||||
|
use Spatie\Permission\PermissionRegistrar; |
||||||
|
|
||||||
|
class CreatePermissionTables extends Migration |
||||||
|
{ |
||||||
|
/** |
||||||
|
* Run the migrations. |
||||||
|
* |
||||||
|
* @return void |
||||||
|
*/ |
||||||
|
public function up() |
||||||
|
{ |
||||||
|
$tableNames = config('permission.table_names'); |
||||||
|
$columnNames = config('permission.column_names'); |
||||||
|
$teams = config('permission.teams'); |
||||||
|
|
||||||
|
if (empty($tableNames)) { |
||||||
|
throw new \Exception('Error: config/permission.php not loaded. Run [php artisan config:clear] and try again.'); |
||||||
|
} |
||||||
|
if ($teams && empty($columnNames['team_foreign_key'] ?? null)) { |
||||||
|
throw new \Exception('Error: team_foreign_key on config/permission.php not loaded. Run [php artisan config:clear] and try again.'); |
||||||
|
} |
||||||
|
|
||||||
|
Schema::create($tableNames['permissions'], function (Blueprint $table) { |
||||||
|
$table->bigIncrements('id'); // permission id |
||||||
|
$table->string('name'); // For MySQL 8.0 use string('name', 125); |
||||||
|
$table->string('guard_name'); // For MySQL 8.0 use string('guard_name', 125); |
||||||
|
$table->timestamps(); |
||||||
|
|
||||||
|
$table->unique(['name', 'guard_name']); |
||||||
|
}); |
||||||
|
|
||||||
|
Schema::create($tableNames['roles'], function (Blueprint $table) use ($teams, $columnNames) { |
||||||
|
$table->bigIncrements('id'); // role id |
||||||
|
if ($teams || config('permission.testing')) { // permission.testing is a fix for sqlite testing |
||||||
|
$table->unsignedBigInteger($columnNames['team_foreign_key'])->nullable(); |
||||||
|
$table->index($columnNames['team_foreign_key'], 'roles_team_foreign_key_index'); |
||||||
|
} |
||||||
|
$table->string('name'); // For MySQL 8.0 use string('name', 125); |
||||||
|
$table->string('guard_name'); // For MySQL 8.0 use string('guard_name', 125); |
||||||
|
$table->timestamps(); |
||||||
|
if ($teams || config('permission.testing')) { |
||||||
|
$table->unique([$columnNames['team_foreign_key'], 'name', 'guard_name']); |
||||||
|
} else { |
||||||
|
$table->unique(['name', 'guard_name']); |
||||||
|
} |
||||||
|
}); |
||||||
|
|
||||||
|
Schema::create($tableNames['model_has_permissions'], function (Blueprint $table) use ($tableNames, $columnNames, $teams) { |
||||||
|
$table->unsignedBigInteger(PermissionRegistrar::$pivotPermission); |
||||||
|
|
||||||
|
$table->string('model_type'); |
||||||
|
$table->unsignedBigInteger($columnNames['model_morph_key']); |
||||||
|
$table->index([$columnNames['model_morph_key'], 'model_type'], 'model_has_permissions_model_id_model_type_index'); |
||||||
|
|
||||||
|
$table->foreign(PermissionRegistrar::$pivotPermission) |
||||||
|
->references('id') // permission id |
||||||
|
->on($tableNames['permissions']) |
||||||
|
->onDelete('cascade'); |
||||||
|
if ($teams) { |
||||||
|
$table->unsignedBigInteger($columnNames['team_foreign_key']); |
||||||
|
$table->index($columnNames['team_foreign_key'], 'model_has_permissions_team_foreign_key_index'); |
||||||
|
|
||||||
|
$table->primary([$columnNames['team_foreign_key'], PermissionRegistrar::$pivotPermission, $columnNames['model_morph_key'], 'model_type'], |
||||||
|
'model_has_permissions_permission_model_type_primary'); |
||||||
|
} else { |
||||||
|
$table->primary([PermissionRegistrar::$pivotPermission, $columnNames['model_morph_key'], 'model_type'], |
||||||
|
'model_has_permissions_permission_model_type_primary'); |
||||||
|
} |
||||||
|
|
||||||
|
}); |
||||||
|
|
||||||
|
Schema::create($tableNames['model_has_roles'], function (Blueprint $table) use ($tableNames, $columnNames, $teams) { |
||||||
|
$table->unsignedBigInteger(PermissionRegistrar::$pivotRole); |
||||||
|
|
||||||
|
$table->string('model_type'); |
||||||
|
$table->unsignedBigInteger($columnNames['model_morph_key']); |
||||||
|
$table->index([$columnNames['model_morph_key'], 'model_type'], 'model_has_roles_model_id_model_type_index'); |
||||||
|
|
||||||
|
$table->foreign(PermissionRegistrar::$pivotRole) |
||||||
|
->references('id') // role id |
||||||
|
->on($tableNames['roles']) |
||||||
|
->onDelete('cascade'); |
||||||
|
if ($teams) { |
||||||
|
$table->unsignedBigInteger($columnNames['team_foreign_key']); |
||||||
|
$table->index($columnNames['team_foreign_key'], 'model_has_roles_team_foreign_key_index'); |
||||||
|
|
||||||
|
$table->primary([$columnNames['team_foreign_key'], PermissionRegistrar::$pivotRole, $columnNames['model_morph_key'], 'model_type'], |
||||||
|
'model_has_roles_role_model_type_primary'); |
||||||
|
} else { |
||||||
|
$table->primary([PermissionRegistrar::$pivotRole, $columnNames['model_morph_key'], 'model_type'], |
||||||
|
'model_has_roles_role_model_type_primary'); |
||||||
|
} |
||||||
|
}); |
||||||
|
|
||||||
|
Schema::create($tableNames['role_has_permissions'], function (Blueprint $table) use ($tableNames) { |
||||||
|
$table->unsignedBigInteger(PermissionRegistrar::$pivotPermission); |
||||||
|
$table->unsignedBigInteger(PermissionRegistrar::$pivotRole); |
||||||
|
|
||||||
|
$table->foreign(PermissionRegistrar::$pivotPermission) |
||||||
|
->references('id') // permission id |
||||||
|
->on($tableNames['permissions']) |
||||||
|
->onDelete('cascade'); |
||||||
|
|
||||||
|
$table->foreign(PermissionRegistrar::$pivotRole) |
||||||
|
->references('id') // role id |
||||||
|
->on($tableNames['roles']) |
||||||
|
->onDelete('cascade'); |
||||||
|
|
||||||
|
$table->primary([PermissionRegistrar::$pivotPermission, PermissionRegistrar::$pivotRole], 'role_has_permissions_permission_id_role_id_primary'); |
||||||
|
}); |
||||||
|
|
||||||
|
app('cache') |
||||||
|
->store(config('permission.cache.store') != 'default' ? config('permission.cache.store') : null) |
||||||
|
->forget(config('permission.cache.key')); |
||||||
|
} |
||||||
|
|
||||||
|
/** |
||||||
|
* Reverse the migrations. |
||||||
|
* |
||||||
|
* @return void |
||||||
|
*/ |
||||||
|
public function down() |
||||||
|
{ |
||||||
|
$tableNames = config('permission.table_names'); |
||||||
|
|
||||||
|
if (empty($tableNames)) { |
||||||
|
throw new \Exception('Error: config/permission.php not found and defaults could not be merged. Please publish the package configuration before proceeding, or drop the tables manually.'); |
||||||
|
} |
||||||
|
|
||||||
|
Schema::drop($tableNames['role_has_permissions']); |
||||||
|
Schema::drop($tableNames['model_has_roles']); |
||||||
|
Schema::drop($tableNames['model_has_permissions']); |
||||||
|
Schema::drop($tableNames['roles']); |
||||||
|
Schema::drop($tableNames['permissions']); |
||||||
|
} |
||||||
|
} |
||||||
Loading…
Reference in new issue