rbdwllr/reallysimplecollection

A simple collection library for PHP.

0.1.0 2018-05-10 10:48 UTC

Requires

• php: >=7.0.0

Requires (Dev)

• phpmd/phpmd: 2.6.*
• phpstan/phpstan: 0.9.*
• phpunit/phpunit: 6.5.*

MIT

• Rob Waller

• php
• array
• collection
• pipeline

README

A very simple PHP collection library that helps you turn arrays into collections. Provides lots of useful methods such as first, map, filter, etc.

Usage

To use the collection just pass an array into the new instance of the collection class.

use ReallySimple\Collection;

$items = ['item1', 'item2', 'item3'];

$collection = new Collection($items);

echo $collection->count(); // Will Output 3.

You can also create the collection statically.

use ReallySimple\Collection;

$items = ['item1', 'item2', 'item3'];

$collection = Collection::make($items);

echo $collection->count(); // Will Output 3.

Methods Available

The following methods are currently available for this collection library.

// Return the number of items in the collection
$collection->count(): int;

// Return the current item the collection pointer is on
$collection->current();

// Filter the collection based on the values and return a new collection
$collection->filter(callable $callback): Collection;

// Filter the collection based on the keys and return a new collection
$collection->filterKeys(callable $callback): Collection;

// Filter the collection based on the keys and values and return a new collection
$collection->filterKeysValues(callable $callback): Collection;

// Return the first item from the collection
$collection->first();

// Return the current key the collection pointer is on
$collection->key();

// Map the collection and return a new collection
$collection->map(callable $callback): Collection;

// Move the collection point forward by one and return value
$collection->next();

// Return the collection pointer to the start of the collection
$collection->rewind();

// Reduce the collection and return a new collection
$collection->reduce(callable $callback, $initial = null): Collection;

// Return the collection as an array
$collection->toArray(): array;

// Check the collection key is valid
$collection->valid(): bool;

Author

• Rob Waller
• @RobDWaller
• Website