Collection

Collection is a small PHP library that provides convenient tools for handling arrays.

The current release requires PHP 8.3 or later.

Installation

Just add chindit/collection to your composer.json

composer require chindit/collection

Usage

To create a collection, pass an array to the constructor:

use Chindit\Collection\Collection;

$collection = new Collection(['a', 'b' => 'c']);

Methods

• all() array : return all values of the collection, without preserving keys
• contains($search) bool : check whether a value is strictly present
• count() int : return the number of elements
• each($callable) Collection : apply a callback to every element; stop when it returns false
• filter($callable) Collection : return only the elements accepted by the callback
• first() mixed : return the first element
• flatten($depth = 500) Collection : flatten nested arrays and collections up to $depth
• get($key, $defaultValue = null) mixed : return the value for a key, or the default value
• getIterator() Traversable : provide a fresh iterator for use with foreach
• groupBy($key) Collection : group elements by a field/accessor or by a callback
• has($key) bool : check whether a key exists
• isEmpty() bool : check whether the collection is empty
• isNotEmpty() bool : check whether the collection is not empty
• keyBy($key) Collection : rewrite keys using an accessor or callback
• keys() Collection : return the collection’s keys
• map($callable) Collection : apply a callback to each element
• merge($collection) Collection : merge another collection
• mergeRecursive($collection) Collection : recursively merge another collection
• pluck($string) Collection : extract a field from every element
• push($element) Collection : append an element
• put($key, $element) Collection : add an element with a specific key
• rsort() Collection : sort the collection in reverse order
• sort() Collection : sort the collection
• toArray() array : convert the collection, including nested collections, to an array while preserving keys
• unique() Collection : return the collection without duplicate values

Examples

// Let's assume we have some Car objects
$myObject = new Car();

$myCollection = new Collection($arrayOfCarObjects);

// «pluck» will access «brand» property or «getBrand» method on all elements of the collection and return its value
// «unique» will remove all duplicates
$uniqueBrands = $myCollection->pluck('brand')->unique();

Collections can be iterated with foreach. A new iterator is created for each loop:

foreach ($myCollection as $key => $value) {
    // use $key and $value
}

Support & Contact

If you have any issue or question with this repository, do not hesitate to leave a comment in the «Issue» sections ^^