A classe ArrayIterator

(PHP 5, PHP 7, PHP 8)

Introdução

Permite a remoção de elementos e a modificação de chaves e valores ao iterar sobre arrays ou objects.

Para iterar o mesmo array mais de uma vez, é recomendado instanciar ArrayObject e usar a instância de ArrayIterator criada implicitamente ao usar foreach para iterar sobre o array armazenado, ou criar uma chamando o método ArrayObject::getIterator() manualmente.

Resumo da classe

class ArrayIterator implements SeekableIterator, ArrayAccess, Serializable, Countable {

/* Constantes */

public const int STD_PROP_LIST;

public const int ARRAY_AS_PROPS;

/* Métodos */

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

public append(mixed $value): void

public asort(int $flags = SORT_REGULAR): true

public count(): int

public current(): mixed

public getArrayCopy(): array

public getFlags(): int

public key(): string|int|null

public ksort(int $flags = SORT_REGULAR): true

public natcasesort(): true

public natsort(): true

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): true

public uksort(callable $callback): true

public unserialize(string $data): void

public valid(): bool

}

Constantes predefinidas

ArrayIterator Flags

ArrayIterator::STD_PROP_LIST: As propriedades de objeto têm sua funcionalidade normal quando acessados como listas (var_dump(), foreach etc.).
ArrayIterator::ARRAY_AS_PROPS: Itens podem ser acessados como propriedades (leitura e escrita).

Índice

ArrayIterator::append — Anexa um elemento
ArrayIterator::asort — Ordena entradas pelos valores
ArrayIterator::__construct — Constrói um ArrayIterator
ArrayIterator::count — Conta os elementos
ArrayIterator::current — Retorna o valor do elemento atual do array
ArrayIterator::getArrayCopy — Obtém cópia do array
ArrayIterator::getFlags — Retorna as flags de comportamento
ArrayIterator::key — Retorna a chave do elemento atual do array
ArrayIterator::ksort — Ordena entradas por chaves
ArrayIterator::natcasesort — Ordena entradas naturalmente, sem diferenciar maiúsculas de minúsculas
ArrayIterator::natsort — Ordena entradas naturalmente
ArrayIterator::next — Avança para o próximo elemento
ArrayIterator::offsetExists — Verificar se o deslocamento existe
ArrayIterator::offsetGet — Obtém valor para um deslocamento
ArrayIterator::offsetSet — Define valor para um deslocamento
ArrayIterator::offsetUnset — Remove valor para um deslocamento
ArrayIterator::rewind — Retrocede o array
ArrayIterator::seek — Aponta para uma posição
ArrayIterator::serialize — Serializa
ArrayIterator::setFlags — Define as flags que irão alterar o comportamento
ArrayIterator::uasort — Ordena com uma função de comparação definida pelo usuário e manter a associação de índices
ArrayIterator::uksort — Ordena por chaves usando uma função de comparação definida pelo usuário
ArrayIterator::unserialize — Desserializa
ArrayIterator::valid — Verifica se o array possui mais elementos