jarjak / collection
Immutable, type-aware PHP Collection.
Installs: 11 465
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 3
Requires
- php: >=7.1
- ext-json: *
Requires (Dev)
- phpunit/phpunit: ^9.4
- symplify/easy-coding-standard: ^8.3
README
Collection pattern implementation with map, flatMap, reduce, sort, unique etc. methods. Serializable to JSON.
Requirements
PHP >= 7.1
Installation
This package is available on composer via packagist.
composer require jarjak/collection
Usage
Basic usage
use JarJak\Collection\Collection; $dateArray = [ new DateTime(), new DateTimeImmutable(), ]; $dateCollection = new Collection(...$dateArray); # or $dateCollection = Collection::from($dateArray); # then do what you know from other collection implementations $plusYears = $dateCollection ->map(fn($date) => $date->modify('+1 year')) ->toArray();
Adding type check feature
One of the coolest features of this implementation is that you can set up your own specific, type-aware collections (think about them like aggregates / repositories). Then you can encapsulate any custom operations that you need to perform on a group of same-type objects (instead for doing it in foreach loop somewhere in your controller / service).
use JarJak\Collection\Collection; class DateCollection extends Collection { // accept only date objects public function __construct(DateTimeInterface ...$items) { parent::__construct(...$items); } // you can personalize it by adding custom methods too! public function getMaxYear(): int { return $this->reduce( 0, function (int $current, DateTimeInterface $date): int { $year = (int) $date->format('Y'); return $current > $year ? $current : $year; } ); } } # this is acceptable $dateCollection = new DateCollection( new DateTime(), new DateTimeImmutable() ); # this will result in an error $dateCollection = new DateCollection( new DateTime(), new DateTimeImmutable(), date('now') ); # then this will work $plusYears = $dateCollection->map(fn($date) => $date->modify('+1 year')); # but this won't $dateStrings = $dateCollection->map(fn($date) => $date->format('Y-m-d')); # unless you explicitly disable type check (which effectively sends you back to the base Collection class) $dateStrings = $dateCollection ->disableTypeCheck() ->map(fn($date) => $date->format('Y-m-d'));