ArrayObject::getIterator

(PHP 5, PHP 7, PHP 8)

ArrayObject::getIterator — ArrayObject インスタンスから新規イテレータを生成する

説明

public function ArrayObject::getIterator(): Iterator

新しい Iterator (デフォルトは ArrayIterator) を ArrayObject インスタンスから作成します。

パラメータ

この関数にはパラメータはありません。

戻り値

ArrayObject からイテレータを返します。

例

例1 ArrayObject::getIterator() の例

<?php

$array = [
    '1' => 'one',
    '2' => 'two',
    '3' => 'three',
];

$arrayobject = new ArrayObject($array);

$iterator = $arrayobject->getIterator();

while ($iterator->valid()) {
    echo $iterator->key() . ' => ' . $iterator->current() . "\n";

    $iterator->next();
}

?>

上の例の出力は以下となります。

1 => one
2 => two
3 => three

関連キーワード:

ArrayObject getIterator iterator インスタンスイテレータ Iterator three arrayobject getFlags getIteratorClass ArrayIterator while valid current next