Merge pull request #86 from Yarre/support-optional-nullable

Support optional nullable

Author: vsouz4

CHANGELOG.md

@@ -0,0 +1,61 @@
+<?php
+
+namespace OpenApi\PetStoreApiConsumer;
+
+use GuzzleHttp\Client;
+use OpenApi\PetStoreClient\Request\DeletePetRequest;
+use OpenApi\PetStoreClient\Request\FindPetsByStatusRequest;
+use OpenApi\PetStoreClient\Request\GetPetByIdRequest;
+use OpenApi\PetStoreClient\Request\UpdatePetRequest;
+use OpenApi\PetStoreClient\Schema\Pet;
+use OpenApi\PetStoreClient\SwaggerPetstoreOpenAPI3ClientFactory;
+use UnexpectedValueException;
+
+class PetStoreApiConsumer
+{
+    private $petClient;
+
+    public function __construct()
+    {
+        $this->petClient = (new SwaggerPetstoreOpenAPI3ClientFactory())
+            ->create(new Client(['base_uri' => 'http://pet.wiremock:8080']));
+    }
+
+    public function findPetsByStatus(): Pet
+    {
+        $request = new FindPetsByStatusRequest();
+        $request->setStatus('sold');
+        $result = $this->petClient->findPetsByStatus($request);
+        if ($result === null || $result->count() === 0) {
+            throw new UnexpectedValueException('findPetsByStatus should be not null or empty');
+        }
+
+        return $result->first();
+    }
+
+    public function getPetById(int $petId): Pet
+    {
+        $request = new GetPetByIdRequest($petId);
+        $result  = $this->petClient->getPetById($request);
+        if ($result === null) {
+            throw new UnexpectedValueException('getPetById should not be null');
+        }
+
+        return $result;
+    }
+
+    public function updatePet(Pet $pet, string $mimeType): void
+    {
+        $request = new UpdatePetRequest($pet, $mimeType);
+        $result  = $this->petClient->updatePet($request);
+        if ($result === null) {
+            printf('getPetById failed, result: %s', json_encode($result, JSON_THROW_ON_ERROR)) || exit(1);
+        }
+    }
+
+    public function deletePet(int $petId): void
+    {
+        $request = new DeletePetRequest($petId);
+        $this->petClient->deletePet($request);
+    }
+}

README.md

@@ -10,7 +10,7 @@
     },
     "require": {
         "php": ">=7.4",
-        "docler-labs/api-client-exception": "^1.0",
+        "docler-labs/api-client-exception": "^1.0|^2.0",
         "ext-dom": "*",
         "ext-json": "*",
         "guzzlehttp/psr7": "^1.6",

example/PetStoreApiConsumer/PetStoreApiConsumer.php

@@ -1089,6 +1089,11 @@
               "pending",
               "sold"
             ]
+          },
+          "chipped": {
+            "type": "boolean",
+            "description": "Is pet is chipped or not. Null means there is no information",
+            "nullable": true
           }
         },
         "xml": {

example/gen/README.md renamed to example/PetStoreClient/README.md

@@ -18,20 +18,34 @@ class Category implements SerializableInterface, JsonSerializable
 
     private ?string $name = null;
 
+    private array $optionalPropertyChanged = ['id' => false, 'name' => false];
+
     public function setId(int $id): self
     {
-        $this->id = $id;
+        $this->id                            = $id;
+        $this->optionalPropertyChanged['id'] = true;
 
         return $this;
     }
 
     public function setName(string $name): self
     {
-        $this->name = $name;
+        $this->name                            = $name;
+        $this->optionalPropertyChanged['name'] = true;
 
         return $this;
     }
 
+    public function hasId(): bool
+    {
+        return $this->optionalPropertyChanged['id'];
+    }
+
+    public function hasName(): bool
+    {
+        return $this->optionalPropertyChanged['name'];
+    }
+
     public function getId(): ?int
     {
         return $this->id;
@@ -45,10 +59,10 @@ public function getName(): ?string
     public function toArray(): array
     {
         $fields = [];
-        if ($this->id !== null) {
+        if ($this->hasId()) {
             $fields['id'] = $this->id;
         }
-        if ($this->name !== null) {
+        if ($this->hasName()) {
             $fields['name'] = $this->name;
         }
 

example/gen/composer.json renamed to example/PetStoreClient/composer.json

@@ -47,6 +47,9 @@ public function toSchema(array $payload): Pet
         if (isset($payload['status'])) {
             $schema->setStatus($payload['status']);
         }
+        if (\array_key_exists('chipped', $payload)) {
+            $schema->setChipped($payload['chipped']);
+        }
 
         return $schema;
     }

example/gen/doc/petstore3.json renamed to example/PetStoreClient/doc/petstore3.json

@@ -33,48 +33,86 @@ class Order implements SerializableInterface, JsonSerializable
 
     private ?bool $complete = null;
 
+    private array $optionalPropertyChanged = ['id' => false, 'petId' => false, 'quantity' => false, 'shipDate' => false, 'status' => false, 'complete' => false];
+
     public function setId(int $id): self
     {
-        $this->id = $id;
+        $this->id                            = $id;
+        $this->optionalPropertyChanged['id'] = true;
 
         return $this;
     }
 
     public function setPetId(int $petId): self
     {
-        $this->petId = $petId;
+        $this->petId                            = $petId;
+        $this->optionalPropertyChanged['petId'] = true;
 
         return $this;
     }
 
     public function setQuantity(int $quantity): self
     {
-        $this->quantity = $quantity;
+        $this->quantity                            = $quantity;
+        $this->optionalPropertyChanged['quantity'] = true;
 
         return $this;
     }
 
     public function setShipDate(DateTimeInterface $shipDate): self
     {
-        $this->shipDate = $shipDate;
+        $this->shipDate                            = $shipDate;
+        $this->optionalPropertyChanged['shipDate'] = true;
 
         return $this;
     }
 
     public function setStatus(string $status): self
     {
-        $this->status = $status;
+        $this->status                            = $status;
+        $this->optionalPropertyChanged['status'] = true;
 
         return $this;
     }
 
     public function setComplete(bool $complete): self
     {
-        $this->complete = $complete;
+        $this->complete                            = $complete;
+        $this->optionalPropertyChanged['complete'] = true;
 
         return $this;
     }
 
+    public function hasId(): bool
+    {
+        return $this->optionalPropertyChanged['id'];
+    }
+
+    public function hasPetId(): bool
+    {
+        return $this->optionalPropertyChanged['petId'];
+    }
+
+    public function hasQuantity(): bool
+    {
+        return $this->optionalPropertyChanged['quantity'];
+    }
+
+    public function hasShipDate(): bool
+    {
+        return $this->optionalPropertyChanged['shipDate'];
+    }
+
+    public function hasStatus(): bool
+    {
+        return $this->optionalPropertyChanged['status'];
+    }
+
+    public function hasComplete(): bool
+    {
+        return $this->optionalPropertyChanged['complete'];
+    }
+
     public function getId(): ?int
     {
         return $this->id;
@@ -108,22 +146,22 @@ public function getComplete(): ?bool
     public function toArray(): array
     {
         $fields = [];
-        if ($this->id !== null) {
+        if ($this->hasId()) {
             $fields['id'] = $this->id;
         }
-        if ($this->petId !== null) {
+        if ($this->hasPetId()) {
             $fields['petId'] = $this->petId;
         }
-        if ($this->quantity !== null) {
+        if ($this->hasQuantity()) {
             $fields['quantity'] = $this->quantity;
         }
-        if ($this->shipDate !== null) {
+        if ($this->hasShipDate()) {
             $fields['shipDate'] = $this->shipDate->format(DATE_RFC3339);
         }
-        if ($this->status !== null) {
+        if ($this->hasStatus()) {
             $fields['status'] = $this->status;
         }
-        if ($this->complete !== null) {
+        if ($this->hasComplete()) {
             $fields['complete'] = $this->complete;
         }