TraverseArray::using()

Description

TraverseArray::using() - iterate over a PHP array

use GanbaroDigital\MissingBits\ListTraversals\TraverseArray;
void TraverseArray::using(array $list, string $listName, callable $callable);

Parameters

TraverseArray::using() takes three parameters:

• array $list - the list to iterate over
• string $listName - what you call $list in the calling code
• callable $callable - the function to call with each member of $list

$callable is any PHP callable. It should take three parameters:

$callable = function($value, $key, $name) {
    // .. do something here
}

• mixed $value - a single entry from $list
• mixed $key - the array index of $value
• string $name - the human-readable name of $value, suitable for including in exception messages and logs

For example:

$myList = [ "harry", "sally", "alice" ];
$callable = function($value, $key, $name) {
    echo "$name is $value" . PHP_EOL;
}
TraverseArray::using($myList, 'myList', $callable);

will output:

$myList[0] is harry
$myList[1] is sally
$myList[2] is alice

Return Value

TraverseArray::using() does not return a value.

Throws

TraverseArray::using() throws an InvalidArgumentException if $list is not a PHP array.

Works With

TraverseArray::using() and traverse_array are supported on these versions of PHP: