CoolCMS API

UserRole extends BaseEntity

in package

• Application

implements IdentifiableInterface uses IdentifiableTrait, PrivilegeRelCollectionTrait

Tags

template

Table of Contents

Interfaces

IdentifiableInterface

Entity with a simple integer primary key. Most entities have one (often via {@see \App\Core\Traits\Shared\Models\Entities\IdentifiableTrait}); texts and links with a composite key do not, which is why `getId()` is not on {@see \App\Core\Base\BaseEntity}. Code that needs the id of a generic entity asks for this interface (parameter type, template bound, `instanceof`).

Properties

$assignable  : bool

Whether the role may be assigned to a user through `cms_system_user_role_relations`.

$code  : string

Stable role identifier for the RBAC resolver; `name` is an editable admin label, `code` is not. Unique in the db, no default validation here.

$conditional  : bool

Conditional grant: `allowed=1` from a role with `conditional=1` means `ALLOW_IF_OWNER`, not `ALLOW`. An unconditional grant from another role still wins (or-combination), which is the trap here.

$id  : int|null

$implicit  : string

Implicit assignment of the role without a row in the relation table: `none` = normal role (must be in `cms_system_user_role_relations`), `anonymous` = applies to `userId === null` (guest), `authenticated` = applies to every `userId > 0` (owner).

$lft  : int

$name  : string

$privileged  : bool

Full write scope without the ownership check (field tier). Currently only `admin`.

$privilegeRels  : Collection<int, TPrivilegeRel>

$protectLastHolder  : bool

Protected role: the last active holder cannot be deleted or lose the role; enforced by the Api `UserManager` (`UserRolePolicy`). Currently `admin`.

$rgt  : int

$setAfterRegistration  : bool

$users  : Collection<int, TUser>

Methods

__construct()  : mixed

addPrivilegeRel()  : $this

callInitMethods()  : void

Calls `init{TraitName}()` for every used trait that defines such a method.

clearPrivilegeRels()  : $this

getAllTraits()  : array<string, string>

Returns all traits the class uses, including those used by parent classes and nested traits.

getAssignable()  : bool

getCode()  : string

getConditional()  : bool

getId()  : int|null

getImplicit()  : string

getLft()  : int

getName()  : string

getPrivileged()  : bool

getPrivilegeRels()  : Collection<int, TPrivilegeRel>

getProtectLastHolder()  : bool

getRgt()  : int

getSetAfterRegistration()  : bool

isAssignable()  : bool

isConditional()  : bool

isPersisted()  : bool

isPrivileged()  : bool

isSetAfterRegistration()  : bool

privilegeRelCollectionInit()  : void

removePrivilegeRel()  : $this

setAssignable()  : $this

setCode()  : $this

setConditional()  : $this

setId()  : $this

setImplicit()  : $this

setLft()  : $this

setName()  : $this

setPrivileged()  : $this

setPrivilegeRels()  : $this

setProtectLastHolder()  : $this

setRgt()  : $this

setSetAfterRegistration()  : $this

getTraitsRecursive()  : array<string, string>

Walks the trait list recursively and collects nested traits too.