The ArrayIterator class

(PHP 5, PHP 7, PHP 8)

Introduction

Allows the removal of elements, and the modification of keys or values while iterating over arrays or objects.

To iterate the same array more than once, it is recommended to instantiate ArrayObject and use the ArrayIterator instance either implicitly created when using foreach to iterate over the array stored internally, or create one by calling the ArrayObject::getIterator() method manually.

Class synopsis

class ArrayIterator implements SeekableIterator, ArrayAccess, Serializable, Countable {
/* Constants */
public const int STD_PROP_LIST;
public const int ARRAY_AS_PROPS;
/* Methods */
public function __construct(array|object $array = [], int $flags = 0)
public function append(mixed $value): void
#[\Deprecated(since: '8.6')]
public function asort(int $flags = SORT_REGULAR): true
public function count(): int
public function current(): mixed
public function getArrayCopy(): array
#[\Deprecated(since: '8.6')]
public function getFlags(): int
public function key(): string|int|null
#[\Deprecated(since: '8.6')]
public function ksort(int $flags = SORT_REGULAR): true
#[\Deprecated(since: '8.6')]
public function natcasesort(): true
#[\Deprecated(since: '8.6')]
public function natsort(): true
public function next(): void
public function offsetExists(mixed $key): bool
public function offsetGet(mixed $key): mixed
public function offsetSet(mixed $key, mixed $value): void
public function offsetUnset(mixed $key): void
public function rewind(): void
public function seek(int $offset): void
#[\Deprecated(since: '8.6')]
public function serialize(): string
#[\Deprecated(since: '8.6')]
public function setFlags(int $flags): void
#[\Deprecated(since: '8.6')]
public function uasort(callable $callback): true
#[\Deprecated(since: '8.6')]
public function uksort(callable $callback): true
#[\Deprecated(since: '8.6')]
public function unserialize(string $data): void
public function valid(): bool
}

Predefined Constants

ArrayIterator Flags

ArrayIterator::STD_PROP_LIST

Properties of the object have their normal functionality when accessed as list (var_dump(), foreach, etc.).

ArrayIterator::ARRAY_AS_PROPS

Entries can be accessed as properties (read and write).

Changelog

Version Description
8.4.0 The class constants are now typed.

Table of Contents