The ArrayIterator class

The ArrayIterator class

Introduction

(PHP 5, PHP 7, PHP 8)

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

When you want to iterate over the same array multiple times you need to instantiate ArrayObject and let it create ArrayIterator instances that refer to it either by using foreach or by calling its getIterator() method manually.

Class synopsis

class ArrayIterator implements ArrayAccess, SeekableIterator, Countable, Serializable {

/* Constants */

const int STD_PROP_LIST = 1;

const int ARRAY_AS_PROPS = 2;

/* Methods */

public __construct(array|object $array = [], int $flags = 0)

public append(mixed $value): void

public asort(int $flags = SORT_REGULAR): bool

public count(): int

public current(): mixed

public getArrayCopy(): array

public getFlags(): int

public key(): mixed

public ksort(int $flags = SORT_REGULAR): bool

public natcasesort(): bool

public natsort(): bool

public next(): void

public offsetExists(mixed $key): bool

public offsetGet(mixed $key): mixed

public offsetSet(mixed $key, mixed $value): void

public offsetUnset(mixed $key): void

public rewind(): void

public seek(int $offset): void

public serialize(): string

public setFlags(int $flags): void

public uasort(callable $callback): bool

public uksort(callable $callback): bool

public unserialize(string $data): void

public 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).

Table of Contents

• ArrayIterator::append — Append an element
• ArrayIterator::asort — Sort entries by values
• ArrayIterator::__construct — Construct an ArrayIterator
• ArrayIterator::count — Count elements
• ArrayIterator::current — Return current array entry
• ArrayIterator::getArrayCopy — Get array copy
• ArrayIterator::getFlags — Get behavior flags
• ArrayIterator::key — Return current array key
• ArrayIterator::ksort — Sort entries by keys
• ArrayIterator::natcasesort — Sort entries naturally, case insensitive
• ArrayIterator::natsort — Sort entries naturally
• ArrayIterator::next — Move to next entry
• ArrayIterator::offsetExists — Check if offset exists
• ArrayIterator::offsetGet — Get value for an offset
• ArrayIterator::offsetSet — Set value for an offset
• ArrayIterator::offsetUnset — Unset value for an offset
• ArrayIterator::rewind — Rewind array back to the start
• ArrayIterator::seek — Seek to position
• ArrayIterator::serialize — Serialize
• ArrayIterator::setFlags — Set behaviour flags
• ArrayIterator::uasort — Sort with a user-defined comparison function and maintain index association
• ArrayIterator::uksort — Sort by keys using a user-defined comparison function
• ArrayIterator::unserialize — Unserialize
• ArrayIterator::valid — Check whether array contains more entries

© 1997–2020 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/class.arrayiterator.php