API Documentation
Back to top  

AdminAccessGroupItemCollection

Extends \AbstractCollection

Class AdminAccessGroupItemCollection

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 group item to this collection.

add(\AdminAccessGroupItemInterface $item) : \AdminAccessGroupItemCollection
Throws
\InvalidArgumentException

When $item has an invalid type.

Arguments

$item

\AdminAccessGroupItemInterface

Item which should add to the collection

Response

\AdminAccessGroupItemCollection

Get collection item count.

count() : integer
inherited

Response

integer

Get the collection as an array.

getArray() : array
inherited

Response

array

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 group item from this collection.

remove(\AdminAccessGroupItemInterface $item) : \AdminAccessGroupitemCollection
Throws
\GroupItemNotFoundInCollectionException

Arguments

$item

\AdminAccessGroupItemInterface

Group item.

Response

\AdminAccessGroupitemCollection

Returns same instance for chained method calls.

Properties