tobento / service-iterable
Iterables and iterators
1.0.0
2022-10-28 17:03 UTC
Requires
- php: >=8.0
- tobento/service-filesystem: ^1.0
Requires (Dev)
- phpunit/phpunit: ^9.5
- vimeo/psalm: ^4.0
This package is not auto-updated.
Last update: 2024-11-10 00:48:57 UTC
README
Iterable helper and common iterators used in other services.
Table of Contents
Getting started
Add the latest version of the iterable service project running this command.
composer require tobento/service-iterable
Requirements
- PHP 8.0 or greater
Highlights
- Framework-agnostic, will work with any project
- Decoupled design
Documentation
Iterable
toArray
Converts any iterable to an array.
use Tobento\Service\Iterable\Iter; $iterable = ['key' => 'value']; $array = Iter::toArray(iterable: $iterable);
toIterator
Converts any iterable to an iterator.
use Tobento\Service\Iterable\Iter; use Iterator; $iterable = ['key' => 'value']; $iterator = Iter::toIterator(iterable: $iterable); var_dump($iterator instanceof Iterator); // bool(true)
Iterators
Chunk Iterator
use Tobento\Service\Iterable\ChunkIterator; $iterator = new ChunkIterator( iterable: range(1, 10), chunkLength: 2, ); foreach($iterator as $chunk) {} // [1, 2], [3, 4], ...
Modify Iterator
use Tobento\Service\Iterable\ModifyIterator; $iterator = new ModifyIterator( iterable: range(1, 5), modifier: function(int $number): int { return $number * 10; } ); foreach($iterator as $number) {} // 10, 20, ...
Item Factory Iterator
You may use the item factory iterator to seed items and use the Seeder Service to generate fake data.
use Tobento\Service\Iterable\ItemFactoryIterator; use Tobento\Service\Seeder\Str; use Tobento\Service\Seeder\Arr; $callable = function(): array { return [ 'name' => Str::string(10), 'color' => Arr::item(['green', 'red', 'blue']), ]; }; $iterator = new ItemFactoryIterator( factory: $callable, create: 10 );
Json File Iterator
use Tobento\Service\Iterable\JsonFileIterator; $iterator = new JsonFileIterator( file: 'private/src/file.json', ); foreach($iterator as $key => $item) {}
For large files you may consider Json Maschine.