Add not supported exception for nullable optional parameters, amend docs, small improvements

Author: Yarre

CHANGELOG.md

@@ -6,7 +6,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [10.1.0] - 2023.03.21
 ### Added
-- support for optional nullable properties
+- support for optional nullable scheme properties
 
 ## [10.0.1] - 2023.01.10
 ### Added

README.md

@@ -32,7 +32,7 @@ API client generator is a console application capable of auto-generating a [PSR1
 - Applies code style rules to generated code, you can specify your own.
 - Generates README and composer.json files with possibility to use your own template.
 - Supports `allOf` OpenAPI parameter.
-- Supports nullable optional parameter.
+- Supports nullable optional scheme property.
 
 ## Example
 Check out [example](https://github.com/DoclerLabs/api-client-generator/tree/master/example) directory to see the code generated by api-client-generator.

src/Entity/OperationCollection.php

@@ -30,6 +30,9 @@ public function toArray(): array
         return $this->items;
     }
 
+    /**
+     * @return ArrayIterator|Operation[]
+     */
     public function getIterator(): ArrayIterator
     {
         return new ArrayIterator($this->toArray());

src/Entity/RequestFieldRegistry.php

@@ -4,8 +4,9 @@
 
 namespace DoclerLabs\ApiClientGenerator\Entity;
 
-use ArrayIterator;
 use IteratorAggregate;
+use RecursiveArrayIterator;
+use RecursiveIteratorIterator;
 use UnexpectedValueException;
 
 class RequestFieldRegistry implements IteratorAggregate
@@ -80,8 +81,13 @@ public function getBody(): ?Field
         return current($this->items[self::ORIGIN_BODY]);
     }
 
-    public function getIterator(): ArrayIterator
+    /**
+     * @return RecursiveIteratorIterator|Field[]
+     */
+    public function getIterator(): RecursiveIteratorIterator
     {
-        return new ArrayIterator($this->items);
+        return new RecursiveIteratorIterator(
+            new RecursiveArrayIterator($this->items, RecursiveArrayIterator::CHILD_ARRAYS_ONLY)
+        );
     }
 }

src/Generator/RequestGenerator.php

@@ -10,6 +10,7 @@
 use DoclerLabs\ApiClientGenerator\Entity\Operation;
 use DoclerLabs\ApiClientGenerator\Entity\Request;
 use DoclerLabs\ApiClientGenerator\Generator\Security\SecurityStrategyAbstract;
+use DoclerLabs\ApiClientGenerator\Input\InvalidSpecificationException;
 use DoclerLabs\ApiClientGenerator\Input\Specification;
 use DoclerLabs\ApiClientGenerator\Naming\CopiedNamespace;
 use DoclerLabs\ApiClientGenerator\Naming\RequestNaming;
@@ -73,11 +74,9 @@ protected function generateRequest(
     protected function generateEnums(Request $request): array
     {
         $statements = [];
-        foreach ($request->getFields() as $fields) {
-            foreach ($fields as $field) {
-                foreach ($this->generateEnumStatements($field) as $statement) {
-                    $statements[] = $statement;
-                }
+        foreach ($request->getFields() as $field) {
+            foreach ($this->generateEnumStatements($field) as $statement) {
+                $statements[] = $statement;
             }
         }
 
@@ -87,20 +86,18 @@ protected function generateEnums(Request $request): array
     protected function generateProperties(Request $request, Operation $operation, Specification $specification): array
     {
         $statements = [];
-        foreach ($request->getFields() as $fields) {
-            foreach ($fields as $field) {
-                if ($field->isComposite()) {
-                    $this->addImport(
-                        sprintf(
-                            '%s%s\\%s',
-                            $this->baseNamespace,
-                            SchemaGenerator::NAMESPACE_SUBPATH,
-                            $field->getPhpClassName()
-                        )
-                    );
-                }
-                $statements[] = $this->generateProperty($field);
+        foreach ($request->getFields() as $field) {
+            if ($field->isComposite()) {
+                $this->addImport(
+                    sprintf(
+                        '%s%s\\%s',
+                        $this->baseNamespace,
+                        SchemaGenerator::NAMESPACE_SUBPATH,
+                        $field->getPhpClassName()
+                    )
+                );
             }
+            $statements[] = $this->generateProperty($field);
         }
 
         $default = null;
@@ -123,26 +120,24 @@ protected function generateConstructor(
     ): ?ClassMethod {
         $params     = [];
         $paramInits = [];
-        foreach ($request->getFields() as $fields) {
-            foreach ($fields as $field) {
-                if ($field->isRequired()) {
-                    array_push($paramInits, ...$this->generateValidationStmts($field));
+        foreach ($request->getFields() as $field) {
+            if ($field->isRequired()) {
+                array_push($paramInits, ...$this->generateValidationStmts($field));
 
-                    $param = $this->builder
-                        ->param($field->getPhpVariableName())
-                        ->setType($field->getPhpTypeHint(), $field->isNullable());
+                $param = $this->builder
+                    ->param($field->getPhpVariableName())
+                    ->setType($field->getPhpTypeHint(), $field->isNullable());
 
-                    if (null !== $field->getDefault()) {
-                        $param->setDefault($field->getDefault());
-                    }
+                if (null !== $field->getDefault()) {
+                    $param->setDefault($field->getDefault());
+                }
 
-                    $params[] = $param->getNode();
+                $params[] = $param->getNode();
 
-                    $paramInits[] = $this->builder->assign(
-                        $this->builder->localPropertyFetch($field->getPhpVariableName()),
-                        $this->builder->var($field->getPhpVariableName())
-                    );
-                }
+                $paramInits[] = $this->builder->assign(
+                    $this->builder->localPropertyFetch($field->getPhpVariableName()),
+                    $this->builder->var($field->getPhpVariableName())
+                );
             }
         }
 
@@ -183,12 +178,14 @@ protected function generateConstructor(
     private function generateSetters(Request $request): array
     {
         $statements = [];
-        foreach ($request->getFields() as $fields) {
-            foreach ($fields as $field) {
-                if (!$field->isRequired()) {
-                    $statements[] = $this->generateSet($field);
-                }
+        foreach ($request->getFields() as $field) {
+            if ($field->isRequired()) {
+                continue;
+            }
+            if ($field->isNullable()) {
+                throw new InvalidSpecificationException('Nullable optional parameter is not supported');
             }
+            $statements[] = $this->generateSet($field);
         }
 
         return $statements;

src/Input/Parser.php

@@ -47,10 +47,8 @@ private function extractCompositeRequestFields(OperationCollection $operations):
         $allFields = new FieldCollection();
         foreach ($operations as $operation) {
             $request = $operation->getRequest();
-            foreach ($request->getFields() as $fields) {
-                foreach ($fields as $field) {
-                    $this->extractField($field, $allFields);
-                }
+            foreach ($request->getFields() as $field) {
+                $this->extractField($field, $allFields);
             }
         }
 

src/Input/Specification.php

@@ -123,14 +123,10 @@ public function getAllContentTypes(): array
 
     public function requiresIntlExtension(): bool
     {
-        /** @var Operation $operation */
         foreach ($this->getOperations() as $operation) {
-            foreach ($operation->getRequest()->getFields() as $fields) {
-                /** @var Field $field */
-                foreach ($fields as $field) {
-                    if ($this->fieldRequiresIntlExtension($field)) {
-                        return true;
-                    }
+            foreach ($operation->getRequest()->getFields() as $field) {
+                if ($this->fieldRequiresIntlExtension($field)) {
+                    return true;
                 }
             }
         }
@@ -172,8 +168,8 @@ private function fieldRequiresIntlExtension(Field $field): bool
             $field->isObject()
             && !empty($field->getObjectProperties())
         ) {
-            foreach ($field->getObjectProperties() as $field) {
-                if ($this->fieldRequiresIntlExtension($field)) {
+            foreach ($field->getObjectProperties() as $objectProperty) {
+                if ($this->fieldRequiresIntlExtension($objectProperty)) {
                     return true;
                 }
             }