Add: attr emptyToNull. InvalidArgumentException

yzen-dev · Jul 14, 2023 · ddbb7e1 · ddbb7e1
1 parent 1f01828
commit ddbb7e1
Show file tree

Hide file tree

Showing 20 changed files with 139 additions and 29 deletions.
diff --git a/composer.json b/composer.json
@@ -1,6 +1,6 @@
 {
   "name": "yzen.dev/plain-to-class",
-  "version": "3.0.3",
+  "version": "3.0.4",
   "description": "Class-transformer to transform your dataset into a structured object",
   "minimum-stability": "dev",
   "prefer-stable": true,

diff --git a/composer.lock b/composer.lock
diff --git a/src/ArgumentsRepository.php b/src/ArgumentsRepository.php
@@ -26,7 +26,7 @@ final class ArgumentsRepository
 
     /**
      *
-     * @param iterable<mixed>|array ...$args
+     * @param iterable<mixed>|object ...$args
      */
     public function __construct(...$args)
     {

diff --git a/src/Attributes/EmptyToNull.php b/src/Attributes/EmptyToNull.php
@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ClassTransformer\Attributes;
+
+use Attribute;
+
+/**
+ *
+ * @psalm-api
+ */
+#[Attribute(Attribute::TARGET_PARAMETER)]
+final class EmptyToNull
+{
+}
diff --git a/src/CacheGenerator/CacheGenerator.php b/src/CacheGenerator/CacheGenerator.php
@@ -120,6 +120,7 @@ private function convertToCacheProperty(RuntimeReflectionProperty $property): Ca
             $property->type,
             $property->hasSetMutator(),
             $property->notTransform(),
+            $property->convertEmptyToNull(),
             $property->getDocComment(),
             $args,
             $this->getAliases($args),

diff --git a/src/ClassRepository.php b/src/ClassRepository.php
@@ -3,8 +3,6 @@
 namespace ClassTransformer;
 
 use ClassTransformer\Contracts\ReflectionProperty;
-use ClassTransformer\Exceptions\ClassNotFoundException;
-use ClassTransformer\Reflection\CacheReflectionProperty;
 use ClassTransformer\Contracts\ReflectionClassRepository;
 
 /**
@@ -14,22 +12,21 @@
  */
 final class ClassRepository
 {
-    /** @var class-string $class */
+    /** @var string $class */
     private string $class;
 
     /** @var ReflectionClassRepository $class */
     private ReflectionClassRepository $classRepository;
 
     /**
-     * @var array<string,CacheReflectionProperty[]>
+     * @var array<string,ReflectionProperty[]>
      */
     private static array $propertiesTypesCache = [];
 
 
     /**
-     * @param class-string $class
-     *
-     * @throws ClassNotFoundException
+     * @param string $class
+     * @param ReflectionClassRepository $classRepository
      */
     public function __construct(
         string $class,

diff --git a/src/Contracts/ReflectionClassRepository.php b/src/Contracts/ReflectionClassRepository.php
@@ -8,7 +8,7 @@
 interface ReflectionClassRepository
 {
     /**
-     * @return array<ReflectionProperty>
+     * @return ReflectionProperty[]
      */
     public function getProperties(): array;
 

diff --git a/src/Contracts/ReflectionProperty.php b/src/Contracts/ReflectionProperty.php
@@ -19,14 +19,14 @@ abstract class ReflectionProperty
     public PropertyType $type;
 
     /**
-     * @param string $name
+     * @param class-string $name
      *
      * @return mixed
      */
     abstract public function getAttribute(string $name): mixed;
 
     /**
-     * @param string $name
+     * @param class-string $name
      *
      * @return null|array<string>
      */
@@ -47,6 +47,11 @@ abstract public function hasSetMutator(): bool;
      */
     abstract public function notTransform(): bool;
 
+    /**
+     * @return bool
+     */
+    abstract public function convertEmptyToNull(): bool;
+
     /**
      * @return array<string>
      */

diff --git a/src/Reflection/CacheReflectionClass.php b/src/Reflection/CacheReflectionClass.php
@@ -17,14 +17,15 @@
  */
 final class CacheReflectionClass implements ReflectionClassRepository
 {
-    /** @var class-string $class */
+    /** @var string $class */
     private string $class;
 
     /** @var array CacheReflectionProperty[] */
     private array $properties;
 
     /**
-     * @param class-string $class
+     * @param string $class
+     * @param CacheReflectionProperty[] $properties
      */
     public function __construct(string $class, array $properties)
     {

diff --git a/src/Reflection/CacheReflectionProperty.php b/src/Reflection/CacheReflectionProperty.php
@@ -14,13 +14,23 @@
 final class CacheReflectionProperty extends \ClassTransformer\Contracts\ReflectionProperty
 {
     /**
+     * @param class-string  $class
+     * @param class-string|string  $name
+     * @param PropertyType $type
+     * @param bool $hasSetMutator
+     * @param bool $notTransform
+     * @param bool $convertEmptyToNull
+     * @param string $docComment
+     * @param array $attributes
+     * @param array $aliases
      */
     public function __construct(
         public string $class,
         public string $name,
         public PropertyType $type,
         public bool $hasSetMutator,
         public bool $notTransform,
+        public bool $convertEmptyToNull,
         public string $docComment,
         public array $attributes,
         public array $aliases,
@@ -42,6 +52,14 @@ public function notTransform(): bool
     {
         return $this->notTransform;
     }
+
+    /**
+     * @return bool
+     */
+    public function convertEmptyToNull(): bool
+    {
+        return $this->convertEmptyToNull;
+    }
 
     /**
      * @param string $name

diff --git a/src/Reflection/RuntimeReflectionProperty.php b/src/Reflection/RuntimeReflectionProperty.php
@@ -4,6 +4,7 @@
 
 namespace ClassTransformer\Reflection;
 
+use ClassTransformer\Attributes\EmptyToNull;
 use ReflectionProperty;
 use ReflectionAttribute;
 use ClassTransformer\TransformUtils;
@@ -58,7 +59,15 @@ public function notTransform(): bool
     }
 
     /**
-     * @param string $name
+     * @return bool
+     */
+    public function convertEmptyToNull(): bool
+    {
+        return $this->getAttribute(EmptyToNull::class) !== null;
+    }
+
+    /**
+     * @param class-string $name
      *
      * @template T
      * @return null|ReflectionAttribute
@@ -77,11 +86,11 @@ public function getAttribute(string $name): ?ReflectionAttribute
     }
 
     /**
-     * @param string|null $name
+     * @param class-string $name
      *
      * @return null|array<string>
      */
-    public function getAttributeArguments(?string $name = null): ?array
+    public function getAttributeArguments(string $name): ?array
     {
         return $this->getAttribute($name)?->getArguments();
     }

diff --git a/src/Reflection/Types/ArrayType.php b/src/Reflection/Types/ArrayType.php
@@ -11,6 +11,8 @@
  */
 class ArrayType extends PropertyType
 {
+    /** @var string|class-string */
     public string $itemsType;
     public bool $isScalarItems;
+
 }
diff --git a/src/Reflection/Types/EnumType.php b/src/Reflection/Types/EnumType.php
@@ -5,6 +5,7 @@
 /**
  * Class EnumType
  *
+ * @psalm-api
  * @author yzen.dev <yzen.dev@gmail.com>
  */
 class EnumType extends PropertyType

diff --git a/src/Reflection/Types/PropertyType.php b/src/Reflection/Types/PropertyType.php
@@ -7,12 +7,13 @@
 /**
  * Class PropertyType
  *
+ * @psalm-api
  * @author yzen.dev <yzen.dev@gmail.com>
  */
 class PropertyType
 {
     /**
-     * @param string $name Name of type
+     * @param string|class-string $name Name of type
      * @param bool $isScalar
      * @param bool $isNullable
      */

diff --git a/src/Reflection/Types/PropertyTypeFactory.php b/src/Reflection/Types/PropertyTypeFactory.php
@@ -32,7 +32,7 @@ public static function create(RuntimeReflectionProperty $property)
         $isNullable = true;
 
         if ($reflectionType instanceof ReflectionType) {
-            $type = $reflectionType;
+            $type = (string)$reflectionType;
             $isNullable = $reflectionType->allowsNull();
         }
         if ($reflectionType instanceof ReflectionNamedType) {
@@ -41,6 +41,14 @@ public static function create(RuntimeReflectionProperty $property)
             $isNullable = $reflectionType->allowsNull();
         }
 
+        if ($property->notTransform()) {
+            return new ScalarType(
+                $type,
+                $isScalar,
+                $isNullable
+            );
+        }
+
         if ($type === TypeEnums::TYPE_ARRAY) {
             $arrayTypeAttr = $property->getAttributeArguments(ConvertArray::class);
 
@@ -50,18 +58,19 @@ public static function create(RuntimeReflectionProperty $property)
                 $arrayType = TransformUtils::getClassFromPhpDoc($property->getDocComment());
             }
             $arrayType ??= TypeEnums::TYPE_MIXED;
-            $type = new ArrayType(
+
+            $typeInstance = new ArrayType(
                 $type,
                 $isScalar,
                 $isNullable
             );
-            $type->itemsType = $arrayType ?? TypeEnums::TYPE_MIXED;
-            $type->isScalarItems = in_array($arrayType, [TypeEnums::TYPE_INTEGER, TypeEnums::TYPE_FLOAT, TypeEnums::TYPE_STRING, TypeEnums::TYPE_BOOLEAN, TypeEnums::TYPE_MIXED]);
+            $typeInstance->itemsType = $arrayType ?? TypeEnums::TYPE_MIXED;
+            $typeInstance->isScalarItems = in_array($arrayType, [TypeEnums::TYPE_INTEGER, TypeEnums::TYPE_FLOAT, TypeEnums::TYPE_STRING, TypeEnums::TYPE_BOOLEAN, TypeEnums::TYPE_MIXED]);
 
-            return $type;
+            return $typeInstance;
         }
 
-        if ($isScalar || $property->notTransform()) {
+        if ($isScalar) {
             return new ScalarType(
                 $type,
                 $isScalar,
@@ -80,7 +89,6 @@ public static function create(RuntimeReflectionProperty $property)
         return new TransformableType(
             $type,
             $isScalar,
-            $isNullable
         );
     }
 }
diff --git a/src/Reflection/Types/ScalarType.php b/src/Reflection/Types/ScalarType.php
@@ -7,6 +7,7 @@
 /**
  * Class ScalarType
  *
+ * @psalm-api
  * @author yzen.dev <yzen.dev@gmail.com>
  */
 class ScalarType extends PropertyType

diff --git a/src/Reflection/Types/TransformableType.php b/src/Reflection/Types/TransformableType.php
@@ -11,4 +11,14 @@
  */
 class TransformableType extends PropertyType
 {
+    /**
+     * @param class-string $name Name of type
+     * @param bool $isNullable
+     */
+    public function __construct(
+        public string $name,
+        public bool $isNullable
+    ) {
+        parent::__construct($this->name, false, $isNullable);
+    }
 }