ext-collections/README.md

ext-collections

1. Introduction

This PHP extension provides a set of useful functional-style operations on PHP arrays, which makes array manipulation simple and scalable.

Method names and functionalities are inspired by Kotlin.Collections.

2. Documentation

See stubs directory for signature of all classes and methods of this extension, with PHPDoc.

3. Example

Here is a simple example for how to work with arrays gracefully using this extension.

$employees = [
    ['name' => 'Alice', 'sex' => 'female', 'age' => 35],
    ['name' => 'Bob', 'sex' => 'male', 'age' => 29],
    ['name' => 'David', 'sex' => 'male', 'age' => 40],
    ['name' => 'Benjamin', 'sex' => 'male', 'age' => 32]
];
// Trying to get an array of names of male employees,
// sorted by the descending order of their age.
$names = Collection::init($employees)
    ->filter(function ($it) {
        return $it['sex'] == 'male';
    })
    ->sortedByDescending(function ($it) {
        return $it['age'];
    })
    ->map(function ($it) {
        return $it['name'];
    })
    ->toArray();
// You got $names == ['David', 'Benjamin', 'Bob'].