⚙️Collection API Reference

use Siro\Core\Collection;

// From array
$collection = new Collection([1, 2, 3, 4, 5]);

// Static factory
$collection = Collection::make([1, 2, 3]);

// From query results
$users = Collection::make($usersData);

$col = Collection::make([1, 2, 3]);

$col->count();        // 3
$col->isEmpty();      // false
$col->isNotEmpty();   // true
$col->first();        // 1
$col->last();         // 3

$col = Collection::make([1, 2, 3]);
$doubled = $col->map(fn($n) => $n * 2);
// [2, 4, 6]

$col = Collection::make([1, 2, 3, 4, 5]);
$evens = $col->filter(fn($n) => $n % 2 === 0);
// [2, 4]

$users = Collection::make([
    ['id' => 1, 'name' => 'Alice'],
    ['id' => 2, 'name' => 'Bob'],
]);

$names = $users->pluck('name');
// ['Alice', 'Bob']

$keyed = $users->pluck('name', 'id');
// [1 => 'Alice', 2 => 'Bob']

$total = Collection::make([1, 2, 3])->reduce(fn($carry, $n) => $carry + $n, 0);
// 6

$products = Collection::make([
    ['name' => 'Laptop', 'price' => 999, 'stock' => 5],
    ['name' => 'Mouse', 'price' => 25, 'stock' => 100],
    ['name' => 'Keyboard', 'price' => 75, 'stock' => 0],
]);

$available = $products->where('stock', '>', 0);
// [['name' => 'Laptop', ...], ['name' => 'Mouse', ...]]

$cheap = $products->where('price', '<', 100);
// [['name' => 'Mouse', ...], ['name' => 'Keyboard', ...]]

$filtered = $products->whereIn('name', ['Laptop', 'Keyboard']);

$inStock = $products->reject(fn($p) => $p['stock'] === 0);

$sorted = $collection->sort('price', 'asc');
$sorted = $collection->sortByDesc('price');
$reversed = $collection->reverse();

$prices = Collection::make([10, 20, 30, 40]);

$prices->sum();      // 100
$prices->avg();      // 25
$prices->min();      // 10
$prices->max();      // 40

$col = Collection::make([1, 2, 3]);

$col->push(4);          // [1, 2, 3, 4]
$col->pop();            // returns 4, collection becomes [1, 2, 3]
$col->shift();          // returns 1, collection becomes [2, 3]
$col->unshift(0);       // [0, 1, 2, 3]

$chunks = Collection::make([1, 2, 3, 4, 5])->chunk(2);
// [[1, 2], [3, 4], [5]]

$slice = Collection::make([1, 2, 3, 4, 5])->slice(1, 3);
// [2, 3, 4]

$unique = Collection::make([1, 1, 2, 2, 3])->unique();
// [1, 2, 3]

$col = Collection::make(['name' => 'Siro', 'version' => '0.35.0']);

$col->toArray();         // ['name' => 'Siro', 'version' => '0.35.0']
$col->toJson();          // '{"name":"Siro","version":"0.35.0"}'
$col->implode(', ');     // 'Siro, 0.35.0'

$result = Collection::make($products)
    ->where('price', '>', 100)
    ->where('stock', '>', 0)
    ->sort('price')
    ->pluck('name');

// tap — do something without breaking chain
$result = Collection::make($data)
    ->tap(fn($c) => Logger::debug('Processing', ['count' => $c->count()]))
    ->map(fn($item) => $this->process($item));

// pipe — pass collection to a function
$result = Collection::make($data)->pipe(fn($c) => $this->customTransform($c));

// Dump and die
Collection::make($data)->dd();

// Dump and continue
Collection::make($data)->dump();