Add type annotations

sebastianbergmann · Oct 14, 2022 · ce5b6af · ce5b6af
1 parent c54f09c
commit ce5b6af
Show file tree

Hide file tree

Showing 26 changed files with 343 additions and 1 deletion.
diff --git a/src/Framework/Attributes/CoversFunction.php b/src/Framework/Attributes/CoversFunction.php
@@ -19,13 +19,22 @@
 #[Attribute(Attribute::TARGET_CLASS | Attribute::IS_REPEATABLE)]
 final class CoversFunction
 {
+    /**
+     * @psalm-var non-empty-string
+     */
     private readonly string $functionName;
 
+    /**
+     * @psalm-param non-empty-string $functionName
+     */
     public function __construct(string $functionName)
     {
         $this->functionName = $functionName;
     }
 
+    /**
+     * @psalm-return non-empty-string
+     */
     public function functionName(): string
     {
         return $this->functionName;

diff --git a/src/Framework/Attributes/DataProvider.php b/src/Framework/Attributes/DataProvider.php
@@ -19,13 +19,22 @@
 #[Attribute(Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)]
 final class DataProvider
 {
+    /**
+     * @psalm-var non-empty-string
+     */
     private readonly string $methodName;
 
+    /**
+     * @psalm-param non-empty-string $methodName
+     */
     public function __construct(string $methodName)
     {
         $this->methodName = $methodName;
     }
 
+    /**
+     * @psalm-return non-empty-string
+     */
     public function methodName(): string
     {
         return $this->methodName;

diff --git a/src/Framework/Attributes/DataProviderExternal.php b/src/Framework/Attributes/DataProviderExternal.php
@@ -23,10 +23,15 @@ final class DataProviderExternal
      * @psalm-var class-string
      */
     private readonly string $className;
+
+    /**
+     * @psalm-var non-empty-string
+     */
     private readonly string $methodName;
 
     /**
      * @psalm-param class-string $className
+     * @psalm-param non-empty-string $methodName
      */
     public function __construct(string $className, string $methodName)
     {
@@ -42,6 +47,9 @@ public function className(): string
         return $this->className;
     }
 
+    /**
+     * @psalm-return non-empty-string
+     */
     public function methodName(): string
     {
         return $this->methodName;

diff --git a/src/Framework/Attributes/Depends.php b/src/Framework/Attributes/Depends.php
@@ -19,13 +19,22 @@
 #[Attribute(Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)]
 final class Depends
 {
+    /**
+     * @psalm-var non-empty-string
+     */
     private readonly string $methodName;
 
+    /**
+     * @psalm-param non-empty-string $methodName
+     */
     public function __construct(string $methodName)
     {
         $this->methodName = $methodName;
     }
 
+    /**
+     * @psalm-return non-empty-string
+     */
     public function methodName(): string
     {
         return $this->methodName;

diff --git a/src/Framework/Attributes/DependsExternal.php b/src/Framework/Attributes/DependsExternal.php
@@ -23,10 +23,15 @@ final class DependsExternal
      * @psalm-var class-string
      */
     private readonly string $className;
+
+    /**
+     * @psalm-var non-empty-string
+     */
     private readonly string $methodName;
 
     /**
      * @psalm-param class-string $className
+     * @psalm-param non-empty-string $methodName
      */
     public function __construct(string $className, string $methodName)
     {
@@ -42,6 +47,9 @@ public function className(): string
         return $this->className;
     }
 
+    /**
+     * @psalm-return non-empty-string
+     */
     public function methodName(): string
     {
         return $this->methodName;

diff --git a/src/Framework/Attributes/DependsExternalUsingDeepClone.php b/src/Framework/Attributes/DependsExternalUsingDeepClone.php
@@ -23,10 +23,15 @@ final class DependsExternalUsingDeepClone
      * @psalm-var class-string
      */
     private readonly string $className;
+
+    /**
+     * @psalm-var non-empty-string
+     */
     private readonly string $methodName;
 
     /**
      * @psalm-param class-string $className
+     * @psalm-param non-empty-string $methodName
      */
     public function __construct(string $className, string $methodName)
     {
@@ -42,6 +47,9 @@ public function className(): string
         return $this->className;
     }
 
+    /**
+     * @psalm-return non-empty-string
+     */
     public function methodName(): string
     {
         return $this->methodName;

diff --git a/src/Framework/Attributes/DependsExternalUsingShallowClone.php b/src/Framework/Attributes/DependsExternalUsingShallowClone.php
@@ -23,10 +23,15 @@ final class DependsExternalUsingShallowClone
      * @psalm-var class-string
      */
     private readonly string $className;
+
+    /**
+     * @psalm-var non-empty-string
+     */
     private readonly string $methodName;
 
     /**
      * @psalm-param class-string $className
+     * @psalm-param non-empty-string $methodName
      */
     public function __construct(string $className, string $methodName)
     {
@@ -42,6 +47,9 @@ public function className(): string
         return $this->className;
     }
 
+    /**
+     * @psalm-return non-empty-string
+     */
     public function methodName(): string
     {
         return $this->methodName;

diff --git a/src/Framework/Attributes/DependsUsingDeepClone.php b/src/Framework/Attributes/DependsUsingDeepClone.php
@@ -19,13 +19,22 @@
 #[Attribute(Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)]
 final class DependsUsingDeepClone
 {
+    /**
+     * @psalm-var non-empty-string
+     */
     private readonly string $methodName;
 
+    /**
+     * @psalm-param non-empty-string $methodName
+     */
     public function __construct(string $methodName)
     {
         $this->methodName = $methodName;
     }
 
+    /**
+     * @psalm-return non-empty-string
+     */
     public function methodName(): string
     {
         return $this->methodName;

diff --git a/src/Framework/Attributes/DependsUsingShallowClone.php b/src/Framework/Attributes/DependsUsingShallowClone.php
@@ -19,13 +19,22 @@
 #[Attribute(Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)]
 final class DependsUsingShallowClone
 {
+    /**
+     * @psalm-var non-empty-string
+     */
     private readonly string $methodName;
 
+    /**
+     * @psalm-param non-empty-string $methodName
+     */
     public function __construct(string $methodName)
     {
         $this->methodName = $methodName;
     }
 
+    /**
+     * @psalm-return non-empty-string
+     */
     public function methodName(): string
     {
         return $this->methodName;

diff --git a/src/Framework/Attributes/ExcludeGlobalVariableFromBackup.php b/src/Framework/Attributes/ExcludeGlobalVariableFromBackup.php
@@ -19,13 +19,22 @@
 #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)]
 final class ExcludeGlobalVariableFromBackup
 {
+    /**
+     * @psalm-var non-empty-string
+     */
     private readonly string $globalVariableName;
 
+    /**
+     * @psalm-param non-empty-string $globalVariableName
+     */
     public function __construct(string $globalVariableName)
     {
         $this->globalVariableName = $globalVariableName;
     }
 
+    /**
+     * @psalm-return non-empty-string
+     */
     public function globalVariableName(): string
     {
         return $this->globalVariableName;

diff --git a/src/Framework/Attributes/ExcludeStaticPropertyFromBackup.php b/src/Framework/Attributes/ExcludeStaticPropertyFromBackup.php
@@ -23,10 +23,15 @@ final class ExcludeStaticPropertyFromBackup
      * @psalm-var class-string
      */
     private readonly string $className;
+
+    /**
+     * @psalm-var non-empty-string
+     */
     private readonly string $propertyName;
 
     /**
      * @psalm-param class-string $className
+     * @psalm-param non-empty-string $propertyName
      */
     public function __construct(string $className, string $propertyName)
     {
@@ -42,6 +47,9 @@ public function className(): string
         return $this->className;
     }
 
+    /**
+     * @psalm-return non-empty-string
+     */
     public function propertyName(): string
     {
         return $this->propertyName;

diff --git a/src/Framework/Attributes/Group.php b/src/Framework/Attributes/Group.php
@@ -19,13 +19,22 @@
 #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)]
 final class Group
 {
+    /**
+     * @psalm-var non-empty-string
+     */
     private readonly string $name;
 
+    /**
+     * @psalm-param non-empty-string $name
+     */
     public function __construct(string $name)
     {
         $this->name = $name;
     }
 
+    /**
+     * @psalm-return non-empty-string
+     */
     public function name(): string
     {
         return $this->name;

diff --git a/src/Framework/Attributes/RequiresFunction.php b/src/Framework/Attributes/RequiresFunction.php
@@ -19,13 +19,22 @@
 #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)]
 final class RequiresFunction
 {
+    /**
+     * @psalm-var non-empty-string
+     */
     private readonly string $functionName;
 
+    /**
+     * @psalm-param non-empty-string $functionName
+     */
     public function __construct(string $functionName)
     {
         $this->functionName = $functionName;
     }
 
+    /**
+     * @psalm-return non-empty-string
+     */
     public function functionName(): string
     {
         return $this->functionName;

diff --git a/src/Framework/Attributes/RequiresMethod.php b/src/Framework/Attributes/RequiresMethod.php
@@ -23,10 +23,15 @@ final class RequiresMethod
      * @psalm-var class-string
      */
     private readonly string $className;
+
+    /**
+     * @psalm-var non-empty-string
+     */
     private readonly string $methodName;
 
     /**
      * @psalm-param class-string $className
+     * @psalm-param non-empty-string $methodName
      */
     public function __construct(string $className, string $methodName)
     {
@@ -42,6 +47,9 @@ public function className(): string
         return $this->className;
     }
 
+    /**
+     * @psalm-return non-empty-string
+     */
     public function methodName(): string
     {
         return $this->methodName;

diff --git a/src/Framework/Attributes/RequiresOperatingSystem.php b/src/Framework/Attributes/RequiresOperatingSystem.php
@@ -19,13 +19,22 @@
 #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)]
 final class RequiresOperatingSystem
 {
+    /**
+     * @psalm-var non-empty-string
+     */
     private readonly string $regularExpression;
 
+    /**
+     * @psalm-param non-empty-string $regularExpression
+     */
     public function __construct(string $regularExpression)
     {
         $this->regularExpression = $regularExpression;
     }
 
+    /**
+     * @psalm-return non-empty-string
+     */
     public function regularExpression(): string
     {
         return $this->regularExpression;

diff --git a/src/Framework/Attributes/RequiresOperatingSystemFamily.php b/src/Framework/Attributes/RequiresOperatingSystemFamily.php
@@ -19,13 +19,22 @@
 #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)]
 final class RequiresOperatingSystemFamily
 {
+    /**
+     * @psalm-var non-empty-string
+     */
     private readonly string $operatingSystemFamily;
 
+    /**
+     * @psalm-param non-empty-string $operatingSystemFamily
+     */
     public function __construct(string $operatingSystemFamily)
     {
         $this->operatingSystemFamily = $operatingSystemFamily;
     }
 
+    /**
+     * @psalm-return non-empty-string
+     */
     public function operatingSystemFamily(): string
     {
         return $this->operatingSystemFamily;