Skip to content

README.md

Latest commit

 

History

History
118 lines (83 loc) · 4.41 KB

README.md

File metadata and controls

118 lines (83 loc) · 4.41 KB

Nette Framework class reflection extension for PHPStan

Build Latest Stable Version License

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

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)

Links checking (can be enabled separately by - see configuration):

  • Validate parameters passed to 'link()', 'lazyLink()', 'redirect()', 'redirectPermanent()', 'forward()', 'isLinkCurrent()' and 'canonicalize()' methods
  • Works for presenters, components and 'LinkGenerator' service
  • Checks if passed destination is valid and points to existing presenter, action or signal
  • Checks if passed link parameters are valid and match relevant 'action*()', 'render*()' or 'handle*()' method signature
  • Checks also links to sub-components of known types (createComponent*() method must exists)

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

Configuration

containerLoader

Container loader can be used to create instance of Nette application DI container.

Example:

parameters:
    nette:
        containerLoader: './containerLoader.php'

Example containerLoader.php:

<?php

return App\Bootstrap::boot()->createContainer();

applicationMapping

Application mapping is used to map presenter identfiers to classes in link checking.

Example:

parameters:
    nette:
        applicationMapping:
            *: App\Presenters\*\*Presenter

checkLinks

Link checking can be disabled/enabled by setting checkLinks parameter. It is enabled by default if bleedingEndge is enabled.

Either applicationMapping or containerLoader (for automatically loading mappings from PresenterFactory service in your app) must be set for link checking to work.

Example:

parameters:
    nette:
        checkLinks: true

If you use non-standard PresenterFactory this feature might not work because logic for mapping presenter name (e.g. MyModule:Homepage) to presenter class (e.g. \App\Presenters\MyModule\HomepagePresenter) and vice versa would work differently.

If you use containerLoader you might solve this by implementing method unformatPresenterClass in your custom PresenterFactory class. This method should return presenter name for given presenter class.

Or you can create custom implementation overriding PHPStan\Nette\PresenterResolver service and replace it in your PHPStan config:

services:
    nettePresenterResolver:
        class: MyCustom\PresenterResolver