vistik/type-hinted-arrays

There is no license information available for the latest version (v2.0.0) of this package.

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

v2.0.0 2017-02-11 20:26 UTC

README

Build Status

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/type-hinted-arrays

Use build in Collections for primitives

Out-of-the-box collections for:

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

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

Look how easy it is:

class UserCollection extends TypedCollection{
    protected $type = 'Vistik\Example\User';
}

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