chipslays/collection

Library for manipulating array as collection.

1.2.0 2022-10-31 10:22 UTC

Requires

• chipslays/array: ^1.1

Requires (Dev)

• phpunit/phpunit: ^9.5

MIT

• chipslays

README

Simple library for manipulating array or object as collection.

ℹ Supported dot-notation and asterisks rules.

The purpose of this library is to provide a generic class for interacting with arrays of data. Convenient support for dot notation and asterisk keys.

Installation

$ composer require chipslays/collection

Documentation

Collection can created by helper function collection().

get(string $key [, $default = null, string $separator = '.'])

Get item from collection by using dot notation.

use Chipslays\Collection\Collection;

$collection = new Collection([
    'user' => [
        'name' => 'chipslays',
    ],
]);

$name = $collection->get('user.name'); // chipslays
$email = $collection->get('user.email', '[e-mail]'); // [e-mail]

$array = $collection->user; // array('name' => 'chipslays')
$name = $collection->user['name']; // chipslays

$collection = collection([
    'foo' => [
        'bar' => ['baz' => 1],
        'bam' => ['baz' => 2],
        'boo' => ['baz' => 3],
    ],
]);

$collection->get('foo.*.baz');
// Array
// (
//     [0] => 1
//     [1] => 2
//     [2] => 3
// )

$collection->get('foo.*');
// Array
// (
//     [0] => Array
//         (
//             [baz] => 1
//         )
//     [1] => Array
//         (
//             [baz] => 2
//         )
//     [2] => Array
//         (
//             [baz] => 3
//         )
// )

$collection = collection([
    'foo' => [
        'bar' => ['baz' => 1],
    ],
]);

$collection->get('foo.*.baz');
// 1

$collection->get('foo.*');
// Array
// (
//     [baz] => 1
// )

set(string $key, $value = null [, string $separator = '.']): Collection

Set/overwrite item in collection using by dot notation key.

use Chipslays\Collection\Collection;

$collection = new Collection([
    'user' => [
        'name' => 'chipslays',
    ],
]);

$collection->set('user.name', 'john doe');
$collection->set('user.email', '[e-mail]');

$name = $collection->get('user.name'); // john doe
$email = $collection->get('user.email'); // [e-mail]

has(string $key [, string $separator = '.']): bool

Check exists item in collection using by dot notation key.

use Chipslays\Collection\Collection;

$collection = new Collection([
    'user' => [
        'name' => 'chipslays',
    ],
]);

$hasName = $collection->has('user.name'); // true
$hasEmail = $collection->has('user.email'); // false

first(): mixed

Returns first item from collection.

use Chipslays\Collection\Collection;

$collection = new Collection(['foo', 'bar', 'baz']);

echo $collection->first(); // foo

last(): mixed

Returns last item from collection.

use Chipslays\Collection\Collection;

$collection = new Collection(['foo', 'bar', 'baz']);

echo $collection->last(); // baz

shift(): mixed

Getting first item and remove her from collection.

use Chipslays\Collection\Collection;

$collection = new Collection(['foo', 'bar', 'baz']);

echo $collection->shift(); // foo
echo $collection->count(); // 2

values(): Collection

Returns values without keys as collection.

use Chipslays\Collection\Collection;

$collection = new Collection(['color' => 'green', 'name' => 'apple']);

print_r($collection->values()); // collection(green, apple)

keys(): Collection

Returns keys without values as collection.

use Chipslays\Collection\Collection;

$collection = new Collection(['color' => 'green', 'name' => 'apple']);

print_r($collection->keys()); // collection(color, name)

only(): Collection

Returns only selected keys.

use Chipslays\Collection\Collection;

$collection = new Collection(['color' => 'green', 'name' => 'apple']);

print_r($collection->only(['color'])); // collection(color => green)

push(): Collection

replace(): Collection

replaceRecursive(): Collection

merge(): Collection

mergeRecursive(): Collection

trim(): Collection

remove(...string $keys): Collection

limit(): Collection

chunk(int $size): Collection

each(callable $callback($item)): Collection

map(callable $callback($item)): Collection

mapWithKeys(callable $callback($item)): Collection

filter(callable $callback($item, $key) = null): Collection

where($key, $operator = null, $value = null): Collection

all(): array

collect(string $key, string $separator = '.')

reverse(bool $preserveKeys)

count(): int

Get count of items in collection.

use Chipslays\Collection\Collection;

$collection = new Collection(range(1, 10));

echo $collection->count(); // 10
echo count($collection); // 10

clear(): Collection

Clear all items in collection.

use Chipslays\Collection\Collection;

$collection = new Collection(range(1, 10));

$collection->clear();

toArray(): array

Get collection items as array.

use Chipslays\Collection\Collection;

$collection = new Collection(range(1, 10));

$collection->toArray();

toObject(): object

Get collection items as object (stdClass).

use Chipslays\Collection\Collection;

$collection = new Collection(range(1, 10));

$collection->toObject();

__toString(): string

Get items as printable string.

use Chipslays\Collection\Collection;

$collection = new Collection(['one', 'two']);

echo (string) $collection;

/** output string */
Array
(
    [0] => one
    [1] => two
)

👀 See also

• chipslays/array - Simple library for array manipulate.

License

MIT