recursivecallbackfilteriterator(3) [php man page]

RECURSIVECALLBACKFILTERITERATOR(3)					 1					RECURSIVECALLBACKFILTERITERATOR(3)

The RecursiveCallbackFilterIterator class

INTRODUCTION

CLASS SYNOPSIS

       RecursiveCallbackFilterIterator

       RecursiveCallbackFilterIteratorextends
       CallbackFilterIteratorOuterIteratorRecursiveIterator

       Methods

       o public RecursiveCallbackFilterIterator::__construct (RecursiveIterator  $iterator, string  $callback)

       o public RecursiveCallbackFilterIterator RecursiveCallbackFilterIterator::getChildren (void  )

       o public void RecursiveCallbackFilterIterator::hasChildren (void  )

       Inherited methods

       o public string CallbackFilterIterator::accept (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 RecursiveCallbackFilterIterator
	       *
	       * @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
	      }

	      ?>

	Filtering  a  recursive  iterator  generally  involves two conditions. The first is that, to allow recursion, the callback function should
       return TRUE if the current iterator item has children. The second is the normal filter condition, such as a file size or extension check as
       in the example below.

       Example #2

	      Recursive callback basic example

	      <?php

	      $dir = new RecursiveDirectoryIterator(__DIR__);

	      // Filter large files ( > 100MB)
	      $files = new RecursiveCallbackFilterIterator($dir, function ($current, $key, $iterator) {
		  // Allow recursion
		  if ($iterator->hasChildren()) {
		      return TRUE;
		  }
		  // Check for large file
		  if ($current->isFile() && $current->getSize() > 104857600) {
		      return TRUE;
		  }
		  return FALSE;
	      });

	      foreach (new RecursiveIteratorIterator($files) as $file) {
		  echo $file->getPathname() . PHP_EOL;
	      }

	      ?>

PHP Documentation Group 											RECURSIVECALLBACKFILTERITERATOR(3)

Check Out this Related Man Page

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)

Linux and UNIX Man Pages

recursivecallbackfilteriterator(3) [php man page]

Check Out this Related Man Page