php-standard-library/phpstan-extension

PHPStan PSL extension

Maintainers

Details

github.com/php-standard-library/phpstan-extension

Source

Issues

Installs: 445 050

Dependents: 12

Suggesters: 1

Security: 0

Stars: 14

Watchers: 4

Forks: 4

Open Issues: 14

Type:phpstan-extension

2.0.0 2024-11-11 13:31 UTC

Requires

Requires (Dev)

Conflicts

MIT e3e77739a205a8825d56fb9495620923b20ca9fc

This package is auto-updated.

Last update: 2024-11-12 02:20:53 UTC

README

Build Latest Stable Version License

Description

The main goal of this extension is to help PHPStan to detect the types after using Psl\Type\shape.

Given the following example:

use Psl\Type;

$specification = Type\shape([
    'name' => Type\string(),
    'age' => Type\int(),
    'location' => Type\optional(Type\shape([
        'city' => Type\string(),
        'state' => Type\string(),
        'country' => Type\string(),
    ]))
]);

$input = $specification->coerce($_GET['user']);

PHPStan assumes that $input is of type array<"age"|"location"|"name", array<"city"|"country"|"state", string>|int|string>.

If we enable the extension, you will get a more specific and correct type of array{name: string, age: int, location?: array{city: string, state: string, country: string}}.

Besides coerce, this extension also supports matches() and assert() methods.

Installation

To use this extension, require it in Composer:

composer require --dev php-standard-library/phpstan-extension

If you also install phpstan/extension-installer then you're all set!

Manual installation

If you don't want to use phpstan/extension-installer, include extension.neon in your project's PHPStan config:

includes:
    - vendor/php-standard-library/phpstan-extension/extension.neon