Merge pull request #154 from sascha-egerer/add-type-declarations

[TASK] Use Type declarations and remove redundant docblocks
sascha-egerer · Feb 9, 2024 · 947b026 · 947b026
2 parents b73c577 + df4ccc3
commit 947b026
Show file tree

Hide file tree

Showing 25 changed files with 119 additions and 100 deletions.
diff --git a/src/Reflection/RepositoryCountByMethodReflection.php b/src/Reflection/RepositoryCountByMethodReflection.php
@@ -6,6 +6,7 @@
 use PHPStan\Reflection\ClassReflection;
 use PHPStan\Reflection\FunctionVariant;
 use PHPStan\Reflection\MethodReflection;
+use PHPStan\Reflection\ParametersAcceptor;
 use PHPStan\TrinaryLogic;
 use PHPStan\Type\Generic\TemplateTypeMap;
 use PHPStan\Type\IntegerType;
@@ -15,11 +16,9 @@
 class RepositoryCountByMethodReflection implements MethodReflection
 {
 
-	/** @var \PHPStan\Reflection\ClassReflection */
-	private $classReflection;
+	private ClassReflection $classReflection;
 
-	/** @var string */
-	private $name;
+	private string $name;
 
 	public function __construct(ClassReflection $classReflection, string $name)
 	{
@@ -76,7 +75,7 @@ public function getReturnType(): Type
 	}
 
 	/**
-	 * @return \PHPStan\Reflection\ParametersAcceptor[]
+	 * @return ParametersAcceptor[]
 	 */
 	public function getVariants(): array
 	{
@@ -96,7 +95,7 @@ public function getDocComment(): ?string
 		return null;
 	}
 
-	public function isDeprecated(): \PHPStan\TrinaryLogic
+	public function isDeprecated(): TrinaryLogic
 	{
 		return TrinaryLogic::createNo();
 	}
@@ -106,22 +105,22 @@ public function getDeprecatedDescription(): ?string
 		return null;
 	}
 
-	public function isFinal(): \PHPStan\TrinaryLogic
+	public function isFinal(): TrinaryLogic
 	{
 		return TrinaryLogic::createNo();
 	}
 
-	public function isInternal(): \PHPStan\TrinaryLogic
+	public function isInternal(): TrinaryLogic
 	{
 		return TrinaryLogic::createNo();
 	}
 
-	public function getThrowType(): ?\PHPStan\Type\Type
+	public function getThrowType(): ?Type
 	{
 		return null;
 	}
 
-	public function hasSideEffects(): \PHPStan\TrinaryLogic
+	public function hasSideEffects(): TrinaryLogic
 	{
 		return TrinaryLogic::createNo();
 	}

diff --git a/src/Reflection/RepositoryCountByMethodsClassReflectionExtension.php b/src/Reflection/RepositoryCountByMethodsClassReflectionExtension.php
@@ -14,8 +14,7 @@ class RepositoryCountByMethodsClassReflectionExtension implements MethodsClassRe
 
 	use Typo3ClassNamingUtilityTrait;
 
-	/** @var ReflectionProvider */
-	private $reflectionProvider;
+	private ReflectionProvider $reflectionProvider;
 
 	public function __construct(ReflectionProvider $reflectionProvider)
 	{

diff --git a/src/Reflection/RepositoryCountByParameterReflection.php b/src/Reflection/RepositoryCountByParameterReflection.php
@@ -9,11 +9,9 @@
 class RepositoryCountByParameterReflection implements ParameterReflection
 {
 
-	/** @var string */
-	private $name;
+	private string $name;
 
-	/** @var Type */
-	private $type;
+	private Type $type;
 
 	public function __construct(string $name, Type $type)
 	{

diff --git a/src/Reflection/RepositoryFindByMethodReflection.php b/src/Reflection/RepositoryFindByMethodReflection.php
@@ -6,11 +6,14 @@
 use PHPStan\Reflection\ClassReflection;
 use PHPStan\Reflection\FunctionVariant;
 use PHPStan\Reflection\MethodReflection;
+use PHPStan\Reflection\ParametersAcceptor;
 use PHPStan\Reflection\ReflectionProvider;
 use PHPStan\TrinaryLogic;
 use PHPStan\Type\Generic\GenericObjectType;
 use PHPStan\Type\Generic\TemplateTypeMap;
+use PHPStan\Type\MixedType;
 use PHPStan\Type\ObjectType;
+use PHPStan\Type\Type;
 use SaschaEgerer\PhpstanTypo3\Helpers\Typo3ClassNamingUtilityTrait;
 use TYPO3\CMS\Extbase\Persistence\QueryResultInterface;
 
@@ -19,14 +22,11 @@ class RepositoryFindByMethodReflection implements MethodReflection
 
 	use Typo3ClassNamingUtilityTrait;
 
-	/** @var \PHPStan\Reflection\ClassReflection */
-	private $classReflection;
+	private ClassReflection $classReflection;
 
-	/** @var string */
-	private $name;
+	private string $name;
 
-	/** @var ReflectionProvider */
-	private $reflectionProvider;
+	private ReflectionProvider $reflectionProvider;
 
 	public function __construct(ClassReflection $classReflection, string $name, ReflectionProvider $reflectionProvider)
 	{
@@ -89,7 +89,7 @@ public function getParameters(): array
 		if ($modelReflection->hasNativeProperty($this->getPropertyName())) {
 			$type = $modelReflection->getNativeProperty($this->getPropertyName())->getReadableType();
 		} else {
-			$type = new \PHPStan\Type\MixedType(\false);
+			$type = new MixedType(\false);
 		}
 
 		return [
@@ -108,7 +108,7 @@ public function getReturnType(): GenericObjectType
 	}
 
 	/**
-	 * @return \PHPStan\Reflection\ParametersAcceptor[]
+	 * @return ParametersAcceptor[]
 	 */
 	public function getVariants(): array
 	{
@@ -148,7 +148,7 @@ public function isInternal(): TrinaryLogic
 		return TrinaryLogic::createNo();
 	}
 
-	public function getThrowType(): ?\PHPStan\Type\Type
+	public function getThrowType(): ?Type
 	{
 		return null;
 	}

diff --git a/src/Reflection/RepositoryFindByParameterReflection.php b/src/Reflection/RepositoryFindByParameterReflection.php
@@ -11,11 +11,9 @@
 class RepositoryFindByParameterReflection implements ParameterReflection
 {
 
-	/** @var string */
-	private $name;
+	private string $name;
 
-	/** @var Type */
-	private $type;
+	private Type $type;
 
 	public function __construct(string $name, Type $type)
 	{

diff --git a/src/Reflection/RepositoryFindMethodsClassReflectionExtension.php b/src/Reflection/RepositoryFindMethodsClassReflectionExtension.php
@@ -14,8 +14,7 @@ class RepositoryFindMethodsClassReflectionExtension implements MethodsClassRefle
 
 	use Typo3ClassNamingUtilityTrait;
 
-	/** @var ReflectionProvider $reflectionProvider */
-	private $reflectionProvider;
+	private ReflectionProvider $reflectionProvider;
 
 	public function __construct(
 		ReflectionProvider $reflectionProvider

diff --git a/src/Reflection/RepositoryFindOneByMethodReflection.php b/src/Reflection/RepositoryFindOneByMethodReflection.php
@@ -6,6 +6,7 @@
 use PHPStan\Reflection\ClassReflection;
 use PHPStan\Reflection\FunctionVariant;
 use PHPStan\Reflection\MethodReflection;
+use PHPStan\Reflection\ParametersAcceptor;
 use PHPStan\Reflection\ReflectionProvider;
 use PHPStan\TrinaryLogic;
 use PHPStan\Type\Generic\TemplateTypeMap;
@@ -19,14 +20,11 @@ class RepositoryFindOneByMethodReflection implements MethodReflection
 
 	use Typo3ClassNamingUtilityTrait;
 
-	/** @var \PHPStan\Reflection\ClassReflection */
-	private $classReflection;
+	private ClassReflection $classReflection;
 
-	/** @var string */
-	private $name;
+	private string $name;
 
-	/** @var ReflectionProvider */
-	private $reflectionProvider;
+	private ReflectionProvider $reflectionProvider;
 
 	public function __construct(ClassReflection $classReflection, string $name, ReflectionProvider $reflectionProvider)
 	{
@@ -105,7 +103,7 @@ public function getReturnType(): Type
 	}
 
 	/**
-	 * @return \PHPStan\Reflection\ParametersAcceptor[]
+	 * @return ParametersAcceptor[]
 	 */
 	public function getVariants(): array
 	{
@@ -125,7 +123,7 @@ public function getDocComment(): ?string
 		return null;
 	}
 
-	public function isDeprecated(): \PHPStan\TrinaryLogic
+	public function isDeprecated(): TrinaryLogic
 	{
 		return TrinaryLogic::createNo();
 	}
@@ -135,22 +133,22 @@ public function getDeprecatedDescription(): ?string
 		return null;
 	}
 
-	public function isFinal(): \PHPStan\TrinaryLogic
+	public function isFinal(): TrinaryLogic
 	{
 		return TrinaryLogic::createNo();
 	}
 
-	public function isInternal(): \PHPStan\TrinaryLogic
+	public function isInternal(): TrinaryLogic
 	{
 		return TrinaryLogic::createNo();
 	}
 
-	public function getThrowType(): ?\PHPStan\Type\Type
+	public function getThrowType(): ?Type
 	{
 		return null;
 	}
 
-	public function hasSideEffects(): \PHPStan\TrinaryLogic
+	public function hasSideEffects(): TrinaryLogic
 	{
 		return TrinaryLogic::createNo();
 	}

diff --git a/src/Rule/ContextAspectValidationRule.php b/src/Rule/ContextAspectValidationRule.php
@@ -3,17 +3,23 @@
 namespace SaschaEgerer\PhpstanTypo3\Rule;
 
 use PhpParser\Node;
+use PhpParser\Node\Arg;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Identifier;
+use PhpParser\Node\Scalar\String_;
 use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
+use TYPO3\CMS\Core\Context\Context;
 
 /**
- * @implements \PHPStan\Rules\Rule<\PhpParser\Node\Expr\MethodCall>
+ * @implements Rule<MethodCall>
  */
-class ContextAspectValidationRule implements \PHPStan\Rules\Rule
+class ContextAspectValidationRule implements Rule
 {
 
 	/** @var array<string, string> */
-	private $contextApiGetAspectMapping;
+	private array $contextApiGetAspectMapping;
 
 	/**
 	 * @param array<string, string> $contextApiGetAspectMapping
@@ -25,15 +31,15 @@ public function __construct(array $contextApiGetAspectMapping)
 
 	public function getNodeType(): string
 	{
-		return Node\Expr\MethodCall::class;
+		return MethodCall::class;
 	}
 
 	/**
 	 * @param Node\Expr\MethodCall $node
 	 */
 	public function processNode(Node $node, Scope $scope): array
 	{
-		if (!$node->name instanceof Node\Identifier) {
+		if (!$node->name instanceof Identifier) {
 			return [];
 		}
 
@@ -49,13 +55,13 @@ public function processNode(Node $node, Scope $scope): array
 
 		$declaringClass = $methodReflection->getDeclaringClass();
 
-		if ($declaringClass->getName() !== \TYPO3\CMS\Core\Context\Context::class) {
+		if ($declaringClass->getName() !== Context::class) {
 			return [];
 		}
 
 		$argument = $node->getArgs()[0] ?? null;
 
-		if (!($argument instanceof Node\Arg) || !($argument->value instanceof Node\Scalar\String_)) {
+		if (!($argument instanceof Arg) || !($argument->value instanceof String_)) {
 			return [];
 		}
 

diff --git a/src/Rule/RequestAttributeValidationRule.php b/src/Rule/RequestAttributeValidationRule.php
@@ -3,18 +3,23 @@
 namespace SaschaEgerer\PhpstanTypo3\Rule;
 
 use PhpParser\Node;
+use PhpParser\Node\Arg;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Identifier;
+use PhpParser\Node\Scalar\String_;
 use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
 use Psr\Http\Message\ServerRequestInterface;
 
 /**
- * @implements \PHPStan\Rules\Rule<\PhpParser\Node\Expr\MethodCall>
+ * @implements Rule<MethodCall>
  */
-class RequestAttributeValidationRule implements \PHPStan\Rules\Rule
+class RequestAttributeValidationRule implements Rule
 {
 
 	/** @var array<string, string> */
-	private $requestGetAttributeMapping;
+	private array $requestGetAttributeMapping;
 
 	/**
 	 * @param array<string, string> $requestGetAttributeMapping
@@ -26,15 +31,15 @@ public function __construct(array $requestGetAttributeMapping)
 
 	public function getNodeType(): string
 	{
-		return Node\Expr\MethodCall::class;
+		return MethodCall::class;
 	}
 
 	/**
 	 * @param Node\Expr\MethodCall $node
 	 */
 	public function processNode(Node $node, Scope $scope): array
 	{
-		if (!$node->name instanceof Node\Identifier) {
+		if (!$node->name instanceof Identifier) {
 			return [];
 		}
 
@@ -54,7 +59,7 @@ public function processNode(Node $node, Scope $scope): array
 
 		$argument = $node->getArgs()[0] ?? null;
 
-		if (!($argument instanceof Node\Arg) || !($argument->value instanceof Node\Scalar\String_)) {
+		if (!($argument instanceof Arg) || !($argument->value instanceof String_)) {
 			return [];
 		}