Add Schema::hasType() to encapsulate string|array duality of schema type (#1936)

Author: DerManoMann

docs/examples/processors/schema-query-parameter/scan.php

@@ -23,7 +23,7 @@
 };
 
 $openapi = (new Generator())
-    ->withProcessorPipeline(function (Pipeline $pipeline) use ($insertMatch) { $pipeline->insert(new SchemaQueryParameter(), $insertMatch); })
+    ->withProcessorPipeline(fn (Pipeline $pipeline) => $pipeline->insert(new SchemaQueryParameter(), $insertMatch))
     ->generate([__DIR__ . '/app']);
 // file_put_contents(__DIR__ . '/schema-query-parameter.yaml', $openapi->toYaml());
 echo $openapi->toYaml();

src/Annotations/Schema.php

@@ -514,6 +514,14 @@ public function isNullable(): bool
         return !Generator::isDefault($this->nullable) && $this->nullable;
     }
 
+    /**
+     * Check if the given type is valid for this schema.
+     */
+    public function hasType(string $type): bool
+    {
+        return in_array($type, (array) $this->type, true);
+    }
+
     public function jsonSerialize(): \stdClass
     {
         $data = parent::jsonSerialize();
@@ -534,7 +542,7 @@ public function jsonSerialize(): \stdClass
      */
     public function validate(array $stack = [], array $skip = [], string $ref = '', ?object $context = null): bool
     {
-        if ($this->type === 'array' && Generator::isDefault($this->items)) {
+        if ($this->hasType('array') && Generator::isDefault($this->items)) {
             $this->_context->logger->warning('@OA\\Items() is required when ' . $this->identity() . ' has type "array" in ' . $this->_context);
 
             return false;

tests/Annotations/AttachableTest.php

@@ -33,7 +33,7 @@ public function testCustomAttachableImplementationsAreAttached(): void
             ->setTypeResolver($this->getTypeResolver())
             ->addAlias('oaf', 'OpenApi\Tests\Fixtures\Annotations')
             ->addNamespace('OpenApi\Tests\Fixtures\Annotations\\')
-            ->withProcessorPipeline(function (Pipeline $processor) { $processor->remove(null, function ($pipe) { return !$pipe instanceof CleanUnusedComponents; }); })
+            ->withProcessorPipeline(fn (Pipeline $processor) => $processor->remove(null, fn ($pipe) => !$pipe instanceof CleanUnusedComponents))
             ->generate($this->fixtures(['UsingCustomAttachables.php']), $analysis);
 
         $schemas = $analysis->getAnnotationsOfType(OA\Schema::class, true);

tests/Fixtures/Scratch/NestedSchema.php

@@ -70,7 +70,7 @@ public function __construct(
             uniqueItems: true,
             additionalProperties: new OAT\AdditionalProperties(
                 description: 'Array of error messages for property',
-                type: 'array',
+                type: ['array'],
                 items: new OAT\Items(
                     type: 'string',
                 ),

tests/Fixtures/Scratch/PromotedProperty3.0.0.yaml

@@ -24,15 +24,15 @@ components:
         other:
           description: 'Other value.'
           type: string
-        myEnum:
-          $ref: '#/components/schemas/MyEnum'
-        thename:
-          description: 'Property name.'
-          type: string
         themeta:
           description: 'Property meta.'
           type: string
         different:
           description: 'Property different.'
           type: string
+        myEnum:
+          $ref: '#/components/schemas/MyEnum'
+        thename:
+          description: 'Property name.'
+          type: string
       type: object

tests/Fixtures/Scratch/PromotedProperty3.1.0.yaml

@@ -24,15 +24,15 @@ components:
         other:
           description: 'Other value.'
           type: string
-        myEnum:
-          $ref: '#/components/schemas/MyEnum'
-        thename:
-          description: 'Property name.'
-          type: string
         themeta:
           description: 'Property meta.'
           type: string
         different:
           description: 'Property different.'
           type: string
+        myEnum:
+          $ref: '#/components/schemas/MyEnum'
+        thename:
+          description: 'Property name.'
+          type: string
       type: object

tests/Fixtures/Scratch/PromotedProperty3.2.0.yaml

@@ -24,15 +24,15 @@ components:
         other:
           description: 'Other value.'
           type: string
-        myEnum:
-          $ref: '#/components/schemas/MyEnum'
-        thename:
-          description: 'Property name.'
-          type: string
         themeta:
           description: 'Property meta.'
           type: string
         different:
           description: 'Property different.'
           type: string
+        myEnum:
+          $ref: '#/components/schemas/MyEnum'
+        thename:
+          description: 'Property name.'
+          type: string
       type: object

tests/Fixtures/Scratch/PropertyItems.php

@@ -33,7 +33,7 @@ class PropertyItems
         items: new OAT\Items(type: ItemDto::class),
         minItems: 2,
     )]
-    public array $list1;
+    public ?array $list1;
 
     /**
      * @var ItemDto[] $list2

tests/Fixtures/Scratch/PropertyItems3.0.0.yaml

@@ -32,6 +32,7 @@ components:
           items:
             $ref: '#/components/schemas/ItemDto'
           minItems: 2
+          nullable: true
         list2:
           description: 'With docblock'
           type: array

tests/Fixtures/Scratch/PropertyItems3.1.0.yaml

@@ -28,7 +28,9 @@ components:
       properties:
         list1:
           description: 'Missing docblock'
-          type: array
+          type:
+            - array
+            - 'null'
           items:
             $ref: '#/components/schemas/ItemDto'
           minItems: 2