README.md

Collections

Various implementations of Doctrine's Collection interface allowing you to kickstart development of own ones. Each time an interface or an abstract class requires you to implement compare method it needs a standard PHP comparison function that returns an integer less than, equal to, or greater than zero if the first argument is considered to be respectively less than, equal to, or greater than the second.

This library sports:

SortedCollection

Collection that ensures it is always sorted, uses uasort by default however this can be changed via constructor argument. Example usage:

class SortedCollection extends Malarzm\Collections\SortedCollection
{
    public function compare($a, $b)
    {
        // ...
    }
}

$coll = new SortedIntCollection([], 'usort');

ObjectSet

Collection that ensures it contains only one instance of a given object at a time thus providing very efficient contains implementation. Add/set calls are NOP in case of object being already in the collection.

It's ready to use right away.

Set

More general version of ObjectSet that bases on custom comparison function instead of object hashes effectively allowing you to store any kind of values in it. Add/set calls are NOP in case of value being already in the collection.

class Set extends Malarzm\Collections\Set
{
    public function compare($a, $b)
    {
        // ...
    }
}

Diffable

Collection that allows you to track changes done between snapshots (first one is taken just after constructing collection, next are taken at the discretion of developer by calling ->snapshot()). Use ->getAddedElements() and ->getRemovedElements() to get new and no longer existing elements respectively.

class Diffable extends Malarzm\Collections\Diffable
{
    public function compare($a, $b)
    {
        // ...
    }
}

Library also ships Malarzm\Collections\DiffableCollection interface than can be backed up by Malarzm\Collections\Mixin\Diffable trait for your own use.

ListArray

Collection that ensures held elements are always stored as a list (array indexed by consecutive numbers). An exception is thrown when trying to write to invalid index.

It's ready to use right away.

SortedList

Extended implementation of ListArray that additionally keeps elements sorted thus providing more efficient contains, indexOf and removeElement implementations.

class SortedList extends Malarzm\Collections\SortedList
{
    public function compare($a, $b)
    {
        // ...
    }
}