phpstan strict rules

Extra strenge und merkende Regeln für Phpstan

Phpstan konzentriert sich darauf, Fehler in Ihrem Code zu finden. Aber in PHP gibt es viel Spielraum darin, wie Sachen geschrieben werden können. Dieses Repository enthält zusätzliche Regeln, die sich streng und stark typisierten Code ohne lockeres Casting für diejenigen, die zusätzliche Sicherheit in extrem defensiver Programmierung wünschen:

• Erfordern Sie Booleans in if , elseif , ternärer Operator, danach ! und auf beiden Seiten von && und || .
• Erfordern Sie numerische Operanden oder Arrays in + und numerischen Operanden in - / * / / ** / % .
• Benötigen numerische Operand in $var++ , $var-- , ++$var und- --$var .
• Diese Funktionen enthalten einen $strict Parameter für eine bessere Sicherheitstypsicherheit. Er muss auf true festgelegt werden:
  • in_array (3. Parameter)
  • array_search (3. Parameter)
  • array_keys (3. Parameter; nur wenn der 2. Parameter $search_value bereitgestellt wird)
  • base64_decode (2. Parameter)
• Variablen, die while der Schleifenbedingung und for die Schleifenanfangszuweisung zugewiesen sind, können nach der Schleife nicht verwendet werden.
• Variablen, die nach der Schleife nicht verwendet werden können, dank nicht leerer Arrays können immer geschoben werden.
• Typen in switch -Zustand und case müssen übereinstimmen. PHP vergleicht sie standardmäßig lose und dies kann zu unerwarteten Ergebnissen führen.
• Überprüfen Sie, ob statisch deklarierte Methoden statisch aufgerufen werden.
• empty() - Es ist ein sehr lockerer Vergleich (siehe Handbuch), es wird empfohlen, strengere zu verwenden.
• Der kurze ternäre Operator ( ?: :) - impliziert einen schwachen Vergleich. Es wird empfohlen, den Null -Koales -Operator ( ?? ) oder den ternären Bediener mit strenger Bedingung zu verwenden.
• Variable Variablen nicht zulassen ( $$foo , $this->$method() usw.)
• Überschreiben Sie Variablen mit für den Taste und die Wertvariablen für den Eacher aus
• Immer wahre instanceof , Typ-Überprüfung is_* Funktionen und strenge Vergleiche === / !== . Diese Überprüfungen können ausgeschaltet werden, indem checkAlwaysTrueInstanceof / checkAlwaysTrueCheckTypeFunctionCall / Checkalways -for checkAlwaysTrueStrictComparison zu False festgelegt wird.
• Richtiger Fall für Referenz und Aufschluss als Funktionsnamen.
• Richtiger Fall für vererbte und implementierte Methodennamen.
• Kontravarianz für Parametertypen und Kovarianz für Rückkehrtypen in ererbten Methoden (auch als Liskov -Substitutionsprinzip bekannt - LSP)
• Überprüfen Sie LSP auch auf statische Methoden
• Erfordern Sie, übergeordnete Konstruktor aufzurufen
• Nutzung des Backtick -Operators nicht zulassen ( $ls = `ls -la` )
• Der Verschluss sollte $this direkt verwenden, anstatt $this variable indirekt zu verwenden

Weitere Regeln kommen in nachfolgenden Veröffentlichungen!

Installation

Um diese Erweiterung zu verwenden, benötigen Sie sie in Komponist:

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

Wenn Sie auch Phpstan/Extension-Installer installieren, sind Sie alle festgelegt!

Manuelle Installation

Wenn Sie phpstan/extension-installer nicht verwenden möchten, geben Sie Regeln ein. Neon in der Phpstan-Konfiguration Ihres Projekts:

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

Regeln deaktivieren

Sie können Regeln mithilfe von Konfigurationsparametern deaktivieren:

 parameters :
	strictRules :
		disallowedLooseComparison : false
		booleansInConditions : 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

Neben der Einführung neuer benutzerdefinierter Regeln ändern Phpstan-Strict-Rules auch die Standardwerte einiger Konfigurationsparameter, die in Phpstan selbst vorhanden sind. Diese Parameter sind auf phpstan.org dokumentiert.

Ermöglichen von Regeln eins von eins

Wenn Sie nicht alle verfügbaren strengen Regeln gleichzeitig verwenden möchten, sondern nur ein oder zwei, können Sie!

Sie können alle Regeln aus den enthaltenen rules.neon deaktivieren. Neon mit:

 parameters :
	strictRules :
		allRules : false

Anschließend können Sie einzelne Regeln mit Konfigurationsparametern erneut untersucht:

 parameters :
	strictRules :
		allRules : false
		booleansInConditions : true

Selbst bei strictRules.allRules false Dies liegt daran, dass Phpstan-Strict-Rules auch die Standardwerte einiger Konfigurationsparameter ändern, die in Phpstan selbst vorhanden sind. Diese Parameter sind auf phpstan.org dokumentiert.