phpstan/phpstan-nette

Nette Framework class reflection extension for PHPStan

2.0.0 2024-10-26 16:03 UTC

Requires

• php: ^7.4 || ^8.0
• phpstan/phpstan: ^2.0

Requires (Dev)

• nette/application: ^3.0
• nette/di: ^3.1.10
• nette/forms: ^3.0
• nette/utils: ^2.3.0 || ^3.0.0
• php-parallel-lint/php-parallel-lint: ^1.2
• phpstan/phpstan-phpunit: ^2.0
• phpstan/phpstan-strict-rules: ^2.0
• phpunit/phpunit: ^9.6

Conflicts

• nette/application: <2.3.0
• nette/component-model: <2.3.0
• nette/di: <2.3.0
• nette/forms: <2.3.0
• nette/http: <2.3.0
• nette/utils: <2.3.0

MIT

README

• PHPStan
• Nette Framework

This extension provides following features:

• Nette\ComponentModel\Container::getComponent() knows type of the component because it reads the return type on createComponent* (this works best in presenters and controls)
• Nette\DI\Container::getByType and createInstance return type based on first parameter (Foo::class).
• Nette\Forms\Container::getValues return type based on $asArray parameter.
• Nette\ComponentModel\Component::lookup return type based on $throw parameter.
• Nette\Application\UI\Component::getPresenter return type based on $throw parameter.
• Dynamic methods of Nette\Utils\Html
• Magic Nette\Object and Nette\SmartObject properties
• Event listeners through the on* properties
• Defines early terminating method calls for Presenter methods to prevent Undefined variable errors
• Understand the exact array shape coming from Nette\Utils\Strings::match() and Nette\Utils\Strings::matchAll() based on pattern

It also contains these framework-specific rules (can be enabled separately):

• Do not extend Nette\Object, use Nette\SmartObject trait instead
• Rethrow exceptions that are always meant to be rethrown (like AbortException)

Installation

To use this extension, require it in Composer:

composer require --dev phpstan/phpstan-nette

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/phpstan/phpstan-nette/extension.neon

To perform framework-specific checks, include also this file:

    - vendor/phpstan/phpstan-nette/rules.neon