README

A set of interfaces in PHP for storing and manipulating a collection of objects.

• LinkedList A double linked list implementation, add is an O(1) operation.
• ArrayList An array backed list gaurantees set and get by index are O(1) operations, unset is O(n).
• Stack A double linked list backed LIFO structure, push, pop and peek are all O(1).
• Queue A double linked list backed FIFO structure, queue, dequeue and peek are all O(1).

Installation

composer require sokumar2/collections

Usage

Linked List

You can get an instance of a LinkedList from its factory by calling the createInstance method. This ensures that only a concrete implementation of ListInterface is created.

$listFactory = new LinkedListFactory();

$linkedList = $listFactory->createInstance();

Laravel

When using in a Laravel application, you can define the list service as follows (if not taking help of the provided factory method) to ensure that the instantiation is again tied to its implementation.

class ListServiceProvider extends ServiceProvider implements DeferrableProvider
{
    public function register(): void
    {
        $this->app->bind(ListInterface::class, LinkedList::class);
    }

    public function provides(): array
    {
        return [
            ListInterface::class
        ];
    }
}

Tests

composer run test

For coverage report, make sure you have xdebug extenstion installed.

composer run coverage