AclRole
extends AbstractAcl
in package
Acl role class
Tags
Table of Contents
Properties
- $children : array<string|int, mixed>
- Role children
- $data : mixed
- Array data
- $name : string|null
- Role name
- $parent : AclRole|null
- Role parent
Methods
- __construct() : mixed
- Constructor
- __get() : mixed
- Get a value
- __isset() : bool
- Is value set
- __serialize() : mixed
- Serialize magic method
- __set() : static
- Magic method to set the property to the value of $this->data[$name]
- __toString() : string
- Return the string value of the name of the acl role
- __unserialize() : ArrayObject
- Unserialize magic method
- __unset() : void
- Unset a value
- addChild() : AclRole
- Add a child role
- contains() : bool
- Determine if an item exists in the array
- count() : int
- Method to get the count of data in the collection
- createFromJson() : ArrayObject
- Create array object from JSON string
- createFromSerialized() : ArrayObject
- Create array object from serialized string
- current() : mixed
- Get the current item of the array
- first() : mixed
- Get the first item of the array
- getChildren() : array<string|int, mixed>
- Get child roles
- getIterator() : ArrayIterator
- Method to iterate over the array object
- getName() : string|null
- Get the acl role name
- getParent() : AclRole|null
- Get the role parent
- hasChildren() : bool
- Has child roles
- hasParent() : bool
- See if the role has a parent
- join() : string
- Join the array values into a string
- jsonSerialize() : string
- JSON serialize the array object
- jsonUnserialize() : ArrayObject
- Unserialize a JSON string
- key() : mixed
- Get the key of the current item of the array
- ksort() : array<string|int, mixed>
- Sort array by keys
- ksortDesc() : static
- Sort array by keys, descending
- last() : mixed
- Get the last item of the array
- next() : mixed
- Get the next item of the array
- 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
- sort() : array<string|int, mixed>
- Sort array
- sortDesc() : static
- Sort array descending
- split() : static
- Split a string into an array object
- toArray() : array<string|int, mixed>
- Get the values as an array
- uksort() : array<string|int, mixed>
- Sort array by user-defined callback using keys
- unserialize() : ArrayObject
- Unserialize a string
- usort() : static
- Sort array by user-defined callback
Properties
$children
Role children
protected
array<string|int, mixed>
$children
= []
$data
Array data
protected
mixed
$data
= null
$name
Role name
protected
string|null
$name
= null
$parent
Role parent
protected
AclRole|null
$parent
= null
Methods
__construct()
Constructor
public
__construct([mixed|null $data = null ]) : mixed
Instantiate the array object
Parameters
- $data : mixed|null = null
Tags
__get()
Get a value
public
__get(string $name) : mixed
Parameters
- $name : string
__isset()
Is value set
public
__isset(string $name) : bool
Parameters
- $name : string
Return values
bool__serialize()
Serialize magic method
public
__serialize() : mixed
__set()
Magic method to set the property to the value of $this->data[$name]
public
__set([string|null $name = null ][, mixed $value = null ]) : static
Parameters
- $name : string|null = null
- $value : mixed = null
Return values
static__toString()
Return the string value of the name of the acl role
public
__toString() : string
Return values
string__unserialize()
Unserialize magic method
public
__unserialize(array<string|int, mixed> $data) : ArrayObject
Parameters
- $data : array<string|int, mixed>
Return values
ArrayObject__unset()
Unset a value
public
__unset(string $name) : void
Parameters
- $name : string
addChild()
Add a child role
public
addChild(AclRole $child) : AclRole
Parameters
- $child : AclRole
Return values
AclRolecontains()
Determine if an item exists in the array
public
contains(mixed $key[, bool $strict = false ]) : bool
Parameters
- $key : mixed
- $strict : bool = false
Return values
boolcount()
Method to get the count of data in the collection
public
count() : int
Return values
intcreateFromJson()
Create array object from JSON string
public
static createFromJson(string $jsonString[, int $depth = 512 ][, int $options = 0 ]) : ArrayObject
Parameters
- $jsonString : string
- $depth : int = 512
- $options : int = 0
Return values
ArrayObjectcreateFromSerialized()
Create array object from serialized string
public
static createFromSerialized(string $string) : ArrayObject
Parameters
- $string : string
Tags
Return values
ArrayObjectcurrent()
Get the current item of the array
public
current() : mixed
first()
Get the first item of the array
public
first() : mixed
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
ArrayIteratorgetName()
Get the acl role name
public
getName() : string|null
Return values
string|nullgetParent()
Get the role parent
public
getParent() : AclRole|null
Return values
AclRole|nullhasChildren()
Has child roles
public
hasChildren() : bool
Return values
boolhasParent()
See if the role has a parent
public
hasParent() : bool
Return values
booljoin()
Join the array values into a string
public
join(string $glue[, string $finalGlue = '' ]) : string
Parameters
- $glue : string
- $finalGlue : string = ''
Return values
stringjsonSerialize()
JSON serialize the array object
public
jsonSerialize([int $options = 0 ][, int $depth = 512 ]) : string
Parameters
- $options : int = 0
- $depth : int = 512
Return values
stringjsonUnserialize()
Unserialize a JSON string
public
jsonUnserialize(string $jsonString[, int $depth = 512 ][, int $options = 0 ]) : ArrayObject
Parameters
- $jsonString : string
- $depth : int = 512
- $options : int = 0
Return values
ArrayObjectkey()
Get the key of the current item of the array
public
key() : mixed
ksort()
Sort array by keys
public
ksort([int $flags = SORT_REGULAR ][, bool $descending = false ]) : array<string|int, mixed>
Parameters
- $flags : int = SORT_REGULAR
- $descending : bool = false
Return values
array<string|int, mixed>ksortDesc()
Sort array by keys, descending
public
ksortDesc([int $flags = SORT_REGULAR ]) : static
Parameters
- $flags : int = SORT_REGULAR
Return values
staticlast()
Get the last item of the array
public
last() : mixed
next()
Get the next item of the array
public
next() : mixed
offsetExists()
ArrayAccess offsetExists
public
offsetExists(mixed $offset) : bool
Parameters
- $offset : mixed
Return values
booloffsetGet()
ArrayAccess offsetGet
public
offsetGet(mixed $offset) : mixed
Parameters
- $offset : mixed
offsetSet()
ArrayAccess offsetSet
public
offsetSet(mixed $offset, mixed $value) : void
Parameters
- $offset : mixed
- $value : mixed
offsetUnset()
ArrayAccess offsetUnset
public
offsetUnset(mixed $offset) : void
Parameters
- $offset : mixed
serialize()
Serialize the array object
public
serialize([bool $self = false ]) : string
Parameters
- $self : bool = false
Return values
stringsetName()
Set the acl role name
public
setName(string $name) : AbstractAcl
Parameters
- $name : string
Return values
AbstractAclsetParent()
Set the parent role
public
setParent(AclRole $parent) : AclRole
Parameters
- $parent : AclRole
Return values
AclRolesort()
Sort array
public
sort([int $flags = SORT_REGULAR ][, bool $assoc = true ][, bool $descending = false ]) : array<string|int, mixed>
Parameters
- $flags : int = SORT_REGULAR
- $assoc : bool = true
- $descending : bool = false
Return values
array<string|int, mixed>sortDesc()
Sort array descending
public
sortDesc([int $flags = SORT_REGULAR ][, bool $assoc = true ]) : static
Parameters
- $flags : int = SORT_REGULAR
- $assoc : bool = true
Return values
staticsplit()
Split a string into an array object
public
static split(string $string, string $separator[, int $limit = PHP_INT_MAX ]) : static
Parameters
- $string : string
- $separator : string
- $limit : int = PHP_INT_MAX
Return values
statictoArray()
Get the values as an array
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>uksort()
Sort array by user-defined callback using keys
public
uksort(mixed $callback) : array<string|int, mixed>
Parameters
- $callback : mixed
Return values
array<string|int, mixed>unserialize()
Unserialize a string
public
unserialize(string $string) : ArrayObject
Parameters
- $string : string
Tags
Return values
ArrayObjectusort()
Sort array by user-defined callback
public
usort(mixed $callback[, bool $assoc = true ]) : static
Parameters
- $callback : mixed
- $assoc : bool = true