WebviepRole
in package
FinalYes
Aggregate for a WebVIEP role with capabilities and metadata.
Table of Contents
Properties
- $capabilities : array<string, WebviepCapability>
- $description : string
- $isBuiltin : bool
- $key : WebviepRoleKey
- $label : string
Methods
- __construct() : mixed
- WebviepRole constructor.
- assignCapability() : void
- Assign a capability to the role.
- capabilities() : array<string|int, WebviepCapability>
- Capabilities assigned to this role.
- clearCapabilities() : void
- Remove all capabilities.
- description() : string
- Description text.
- isBuiltin() : bool
- Whether this role is built-in (core).
- key() : WebviepRoleKey
- Role key.
- label() : string
- Human-readable label.
- revokeCapability() : void
- Revoke a capability from the role.
- setCapabilities() : void
- Set capabilities, replacing existing ones.
Properties
$capabilities
private
array<string, WebviepCapability>
$capabilities
= []
$description
private
string
$description
$isBuiltin
private
bool
$isBuiltin
$key
private
WebviepRoleKey
$key
$label
private
string
$label
Methods
__construct()
WebviepRole constructor.
public
__construct(WebviepRoleKey $key, string $label[, string $description = '' ][, bool $isBuiltin = false ][, array<string|int, WebviepCapability> $capabilities = [] ]) : mixed
Parameters
- $key : WebviepRoleKey
- $label : string
- $description : string = ''
- $isBuiltin : bool = false
- $capabilities : array<string|int, WebviepCapability> = []
assignCapability()
Assign a capability to the role.
public
assignCapability(WebviepCapability $capability) : void
Parameters
- $capability : WebviepCapability
capabilities()
Capabilities assigned to this role.
public
capabilities() : array<string|int, WebviepCapability>
Return values
array<string|int, WebviepCapability>clearCapabilities()
Remove all capabilities.
public
clearCapabilities() : void
description()
Description text.
public
description() : string
Return values
stringisBuiltin()
Whether this role is built-in (core).
public
isBuiltin() : bool
Return values
boolkey()
Role key.
public
key() : WebviepRoleKey
Return values
WebviepRoleKeylabel()
Human-readable label.
public
label() : string
Return values
stringrevokeCapability()
Revoke a capability from the role.
public
revokeCapability(WebviepCapability $capability) : void
Parameters
- $capability : WebviepCapability
setCapabilities()
Set capabilities, replacing existing ones.
public
setCapabilities(array<string|int, WebviepCapability> $capabilities) : void
Parameters
- $capabilities : array<string|int, WebviepCapability>