Merge pull request #17 from swissspidy/fix/use-rule-error-builder

swissspidy · Jun 5, 2024 · 86d67c9 · 86d67c9
2 parents 3608dca + 0909bdf
commit 86d67c9
Show file tree

Hide file tree

Showing 5 changed files with 66 additions and 32 deletions.
diff --git a/src/Rules/NoPrivate/CallToPrivateFunctionRule.php b/src/Rules/NoPrivate/CallToPrivateFunctionRule.php
@@ -9,6 +9,7 @@
 use PHPStan\Broker\FunctionNotFoundException;
 use PHPStan\Reflection\ReflectionProvider;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\Type\FileTypeMapper;
 use function sprintf;
 
@@ -66,10 +67,13 @@ public function processNode(Node $node, Scope $scope): array
 			return [];
 		}
 
-		return [sprintf(
-			'Call to private/internal function %s().',
-			$function->getName()
-		)];
+		return [
+			RuleErrorBuilder::message(
+				sprintf('Call to private/internal function %s().', $function->getName())
+			)
+	            ->identifier('no.private.function')
+	            ->build()
+		];
 	}
 
 }
diff --git a/src/Rules/NoPrivate/CallToPrivateMethodRule.php b/src/Rules/NoPrivate/CallToPrivateMethodRule.php
@@ -10,6 +10,7 @@
 use PHPStan\Reflection\MissingMethodFromReflectionException;
 use PHPStan\Reflection\ReflectionProvider;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\Type\FileTypeMapper;
 use function sprintf;
 
@@ -81,11 +82,17 @@ public function processNode(Node $node, Scope $scope): array
 					continue;
 				}
 
-				return [sprintf(
-					'Call to private/internal method %s() of class %s.',
-					$methodReflection->getName(),
-					$methodReflection->getDeclaringClass()->getName()
-				)];
+				return [
+					RuleErrorBuilder::message(
+						sprintf(
+							'Call to private/internal method %s() of class %s.',
+							$methodReflection->getName(),
+							$methodReflection->getDeclaringClass()->getName()
+						)
+					)
+		                ->identifier('no.private.method')
+		                ->build()
+				];
 			} catch (ClassNotFoundException $e) {
 				// Other rules will notify if the class is not found
 			} catch (MissingMethodFromReflectionException $e) {

diff --git a/src/Rules/NoPrivate/CallToPrivateStaticMethodRule.php b/src/Rules/NoPrivate/CallToPrivateStaticMethodRule.php
@@ -11,6 +11,7 @@
 use PHPStan\Reflection\MissingMethodFromReflectionException;
 use PHPStan\Reflection\ReflectionProvider;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\Rules\RuleLevelHelper;
 use PHPStan\Type\ErrorType;
 use PHPStan\Type\FileTypeMapper;
@@ -90,11 +91,15 @@ static function (Type $type) use ($methodName): bool {
 
 			$resolvedPhpDoc = $class->getResolvedPhpDoc();
 			if ($resolvedPhpDoc && PrivateAnnotationHelper::isPrivate($resolvedPhpDoc)) {
-				$errors[] = sprintf(
-					'Call to method %s() of private/internal class %s.',
-					$methodReflection->getName(),
-					$methodReflection->getDeclaringClass()->getName()
-				);
+				$errors[] = RuleErrorBuilder::message(
+					sprintf(
+						'Call to method %s() of private/internal class %s.',
+						$methodReflection->getName(),
+						$methodReflection->getDeclaringClass()->getName()
+					)
+				)
+	                ->identifier('no.private.method')
+	                ->build();
 				continue;
 			}
 
@@ -124,11 +129,15 @@ static function (Type $type) use ($methodName): bool {
 				continue;
 			}
 
-			$errors[] = sprintf(
-				'Call to private/internal method %s() of class %s.',
-				$methodReflection->getName(),
-				$methodReflection->getDeclaringClass()->getName()
-			);
+			$errors[] = RuleErrorBuilder::message(
+				sprintf(
+					'Call to private/internal method %s() of class %s.',
+					$methodReflection->getName(),
+					$methodReflection->getDeclaringClass()->getName()
+				)
+			)
+                ->identifier('no.private.method')
+                ->build();
 		}
 
 		return $errors;

diff --git a/src/Rules/NoPrivate/InheritanceOfPrivateClassRule.php b/src/Rules/NoPrivate/InheritanceOfPrivateClassRule.php
@@ -8,6 +8,7 @@
 use PHPStan\Broker\ClassNotFoundException;
 use PHPStan\Reflection\ReflectionProvider;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
 use function sprintf;
 
 /**
@@ -57,16 +58,24 @@ public function processNode(Node $node, Scope $scope): array
 			}
 
 			if (!$class->isAnonymous()) {
-				$errors[] = sprintf(
-					'Class %s extends private/internal class %s.',
-					$className,
-					$parentClassName
-				);
+				$errors[] = RuleErrorBuilder::message(
+					sprintf(
+						'Class %s extends private/internal class %s.',
+						$className,
+						$parentClassName
+					)
+				)
+                    ->identifier('no.private.class')
+                    ->build();
 			} else {
-				$errors[] = sprintf(
-					'Anonymous class extends private/internal class %s.',
-					$parentClassName
-				);
+				$errors[] = RuleErrorBuilder::message(
+					sprintf(
+						'Anonymous class extends private/internal class %s.',
+						$parentClassName
+					)
+				)
+                    ->identifier('no.private.class')
+                    ->build();
 			}
 		} catch (ClassNotFoundException $e) {
 			// Other rules will notify if the interface is not found

diff --git a/src/Rules/NoPrivate/InstantiationOfPrivateClassRule.php b/src/Rules/NoPrivate/InstantiationOfPrivateClassRule.php
@@ -10,6 +10,7 @@
 use PHPStan\Broker\ClassNotFoundException;
 use PHPStan\Reflection\ReflectionProvider;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\Rules\RuleLevelHelper;
 use PHPStan\Type\ErrorType;
 use function sprintf;
@@ -80,10 +81,14 @@ static function (): bool {
 				continue;
 			}
 
-			$errors[] = sprintf(
-				'Instantiation of private/internal class %s.',
-				$referencedClass
-			);
+			$errors[] = RuleErrorBuilder::message(
+				sprintf(
+					'Instantiation of private/internal class %s.',
+					$referencedClass
+				)
+			)
+                ->identifier('no.private.class')
+                ->build();
 		}
 
 		return $errors;