https://github.com/oved-php/typed-collections

A simple library to create type hinted collections in PHP- build on Laravals Collection class
https://github.com/oved-php/typed-collections

collections laravel laravel-collections php-library php7 type-hints type-safe

Last synced: 9 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/oved-php/typed-collections
• Owner: OveD-php
• Created: 2017-02-12T12:11:08.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2020-04-22T20:31:57.000Z (over 5 years ago)
• Last Synced: 2025-03-17T17:38:38.254Z (9 months ago)
• Topics: collections, laravel, laravel-collections, php-library, php7, type-hints, type-safe
• Language: PHP
• Homepage:
• Size: 60.5 KB
• Stars: 10
• Watchers: 3
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
[![Build Status](https://travis-ci.org/vistik/typed-collections.svg?branch=master)](https://travis-ci.org/vistik/typed-collections)

### 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(['hello@example.org', 'write@me.com'])` - 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](https://github.com/illuminate/support)

* Very simple to implement custom Collections