MissingClassConstantTypehintRule

Author: ondrejmirtes

conf/config.level6.neon

@@ -8,6 +8,7 @@ parameters:
 	checkMissingTypehints: true
 
 rules:
+	- PHPStan\Rules\Constants\MissingClassConstantTypehintRule
 	- PHPStan\Rules\Functions\MissingFunctionParameterTypehintRule
 	- PHPStan\Rules\Functions\MissingFunctionReturnTypehintRule
 	- PHPStan\Rules\Methods\MissingMethodParameterTypehintRule

src/Rules/Constants/MissingClassConstantTypehintRule.php

@@ -0,0 +1,88 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Constants;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\ClassReflection;
+use PHPStan\Rules\MissingTypehintCheck;
+use PHPStan\Rules\RuleError;
+use PHPStan\Rules\RuleErrorBuilder;
+use PHPStan\Type\VerbosityLevel;
+
+/**
+ * @implements \PHPStan\Rules\Rule<Node\Stmt\ClassConst>
+ */
+final class MissingClassConstantTypehintRule implements \PHPStan\Rules\Rule
+{
+
+	private \PHPStan\Rules\MissingTypehintCheck $missingTypehintCheck;
+
+	public function __construct(MissingTypehintCheck $missingTypehintCheck)
+	{
+		$this->missingTypehintCheck = $missingTypehintCheck;
+	}
+
+	public function getNodeType(): string
+	{
+		return Node\Stmt\ClassConst::class;
+	}
+
+	public function processNode(Node $node, Scope $scope): array
+	{
+		if (!$scope->isInClass()) {
+			throw new \PHPStan\ShouldNotHappenException();
+		}
+
+		$errors = [];
+		foreach ($node->consts as $const) {
+			$constantName = $const->name->toString();
+			$errors = array_merge($errors, $this->processSingleConstant($scope->getClassReflection(), $constantName));
+		}
+
+		return $errors;
+	}
+
+	/**
+	 * @param string $constantName
+	 * @return RuleError[]
+	 */
+	private function processSingleConstant(ClassReflection $classReflection, string $constantName): array
+	{
+		$constantReflection = $classReflection->getConstant($constantName);
+		$constantType = $constantReflection->getValueType();
+
+		$errors = [];
+		foreach ($this->missingTypehintCheck->getIterableTypesWithMissingValueTypehint($constantType) as $iterableType) {
+			$iterableTypeDescription = $iterableType->describe(VerbosityLevel::typeOnly());
+			$errors[] = RuleErrorBuilder::message(sprintf(
+				'Constant %s::%s type has no value type specified in iterable type %s.',
+				$constantReflection->getDeclaringClass()->getDisplayName(),
+				$constantName,
+				$iterableTypeDescription
+			))->tip(MissingTypehintCheck::TURN_OFF_MISSING_ITERABLE_VALUE_TYPE_TIP)->build();
+		}
+
+		foreach ($this->missingTypehintCheck->getNonGenericObjectTypesWithGenericClass($constantType) as [$name, $genericTypeNames]) {
+			$errors[] = RuleErrorBuilder::message(sprintf(
+				'Constant %s::%s with generic %s does not specify its types: %s',
+				$constantReflection->getDeclaringClass()->getDisplayName(),
+				$constantName,
+				$name,
+				implode(', ', $genericTypeNames)
+			))->tip(MissingTypehintCheck::TURN_OFF_NON_GENERIC_CHECK_TIP)->build();
+		}
+
+		foreach ($this->missingTypehintCheck->getCallablesWithMissingSignature($constantType) as $callableType) {
+			$errors[] = RuleErrorBuilder::message(sprintf(
+				'Constant %s::%s type has no signature specified for %s.',
+				$constantReflection->getDeclaringClass()->getDisplayName(),
+				$constantName,
+				$callableType->describe(VerbosityLevel::typeOnly())
+			))->build();
+		}
+
+		return $errors;
+	}
+
+}

tests/PHPStan/Rules/Constants/MissingClassConstantTypehintRuleTest.php

@@ -0,0 +1,40 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Constants;
+
+use PHPStan\Rules\MissingTypehintCheck;
+use PHPStan\Testing\RuleTestCase;
+
+/**
+ * @extends RuleTestCase<MissingClassConstantTypehintRule>
+ */
+class MissingClassConstantTypehintRuleTest extends RuleTestCase
+{
+
+	protected function getRule(): \PHPStan\Rules\Rule
+	{
+		$reflectionProvider = $this->createReflectionProvider();
+		return new MissingClassConstantTypehintRule(new MissingTypehintCheck($reflectionProvider, true, true, true));
+	}
+
+	public function testRule(): void
+	{
+		$this->analyse([__DIR__ . '/data/missing-class-constant-typehint.php'], [
+			[
+				'Constant MissingClassConstantTypehint\Foo::BAR type has no value type specified in iterable type array.',
+				11,
+				'See: https://phpstan.org/blog/solving-phpstan-no-value-type-specified-in-iterable-type',
+			],
+			[
+				'Constant MissingClassConstantTypehint\Foo::BAZ with generic class MissingClassConstantTypehint\Bar does not specify its types: T',
+				17,
+				'You can turn this off by setting <fg=cyan>checkGenericClassInNonGenericObjectType: false</> in your <fg=cyan>%configurationFile%</>.',
+			],
+			[
+				'Constant MissingClassConstantTypehint\Foo::LOREM type has no signature specified for callable.',
+				20,
+			],
+		]);
+	}
+
+}

tests/PHPStan/Rules/Constants/data/missing-class-constant-typehint.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace MissingClassConstantTypehint;
+
+class Foo
+{
+
+	private const FOO = '1';
+
+	/** @var array */
+	private const BAR = [];
+
+	/** @var mixed[] */
+	private const BARR = [];
+
+	/** @var Bar */
+	private const BAZ = 1;
+
+	/** @var callable */
+	private const LOREM = 1;
+
+}
+
+/** @template T */
+class Bar
+{
+
+}