CachingIterator::setFlags

CachingIterator オブジェクトのフラグを設定する

説明

public void CachingIterator::setFlags(int $flags)

CachingIterator のフラグを flags で置き換えます。

CachingIterator::FULL_CACHE を有効にすると、キャッシュは空になり、 イテレータが次に移動したときから要素が追加されていきます。

パラメータ

flags
CachingIterator の定数のビットマスク。 CachingIterator::CALL_TOSTRING、 CachingIterator::TOSTRING_USE_KEY、 CachingIterator::TOSTRING_USE_CURRENT、 CachingIterator::TOSTRING_USE_INNER のうち、指定できるのはひとつまでです。

戻り値

値を返しません。

エラー / 例外

flags に CachingIterator::CALL_TOSTRING、 CachingIterator::TOSTRING_USE_KEY、 CachingIterator::TOSTRING_USE_CURRENT、 CachingIterator::TOSTRING_USE_INNER のうち複数が含まれている場合、ValueError をスローします。

CachingIterator::CALL_TOSTRING と CachingIterator::TOSTRING_USE_INNER は解除できません。 どちらかが設定されている場合、そのフラグを含まない flags を渡すと、 InvalidArgumentException をスローします。

変更履歴

バージョン 説明
8.0.0 flags に文字列変換フラグが複数含まれている場合、 ValueError をスローするようになりました。 これより前のバージョンでは、 InvalidArgumentException がスローされていました。

例

例1 全要素のキャッシュを有効にする

<?php
$iterator = new CachingIterator(new ArrayIterator(['a', 'b', 'c']), 0);
$iterator->setFlags(CachingIterator::FULL_CACHE);

foreach ($iterator as $value) {
    // ...
}

var_dump($iterator->getCache());
?>

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

array(3) {
  [0]=>
  string(1) "a"
  [1]=>
  string(1) "b"
  [2]=>
  string(1) "c"
}

参考

  • CachingIterator::getFlags
  • CachingIterator::__construct