Rule Levels
If you want to use PHPStan but your codebase isn’t up to speed with strong typing and PHPStan’s strict checks, you can currently choose from 11 levels (0 is the loosest and 10 is the strictest) by passing -l|--level to the analyse command.
vendor/bin/phpstan analyse -l 6 src testsThe default level is 0. Once you specify a configuration file, you also have to specify the level to run.
This feature enables incremental adoption of PHPStan checks. You can start using PHPStan with a lower rule level and increase it when you feel like it.
Baseline
To be able to run a higher level without fixing all the reported errors first, check out a feature called the baseline.
You can also use --level max as an alias for the highest level. This will ensure that you will always use the highest level when upgrading to new versions of PHPStan. [1]
Here’s a brief overview of what’s checked on each level. Levels are cumulative - for example running level 5 also gives you all the checks from levels 0-4.
- basic checks, unknown classes, unknown functions, unknown methods called on
$this, wrong number of arguments passed to those methods and functions, always undefined variables - possibly undefined variables, unknown magic methods and properties on classes with
__calland__get - unknown methods checked on all expressions (not just
$this), validating PHPDocs - return types, types assigned to properties
- basic dead code checking - always false
instanceofand other type checks, deadelsebranches, unreachable code after return; etc. - checking types of arguments passed to methods and functions
- report missing typehints
- report partially wrong union types - if you call a method that only exists on some types in a union type, level 7 starts to report that; other possibly incorrect situations
- report calling methods and accessing properties on nullable types
- be strict about explicit
mixedtype - the only allowed operation you can do with it is to pass it to anothermixed - (New in PHPStan 2.0) be even more strict about the
mixedtype - reports errors even for implicit mixed (missing type), not just explicit mixed
Want to go further? #
If the level 10 isn’t enough for you and you’re looking for even more strictness and type safety, here are some tips. You can use them even alongside lower rule levels.
Use phpstan-strict-rules extension. It configures PHPStan in a stricter way and offers additional rules that revolve around strictly and strongly typed code with no loose casting for those who want additional safety in extremely defensive programming.
Enable Bleeding Edge. It’s a preview of what’s coming in the next major release of PHPStan, but shipping in the current stable release. Bleeding edge users are often rewarded with a more capable analysis sooner than the rest. It can also come with performance improvements. If you enable bleeding edge, and adopt new PHPStan features continuously, you’re gonna have much less work to do when the next major version ships for everyone.
If you use a popular framework like Symfony, Doctrine or Laravel etc., make sure you install a corresponding extension. It will improve understanding of your code, and also comes with extra rules for correct usage.
Go through the extra configuration options for stricter analysis. Some of them are enabled when you install phpstan-strict-rules, but there are some extra options that aren’t part of any rule level, nor phpstan-strict-rules. A few examples:
checkUninitializedProperties: Report typed properties not set in constructorcheckBenevolentUnionTypes: Report wrong usage of unknown array keys, and other typesrememberPossiblyImpureFunctionValues: false: Do not remember return values of functions that are not marked as purereportPossiblyNonexistentGeneralArrayOffset: Make sure offset exists before accessing it on a general arrayreportPossiblyNonexistentConstantArrayOffset: Make sure offset exists before accessing it on an array shape- Bring your exceptions under control with
@throws
Please note that this can create a significant obstacle when upgrading to a newer version because you might have to fix a lot of code to bring the number of errors down to zero. ↩︎