vistik/typed-collections

A simple way to create typed collections in PHP - build on Illuminate\Support\Collection

v2.0.2 2017-07-27 22:24 UTC

Requires

• php: >=7.0.0
• illuminate/support: 5.4.*|5.3.*|5.2.*|5.1.*
• squizlabs/php_codesniffer: *

Requires (Dev)

• phpmd/phpmd: ^2.6
• phpunit/phpunit: ~6.0

MIT

• Visti Kløft

• collections
• array
• collection
• type hint
• type hinted

README

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(['[e-mail]', '[e-mail]']) - 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