TraverseObject::using()

Description

TraverseObject::using() - iterate over an object's public properties

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

Parameters

TraverseObject::using() takes three parameters:

• object $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 object attribute of $value
• string $name - the human-readable name of $value, suitable for including in exception messages and logs

For example:

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

will output:

$myList->harry is sally
$myList->alice is wonderland

Return Value

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

Throws

TraverseObject::using() throws an InvalidArgumentException if $list is not a PHP object.

Works With

TraverseObject::using() and traverse_object() are supported on these versions of PHP: