team-a/collection

Filtered collections.

2.1.1 2020-02-05 20:26 UTC

Requires

• php: ^7.4

Requires (Dev)

• phpstan/phpstan: ^0.12
• phpunit/phpunit: ^8.5
• squizlabs/php_codesniffer: ^3.5

MIT

• Alexey Khokhlov

• collection

README

TeamA\Collection is a library of interfaces and traits for filtering and sorting collections.

The library solves performance problems, code duplication, and allows you to design contexts for using collections in separate classes.

It is possible to implement sorting and filtering by many criteria.

Sorting and filtering by many criteria is supported. Filters and sorters are implemented as objects with a set of modifiers. Filters can be joined using the "AND", "OR" logic.

Provides a check for matching the types included in the collection with the types for which filters are implemented.

Requirements

• php >= 7.4

Install via Composer

composer require team-a/collection:^2.1

Methods

Collection

• sort
• sortReverse
• filter
• filterNotMatched
• first
• firstNotMatched
• last
• lastNotMatched
• has
• isAllMatched
• isEmpty
• hasNot
• count
• countNotMatched
• asArray
• asArrayNotMatched

Filter chains

• and
• or
• not

Examples

For a working example, see tests/Model.

<?php

$collection = new CarCollection($cars); 

$collection = $collection->sort(
    CarCollectionSorter::new()
        ->byModel()
        ->byColor()
);


$filter = CollectionFilter::new()
    ->withColor('blue')
    ->or(
        CarCollectionFilter::new()->withModel('408')
    )->or(
        CarCollectionFilter::new()->withVendor('VAZ')
    )
;

$hasAtLeastOneCar = $collection->has($filter);
$hasNoCars        = $collection->isEmpty($filter);
$hasDiscardedCars = $collection->hasNot($filter);

$firstCar = $collection->first($filter);
$lastCar  = $collection->last($filter);

$array = $collection->filter($filter)->asArray();
$count = $collection->count($filter);