Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/phpstan/phpstan-symfony
Symfony extension for PHPStan
https://github.com/phpstan/phpstan-symfony
php php7 phpstan static-analysis static-code-analysis symfony testing
Last synced: 3 days ago
JSON representation
Symfony extension for PHPStan
- Host: GitHub
- URL: https://github.com/phpstan/phpstan-symfony
- Owner: phpstan
- License: mit
- Created: 2018-05-14T10:59:05.000Z (over 6 years ago)
- Default Branch: 2.0.x
- Last Pushed: 2024-10-14T03:22:50.000Z (4 months ago)
- Last Synced: 2024-10-29T15:47:21.126Z (3 months ago)
- Topics: php, php7, phpstan, static-analysis, static-code-analysis, symfony, testing
- Language: PHP
- Size: 673 KB
- Stars: 708
- Watchers: 11
- Forks: 89
- Open Issues: 63
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PHPStan Symfony Framework extensions and rules
[](https://github.com/phpstan/phpstan-symfony/actions)
[](https://packagist.org/packages/phpstan/phpstan-symfony)
[](https://packagist.org/packages/phpstan/phpstan-symfony)
* [PHPStan](https://phpstan.org/)
This extension provides following features:
* Provides correct return type for `ContainerInterface::get()` and `::has()` methods.
* Provides correct return type for `Controller::get()` and `::has()` methods.
* Provides correct return type for `AbstractController::get()` and `::has()` methods.
* Provides correct return type for `ContainerInterface::getParameter()` and `::hasParameter()` methods.
* Provides correct return type for `ParameterBagInterface::get()` and `::has()` methods.
* Provides correct return type for `Controller::getParameter()` method.
* Provides correct return type for `AbstractController::getParameter()` method.
* Provides correct return type for `Request::getContent()` method based on the `$asResource` parameter.
* Provides correct return type for `HeaderBag::get()` method based on the `$first` parameter.
* Provides correct return type for `Envelope::all()` method based on the `$stampFqcn` parameter.
* Provides correct return type for `InputBag::get()` method based on the `$default` parameter.
* Provides correct return type for `InputBag::all()` method based on the `$key` parameter.
* Provides correct return types for `TreeBuilder` and `NodeDefinition` objects.
* Notifies you when you try to get an unregistered service from the container.
* Notifies you when you try to get a private service from the container.
* Optionally correct return types for `InputInterface::getArgument()`, `::getOption`, `::hasArgument`, and `::hasOption`.
## Installation
To use this extension, require it in [Composer](https://getcomposer.org/):
```
composer require --dev phpstan/phpstan-symfony
```
If you also install [phpstan/extension-installer](https://github.com/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-symfony/extension.neon
```
To perform framework-specific checks, include also this file:
```
includes:
- vendor/phpstan/phpstan-symfony/rules.neon
```
# Configuration
You have to provide a path to `srcDevDebugProjectContainer.xml` or similar XML file describing your container.
```yaml
parameters:
symfony:
containerXmlPath: var/cache/dev/srcDevDebugProjectContainer.xml
# or with Symfony 4.2+
containerXmlPath: var/cache/dev/srcApp_KernelDevDebugContainer.xml
# or with Symfony 5+
containerXmlPath: var/cache/dev/App_KernelDevDebugContainer.xml
# If you're using PHP config files for Symfony 5.3+, you also need this for auto-loading of `Symfony\Config`:
scanDirectories:
- var/cache/dev/Symfony/Config
# If you're using PHP config files (including the ones under packages/*.php) for Symfony 5.3+,
# you need this to load the helper functions (i.e. service(), env()):
scanFiles:
- vendor/symfony/dependency-injection/Loader/Configurator/ContainerConfigurator.php
```
## Constant hassers
Sometimes, when you are dealing with optional dependencies, the `::has()` methods can cause problems. For example, the following construct would complain that the condition is always either on or off, depending on whether you have the dependency for `service` installed:
```php
if ($this->has('service')) {
// ...
}
```
In that case, you can disable the `::has()` method return type resolving like this:
```
parameters:
symfony:
constantHassers: false
```
Be aware that it may hide genuine errors in your application.
## Analysis of Symfony Console Commands
You can opt in for more advanced analysis of [Symfony Console Commands](https://symfony.com/doc/current/console.html)
by providing the console application from your own application. This will allow the correct argument and option types to be inferred when accessing `$input->getArgument()` or `$input->getOption()`.
```neon
parameters:
symfony:
consoleApplicationLoader: tests/console-application.php
```
Symfony 4:
```php
// tests/console-application.php
use App\Kernel;
use Symfony\Bundle\FrameworkBundle\Console\Application;
require __DIR__ . '/../config/bootstrap.php';
$kernel = new Kernel($_SERVER['APP_ENV'], (bool) $_SERVER['APP_DEBUG']);
return new Application($kernel);
```
Symfony 5:
```php
// tests/console-application.php
use App\Kernel;
use Symfony\Bundle\FrameworkBundle\Console\Application;
use Symfony\Component\Dotenv\Dotenv;
require __DIR__ . '/../vendor/autoload.php';
(new Dotenv())->bootEnv(__DIR__ . '/../.env');
$kernel = new Kernel($_SERVER['APP_ENV'], (bool) $_SERVER['APP_DEBUG']);
return new Application($kernel);
```
[Single Command Application](https://symfony.com/doc/current/components/console/single_command_tool.html):
```php
// tests/console-application.php
use App\Application; // where Application extends Symfony\Component\Console\SingleCommandApplication
use Symfony\Component\Console;
require __DIR__ . '/../vendor/autoload.php';
$application = new Console\Application();
$application->add(new Application());
return $application;
```
You may then encounter an error with PhpParser:
> Compile Error: Cannot Declare interface PhpParser\NodeVisitor, because the name is already in use
If this is the case, you should create a new environment for your application that will disable inlining. In `config/packages/phpstan_env/parameters.yaml`:
```yaml
parameters:
container.dumper.inline_class_loader: false
```
Call the new env in your `console-application.php`:
```php
$kernel = new \App\Kernel('phpstan_env', (bool) $_SERVER['APP_DEBUG']);
```