Role
extends BaseEntity
in package
uses
LazyLoadEntityTrait
Role Entity - KMP RBAC Role Management
Represents a security role containing permissions. Assigned to members through time-bounded MemberRole assignments.
Table of Contents
Properties
- $branch_id : int|null
- $created : DateTime|null
- $id : int
- $Members : array<string|int, Member>
- $modified : DateTime|null
- $name : string
- $permissions : array<string|int, Permission>
- $_accessible : array<string, bool>
- Fields that can be mass assigned using newEntity() or patchEntity().
Methods
- getBranchId() : int|null
- Get the branch ID for authorization checks.
Properties
$branch_id
public
int|null
$branch_id
Associated branch ID (when applicable)
$created
public
DateTime|null
$created
Creation timestamp
$id
public
int
$id
Primary key
$Members
public
array<string|int, Member>
$Members
Members with this role
$modified
public
DateTime|null
$modified
Last modification timestamp
$name
public
string
$name
Unique role name
$permissions
public
array<string|int, Permission>
$permissions
Role permissions
$_accessible
Fields that can be mass assigned using newEntity() or patchEntity().
protected
array<string, bool>
$_accessible
= ['name' => true, 'Members' => true, 'permissions' => true]
Note that when '' is set to true, this allows all unspecified fields to be mass assigned. For security purposes, it is advised to set '' to false (or remove it), and explicitly make individual fields accessible as needed.
Methods
getBranchId()
Get the branch ID for authorization checks.
public
getBranchId() : int|null
Child classes should override for complex branch relationships.
Return values
int|null —The branch ID, or null if no association