Merge pull request #1490 from scyzoryck/alternative-doc-blocks-names

feat(TypeResolvers): Add support for alternative name in doc blocs.
schmittjoh · Jun 24, 2023 · 926a7d5 · 926a7d5
2 parents 72a24a3 + a57be74
commit 926a7d5
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 3 deletions.
diff --git a/phpcs.xml.dist b/phpcs.xml.dist
@@ -14,7 +14,7 @@
 
     <file>src/</file>
     <file>tests/</file>
-
+    <exclude-pattern>tests/Fixtures/DocBlockType/AlternativePHPDocsNames.php</exclude-pattern>
     <rule ref="Doctrine">
         <exclude name="Generic.Formatting.SpaceAfterNot"/>
         <exclude name="Generic.Formatting.MultipleStatementAlignment"/>
@@ -40,7 +40,7 @@
 
     <rule ref="SlevomatCodingStandard.ControlStructures.RequireYodaComparison"/>
 
-     <rule ref="SlevomatCodingStandard.Commenting.ForbiddenAnnotations">
+    <rule ref="SlevomatCodingStandard.Commenting.ForbiddenAnnotations">
         <properties>
             <property
                 name="forbiddenAnnotations"

diff --git a/src/Metadata/Driver/DocBlockDriver/DocBlockTypeResolver.php b/src/Metadata/Driver/DocBlockDriver/DocBlockTypeResolver.php
@@ -293,7 +293,7 @@ private function endsWith(string $statementClassToCheck, string $typeHintToSearc
 
     private function isPrimitiveType(string $type): bool
     {
-        return in_array($type, ['int', 'float', 'bool', 'string']);
+        return in_array($type, ['int', 'integer', 'float', 'bool', 'boolean', 'double', 'string']);
     }
 
     private function hasGlobalNamespacePrefix(string $typeHint): bool

diff --git a/tests/Fixtures/DocBlockType/AlternativePHPDocsNames.php b/tests/Fixtures/DocBlockType/AlternativePHPDocsNames.php
@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace JMS\Serializer\Tests\Fixtures\DocBlockType;
+
+class AlternativePHPDocsNames
+{
+    /** @var integer */
+    public $integer;
+
+    /** @var double */
+    public $double;
+
+    /** @var boolean */
+    public $boolean;
+}
diff --git a/tests/Metadata/Driver/DocBlockDriverTest.php b/tests/Metadata/Driver/DocBlockDriverTest.php
@@ -10,6 +10,7 @@
 use JMS\Serializer\Metadata\Driver\DocBlockDriver;
 use JMS\Serializer\Metadata\Driver\TypedPropertiesDriver;
 use JMS\Serializer\Naming\IdenticalPropertyNamingStrategy;
+use JMS\Serializer\Tests\Fixtures\DocBlockType\AlternativePHPDocsNames;
 use JMS\Serializer\Tests\Fixtures\DocBlockType\Collection\CollectionAsList;
 use JMS\Serializer\Tests\Fixtures\DocBlockType\Collection\CollectionOfClassesFromDifferentNamespace;
 use JMS\Serializer\Tests\Fixtures\DocBlockType\Collection\CollectionOfClassesFromDifferentNamespaceUsingGroupAlias;
@@ -462,4 +463,24 @@ public function testInferTypeForVirtualPropertyGetter()
             $m->propertyMetadata['arrayOfStrings']->type
         );
     }
+
+    public function testAlternativeNames()
+    {
+        $m = $this->resolve(AlternativePHPDocsNames::class);
+
+        self::assertEquals(
+            ['name' => 'integer', 'params' => []],
+            $m->propertyMetadata['integer']->type
+        );
+
+        self::assertEquals(
+            ['name' => 'double', 'params' => []],
+            $m->propertyMetadata['double']->type
+        );
+
+        self::assertEquals(
+            ['name' => 'boolean', 'params' => []],
+            $m->propertyMetadata['boolean']->type
+        );
+    }
 }