La classe ArrayIterator

(PHP 5, PHP 7, PHP 8)

Permet la suppression d'éléments, et la modification de clés ou valeurs lors de l'itération de arrays ou d'objects.

Pour parcourir le même tableau plusieurs fois, il est recommandé d'instancier ArrayObject et d'utiliser l'instance de ArrayIterator soit implicitement créée en utilisant foreach pour itérer sur le tableau stocké en interne, soit en en créant une en appelant la méthode ArrayObject::getIterator() manuellement.

class ArrayIterator implements SeekableIterator, ArrayAccess, Serializable, Countable {

/* Constantes */

public const int STD_PROP_LIST;

public const int ARRAY_AS_PROPS;

/* Méthodes */

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

public function append(mixed $value): void

public function asort(int $flags = SORT_REGULAR): true

public function count(): int

public function current(): mixed

public function getArrayCopy(): array

public function getFlags(): int

public function key(): string|int|null

public function ksort(int $flags = SORT_REGULAR): true

public function natcasesort(): true

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

public function serialize(): string

public function setFlags(int $flags): void

public function uasort(callable $callback): true

public function uksort(callable $callback): true

public function unserialize(string $data): void

public function valid(): bool

}

ArrayIterator::STD_PROP_LIST: Les propriétés de l'objet conservent leurs fonctionnalités normales lorsqu'elles sont accédées en tant que liste (var_dump(), foreach, etc.).
ArrayIterator::ARRAY_AS_PROPS: Les entrées peuvent être accédées comme des propriétés (lecture et écriture).

Version	Description
8.4.0	Les constantes de classe sont désormais typées.

Sommaire

ArrayIterator::append — Ajoute un élément
ArrayIterator::asort — Trie les entrées par les valeurs
ArrayIterator::__construct — Construit un ArrayIterator
ArrayIterator::count — Compte les éléments
ArrayIterator::current — Retourne l'entrée courante du tableau
ArrayIterator::getArrayCopy — Récupère la copie d'un tableau
ArrayIterator::getFlags — Récupère les drapeaux de comportement
ArrayIterator::key — Retourne la clé courante du tableau
ArrayIterator::ksort — Trie les entrées par les clés
ArrayIterator::natcasesort — Trie naturellement les entrées, en ne tenant pas compte de la casse
ArrayIterator::natsort — Trie naturellement les entrées
ArrayIterator::next — Se déplace vers la prochaine entrée
ArrayIterator::offsetExists — Vérifie si une position existe
ArrayIterator::offsetGet — Récupère la valeur pour une position
ArrayIterator::offsetSet — Définit la valeur d'une position
ArrayIterator::offsetUnset — Efface la valeur d'une position
ArrayIterator::rewind — Revient à la position initiale
ArrayIterator::seek — Avance à une position donnée
ArrayIterator::serialize — Sérialisation
ArrayIterator::setFlags — Définit les drapeaux de comportements
ArrayIterator::uasort — Trier avec une fonction de comparaison définie par l'utilisateur et maintient l'association de l'index
ArrayIterator::uksort — Trier par clés à l'aide d'une fonction de comparaison définie par l'utilisateur
ArrayIterator::unserialize — Désérialisation
ArrayIterator::valid — Vérifie si un tableau contient d'autres entrées