README

Empty Laravel collections correctly understood by PHPStan

Installation

You can install the package via composer:

composer require soyhuce/empty-collection

Add the provided PHPStan extension in your PHPStan configuration:

includes:
  - ./vendor/soyhuce/empty-collection/extension.neon

This package does not require phpstan/phpstan to be installed in order to keep it in your dev dependencies. Be sure to use version 1.4.6 or higher.

Usage

Have you ever had some issue with incorrectly typed empty collections in Laravel ? Have you ever seen these PHPStan errors ?

Property App\Service\MyService::$items (Illuminate\Support\Collection<int, App\Service\Item>) does not accept Illuminate\Support\Collection<*NEVER*, *NEVER*>.
Unable to resolve the template type TKey in call to function collect
Unable to resolve the template type TValue in call to function collect

We get you covered !

This package provides an easy way to initialise empty collections, correctly typed for PHPStan.

Let's take an example:

class MyService {

    /**
     * @var \Illuminate\Support\Collection<int, App\Service\Item>
     */
    private Collection $items;

    public function __construct()
    {
-        $this->items = collect();
+        $this->items = empty_collection('int', Item::class);
    }
}

This way, PHPStan won't complain about the type of the collection.

Available functions

`empty_collection(string $keyType, string $valueType) : \Illuminate\Support\Collection`

$keyType must be 'int' or 'string'. $valueType must be some type PHPStan will understand.

Exemples:

empty_collection('int', 'int'); // Illuminate\Support\Collection<int, int>
empty_collection('int', 'string'); // Illuminate\Support\Collection<int, string>
empty_collection('string', 'array<string, bool>'); // Illuminate\Support\Collection<string, array<string, bool>>
empty_collection('string', Item::class); // Illuminate\Support\Collection<string, App\Service\Item>

`empty_eloquent_collection(string $keyType, string $valueType) : \Illuminate\Database\Eloquent\Collection`

$keyType must be 'int' or 'string'. $valueType must be a class name.

Exemples:

empty_eloquent_collection('int', User::class); // Illuminate\Database\Eloquent\Collection<int, App\Models\User>
empty_eloquent_collection('string', User::class); // Illuminate\Database\Eloquent\Collection<string, App\Models\User>

Testing

Testing is done via PHPStan and can be run with

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

License

The MIT License (MIT). Please see License File for more information.

soyhuce / empty-collection

Maintainers

Details