This package is not installable via Composer 1.x, please make sure you upgrade to Composer 2+. Read more about our Composer 1.x deprecation policy.
This package is abandoned and no longer maintained. The author suggests using the brainite/splash package instead.

Chainable SPL and custom iterators.

dev-master 2019-05-30 17:23 UTC

This package is auto-updated.

Last update: 2020-02-27 17:23:01 UTC


Tested against PHP 5.3/5.4/5.5/HHVM

Build Status

Splash is a chainable (and therefore concise) way to interact with the SPL iterators.

// Basic example.
foreach (splash(__DIR__)->recursiveDirectory()->recursiveIterator()->regex($match) as $path) {

For more information, visit the project page.

Splash Custom Iterators

Splash comes bundles with some iterators that did not make it into SPL. Currently, this includes:


This is a simple iterator that excludes any items that match a regular expression.

$dat = splash('a', 'b')->inverseRegex('/a/')->toArray();
// $dat == array('b')


This is a simple iterator that narrows results to a slice like array_slice().

$dat = splash('a', 'b', 'c')->slice(1, 1)->toArray();
// $dat == array('b')


This is an iterator that runs a callback against each element and allows the callback to either return TRUE to retain values (like with CallbackFilterIterator) or to directly manipulate the new iterator. The direct advanced option allows for the splitting of values via the callback.

 * Callback for CallbackIterator
 * @param $current   Current item's value
 * @param $key       Current item's key
 * @param $iterator  Iterator being traversed
 * @param $new_iterator Iterator being built (to allow item splits)
 * @return boolean   TRUE to auto-add the current item to $new_iterator, FALSE otherwise
function my_callback(&$current, $key, $iterator, &$new_iterator) {
  $current = 'a';
  return TRUE;

$dat = splash('a', 'b', 'c')->callback('my_callback')->toArray();
// $dat == array('a', 'a', 'a')