API Documentation
Back to top  

AdminAccessRoleCollection

Extends \AbstractCollection

Class AdminAccessRoleCollection

category

System
package

AdminAccess
subpackage

Collections

Methods

Initialize the collection instance.

__construct(array|mixed|null $argumentsArray = null)
inherited
Throws
\InvalidArgumentException

Arguments

$argumentsArray

array|mixed|null

Add a new item.

_add(mixed $item)
inherited

This method must be used by child-collection classes.

Throws
\InvalidArgumentException

When $item has an invalid type.

Arguments

$item

mixed

Item which should add to the collection

Get exception text.

_getExceptionText() : string
inherited

Response

string

Get valid type.

_getValidType() : string
inherited abstract

This method must be implemented in the child-collection classes.

Response

string

Check if a new item has the valid collection type.

_itemIsValid(mixed $dataItem) : boolean
inherited

Arguments

$dataItem

mixed

Response

boolean

Adds a given role to this collection.

add(\AdminAccessRoleInterface $role) : \AdminAccessRoleCollection

Arguments

$role

\AdminAccessRoleInterface

Access role.

Response

\AdminAccessRoleCollection

Returns same instance for chained method calls.

Get collection item count.

count() : integer
inherited

Response

integer

Get the collection as an array.

getArray() : array
inherited

Response

array

Clones this collection.

getClone() : \AdminAccessRoleCollection

Response

\AdminAccessRoleCollection

Clone of role collection, so changes on clone won't affect original collection.

Get specific collection item by index.

getItem( $p_index) : mixed
inherited
Throws
\InvalidArgumentException

if index is not numeric | OutOfBoundsException if index is out of bounds

Arguments

$p_index

Response

mixed

getIterator

getIterator()
inherited

Determine whether the collection is empty or not.

isEmpty() : boolean
inherited

Response

boolean

Removes a given role from this collection.

remove(\AdminAccessRoleInterface $role) : \AdminAccessRoleCollection
Throws
\RoleNotFoundInCollectionException

If role is not in the collection.

Arguments

$role

\AdminAccessRoleInterface

Access role.

Response

\AdminAccessRoleCollection

Returns same instance for chained method calls.

Properties

Content Collection

collectionContentArray : array
inherited
var

Type(s)

array