kununu/collections

To reduce boilerplate associated with collections

v5.1.0 2024-11-18 14:38 UTC

Requires

• php: >=8.1

Requires (Dev)

• kununu/scripts: >=5.0
• phpunit/phpunit: ^10.5

MIT

• Hugo Gonçalves

• collections

README

The goal of this library is to provide some boilerplate code to assist you in creating more friendly collections when using ArrayIterator.

Install

You can use this library by issuing the following command:

composer require kununu/collections

Running Tests

Run the tests by doing:

composer install
vendor/bin/phpunit

or

composer install
composer test

To run test and generate coverage information:

composer install
composer test-coverage

Usage

The library defines interfaces to deal with collections and also boilerplate code with default implementations.

You can either use the provided traits to your custom class extending ArrayIterator or simply expand the abstract collection classes using them.

It has a default implementation for a "basic" collection and also one to filter and group data on your collections (a "filterable" collection).

It defines interfaces to convert collection items to array, string and int and to compare items.

More details:

• Collection Interfaces
• Collection Trait
• Filterable Collection Trait
• Auto Sortable OffsetSet Trait
• Convertible
• Abstract Collections
• Abstract Item
• Mapper

Contribute

If you are interested in contributing read our contributing guidelines.