Download the PHP package psalm/plugin-symfony without Composer
On this page you can find all versions of the php package psalm/plugin-symfony. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package plugin-symfony
Symfony Psalm Plugin
Installation
Versions & Dependencies
| Symfony Psalm Plugin | PHP | Symfony | Psalm |
|---|---|---|---|
| 5.x | ^8.0 | 5, 6, 7 | 5 |
| 4.x | ^7.4, ^8.0 | 4, 5, 6 | 4 |
| 3.x | ^7.1, ^8.0 | 4, 5, 6 | 4 |
| 2.x | ^7.1, ^8.0 | 4, 5 | 4 |
| 1.x | ^7.1 | 3, 4, 5 | 3 |
Features
- Detects the
ContainerInterface::get()result type. Works better if you configure a compiled container XML file. - Detects parameter return types from
ContainerInterface::getParameter(). - Supports Service Subscribers. Works only if you configure a compiled container XML file.
- Detects return types from console arguments (
InputInterface::getArgument()) and options (InputInterface::getOption()). Enforces to use "InputArgument" and "InputOption" constants as a best practice. - Detects Doctrine repository classes associated to entities when configured via annotations.
- Fixes
PossiblyInvalidArgumentforSymfony\Component\HttpFoundation\Request::getContent(). The plugin determines the real return type by checking the given argument and marks it as either "string" or "resource". - Detects the return type of
Symfony\Component\HttpFoundation\HeaderBag::get()by checking the default value (third argument for < Symfony 4.4). - Detects the return types of
Symfony\Component\Messenger\Envelope::lastandSymfony\Component\Messenger\Envelope::all, based on the provided argument. - Taint analysis for Symfony.
- Detects services and parameters naming conventions violations.
- Complains when
Containeris injected in a service, and asks to use dependency-injection instead. - Fixes
PropertyNotSetInConstructorfalse positive issues:- $container in AbstractController
- $context in ConstraintValidator classes
- properties in custom
@Annotationclasses
- And much more!
Configuration
If you follow the installation instructions, the psalm-plugin command will add this plugin configuration to the psalm.xml configuration file.
To be able to detect return types of services using ID (generally starts with @ in Symfony YAML config files. Ex: logger service)
containerXml must be provided.
Example:
This file path may change based on your Symfony version, file structure and environment settings. Default files are:
- Symfony 3:
var/cache/dev/srcDevDebugProjectContainer.xml - Symfony 4:
var/cache/dev/srcApp_KernelDevDebugContainer.xml - Symfony 5+:
var/cache/dev/App_KernelDevDebugContainer.xml
Multiple container files can be configured. In this case, the first valid file is taken into account. If none of the given files is valid, a configuration exception is thrown. Example:
If you're using PHP config files for Symfony 5.3+, you also need this for auto-loading of Symfony\Config:
If you're using Symfony's env() or param() functions in your PHP config files, you also need this for auto-loading them:
If you're getting the following error
MissingFile - config/preload.php - Cannot find file ...var/cache/prod/App_KernelProdContainer.preload.php to include
...you can suppress it like this:
Symfony version
By default, the plugin uses the Kernel::MAJOR_VERSION constant to determine your version of Symfony. However, this
might not be accurate if you have Psalm installed globally. You can set the version explicitly using
the symfonyMajorVersion configuration option:
Twig tainting (experimental)
When it comes to taint analysis for Twig templates, there are currently two approaches:
- The first one is based on a specific file analyzer (
Psalm\SymfonyPsalmPlugin\Twig\TemplateFileAnalyzer) which leverages the Twig parser and visits the AST nodes. - The second one is based on the already compiled Twig templates, it only bridges calls from
Twig\Environment::renderto the actualdoRendermethod of the compiled template.
Twig Analyzer
This approach is more robust since it relies on the official Twig parser and node visitor mechanisms. For the moment, it is only able to detect simple tainted paths.
To leverage the real Twig file analyzer, you have to configure a checker for the .twig extension as follows:
See the currently supported cases.
Cache Analyzer
This approach is "dirtier", since it tries to connect the taints from the application code to the compiled PHP code representing a given template. It is theoretically able to detect more taints than the previous approach out-of-the-box, but it still lacks ways to handle inheritance and stuff like that.
To allow the analysis through the cached template files, you have to add the twigCachePath entry to the plugin configuration :
See the currently supported cases.
Credits
- Plugin created by @seferov
- @weirdan for codeception psalm module
All versions of plugin-symfony with dependencies
ext-simplexml Version *
symfony/framework-bundle Version ^5.0 || ^6.0 || ^7.0
vimeo/psalm Version ^5.16