Improve property access checking with property tag support

Author: kayw-geek

src/Rules/Properties/AccessPropertiesCheck.php

@@ -23,9 +23,11 @@
 use PHPStan\Type\StaticType;
 use PHPStan\Type\Type;
 use PHPStan\Type\VerbosityLevel;
+use function array_keys;
 use function array_map;
 use function array_merge;
 use function count;
+use function in_array;
 use function sprintf;
 
 #[AutowiredService]
@@ -125,9 +127,11 @@ private function processSingleProperty(Scope $scope, PropertyFetch $node, string
 				}
 			}
 
+			$propertyTags = [];
 			if (count($classNames) === 1) {
 				$propertyClassReflection = $this->reflectionProvider->getClass($classNames[0]);
 				$parentClassReflection = $propertyClassReflection->getParentClass();
+				$propertyTags = $propertyClassReflection->getPropertyTags();
 				while ($parentClassReflection !== null) {
 					if ($parentClassReflection->hasProperty($name)) {
 						if ($write) {
@@ -146,11 +150,15 @@ private function processSingleProperty(Scope $scope, PropertyFetch $node, string
 							))->identifier('property.private')->build(),
 						];
 					}
-
+					$propertyTags += $parentClassReflection->getPropertyTags();
 					$parentClassReflection = $parentClassReflection->getParentClass();
 				}
 			}
 
+			if (in_array($name, array_keys($propertyTags), true)) {
+				return [];
+			}
+
 			if ($node->name instanceof Expr) {
 				$propertyExistsExpr = new FuncCall(new FullyQualified('property_exists'), [
 					new Arg($node->var),

tests/PHPStan/Rules/Properties/AccessPropertiesRuleTest.php

@@ -1019,7 +1019,38 @@ public function testPropertyExists(): void
 		$this->checkThisOnly = false;
 		$this->checkUnionTypes = true;
 		$this->checkDynamicProperties = true;
-		$this->analyse([__DIR__ . '/data/property-exists.php'], []);
+		$this->analyse([__DIR__ . '/data/property-exists.php'], [
+			[
+				'Access to an undefined property PropertyExists\Model::$getCreatedByColumn.',
+				27,
+				'Learn more: <fg=cyan>https://phpstan.org/blog/solving-phpstan-access-to-undefined-property</>',
+			],
+			[
+				'Access to an undefined property PropertyExists\Model::$getUpdatedByColumn.',
+				27,
+				'Learn more: <fg=cyan>https://phpstan.org/blog/solving-phpstan-access-to-undefined-property</>',
+			],
+			[
+				'Access to an undefined property PropertyExists\Model::$getDeletedByColumn.',
+				27,
+				'Learn more: <fg=cyan>https://phpstan.org/blog/solving-phpstan-access-to-undefined-property</>',
+			],
+			[
+				'Access to an undefined property PropertyExists\Model::$getCreatedAtColumn.',
+				27,
+				'Learn more: <fg=cyan>https://phpstan.org/blog/solving-phpstan-access-to-undefined-property</>',
+			],
+			[
+				'Access to an undefined property PropertyExists\Model::$getUpdatedAtColumn.',
+				27,
+				'Learn more: <fg=cyan>https://phpstan.org/blog/solving-phpstan-access-to-undefined-property</>',
+			],
+			[
+				'Access to an undefined property PropertyExists\Model::$getDeletedAtColumn.',
+				27,
+				'Learn more: <fg=cyan>https://phpstan.org/blog/solving-phpstan-access-to-undefined-property</>',
+			],
+		]);
 	}
 
 }

tests/PHPStan/Rules/Properties/data/property-exists.php

@@ -2,16 +2,19 @@
 
 namespace PropertyExists;
 
+/**
+ * @property-read \stdClass $getCreator
+ */
 class Model
 {
-
 }
 
 class Defaults
 {
 	public function defaults(Model $model): void
 	{
 		$columns = [
+			'getCreator',
 			'getCreatedByColumn',
 			'getUpdatedByColumn',
 			'getDeletedByColumn',
@@ -21,9 +24,7 @@ public function defaults(Model $model): void
 		];
 
 		foreach ($columns as $column) {
-			if (property_exists($model, $column)) {
-				echo $model->{$column};
-			}
+            echo $model->{$column};
 		}
 	}
 }