ishworkh / multi-level-array-iterator
Provides a way to loop through nested arrays with any depth
Installs: 5 009
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Requires
- php: >=7.0
This package is not auto-updated.
Last update: 2024-12-16 16:27:58 UTC
README
There are times when there is a need to iterate over an array being unknown about the level of nested array it contains. Multi Level Array Iterator lets u do that. This functionality supports associative array and is properly tested.
Basic Usage
$array = [ 1, 2, [ 3, 4 ], [ 5, 6, [ 7, 8 ] ], [ 9, [ [ 10 ] ], 11 ] ]; foreach(\ArrayIterator\ArrayIteratorFacade::iterate($array) as $key => $ArrayItem) { echo $key . ' - ' . $ArrayItem->getValue() . "\n"; } Result: 0 - 1 1 - 2 0 - 3 1 - 4 0 - 5 1 - 6 0 - 7 1 - 8 0 - 9 0 - 10 2 - 11
\ArrayIterator\ArrayIteratorFacade::iterate($array)
returns a generator of ArrayElementInterface
.
ArrayElementInterface
provides
- getValue():mixed
- getKeyHierarchy():KeyHierarchyInterface
- getParentKey(int $parentLevel): string
- getHierarchyLevel(): int
New instance of \ArrayIterator\Iterator\ArrayIterator
can be created with \ArrayIterator\ArrayIteratorFactory
which is accessible through
\ArrayIterator\ArrayIteratorLocator
. Both the facade or locator way can be used to get an instance of ArrayIterator.
It includes special support for laravel framework. For its integration with Laravel's dependency injection container \ArrayIterator\ArrayIteratorServiceProvider
is available which
can be included in the lists of service providers in config/app.php
. After this, type hinting \ArrayIterator\ArrayIteratorFactory
anywhere inside laravel app
will resolve into \ArrayIterator\ArrayIteratorFactory
properly.
Note:
- For debugging purpose, echoing KeyHierarchyInterface
prints out string representation of keys hierarchy
starting from root array separated by '-'.
- Upgraded to php7