AclRole
extends AbstractAcl
in package
Acl role class
Tags
Table of Contents
- $children : array<string|int, mixed>
- Role children
- $data : array<string|int, mixed>
- Array data
- $name : string
- Role name
- $parent : AclRole
- Role parent
- __construct() : mixed
- Constructor
- __get() : mixed
- Get a value
- __isset() : bool
- Is value set
- __set() : ArrayObject
- Set a value
- __toString() : string
- Return the string value of the name of the acl role
- __unset() : void
- Unset a value
- addChild() : AclRole
- Add a child role
- count() : int
- Method to get the count of the array object
- createFromJson() : ArrayObject
- Create array object from JSON string
- createFromSerialized() : ArrayObject
- Create array object from serialized string
- getChildren() : array<string|int, mixed>
- Get child roles
- getIterator() : ArrayIterator
- Method to iterate over the array object
- getName() : string
- Get the acl role name
- getParent() : AclRole
- Get the role parent
- hasChildren() : bool
- Has child roles
- hasParent() : bool
- See if the role has a parent
- jsonSerialize() : string
- JSON serialize the array object
- jsonUnserialize() : ArrayObject
- Unserialize a JSON string
- offsetExists() : bool
- ArrayAccess offsetExists
- offsetGet() : mixed
- ArrayAccess offsetGet
- offsetSet() : void
- ArrayAccess offsetSet
- offsetUnset() : void
- ArrayAccess offsetUnset
- serialize() : string
- Serialize the array object
- setName() : AbstractAcl
- Set the acl role name
- setParent() : AclRole
- Set the parent role
- toArray() : array<string|int, mixed>
- Get the values as an array
- unserialize() : ArrayObject
- Unserialize a string
Properties
$children
Role children
protected
array<string|int, mixed>
$children
= []
$data
Array data
protected
array<string|int, mixed>
$data
= []
$name
Role name
protected
string
$name
= null
$parent
Role parent
protected
AclRole
$parent
= null
Methods
__construct()
Constructor
public
__construct([mixed $data = null ]) : mixed
Instantiate the array object
Parameters
- $data : mixed = null
Tags
Return values
mixed —__get()
Get a value
public
__get(string $name) : mixed
Parameters
- $name : string
Return values
mixed —__isset()
Is value set
public
__isset(string $name) : bool
Parameters
- $name : string
Return values
bool —__set()
Set a value
public
__set(string $name, mixed $value) : ArrayObject
Parameters
- $name : string
- $value : mixed
Return values
ArrayObject —__toString()
Return the string value of the name of the acl role
public
__toString() : string
Return values
string —__unset()
Unset a value
public
__unset(string $name) : void
Parameters
- $name : string
Return values
void —addChild()
Add a child role
public
addChild(AclRole $child) : AclRole
Parameters
- $child : AclRole
Return values
AclRole —count()
Method to get the count of the array object
public
count() : int
Return values
int —createFromJson()
Create array object from JSON string
public
static createFromJson(string $jsonString[, int $depth = 512 ], int $options) : ArrayObject
Parameters
- $jsonString : string
- $depth : int = 512
- $options : int
Return values
ArrayObject —createFromSerialized()
Create array object from serialized string
public
static createFromSerialized(string $string) : ArrayObject
Parameters
- $string : string
Return values
ArrayObject —getChildren()
Get child roles
public
getChildren() : array<string|int, mixed>
Return values
array<string|int, mixed> —getIterator()
Method to iterate over the array object
public
getIterator() : ArrayIterator
Return values
ArrayIterator —getName()
Get the acl role name
public
getName() : string
Return values
string —getParent()
Get the role parent
public
getParent() : AclRole
Return values
AclRole —hasChildren()
Has child roles
public
hasChildren() : bool
Return values
bool —hasParent()
See if the role has a parent
public
hasParent() : bool
Return values
bool —jsonSerialize()
JSON serialize the array object
public
jsonSerialize(int $options[, int $depth = 512 ]) : string
Parameters
- $options : int
- $depth : int = 512
Return values
string —jsonUnserialize()
Unserialize a JSON string
public
jsonUnserialize(string $jsonString[, int $depth = 512 ], int $options) : ArrayObject
Parameters
- $jsonString : string
- $depth : int = 512
- $options : int
Return values
ArrayObject —offsetExists()
ArrayAccess offsetExists
public
offsetExists(mixed $offset) : bool
Parameters
- $offset : mixed
Return values
bool —offsetGet()
ArrayAccess offsetGet
public
offsetGet(mixed $offset) : mixed
Parameters
- $offset : mixed
Return values
mixed —offsetSet()
ArrayAccess offsetSet
public
offsetSet(mixed $offset, mixed $value) : void
Parameters
- $offset : mixed
- $value : mixed
Return values
void —offsetUnset()
ArrayAccess offsetUnset
public
offsetUnset(mixed $offset) : void
Parameters
- $offset : mixed
Return values
void —serialize()
Serialize the array object
public
serialize([bool $self = false ]) : string
Parameters
- $self : bool = false
Return values
string —setName()
Set the acl role name
public
setName(string $name) : AbstractAcl
Parameters
- $name : string
Return values
AbstractAcl —setParent()
Set the parent role
public
setParent(AclRole $parent) : AclRole
Parameters
- $parent : AclRole
Return values
AclRole —toArray()
Get the values as an array
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —unserialize()
Unserialize a string
public
unserialize(string $string) : ArrayObject
Parameters
- $string : string