包简介

Extra strict and opinionated rules for PHPStan

README 文档

README

PHPStan focuses on finding bugs in your code. But in PHP there's a lot of leeway in how stuff can be written. This repository contains additional rules that revolve around strictly and strongly typed code with no loose casting for those who want additional safety in extremely defensive programming:

Configuration Parameters	Rule Description
`booleansInConditions`	Require booleans in `if`, `elseif`, ternary operator, after `!`, and on both sides of `&&` and `\|\|`.
`booleansInLoopConditions`	Require booleans in `while` and `do while` loop conditions.
`uselessCast`	Detect useless casts — e.g. casting to `int` when the expression is already `int`.
`numericOperandsInArithmeticOperators`	Require numeric operands in `+`, `-`, ``, `/`, `%`, `*`, `+$var`, `-$var`, `$var++`, `$var--`, `++$var` and `--$var`.
`strictFunctionCalls`	These functions contain a `$strict` parameter for better type safety, it must be set to `true`: * `in_array` (3rd parameter) * `array_search` (3rd parameter) * `array_keys` (3rd parameter; only if the 2nd parameter `$search_value` is provided) * `base64_decode` (2nd parameter).
`overwriteVariablesWithLoop`	* Disallow overwriting variables with `foreach` key and value variables. * Disallow overwriting variables with `for` loop initial assignment.
`switchConditionsMatchingType`	Types in `switch` condition and `case` value must match. PHP compares them loosely by default and that can lead to unexpected results.
`dynamicCallOnStaticMethod`	Check that statically declared methods are called statically.
`disallowedEmpty`	Disallow `empty()` - it's a very loose comparison (see manual), it's recommended to use more strict one.
`disallowedLooseComparison`	Disallow loose comparison via `==` and `!=`.
`disallowedShortTernary`	Disallow short ternary operator (`?:`) - implies weak comparison, it's recommended to use null coalesce operator (`??`) or ternary operator with strict condition.
`noVariableVariables`	Disallow variable variables (`$$foo`, `$this->$method()` etc.).
`checkAlwaysTrueInstanceof`, `checkAlwaysTrueCheckTypeFunctionCall`, `checkAlwaysTrueStrictComparison`	Always true `instanceof`, type-checking `is_*` functions and strict comparisons `===`/`!==`. These checks can be turned off by setting `checkAlwaysTrueInstanceof`, `checkAlwaysTrueCheckTypeFunctionCall` and `checkAlwaysTrueStrictComparison` to false.
	Correct case for referenced and called function names.
`matchingInheritedMethodNames`	Correct case for inherited and implemented method names.
	Contravariance for parameter types and covariance for return types in inherited methods (also known as Liskov substitution principle - LSP).
	Check LSP even for static methods.
`requireParentConstructorCall`	Require calling parent constructor.
`disallowedBacktick`	Disallow usage of backtick operator ($ls = `ls -la`).
`disallowedImplicitArrayCreation`	Disallow implicit array creation through `$var[] =` when the variable does not exist yet.
`strictArrayFilter`	Require `array_filter()` to have a callback parameter to avoid loose comparison semantics.
`illegalConstructorMethodCall`	Disallow calling `__construct()` on an existing object or as a static call outside of parent constructor.
`closureUsesThis`	Closure should use `$this` directly instead of using `$this` variable indirectly.

Additional rules are coming in subsequent releases!

Installation

To use this extension, require it in Composer:

composer require --dev phpstan/phpstan-strict-rules

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 rules.neon in your project's PHPStan config:

includes:
    - vendor/phpstan/phpstan-strict-rules/rules.neon

Disabling rules

You can disable rules using configuration parameters:

parameters:
	strictRules:
		disallowedLooseComparison: false
		booleansInConditions: false
		booleansInLoopConditions: false
		uselessCast: false
		requireParentConstructorCall: false
		disallowedBacktick: false
		disallowedEmpty: false
		disallowedImplicitArrayCreation: false
		disallowedShortTernary: false
		overwriteVariablesWithLoop: false
		closureUsesThis: false
		matchingInheritedMethodNames: false
		numericOperandsInArithmeticOperators: false
		strictFunctionCalls: false
		dynamicCallOnStaticMethod: false
		switchConditionsMatchingType: false
		noVariableVariables: false
		strictArrayFilter: false
		illegalConstructorMethodCall: false

Aside from introducing new custom rules, phpstan-strict-rules also change the default values of some configuration parameters that are present in PHPStan itself. These parameters are documented on phpstan.org.

Enabling rules one-by-one

If you don't want to start using all the available strict rules at once but only one or two, you can!

You can disable all rules from the included rules.neon with:

parameters:
	strictRules:
		allRules: false

Then you can re-enable individual rules with configuration parameters:

parameters:
	strictRules:
		allRules: false
		booleansInConditions: true

Even with strictRules.allRules set to false, part of this package is still in effect. That's because phpstan-strict-rules also change the default values of some configuration parameters that are present in PHPStan itself. These parameters are documented on phpstan.org.

phpstan/phpstan-strict-rules 适用场景与选型建议

phpstan/phpstan-strict-rules 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 68.51M 次下载、GitHub Stars 达 699，最近一次更新时间为 2017 年 11 月 11 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「static analysis」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 phpstan/phpstan-strict-rules 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 phpstan/phpstan-strict-rules 我们能提供哪些服务？

定制开发 / 二次开发

基于 phpstan/phpstan-strict-rules 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

与 phpstan/phpstan-strict-rules 相关的其它包

同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：

bookdown/themes 11

Bookdown.io With Bootswatch Styles And Prism Syntax Highlighting

twigstan/twigstan 276

TwigStan is a static analyzer for Twig templates powered by PHPStan

truesocialmetrics/sentiment-analysis 1

Sentiment analysis library for PHP.

itpathsolutions/dbstan 44

Database Standardization and Analysis Tool for Laravel

shipmonk/modulint 0

Enforce architecture by defining modules with allowed dependencies. Detects forbidden, uncovered, missing and unused module dependencies in PHP projects.

mvc5/facade 0

Arc5 provides a set of static classes for the Mvc5 Framework

phpstan/phpstan-strict-rules

包简介

关键字：