Merge pull request #5 from openapi-php/remove-nullable-pathitem

Remove nullable PathItem

Author: marcelthole

src/spec/OpenApi.php

@@ -16,7 +16,7 @@
  * @property string $openapi
  * @property Info $info
  * @property array<Server> $servers
- * @property Paths|array<PathItem> $paths
+ * @property Paths $paths
  * @property Components|null $components
  * @property array<PathItem>|null $webhooks
  * @property array<SecurityRequirement> $security

src/spec/Paths.php

@@ -34,12 +34,12 @@
  *
  * @link https://github.com/OAI/OpenAPI-Specification/blob/3.0.2/versions/3.0.2.md#pathsObject
  *
- * @implements ArrayAccess<string, PathItem|null>
- * @implements IteratorAggregate<string, PathItem|null>
+ * @implements ArrayAccess<string, PathItem>
+ * @implements IteratorAggregate<string, PathItem>
  */
 class Paths implements SpecObjectInterface, DocumentContextInterface, ArrayAccess, Countable, IteratorAggregate
 {
-    /** @var array<string, PathItem|null> */
+    /** @var array<string, PathItem> */
     private array $_paths = [];
     /** @var list<string> */
     private array $_errors                          = [];
@@ -57,11 +57,11 @@ public function __construct(array $data)
     {
         foreach ($data as $path => $object) {
             if ($object === null) {
-                $this->_paths[$path] = null;
+                $this->removePath($path);
             } elseif (is_array($object)) {
-                $this->_paths[$path] = new PathItem($object);
+                $this->addPath($path, new PathItem($object));
             } elseif ($object instanceof PathItem) {
-                $this->_paths[$path] = $object;
+                $this->addPath($path, $object);
             } else {
                 $givenType = gettype($object);
                 if (is_object($object)) {
@@ -81,7 +81,7 @@ public function getSerializableData(): object
     {
         $data = [];
         foreach ($this->_paths as $path => $pathItem) {
-            $data[$path] = $pathItem?->getSerializableData();
+            $data[$path] = $pathItem->getSerializableData();
         }
 
         return (object) $data;
@@ -115,10 +115,14 @@ public function addPath(string $name, PathItem $pathItem): void
     /** @param string $name path name */
     public function removePath(string $name): void
     {
+        if (! $this->hasPath($name)) {
+            return;
+        }
+
         unset($this->_paths[$name]);
     }
 
-    /** @return array<string, PathItem|null> */
+    /** @return array<string, PathItem> */
     public function getPaths(): array
     {
         return $this->_paths;
@@ -136,10 +140,6 @@ public function validate(): bool
         $valid         = true;
         $this->_errors = [];
         foreach ($this->_paths as $key => $path) {
-            if ($path === null) {
-                continue;
-            }
-
             if (! $path->validate()) {
                 $valid = false;
             }
@@ -169,10 +169,6 @@ public function getErrors(): array
         }
 
         foreach ($this->_paths as $path) {
-            if ($path === null) {
-                continue;
-            }
-
             $errors[] = $path->getErrors();
         }
 
@@ -267,7 +263,7 @@ public function count(): int
      *
      * @link http://php.net/manual/en/iteratoraggregate.getiterator.php
      *
-     * @return Traversable<PathItem|null> An instance of an object implementing <b>Iterator</b> or <b>Traversable</b>
+     * @return Traversable<PathItem> An instance of an object implementing <b>Iterator</b> or <b>Traversable</b>
      */
     public function getIterator(): Traversable
     {
@@ -282,10 +278,6 @@ public function getIterator(): Traversable
     public function resolveReferences(ReferenceContext|null $context = null): void
     {
         foreach ($this->_paths as $path) {
-            if ($path === null) {
-                continue;
-            }
-
             $path->resolveReferences($context);
         }
     }
@@ -296,10 +288,6 @@ public function resolveReferences(ReferenceContext|null $context = null): void
     public function setReferenceContext(ReferenceContext $context): void
     {
         foreach ($this->_paths as $path) {
-            if ($path === null) {
-                continue;
-            }
-
             $path->setReferenceContext($context);
         }
     }