API Documentation
Back to top  

KeyValueCollection

Extends \AbstractCollection

Class KeyValueCollection

category

System
package

Shared

Methods

Initialize the collection instance.

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

Arguments

$argumentsArray

array|mixed|null

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

Get the value that corresponds to the provided key.

getValue(string $p_keyName) : mixed
Throws
\InvalidArgumentException

Arguments

$p_keyName

string

Response

mixed

Determine whether the collection is empty or not.

isEmpty() : boolean
inherited

Response

boolean

Check if a given key exists within the collection.

keyExists(string $p_keyName) : boolean

Arguments

$p_keyName

string

Response

boolean

Properties