php man page for callbackfilteriterator

CALLBACKFILTERITERATOR(3)						 1						 CALLBACKFILTERITERATOR(3)

The CallbackFilterIterator class

INTRODUCTION
CLASS SYNOPSIS
       CallbackFilterIterator

       CallbackFilterIteratorextends
       FilterIteratorOuterIterator

       Methods

       o public CallbackFilterIterator::__construct (Iterator  $iterator, callable  $callback)

       o public string CallbackFilterIterator::accept (void  )

       Inherited methods

       o publicabstract bool FilterIterator::accept (void  )

       o public FilterIterator::__construct (Iterator  $iterator)

       o public mixed FilterIterator::current (void  )

       o public Iterator FilterIterator::getInnerIterator (void  )

       o public mixed FilterIterator::key (void  )

       o public void FilterIterator::next (void  )

       o public void FilterIterator::rewind (void  )

       o public bool FilterIterator::valid (void  )

EXAMPLES
	The callback should accept up to three arguments: the current item, the current key and the iterator, respectively.

       Example #1

	      Available callback arguments

	      <?php

	      /**
	       * Callback for CallbackFilterIterator
	       *
	       * @param $current   Current item's value
	       * @param $key	   Current item's key
	       * @param $iterator  Iterator being filtered
	       * @return boolean   TRUE to accept the current item, FALSE otherwise
	       */
	      function my_callback($current, $key, $iterator) {
		  // Your filtering code here
	      }

	      ?>

	Any callable may be used; such as a string containing a function name, an array for a method, or an anonymous function.

       Example #2

	      Callback basic examples

	      <?php

	      $dir = new FilesystemIterator(__DIR__);

	      // Filter large files ( > 100MB)
	      function is_large_file($current) {
		  return $current->isFile() && $current->getSize() > 104857600;
	      }
	      $large_files = new CallbackFilterIterator($dir, 'is_large_file');

	      // Filter directories
	      $files = new CallbackFilterIterator($dir, function ($current, $key, $iterator) {
		  return $current->isDir() && ! $iterator->isDot();
	      });

	      ?>

PHP Documentation Group 												 CALLBACKFILTERITERATOR(3)