RecursiveArrayIterator

class RecursiveArrayIterator extends ArrayIterator implements RecursiveIterator (View source)

This iterator allows to unset and modify values and keys while iterating over Arrays and Objects in the same way as the ArrayIterator. Additionally it is possible to iterate over the current iterator entry.

Constants

STD_PROP_LIST

ARRAY_AS_PROPS

CHILD_ARRAYS_ONLY

Methods

__construct(TValue>|object $array = [], int $flags = 0, $iterator_class = null)

Construct an ArrayIterator

from  ArrayIterator
bool
offsetExists(TKey $key)

Check if offset exists

from  ArrayIterator
TValue
offsetGet(TKey $key)

Get value for an offset

from  ArrayIterator
void
offsetSet(TKey $key, TValue $value)

Set value for an offset

from  ArrayIterator
void
offsetUnset(TKey $key)

Unset value for an offset

from  ArrayIterator
void
append(TValue $value)

Append an element

from  ArrayIterator
TValue>
getArrayCopy()

Get array copy

from  ArrayIterator
int<0, max>
count()

Count elements

from  ArrayIterator
int
getFlags()

Get flags

from  ArrayIterator
void
setFlags(int $flags)

Set behaviour flags

from  ArrayIterator
asort(int $flags = SORT_REGULAR)

Sort array by values

from  ArrayIterator
ksort(int $flags = SORT_REGULAR)

Sort array by keys

from  ArrayIterator
uasort(TValue): int $callback)

User defined sort

from  ArrayIterator
uksort(TKey): int $callback)

User defined sort

from  ArrayIterator
natsort()

Sort an array naturally

from  ArrayIterator
natcasesort()

Sort an array naturally, case insensitive

from  ArrayIterator
void
unserialize(string $data)

Unserialize

from  ArrayIterator
string|null
serialize()

Serialize

from  ArrayIterator
void
rewind()

Rewind array back to the start

from  ArrayIterator
TValue
current()

Return current array entry

from  ArrayIterator
TKey|null
key()

Return current array key

void
next()

Move to next entry

from  ArrayIterator
bool
valid()

Check whether array contains more entries

from  ArrayIterator
void
seek(int $offset)

Seek to position

from  ArrayIterator
array
__debugInfo()

No description

from  ArrayIterator
array
__serialize()

No description

from  ArrayIterator
__unserialize(array $data)

No description

from  ArrayIterator
bool
hasChildren()

Returns whether current entry is an array or an object.

RecursiveIterator|null
getChildren()

Returns an iterator for the current entry if it is an array or an object.

Details

in ArrayIterator at line 2010
__construct(TValue>|object $array = [], int $flags = 0, $iterator_class = null)

Construct an ArrayIterator

Parameters

TValue>|object $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

in ArrayIterator at line 2024
bool offsetExists(TKey $key)

Check if offset exists

Parameters

TKey $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.

in ArrayIterator at line 2036
TValue offsetGet(TKey $key)

Get value for an offset

Parameters

TKey $key

The offset to get the value from.

Return Value

TValue

Can return all value types.

in ArrayIterator at line 2051
void offsetSet(TKey $key, TValue $value)

Set value for an offset

Parameters

TKey $key

The index to set for.

TValue $value

The value to set.

Return Value

void

in ArrayIterator at line 2066
void offsetUnset(TKey $key)

Unset value for an offset

Parameters

TKey $key

The offset to unset.

Return Value

void

in ArrayIterator at line 2078
void append(TValue $value)

Append an element

Parameters

TValue $value

The value to append.

Return Value

void

in ArrayIterator at line 2088
TValue> getArrayCopy()

Get array copy

Return Value

TValue>

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

in ArrayIterator at line 2098
int<0, max> count()

Count elements

Return Value

int<0, max>

The custom count as an integer.

The return value is cast to an integer.

in ArrayIterator at line 2107
int getFlags()

Get flags

Return Value

int

The current flags.

in ArrayIterator at line 2122
void setFlags(int $flags)

Set behaviour flags

Parameters

int $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

in ArrayIterator at line 2130
asort(int $flags = SORT_REGULAR)

Sort array by values

Parameters

int $flags

in ArrayIterator at line 2138
ksort(int $flags = SORT_REGULAR)

Sort array by keys

Parameters

int $flags

in ArrayIterator at line 2149
uasort(TValue): int $callback)

User defined sort

Parameters

TValue): int $callback

The compare function used for the sort.

in ArrayIterator at line 2160
uksort(TKey): int $callback)

User defined sort

Parameters

TKey): int $callback

The compare function used for the sort.

in ArrayIterator at line 2168
natsort()

Sort an array naturally

in ArrayIterator at line 2176
natcasesort()

Sort an array naturally, case insensitive

in ArrayIterator at line 2188
void unserialize(string $data)

Unserialize

Parameters

string $data

The string representation of the object.

Return Value

void

in ArrayIterator at line 2197
string|null serialize()

Serialize

Return Value

string|null

The string representation of the object or null

in ArrayIterator at line 2206
void rewind()

Rewind array back to the start

Return Value

void

Any returned value is ignored.

in ArrayIterator at line 2215
TValue current()

Return current array entry

Return Value

TValue

Can return any type.

at line 2317
TKey|null key()

Return current array key

Return Value

TKey|null

TKey on success, or null on failure.

in ArrayIterator at line 2233
void next()

Move to next entry

Return Value

void

Any returned value is ignored.

in ArrayIterator at line 2242
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.

in ArrayIterator at line 2254
void seek(int $offset)

Seek to position

Parameters

int $offset

The position to seek to.

Return Value

void

in ArrayIterator at line 2262
array __debugInfo()

Since: 7.4

No description

Return Value

array

in ArrayIterator at line 2270
array __serialize()

Since: 7.4

No description

Return Value

array

in ArrayIterator at line 2278
__unserialize(array $data)

Since: 7.4

No description

Parameters

array $data

at line 2299
bool hasChildren()

Returns whether current entry is an array or an object.

Return Value

bool

true if the current entry can be iterated over, otherwise returns false.

at line 2308
RecursiveIterator|null getChildren()

Returns an iterator for the current entry if it is an array or an object.

Return Value

RecursiveIterator|null

An iterator for the current entry.