oved-php/typed-collections

A simple library to create type hinted collections in PHP- build on Laravals Collection class

What is this?

This is a very simple way to make arrays type hinted!

$list = new UserCollection(new User());

OK

$list = new UserCollection('User');

Will throw:

Vistik\Exception\InvalidTypeException: Item (string) 'User' is not a Vistik\Example\User object!

Install

Run composer require vistik/typed-collections

Use build in Collections for primitives

Out-of-the-box collections for:

• Booleans
• Integers
• Floats
• Strings
• Emails
• Numbers (float or int)

They can be created with out-of-the-box laraval style helpers:

• bCollect([true, false]) - To create a BoolCollection
• iCollect([1, 2, 3, 4]) - To create a IntegerCollection
• fCollect([3.14, 22/7, 6.66]) - To create a FloatCollection
• sCollect(['hello', 'world'']) - To create a StringCollection
• eCollect(['[email protected]', '[email protected]']) - To create a EmailCollection
• nCollect([1, 2, 3, 4, 3.14, INF]) - To create a NumberCollection

Do I have to create a type for each list? Yes, but

Look how easy it is:

use Phpsafari\Example\User;
class UserCollection extends TypedCollection{
    protected $type = User::class;
}

2 simple steps

1. Create a Class eg. AccountCollection extend TypedCollection
2. Just replace protected $type = 'Vistik\Example\User'; with your class

or

If the check is more then just a is_a check, you can overwrite the function: isValidItem($item) in your new Collection class

Features

• Build upon Illuminate\Support\Collection
• Very simple to implement custom Collections

typed-collections's Issues

Use native type checking combined with variadic parameters

Nice library! Was playing with the same idea.

This concept might be interesting (and better in performance, since it is native?) to implement the TypedCollection:
https://www.sitepoint.com/creating-strictly-typed-arrays-collections-php/

use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Contracts\Support\Collection;

abstract class TypedCollection extends Collection
{

    public function __construct($items = [])
    {
        if (is_array($items)) {
            $this->setItems(...$items);
        }
        if ($items instanceof static) {
            $this->setItems(...$this->items);
        }
        if ($items instanceof Arrayable) {
            $this->setItems(...$items->toArray());
        }

        parent::__construct($items);
    }

    protected abstract function setItems(): void;
}

And then for the specific implementation of the typed Collection:

class Categories extends TypedCollection
{

    protected function setItems(Category ...$items): void
    {
        $this->items = $items;
    }
}

What do you think?