This project provides a composer package with rules for phpstan/phpstan.

Run

composer require --dev ergebnis/phpstan-rules

All of the rules provided (and used) by this library are included in rules.neon.

When you are using phpstan/extension-installer, rules.neon will be automatically included.

Otherwise you need to include rules.neon in your phpstan.neon:

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

💡 You probably want to use these rules on top of the rules provided by:

• phpstan/phpstan
• phpstan/phpstan-deprecation-rules
• phpstan/phpstan-strict-rules

This package provides the following rules for use with phpstan/phpstan:

• Ergebnis\PHPStan\Rules\Classes\FinalRule
• Ergebnis\PHPStan\Rules\Classes\NoExtendsRule
• Ergebnis\PHPStan\Rules\Classes\PHPUnit\Framework\TestCaseWithSuffixRule
• Ergebnis\PHPStan\Rules\Closures\NoNullableReturnTypeDeclarationRule
• Ergebnis\PHPStan\Rules\Closures\NoParameterWithNullableTypeDeclarationRule
• Ergebnis\PHPStan\Rules\Closures\NoParameterWithNullDefaultValueRule
• Ergebnis\PHPStan\Rules\Expressions\NoCompactRule
• Ergebnis\PHPStan\Rules\Expressions\NoErrorSuppressionRule
• Ergebnis\PHPStan\Rules\Expressions\NoEvalRule
• Ergebnis\PHPStan\Rules\Expressions\NoIssetRule
• Ergebnis\PHPStan\Rules\Files\DeclareStrictTypesRule
• Ergebnis\PHPStan\Rules\Functions\NoNullableReturnTypeDeclarationRule
• Ergebnis\PHPStan\Rules\Functions\NoParameterWithNullableTypeDeclaration
• Ergebnis\PHPStan\Rules\Functions\NoParameterWithNullDefaultValueRule
• Ergebnis\PHPStan\Rules\Methods\FinalInAbstractClassRule
• Ergebnis\PHPStan\Rules\Methods\NoConstructorParameterWithDefaultValueRule
• Ergebnis\PHPStan\Rules\Methods\NoNullableReturnTypeDeclarationRule
• Ergebnis\PHPStan\Rules\Methods\NoParameterWithContainerTypeDeclarationRule
• Ergebnis\PHPStan\Rules\Methods\NoParameterWithNullableTypeDeclarationRule
• Ergebnis\PHPStan\Rules\Methods\NoParameterWithNullDefaultValueRule
• Ergebnis\PHPStan\Rules\Methods\PrivateInFinalClassRule
• Ergebnis\PHPStan\Rules\Statements\NoSwitchRule

This rule reports an error when a non-anonymous class is not final.

💡 This rule ignores classes that

• use @Entity, @ORM\Entity, or @ORM\Mapping\Entity annotations
• use Doctrine\ORM\Mapping\Entity attributes

on the class level.

You can set the the enabled parameter to false to disable this rule.

parameters:
	ergebnis:
		final:
			enabled: false

By default, this rule allows to declare abstract classes.

You can set the allowAbstractClasses parameter to false to disallow abstract classes.

parameters:
	ergebnis:
		final:
			allowAbstractClasses: false

You can set the classesNotRequiredToBeAbstractOrFinal parameter to a list of class names that you want to exclude from inspection.

parameters:
	ergebnis:
		final:
			classesNotRequiredToBeAbstractOrFinal:
				- Foo\Bar\NeitherAbstractNorFinal
				- Bar\Baz\NeitherAbstractNorFinal

This rule reports an error when a class extends another class.

By default, this rule allows the following classes to be extended:

• PHPUnit\Framework\TestCase

You can set the the enabled parameter to false to disable this rule.

parameters:
	ergebnis:
		noExtends:
			enabled: false

You can set the classesAllowedToBeExtended parameter to a list of class names that you want to allow to be extended.

parameters:
	ergebnis:
		noExtends:
			classesAllowedToBeExtended:
				- Ergebnis\PHPStan\Rules\Test\Integration\AbstractTestCase
				- Ergebnis\PHPStan\Rules\Test\Integration\AbstractTestCase

This rule reports an error when a concrete class is a sub-class of PHPUnit\Framework\TestCase but does not have a Test suffix.

You can set the the enabled parameter to false to disable this rule.

parameters:
	ergebnis:
		testCaseWithSuffix:
			enabled: false

This rule reports an error when a closure uses a nullable return type declaration.

You can set the the enabled parameter to false to disable this rule.

parameters:
	ergebnis:
		noNullableReturnTypeDeclaration:
			enabled: false

This rule reports an error when a closure has a parameter with a nullable type declaration.

You can set the the enabled parameter to false to disable this rule.

parameters:
	ergebnis:
		noParameterWithNullableTypeDeclaration:
			enabled: false

This rule reports an error when a closure has a parameter with null as default value.

You can set the the enabled parameter to false to disable this rule.

parameters:
	ergebnis:
		noParameterWithNullDefaultValue:
			enabled: false

This rule reports an error when the function compact() is used.

You can set the the enabled parameter to false to disable this rule.

parameters:
	ergebnis:
		noCompact:
			enabled: false

This rule reports an error when the language construct eval() is used.

You can set the the enabled parameter to false to disable this rule.

parameters:
	ergebnis:
		noEval:
			enabled: false

This rule reports an error when @ is used to suppress errors.

You can set the the enabled parameter to false to disable this rule.

parameters:
	ergebnis:
		noErrorSuppression:
			enabled: false

This rule reports an error when the language construct isset() is used.

You can set the the enabled parameter to false to disable this rule.

parameters:
	ergebnis:
		noIsset:
			enabled: false

This rule reports an error when a non-empty file does not contain a declare(strict_types=1) declaration.

You can set the the enabled parameter to false to disable this rule.

parameters:
	ergebnis:
		declareStrictTypes:
			enabled: false

This rule reports an error when a function uses a nullable return type declaration.

You can set the the enabled parameter to false to disable this rule.

parameters:
	ergebnis:
		noNullableReturnTypeDeclaration:
			enabled: false

This rule reports an error when a function has a parameter with a nullable type declaration.

You can set the the enabled parameter to false to disable this rule.

parameters:
	ergebnis:
		noParameterWithNullableTypeDeclaration:
			enabled: false

This rule reports an error when a function has a parameter with null as default value.

You can set the the enabled parameter to false to disable this rule.

parameters:
	ergebnis:
		noParameterWithNullDefaultValue:
			enabled: false

This rule reports an error when a concrete public or protected method in an abstract class is not final.

You can set the the enabled parameter to false to disable this rule.

parameters:
	ergebnis:
		finalInAbstractClass:
			enabled: false

This rule reports an error when a constructor declared in

• an anonymous class
• a class

has a default value.

You can set the the enabled parameter to false to disable this rule.

parameters:
	ergebnis:
		noConstructorParameterWithDefaultValue:
			enabled: false

This rule reports an error when a method declared in

• an anonymous class
• a class
• an interface

uses a nullable return type declaration.

You can set the the enabled parameter to false to disable this rule.

parameters:
	ergebnis:
		noNullableReturnTypeDeclaration:
			enabled: false

This rule reports an error when a method has a type declaration for a known dependency injection container or service locator.

By default, this rule disallows the use of type declarations indicating an implementation of

• Psr\Container\ContainerInterface

is expected to be injected into a method.

You can set the the enabled parameter to false to disable this rule.

parameters:
	ergebnis:
		noParameterWithContainerTypeDeclaration:
			enabled: false

You can set the interfacesImplementedByContainers parameter to a list of interface names of additional containers and service locators.

parameters:
	ergebnis:
		noParameterWithContainerTypeDeclaration:
			interfacesImplementedByContainers:
				- Fancy\DependencyInjection\ContainerInterface
				- Other\ServiceLocatorInterface

You can set the methodsAllowedToUseContainerTypeDeclarations parameter to a list of method names that are allowed to use parameters with container type declarations.

parameters:
	ergebnis:
		noParameterWithContainerTypeDeclaration:
			methodsAllowedToUseContainerTypeDeclarations:
				- loadExtension

This rule reports an error when a method declared in

• an anonymous class
• a class
• an interface

has a parameter with a nullable type declaration.

You can set the the enabled parameter to false to disable this rule.

parameters:
	ergebnis:
		noParameterWithNullableTypeDeclaration:
			enabled: false

This rule reports an error when a method declared in

• an anonymous class
• a class
• an interface

has a parameter with null as default value.

You can set the the enabled parameter to false to disable this rule.

parameters:
	ergebnis:
		noParameterWithNullDefaultValue:
			enabled: false

This rule reports an error when a method in a final class is protected but could be private.

You can set the the enabled parameter to false to disable this rule.

parameters:
	ergebnis:
		privateInFinalClass:
			enabled: false

This rule reports an error when the statement switch() is used.

You can set the the enabled parameter to false to disable this rule.

parameters:
	ergebnis:
		noSwitch:
			enabled: false

The maintainers of this project record notable changes to this project in a changelog.

The maintainers of this project suggest following the contribution guide.

The maintainers of this project ask contributors to follow the code of conduct.

The maintainers of this project provide limited support.

You can support the maintenance of this project by sponsoring @localheinz or requesting an invoice for services related to this project.

This project supports PHP versions with active and security support.

The maintainers of this project add support for a PHP version following its initial release and drop support for a PHP version when it has reached the end of security support.

This project has a security policy.

This project uses the MIT license.

The method FinalRule::isWhitelistedClass() is inspired by the work on FinalClassFixer and FinalInternalClassFixer, contributed by Dariusz Rumiński, Filippo Tessarotto, and Spacepossum for friendsofphp/php-cs-fixer (originally licensed under MIT).

Follow @localheinz and @ergebnis on Twitter.