Collections

Welcome to the PHP Collection Library repository!
This library is designed to provide a comprehensive set of collection types and utility functions to enhance your PHP projects.
Read more about the Data Structures.

Installation

Coming soon. composer require zsolt/collections

Give a Star! ⭐

If you like or are using this project please give it a star. Thanks!

---

Docs

Compatible with PHPStan level 9

Documentation coming soon

Features

ReadOnlyArrayList

Provides more elegant way to work with arrays. It's a read-only version of the ArrayList, it does not allow to manipulate with the data once it is created.

$arrayList = ReadOnlyArrayList::fromValues(1, 2, 3, 4);
$arrayList->toString(); // [1, 2, 3, 4]

$arrayList->count(); // 4
$arrayList->getIdnexes(); // [0, 1, 2, 3]
$arrayList->hasIndex(5); // false
$arrayList->get(2); // 3
$arrayList->getNullable(5); // null

$arrayList->foreach(static fn(mixed $value) => echo $value); // 1234
$arrayList->foreachReversed(static fn(mixed $value) => echo $value); // 4321

foreach($arrayList as $key => $value) { echo $value; } // 1234

ArrayList

Mutable version of the ReadOnlyArrayList. Allows manipulation with data.

$arrayList = ArrayList::fromValues(1, 2, 3);
$arrayList->toString(); // [1, 2, 3]

$arrayList->add(4);
$arrayList->toString(); // [1, 2, 3, 4]

$arrayList->addRange(5, 6, 7);
$arrayList->toString(); // [1, 2, 3, 4, 5, 6, 7]

$arrayList->removeFirst();
$arrayList->removeLast();
$arrayList->toString(); // [2, 3, 4, 5, 6]

$arrayList->remove(4);
$arrayList->removeRange(5, 6);
$arrayList->toString(); // [2, 3]

Queue

$queue = Queue::create(Type::int());
$queue->enqueue(5);
$queue->enqueue(4);
$queue->enqueue(3);
$queue->enqueue(2);

$queue->dequeue(); // 5
$queue->dequeue(); // 4
$queue->peek(); // 3
$queue->dequeue(); // 3

$queue->isEmpty(); // false
$queue->count(); // 1

$queue->clear();

$queue->isEmpty(); // true
$queue->count(); // 0
$queue->dequeue(); // null

Stack

$stack = Stack::create(Type::int());
$stack->push(5);
$stack->push(4);
$stack->push(3);
$stack->push(2);

$stack->pop(); // 2
$stack->pop(); // 3
$stack->peek(); // 4
$stack->pop(); // 4

$stack->isEmpty(); // false
$stack->count(); // 1

$stack->clear();

$stack->isEmpty(); // true
$stack->count(); // 0
$stack->pop(); // null

Dictionary (Coming soon)