CachingIterator::offsetGet

キャッシュの要素を返す

説明

public mixed CachingIterator::offsetGet(string $key)

キャッシュの key に格納されている要素を返します。 このメソッドは、$iterator['key'] のように CachingIterator から配列構文で値を読み取るときにコールされます。

CachingIterator::FULL_CACHE フラグを設定する必要があります。

パラメータ

key
取得したい要素のキー。

戻り値

キャッシュされている要素を返します。 key の要素がキャッシュにない場合は null を返します。

エラー / 例外

CachingIterator::FULL_CACHE フラグが設定されていない場合、 BadMethodCallException をスローします。

key の要素がキャッシュにない場合、 E_WARNING が発生します。

例

例1 反復処理した要素にアクセスする

<?php
$iterator = new CachingIterator(
    new ArrayIterator(['apple' => 3, 'banana' => 5, 'cherry' => 7]),
    CachingIterator::FULL_CACHE
);

foreach ($iterator as $fruit => $count) {
    if ($fruit === 'banana') {
        break;
    }
}

var_dump($iterator['apple']);
var_dump(isset($iterator['cherry']));
?>

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

int(3)
bool(false)

参考

  • CachingIterator::offsetExists
  • CachingIterator::offsetSet
  • CachingIterator::offsetUnset
  • CachingIterator::getCache