Add extension to add additional constructors through code

raalderink · ondrejmirtes · commit b8ff8eaba8ee · 2023-04-19T12:41:46.000+02:00
diff --git a/src/Reflection/AdditionalConstructorsExtension.php b/src/Reflection/AdditionalConstructorsExtension.php
@@ -0,0 +1,29 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Reflection;
+
+/**
+ * This is the extension interface to implement if you want to dynamically
+ * mark methods as constructor. As opposed to simply list them in the configuration file.
+ *
+ * To register it in the configuration file use the `phpstan.additionalConstructorsExtension` service tag:
+ *
+ * ```
+ * services:
+ * 	-
+ *		class: App\PHPStan\MyExtension
+ *		tags:
+ *			- phpstan.additionalConstructorsExtension
+ * ```
+ *
+ * @api
+ */
+interface AdditionalConstructorsExtension
+{
+
+	public const EXTENSION_TAG = 'phpstan.additionalConstructorsExtension';
+
+	/** @return string[] */
+	public function getAdditionalConstructors(ClassReflection $classReflection): array;
+
+}
diff --git a/src/Reflection/ConstructorsHelper.php b/src/Reflection/ConstructorsHelper.php
@@ -2,6 +2,7 @@
 
 namespace PHPStan\Reflection;
 
+use PHPStan\DependencyInjection\Container;
 use ReflectionException;
 use function array_key_exists;
 use function explode;
@@ -16,6 +17,7 @@ final class ConstructorsHelper
 	 * @param list<string> $additionalConstructors
 	 */
 	public function __construct(
+		private Container $container,
 		private array $additionalConstructors,
 	)
 	{
@@ -34,6 +36,15 @@ public function getConstructors(ClassReflection $classReflection): array
 			$constructors[] = $classReflection->getConstructor()->getName();
 		}
 
+		/** @var AdditionalConstructorsExtension[] $extensions */
+		$extensions = $this->container->getServicesByTag(AdditionalConstructorsExtension::EXTENSION_TAG);
+		foreach ($extensions as $extension) {
+			$extensionConstructors = $extension->getAdditionalConstructors($classReflection);
+			foreach ($extensionConstructors as $extensionConstructor) {
+				$constructors[] = $extensionConstructor;
+			}
+		}
+
 		$nativeReflection = $classReflection->getNativeReflection();
 		foreach ($this->additionalConstructors as $additionalConstructor) {
 			[$className, $methodName] = explode('::', $additionalConstructor);
diff --git a/tests/PHPStan/Rules/Properties/MissingReadOnlyByPhpDocPropertyAssignRuleTest.php b/tests/PHPStan/Rules/Properties/MissingReadOnlyByPhpDocPropertyAssignRuleTest.php
@@ -18,9 +18,12 @@ class MissingReadOnlyByPhpDocPropertyAssignRuleTest extends RuleTestCase
 	protected function getRule(): Rule
 	{
 		return new MissingReadOnlyByPhpDocPropertyAssignRule(
-			new ConstructorsHelper([
-				'MissingReadOnlyPropertyAssignPhpDoc\\TestCase::setUp',
-			]),
+			new ConstructorsHelper(
+				self::getContainer(),
+				[
+					'MissingReadOnlyPropertyAssignPhpDoc\\TestCase::setUp',
+				],
+			),
 		);
 	}
 
diff --git a/tests/PHPStan/Rules/Properties/MissingReadOnlyPropertyAssignRuleTest.php b/tests/PHPStan/Rules/Properties/MissingReadOnlyPropertyAssignRuleTest.php
@@ -18,9 +18,12 @@ class MissingReadOnlyPropertyAssignRuleTest extends RuleTestCase
 	protected function getRule(): Rule
 	{
 		return new MissingReadOnlyPropertyAssignRule(
-			new ConstructorsHelper([
-				'MissingReadOnlyPropertyAssign\\TestCase::setUp',
-			]),
+			new ConstructorsHelper(
+				self::getContainer(),
+				[
+					'MissingReadOnlyPropertyAssign\\TestCase::setUp',
+				],
+			),
 		);
 	}
 
diff --git a/tests/PHPStan/Rules/Properties/ReadOnlyByPhpDocPropertyAssignRuleTest.php b/tests/PHPStan/Rules/Properties/ReadOnlyByPhpDocPropertyAssignRuleTest.php
@@ -18,6 +18,7 @@ protected function getRule(): Rule
 		return new ReadOnlyByPhpDocPropertyAssignRule(
 			new PropertyReflectionFinder(),
 			new ConstructorsHelper(
+				self::getContainer(),
 				[
 					'ReadonlyPropertyAssignPhpDoc\\TestCase::setUp',
 				],
diff --git a/tests/PHPStan/Rules/Properties/ReadOnlyPropertyAssignRuleTest.php b/tests/PHPStan/Rules/Properties/ReadOnlyPropertyAssignRuleTest.php
@@ -18,6 +18,7 @@ protected function getRule(): Rule
 		return new ReadOnlyPropertyAssignRule(
 			new PropertyReflectionFinder(),
 			new ConstructorsHelper(
+				self::getContainer(),
 				[
 					'ReadonlyPropertyAssign\\TestCase::setUp',
 				],
diff --git a/tests/PHPStan/Rules/Properties/UninitializedPropertyRuleTest.php b/tests/PHPStan/Rules/Properties/UninitializedPropertyRuleTest.php
@@ -17,6 +17,7 @@ protected function getRule(): Rule
 	{
 		return new UninitializedPropertyRule(
 			new ConstructorsHelper(
+				self::getContainer(),
 				[
 					'UninitializedProperty\\TestCase::setUp',
 				],
@@ -48,6 +49,13 @@ public function isInitialized(PropertyReflection $property, string $propertyName
 		];
 	}
 
+	public static function getAdditionalConfigFiles(): array
+	{
+		return [
+			__DIR__ . '/uninitialized-property-rule.neon',
+		];
+	}
+
 	public function testRule(): void
 	{
 		$this->analyse([__DIR__ . '/data/uninitialized-property.php'], [
@@ -113,4 +121,18 @@ public function testBug7219(): void
 		]);
 	}
 
+	public function testAdditionalConstructorsExtension(): void
+	{
+		$this->analyse([__DIR__ . '/data/uninitialized-property-additional-constructors.php'], [
+			[
+				'Class TestInitializedProperty\TestAdditionalConstructor has an uninitialized property $one. Give it default value or assign it in the constructor.',
+				07,
+			],
+			[
+				'Class TestInitializedProperty\TestAdditionalConstructor has an uninitialized property $three. Give it default value or assign it in the constructor.',
+				11,
+			],
+		]);
+	}
+
 }
diff --git a/tests/PHPStan/Rules/Properties/data/UninitializedPropertyAdditionalConstructorsExtensions.php b/tests/PHPStan/Rules/Properties/data/UninitializedPropertyAdditionalConstructorsExtensions.php
@@ -0,0 +1,20 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Properties;
+
+use PHPStan\Reflection\AdditionalConstructorsExtension;
+use PHPStan\Reflection\ClassReflection;
+
+class TestInitializedProperty implements AdditionalConstructorsExtension
+{
+
+	public function getAdditionalConstructors(ClassReflection $classReflection): array
+	{
+		if ($classReflection->getName() === 'TestInitializedProperty\\TestAdditionalConstructor') {
+			return ['setTwo'];
+		}
+
+		return [];
+	}
+
+}
diff --git a/tests/PHPStan/Rules/Properties/data/uninitialized-property-additional-constructors.php b/tests/PHPStan/Rules/Properties/data/uninitialized-property-additional-constructors.php
@@ -0,0 +1,22 @@
+<?php // lint >= 7.4
+
+namespace TestInitializedProperty;
+
+class TestAdditionalConstructor
+{
+	public string $one;
+
+	protected int $two;
+
+	protected int $three;
+
+	public function setTwo(int $value): void
+	{
+		$this->two = $value;
+	}
+
+	public function setThree(int $value): void
+	{
+		$this->three = $value;
+	}
+}
diff --git a/tests/PHPStan/Rules/Properties/uninitialized-property-rule.neon b/tests/PHPStan/Rules/Properties/uninitialized-property-rule.neon
@@ -0,0 +1,5 @@
+services:
+    -
+        class: PHPStan\Rules\Properties\TestInitializedProperty
+        tags:
+            - phpstan.additionalConstructorsExtension

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@ protected function getRule(): Rule`
`18`	`18`	`return new ReadOnlyByPhpDocPropertyAssignRule(`
`19`	`19`	`new PropertyReflectionFinder(),`
`20`	`20`	`new ConstructorsHelper(`
	`21`	`+ self::getContainer(),`
`21`	`22`	`[`
`22`	`23`	`'ReadonlyPropertyAssignPhpDoc\\TestCase::setUp',`
`23`	`24`	`],`