feat(metadata): add support for stateOptions in YAML and XML for Doctrine ORM/ODM

Author: fmata

src/Metadata/Extractor/XmlResourceExtractor.php

@@ -13,7 +13,9 @@
 
 namespace ApiPlatform\Metadata\Extractor;
 
-use ApiPlatform\Elasticsearch\State\Options;
+use ApiPlatform\Doctrine\Odm\State\Options as OdmOptions;
+use ApiPlatform\Doctrine\Orm\State\Options as OrmOptions;
+use ApiPlatform\Elasticsearch\State\Options as ElasticsearchOptions;
 use ApiPlatform\Metadata\Exception\InvalidArgumentException;
 use ApiPlatform\Metadata\GetCollection;
 use ApiPlatform\Metadata\HeaderParameter;
@@ -454,14 +456,24 @@ private function buildStateOptions(\SimpleXMLElement $resource): ?OptionsInterfa
         if (!$stateOptions) {
             return null;
         }
-        $elasticsearchOptions = $stateOptions->elasticsearchOptions ?? null;
-        if ($elasticsearchOptions) {
-            if (class_exists(Options::class)) {
-                return new Options(
-                    isset($elasticsearchOptions['index']) ? (string) $elasticsearchOptions['index'] : null,
-                    isset($elasticsearchOptions['type']) ? (string) $elasticsearchOptions['type'] : null,
-                );
-            }
+
+        if (isset($stateOptions->elasticsearchOptions) && class_exists(ElasticsearchOptions::class)) {
+            return new ElasticsearchOptions(
+                isset($stateOptions->elasticsearchOptions['index']) ? (string) $stateOptions->elasticsearchOptions['index'] : null,
+                isset($stateOptions->elasticsearchOptions['type']) ? (string) $stateOptions->elasticsearchOptions['type'] : null,
+            );
+        }
+
+        if (isset($stateOptions->doctrineOdmOptions) && class_exists(OdmOptions::class)) {
+            return new OdmOptions(
+                isset($stateOptions->doctrineOdmOptions['documentClass']) ? (string) $stateOptions->doctrineOdmOptions['documentClass'] : null,
+            );
+        }
+
+        if (isset($stateOptions->doctrineOrmOptions) && class_exists(OrmOptions::class)) {
+            return new OrmOptions(
+                isset($stateOptions->doctrineOrmOptions['entityClass']) ? (string) $stateOptions->doctrineOrmOptions['entityClass'] : null,
+            );
         }
 
         return null;

src/Metadata/Extractor/YamlResourceExtractor.php

@@ -13,7 +13,9 @@
 
 namespace ApiPlatform\Metadata\Extractor;
 
-use ApiPlatform\Elasticsearch\State\Options;
+use ApiPlatform\Doctrine\Odm\State\Options as OdmOptions;
+use ApiPlatform\Doctrine\Orm\State\Options as OrmOptions;
+use ApiPlatform\Elasticsearch\State\Options as ElasticsearchOptions;
 use ApiPlatform\Metadata\Exception\InvalidArgumentException;
 use ApiPlatform\Metadata\GetCollection;
 use ApiPlatform\Metadata\HeaderParameter;
@@ -418,9 +420,20 @@ private function buildStateOptions(array $resource): ?OptionsInterface
         $configuration = reset($stateOptions);
         switch (key($stateOptions)) {
             case 'elasticsearchOptions':
-                if (class_exists(Options::class)) {
-                    return new Options($configuration['index'] ?? null, $configuration['type'] ?? null);
+                if (class_exists(ElasticsearchOptions::class)) {
+                    return new ElasticsearchOptions($configuration['index'] ?? null, $configuration['type'] ?? null);
                 }
+                break;
+            case 'doctrineOdmOptions':
+                if (class_exists(OdmOptions::class)) {
+                    return new OdmOptions($configuration['documentClass'] ?? null);
+                }
+                break;
+            case 'doctrineOrmOptions':
+                if (class_exists(OrmOptions::class)) {
+                    return new OrmOptions($configuration['entityClass'] ?? null);
+                }
+                break;
         }
 
         return null;

src/Metadata/Extractor/schema/resources.xsd

@@ -386,6 +386,8 @@
     <xsd:complexType name="stateOptions">
         <xsd:choice>
             <xsd:element ref="elasticsearchOptions"/>
+            <xsd:element ref="doctrineOdmOptions"/>
+            <xsd:element ref="doctrineOrmOptions"/>
         </xsd:choice>
     </xsd:complexType>
 
@@ -396,6 +398,18 @@
         </xsd:complexType>
     </xsd:element>
 
+    <xsd:element name="doctrineOdmOptions">
+        <xsd:complexType>
+            <xsd:attribute name="documentClass" type="xsd:string"/>
+        </xsd:complexType>
+    </xsd:element>
+
+    <xsd:element name="doctrineOrmOptions">
+        <xsd:complexType>
+            <xsd:attribute name="entityClass" type="xsd:string"/>
+        </xsd:complexType>
+    </xsd:element>
+
     <xsd:element name="link">
         <xsd:complexType>
             <xsd:attribute name="rel" type="xsd:string"/>