Improve codebase docblock

thephpleague · Nov 16, 2023 · 553ee60 · 553ee60
1 parent 73f4149
commit 553ee60
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 4 deletions.
diff --git a/src/Serializer/CastToArray.php b/src/Serializer/CastToArray.php
@@ -28,7 +28,7 @@
 use const JSON_THROW_ON_ERROR;
 
 /**
- * @implements TypeCasting<array|null>
+ * @implements TypeCasting<?array>
  */
 final class CastToArray implements TypeCasting
 {

diff --git a/src/Serializer/CastToBool.php b/src/Serializer/CastToBool.php
@@ -18,6 +18,9 @@
 
 use function filter_var;
 
+/**
+ * @implements TypeCasting<?bool>
+ */
 final class CastToBool implements TypeCasting
 {
     private readonly bool $isNullable;

diff --git a/src/Serializer/CastToFloat.php b/src/Serializer/CastToFloat.php
@@ -19,7 +19,7 @@
 use function filter_var;
 
 /**
- * @implements TypeCasting<float|null>
+ * @implements TypeCasting<?float>
  */
 final class CastToFloat implements TypeCasting
 {

diff --git a/src/Serializer/CastToInt.php b/src/Serializer/CastToInt.php
@@ -19,7 +19,7 @@
 use function filter_var;
 
 /**
- * @implements TypeCasting<int|null>
+ * @implements TypeCasting<?int>
  */
 final class CastToInt implements TypeCasting
 {

diff --git a/src/Serializer/CastToString.php b/src/Serializer/CastToString.php
@@ -17,7 +17,7 @@
 use ReflectionProperty;
 
 /**
- * @implements TypeCasting<string|null>
+ * @implements TypeCasting<?string>
  */
 final class CastToString implements TypeCasting
 {

diff --git a/src/Serializer/ClosureCasting.php b/src/Serializer/ClosureCasting.php
@@ -24,12 +24,17 @@
 use function array_key_exists;
 use function class_exists;
 
+/**
+ * @template TValue
+ */
 final class ClosureCasting implements TypeCasting
 {
+    /** @var array<string, Closure(?string, bool, mixed...): TValue> */
     private static array $casters = [];
 
     private readonly string $type;
     private readonly bool $isNullable;
+    /** @var Closure(?string, bool, mixed...): TValue */
     private readonly Closure $closure;
     private readonly array $arguments;
 
@@ -41,6 +46,9 @@ public function __construct(ReflectionProperty|ReflectionParameter $reflectionPr
         $this->arguments = $arguments;
     }
 
+    /**
+     * @return TValue
+     */
     public function toVariable(?string $value): mixed
     {
         try {
@@ -60,6 +68,9 @@ public function toVariable(?string $value): mixed
         }
     }
 
+    /**
+     * @param Closure(?string, bool, mixed...): TValue $closure
+     */
     public static function register(string $type, Closure $closure): void
     {
         self::$casters[$type] = match (true) {