refactor: better handling of data types (#377)

Author: alanpoulain

src/OpenApi/PhpTypeConverter.php

@@ -15,15 +15,9 @@
 
 use ApiPlatform\SchemaGenerator\Model\Property;
 use ApiPlatform\SchemaGenerator\PhpTypeConverterInterface;
-use EasyRdf\Resource as RdfResource;
 
 final class PhpTypeConverter implements PhpTypeConverterInterface
 {
-    public function isDatatype(RdfResource $range): bool
-    {
-        return true;
-    }
-
     public function getPhpType(Property $property, array $config = [], array $classes = []): ?string
     {
         if ($property->reference && $property->isArray) {

src/PhpTypeConverter.php

@@ -17,18 +17,14 @@
 use ApiPlatform\SchemaGenerator\Model\Property;
 use ApiPlatform\SchemaGenerator\Schema\Model\Property as SchemaProperty;
 use ApiPlatform\SchemaGenerator\Schema\TypeConverter;
-use EasyRdf\Resource as RdfResource;
 
 final class PhpTypeConverter implements PhpTypeConverterInterface
 {
-    private const RDF_LANG_STRING = 'http://www.w3.org/1999/02/22-rdf-syntax-ns#langString';
+    private TypeConverter $typeConverter;
 
-    /**
-     * Is this type a datatype?
-     */
-    public function isDatatype(RdfResource $range): bool
+    public function __construct()
     {
-        return isset(TypeConverter::RANGE_MAPPING[$this->getUri($range)]) || $this->isLangString($range);
+        $this->typeConverter = new TypeConverter();
     }
 
     public function getPhpType(Property $property, array $config = [], array $classes = []): ?string
@@ -38,7 +34,7 @@ public function getPhpType(Property $property, array $config = [], array $classe
         }
 
         if ($property->isArray && $property->range) {
-            return ($config['doctrine']['useCollection'] ?? false) && !$this->isDatatype($property->range) ? 'Collection' : 'array';
+            return ($config['doctrine']['useCollection'] ?? false) && !$this->typeConverter->getType($property->range) ? 'Collection' : 'array';
         }
 
         return $this->getNonArrayType($property, $classes);
@@ -101,33 +97,6 @@ private function getNonArrayType(SchemaProperty $property, array $classes): ?str
             return $type;
         }
 
-        if ($this->isLangString($property->range)) {
-            return 'string';
-        }
-
         return null;
     }
-
-    /**
-     * This is a hack to detect internationalized strings.
-     *
-     * @todo find something smarter to detect this kind of strings
-     */
-    private function isLangString(RdfResource $range): bool
-    {
-        return self::RDF_LANG_STRING === $this->getUri($range)
-            || ($range->isBNode() &&
-            null !== ($unionOf = $range->get('owl:unionOf')) &&
-            null !== ($rdfFirst = $unionOf->get('rdf:first')) &&
-            self::RDF_LANG_STRING === $rdfFirst->getUri());
-    }
-
-    private function getUri(RdfResource $range): string
-    {
-        if ($range->isBNode() && $onDatatype = $range->get('owl:onDatatype')) {
-            return $onDatatype->getUri();
-        }
-
-        return $range->getUri();
-    }
 }

src/PhpTypeConverterInterface.php

@@ -15,7 +15,6 @@
 
 use ApiPlatform\SchemaGenerator\Model\Class_;
 use ApiPlatform\SchemaGenerator\Model\Property;
-use EasyRdf\Resource as RdfResource;
 
 interface PhpTypeConverterInterface
 {
@@ -27,11 +26,6 @@ interface PhpTypeConverterInterface
         'collection', // Doctrine
     ];
 
-    /**
-     * Is this type a datatype?
-     */
-    public function isDatatype(RdfResource $range): bool;
-
     /**
      * Gets the PHP type of this field.
      *

src/Schema/PropertyGenerator/PropertyGenerator.php

@@ -177,7 +177,7 @@ public function __invoke(string $name, array $config, Class_ $class, array $cont
     private function getRanges(RdfResource $range, ?array $propertyConfig, array $config): array
     {
         $localName = $range->localName();
-        $dataType = $this->phpTypeConverter->isDatatype($range);
+        $dataType = (bool) $this->typeConverter->getType($range);
         $ranges = [];
         if (!$dataType && $range->isBNode()) {
             if (null !== ($unionOf = $range->get('owl:unionOf'))) {

src/Schema/TypeConverter.php

@@ -17,7 +17,7 @@
 
 final class TypeConverter
 {
-    public const RANGE_MAPPING = [
+    public const RANGE_DATA_TYPE_MAPPING = [
         'https://schema.org/URL' => 'url',
 
         'https://schema.org/Boolean' => 'boolean',
@@ -89,6 +89,8 @@ final class TypeConverter
         'http://www.w3.org/2001/XMLSchema#ENTITY' => 'string',
         'http://www.w3.org/2001/XMLSchema#ENTITIES' => 'string',
 
+        'http://www.w3.org/1999/02/22-rdf-syntax-ns#langString' => 'string',
+
         'https://schema.org/DataType' => 'mixed',
     ];
 
@@ -98,7 +100,7 @@ public function getType(?RdfResource $range): ?string
             return null;
         }
 
-        return self::RANGE_MAPPING[$this->getUri($range)] ?? null;
+        return self::RANGE_DATA_TYPE_MAPPING[$this->getUri($range)] ?? null;
     }
 
     private function getUri(RdfResource $range): string
@@ -107,6 +109,12 @@ private function getUri(RdfResource $range): string
             return $onDatatype->getUri();
         }
 
+        if ($range->isBNode() &&
+            null !== ($unionOf = $range->get('owl:unionOf')) &&
+            null !== ($rdfFirst = $unionOf->get('rdf:first'))) {
+            return $rdfFirst->getUri();
+        }
+
         return $range->getUri();
     }
 }

tests/Command/GenerateCommandTest.php

@@ -442,6 +442,7 @@ public function testActivityStreams(): void
      *
      * @see http://www.w3.org/ns/activitystreams#content
      */
+    #[ORM\Column(type: 'text', nullable: true)]
     #[ApiProperty(iri: 'http://www.w3.org/ns/activitystreams#content')]
     private ?string $content = null;
 PHP