ArrayIterator

class ArrayIterator implements SeekableIterator, ArrayAccess, Serializable, Countable (View source)

This iterator allows to unset and modify values and keys while iterating over Arrays and Objects.

Constants

STD_PROP_LIST

ARRAY_AS_PROPS

Methods

__construct(array $array = [], int $flags = 0, $iterator_class = null)

Construct an ArrayIterator

bool
offsetExists(string $key)

Check if offset exists

mixed
offsetGet(string $key)

Get value for an offset

void
offsetSet(string $key, TValue $value)

Set value for an offset

void
offsetUnset(string $key)

Unset value for an offset

void
append(mixed $value)

Append an element

array
getArrayCopy()

Get array copy

int
count()

Count elements

int
getFlags()

Get flags

void
setFlags(string $flags)

Set behaviour flags

asort(int $flags = SORT_REGULAR)

Sort array by values

ksort(int $flags = SORT_REGULAR)

Sort array by keys

uasort(callable $callback)

User defined sort

uksort(callable $callback)

User defined sort

natsort()

Sort an array naturally

natcasesort()

Sort an array naturally, case insensitive

void
unserialize(string $data)

Unserialize

string|null
serialize()

Serialize

void
rewind()

Rewind array back to the start

mixed
current()

Return current array entry

mixed
key()

Return current array key

void
next()

Move to next entry

bool
valid()

Check whether array contains more entries

void
seek(int $offset)

Seek to position

array
__debugInfo()

No description

array
__serialize()

No description

void
__unserialize(array $data)

No description

Details

at line 1846
__construct(array $array = [], int $flags = 0, $iterator_class = null)

Construct an ArrayIterator

Parameters

array $array

The array or object to be iterated on.
int $flags

Flags to control the behaviour of the ArrayObject object.
$iterator_class

See also

ArrayObject::setFlags

at line 1860
bool offsetExists(string $key)

Check if offset exists

Parameters

string $key

The offset being checked.

Return Value

bool

true on success or false on failure.

The return value will be casted to boolean if non-boolean was returned.

at line 1871
mixed offsetGet(string $key)

Get value for an offset

Parameters

string $key

The offset to get the value from.

Return Value

mixed

Can return all value types.

at line 1885
void offsetSet(string $key, TValue $value)

Set value for an offset

Parameters

string $key

The index to set for.

TValue $value

The value to set.

Return Value

void

at line 1899
void offsetUnset(string $key)

Unset value for an offset

Parameters

string $key

The offset to unset.

Return Value

void

at line 1910
void append(mixed $value)

Append an element

Parameters

mixed $value

The value to append.

Return Value

void

at line 1919
array getArrayCopy()

Get array copy

Return Value

array

A copy of the array, or array of public properties if ArrayIterator refers to an object.

at line 1928
int count()

Count elements

Return Value

int

The custom count as an integer.

The return value is cast to an integer.

at line 1936
int getFlags()

Get flags

Return Value

int

The current flags.

at line 1950
void setFlags(string $flags)

Set behaviour flags

Parameters

string $flags

A bitmask as follows: 0 = Properties of the object have their normal functionality when accessed as list (var_dump, foreach, etc.). 1 = Array indices can be accessed as properties in read/write.

Return Value

void

at line 1957
asort(int $flags = SORT_REGULAR)

Sort array by values

Parameters

int $flags

at line 1965
ksort(int $flags = SORT_REGULAR)

Sort array by keys

Parameters

int $flags

at line 1976
uasort(callable $callback)

User defined sort

Parameters

callable $callback

The compare function used for the sort.

at line 1987
uksort(callable $callback)

User defined sort

Parameters

callable $callback

The compare function used for the sort.

at line 1995
natsort()

Sort an array naturally

at line 2003
natcasesort()

Sort an array naturally, case insensitive

at line 2015
void unserialize(string $data)

Unserialize

Parameters

string $data

The string representation of the object.

Return Value

void

at line 2023
string|null serialize()

Serialize

Return Value

string|null

The string representation of the object or null

at line 2031
void rewind()

Rewind array back to the start

Return Value

void

Any returned value is ignored.

at line 2039
mixed current()

Return current array entry

Return Value

mixed

Can return any type.

at line 2047
mixed key()

Return current array key

Return Value

mixed

TKey on success, or null on failure.

at line 2055
void next()

Move to next entry

Return Value

void

Any returned value is ignored.

at line 2063
bool valid()

Check whether array contains more entries

Return Value

bool

The return value will be casted to boolean and then evaluated. Returns true on success or false on failure.

at line 2074
void seek(int $offset)

Seek to position

Parameters

int $offset

The position to seek to.

Return Value

void

at line 2081
array __debugInfo()

Since: 7.4

No description

Return Value

array

at line 2088
array __serialize()

Since: 7.4

No description

Return Value

array

at line 2095
void __unserialize(array $data)

Since: 7.4

No description

Parameters

array $data

Return Value

void