イテレータ
PHP マニュアル

CallbackFilterIterator クラス

はじめに

クラス概要

CallbackFilterIterator
extends FilterIterator
/* メソッド */
public CallbackFilterIterator::__construct(Iterator $iterator, callable $callback)
public bool CallbackFilterIterator::accept()
/* 継承したメソッド */
public bool accept()
public mixed current()
public mixed key()
public void next()
public void rewind()
public bool valid()
public mixed IteratorIterator::current()
public Iteratornull IteratorIterator::getInnerIterator()
public mixed IteratorIterator::key()
public void IteratorIterator::next()
public void IteratorIterator::rewind()
public bool IteratorIterator::valid()

例

コールバックは、三つの引数を受け付けなければなりません。 それぞれ、現在のアイテム、現在のキー、そしてイテレータを表します。

例1 利用可能なコールバック引数

<?php

/**
 * CallbackFilterIterator 用のコールバック
 *
 * @param $current   現在のアイテムの値
 * @param $key       現在のアイテムのキー
 * @param $iterator  フィルタリングするイテレータ
 * @return boolean   現在のアイテムを受け付ける場合は TRUE、それ以外の場合は FALSE
 */
function my_callback($current, $key, $iterator) {
    // ここにフィルタリングのコードを書きます
}

?>

任意の callable を使うことができます。 関数名を含む文字列、メソッドを表す配列、あるいは無名関数などです。

例2 コールバックの基本例

<?php

$dir = new FilesystemIterator(__DIR__);

// 大きなファイル ( > 100MB) をフィルタします
function is_large_file($current) {
    return $current->isFile() && $current->getSize() > 104857600;
}
$large_files = new CallbackFilterIterator($dir, 'is_large_file');

// ディレクトリをフィルタします
$files = new CallbackFilterIterator($dir, function ($current, $key, $iterator) {
    return $current->isDir() && ! $iterator->isDot();
});

?>
目次