Collection

Collection is a library aimed at providing you easy tools to handle your PHP arrays.

Installation

Just add chindit/collection to your composer.json

composer require chindit/collection

Usage

To initiate a collection, just call the constructor with your array as parameter

$myCollection = new Chindit\Collection(['a', 'b' => 'c']);

Methods

• all() mixed : return all values of your collection
• contains($search) bool : true if any element of your collection is strictly equal to $search. False otherwise
• count() int : number of elements in your collection
• current() mixed : element on which iterator is pointing. First element if not accessed before
• each($callable) Collection : apply $callable on every element of your collection. If $callable returns false, processing is interrupted
• filter($callable) Collection : return a copy of your collection with only the elements for which $callable returned true
• first() mixed : first element of the collection (equals to $array[0])
• flatten($depth = 500) Collection : flatten the colletion until $depth level. $depth must be an int. All sub-collections will be merged to parent level
• get($key, $defaultValue = null) mixed : return the value for the $key element. If $key element doesn’t exist, $defaultValue will be returned instead.
• groupBy($key) Collection : return a copy of your collection, grouped by $key
• has($key) bool : check if $key is a valid key for this collection
• isEmpty() bool : wether the collection is empty
• isNotEmpty() bool : wether the collection is not empty
• key() mixed : key for the current element in iterator
• keyBy($key) Collection : rewrite keys based on $key. $key can be either a callable (in this case, key will be the value returned by the function) or, in the case of an object, a property of this object.
• keys() Collection : return all keys for the collection
• map($callable) Collection : apply $callable on each element of the collection
• merge($collection) Collection : merge $collection into actual collection
• mergeRecursive($collection) Collection : merge recursively $collection into actual collection
• next() void : move iterator to next element
• pluck($string) Collection : take only $string value for all elements of the collection and create a collection for these elements
• push($element) Collection : add $element to actual collection
• put($key, $elemnt) Collection : add $element to actual collection and set its key to $key
• rewind() void : rewind iterator
• rsort() Collection : sort collection by reverse order
• sort() Collection : sort collection
• toArray() array : transfort actual collection to an array
• unique() Collection : return a collection with all unique elements in this collection
• valid() bool : check if iterator is in a valid position

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();

Support & Contact

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