ArrayIterator クラス

(PHP 5, PHP 7, PHP 8)

このイテレータは、配列やオブジェクトを反復処理する際に値やキーを修正したり、要素を削除することができます。

同じ配列を何度も反復処理したい場合は、 ArrayObject をインスタンス化し、内部に保持された配列を foreach で反復する際に暗黙に作られる ArrayIterator のインスタンスを使うか、 ArrayObject::getIterator() メソッドを手動でコールして作成することを推奨します。

class ArrayIterator implements SeekableIterator, ArrayAccess, Serializable, Countable {

/* 定数 */

public const int STD_PROP_LIST;

public const int ARRAY_AS_PROPS;

/* メソッド */

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: オブジェクトのプロパティが、リストとして(var_dump(), foreach などから)アクセスされたときの通常の機能を持つ
ArrayIterator::ARRAY_AS_PROPS: エントリがプロパティとしてアクセスできる(読み書きともに)

バージョン	説明
8.4.0	クラス定数が型付けされるようになりました。

ArrayIterator::append — 要素を追加する
ArrayIterator::asort — 値で配列をソートする
ArrayIterator::__construct — ArrayIterator を作成する
ArrayIterator::count — 要素を数える
ArrayIterator::current — 現在の配列エントリを返す
ArrayIterator::getArrayCopy — 配列のコピーを取得する
ArrayIterator::getFlags — 振る舞いのフラグを取得する
ArrayIterator::key — 現在の配列キーを返す
ArrayIterator::ksort — キーで配列をソートする
ArrayIterator::natcasesort — 大文字小文字を区別せずに自然順で配列をソートする
ArrayIterator::natsort — 自然順で配列をソートする
ArrayIterator::next — 次のエントリに移動する
ArrayIterator::offsetExists — オフセットが存在するかどうかを調べる
ArrayIterator::offsetGet — オフセットの値を取得する
ArrayIterator::offsetSet — オフセットの値を設定する
ArrayIterator::offsetUnset — オフセットの値を削除する
ArrayIterator::rewind — 配列を最初に巻き戻す
ArrayIterator::seek — 位置を移動する
ArrayIterator::serialize — シリアライズする
ArrayIterator::setFlags — 振る舞いのフラグを設定する
ArrayIterator::uasort — ユーザー定義の比較関数を使ってソートを行い、インデックスとの関連を管理する
ArrayIterator::uksort — ユーザー定義の比較関数を使い、キーでソートする
ArrayIterator::unserialize — アンシリアライズする
ArrayIterator::valid — 配列がまだエントリを持っているかどうかチェックする

ArrayIterator クラス

目次