dmstr / yii2-active-record-permissions
_____
Installs: 32 967
Dependents: 4
Suggesters: 0
Security: 0
Stars: 1
Watchers: 9
Forks: 2
Open Issues: 1
Requires
- php: ^7.3 || ^8.0
- yiisoft/yii2: ^2.0.35
Requires (Dev)
- phan/phan: ^2.4
- phpunit/phpunit: ^9.0
This package is auto-updated.
Last update: 2024-10-25 14:40:24 UTC
README
The package has been extracted from https://github.com/dmstr/yii2-db
Installation
Setup
General usage
Configuration options
In application config:
'params' => [
'ActiveRecordAccessTrait' => [
'enableRecursiveRoles' => true
],
],
Note: Static property usage
enableRecursiveRoles
is deprecated.
Example
Traits
dmstr\activeRecordPermissions\ActiveRecordAccessTrait
Option 1:
How to equip your active record model with access control
-
Use update migration in
db/migrations/m160609_090908_add_access_columns
- set all
$tableNames
to be updated and run migration
- set all
This migrations adds the available access check columns to your database table(s)
'access_owner',
'access_read',
'access_update',
'access_delete',
'access_domain',
-
Add
use \dmstr\activeRecordPermissions\ActiveRecordAccessTrait;
to your active record model -
(update your cruds)
RBAC permissions
Permissions for selections
access.availableDomains:any
Permissions to set default values
access.defaults.accessDomain:global
access.defaults.updateDelete:<ROLE>
Add rule for default value in Model::rules()
, if you want to set it automatically
[
[
'access_update',
'access_delete',
],
'default',
'value' => self::getDefaultAccessUpdateDelete()
],
Option 2:
Simply override this method in our AR model and set the access fields you have/want to the field names you have/want!
Default:
public static function accessColumnAttributes()
{
return [
'owner' => 'access_owner',
'read' => 'access_read',
'update' => 'access_update',
'delete' => 'access_delete',
'domain' => 'access_domain',
];
}
Customize:
public static function accessColumnAttributes()
{
return [
'owner' => 'user_id', // the column name with owner permissions
'read' => 'read_permission', // the column name with read permissions
'update' => false, // will do no access checks for update
'delete' => false, // will do no access checks for delete
'domain' => 'language', // the column name with the access domain permission
];
}
㊙️ Congrats, you are now ready to manage specific access checks on your active records!
💡 Access options:
-
All access option
*
-
specific rbac roles and permissions assignable
- single or multi
*
Role1,Role2,Permission1,...
- single or multi
-
limit access to specific domain / language
de
oren
-
Owner
gets all access over other given permissions- every active record can have exact one owner right which stands above
access_read
,access_update
,access_delete
- every active record can have exact one owner right which stands above
Planned updates:
- ActiveRecordAccessTrait
- in cruds use select2 multi for inputs (domain, read, update, delete)
- Setter: authItemArrayToString()
- Getter: authItemStringToArray()
- in cruds use select2 multi for inputs (domain, read, update, delete)
Built by dmstr