Permission
in package
Represents a permission
Table of Contents
- $children : array<string|int, bool>
- $description : string
- $name : string
- __construct() : mixed
- Creates a new Permission object to be attached to Permissible objects
- addChild() : void
- getChildren() : array<string|int, bool>
- getDescription() : string
- getName() : string
- getPermissibles() : array<string|int, PermissibleInternal>
- recalculatePermissibles() : void
- removeChild() : void
- setDescription() : void
Properties
$children
private
array<string|int, bool>
$children
Tags
$description
private
string
$description
$name
private
string
$name
Methods
__construct()
Creates a new Permission object to be attached to Permissible objects
public
__construct(string $name[, string|null $description = null ][, array<string|int, bool> $children = [] ]) : mixed
Parameters
- $name : string
- $description : string|null = null
- $children : array<string|int, bool> = []
Tags
Return values
mixed —addChild()
public
addChild(string $name, bool $value) : void
Parameters
- $name : string
- $value : bool
Return values
void —getChildren()
public
getChildren() : array<string|int, bool>
Tags
Return values
array<string|int, bool> —getDescription()
public
getDescription() : string
Return values
string —getName()
public
getName() : string
Return values
string —getPermissibles()
public
getPermissibles() : array<string|int, PermissibleInternal>
Return values
array<string|int, PermissibleInternal> —recalculatePermissibles()
public
recalculatePermissibles() : void
Return values
void —removeChild()
public
removeChild(string $name) : void
Parameters
- $name : string
Return values
void —setDescription()
public
setDescription(string $value) : void
Parameters
- $value : string