La classe ArrayIterator

(PHP 5, PHP 7, PHP 8)

Introduction

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.

Synopsis de la classe

class ArrayIterator implements SeekableIterator, ArrayAccess, Serializable, Countable {

/* Constantes */

public const int STD_PROP_LIST;

public const int ARRAY_AS_PROPS;

/* Méthodes */

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 pré-définies

Drapeaux ArrayIterator

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

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