vendor/api-platform/core/src/OpenApi/OpenApi.php line 22

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the API Platform project.
  5.  *
  6.  * (c) Kévin Dunglas <dunglas@gmail.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. declare(strict_types=1);
  14. namespace ApiPlatform\OpenApi;
  16. use ApiPlatform\Documentation\DocumentationInterface;
  17. use ApiPlatform\OpenApi\Model\Components;
  18. use ApiPlatform\OpenApi\Model\ExtensionTrait;
  19. use ApiPlatform\OpenApi\Model\Info;
  20. use ApiPlatform\OpenApi\Model\Paths;
  22. final class OpenApi implements DocumentationInterface
  23. {
  24.     use ExtensionTrait;
  26.     // We're actually supporting 3.1 but swagger ui has a version constraint
  27.     // public const VERSION = '3.1.0';
  28.     public const VERSION = '3.0.0';
  30.     private $openapi;
  31.     private $info;
  32.     private $servers;
  33.     private $paths;
  34.     private $components;
  35.     private $security;
  36.     private $tags;
  37.     private $externalDocs;
  38.     private $jsonSchemaDialect;
  39.     private $webhooks;
  41.     public function __construct(Info $info, array $servers, Paths $paths, Components $components = null, array $security = [], array $tags = [], $externalDocs = null, string $jsonSchemaDialect = null, \ArrayObject $webhooks = null)
  42.     {
  43.         $this->openapi = self::VERSION;
  44.         $this->info = $info;
  45.         $this->servers = $servers;
  46.         $this->paths = $paths;
  47.         $this->components = $components;
  48.         $this->security = $security;
  49.         $this->tags = $tags;
  50.         $this->externalDocs = $externalDocs;
  51.         $this->jsonSchemaDialect = $jsonSchemaDialect;
  52.         $this->webhooks = $webhooks;
  53.     }
  55.     public function getOpenapi(): string
  56.     {
  57.         return $this->openapi;
  58.     }
  60.     public function getInfo(): Info
  61.     {
  62.         return $this->info;
  63.     }
  65.     public function getServers(): array
  66.     {
  67.         return $this->servers;
  68.     }
  70.     public function getPaths(): Paths
  71.     {
  72.         return $this->paths;
  73.     }
  75.     public function getComponents(): Components
  76.     {
  77.         return $this->components;
  78.     }
  80.     public function getSecurity(): array
  81.     {
  82.         return $this->security;
  83.     }
  85.     public function getTags(): array
  86.     {
  87.         return $this->tags;
  88.     }
  90.     public function getExternalDocs(): ?array
  91.     {
  92.         return $this->externalDocs;
  93.     }
  95.     public function getJsonSchemaDialect(): ?string
  96.     {
  97.         return $this->jsonSchemaDialect;
  98.     }
  100.     public function getWebhooks(): ?\ArrayObject
  101.     {
  102.         return $this->webhooks;
  103.     }
  105.     public function withOpenapi(string $openapi): self
  106.     {
  107.         $clone = clone $this;
  108.         $clone->openapi = $openapi;
  110.         return $clone;
  111.     }
  113.     public function withInfo(Info $info): self
  114.     {
  115.         $clone = clone $this;
  116.         $clone->info = $info;
  118.         return $clone;
  119.     }
  121.     public function withServers(array $servers): self
  122.     {
  123.         $clone = clone $this;
  124.         $clone->servers = $servers;
  126.         return $clone;
  127.     }
  129.     public function withPaths(Paths $paths): self
  130.     {
  131.         $clone = clone $this;
  132.         $clone->paths = $paths;
  134.         return $clone;
  135.     }
  137.     public function withComponents(Components $components): self
  138.     {
  139.         $clone = clone $this;
  140.         $clone->components = $components;
  142.         return $clone;
  143.     }
  145.     public function withSecurity(array $security): self
  146.     {
  147.         $clone = clone $this;
  148.         $clone->security = $security;
  150.         return $clone;
  151.     }
  153.     public function withTags(array $tags): self
  154.     {
  155.         $clone = clone $this;
  156.         $clone->tags = $tags;
  158.         return $clone;
  159.     }
  161.     public function withExternalDocs(array $externalDocs): self
  162.     {
  163.         $clone = clone $this;
  164.         $clone->externalDocs = $externalDocs;
  166.         return $clone;
  167.     }
  169.     public function withJsonSchemaDialect(?string $jsonSchemaDialect): self
  170.     {
  171.         $clone = clone $this;
  172.         $clone->jsonSchemaDialect = $jsonSchemaDialect;
  174.         return $clone;
  175.     }
  176. }
  178. class_alias(OpenApi::class, \ApiPlatform\Core\OpenApi\OpenApi::class);