vendor/api-platform/core/src/OpenApi/Model/Operation.php line 170

  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\Model;
  16. final class Operation
  17. {
  18.     use ExtensionTrait;
  20.     public function __construct(private ?string $operationId = null, private ?array $tags = null, private ?array $responses = null, private ?string $summary = null, private ?string $description = null, private ?ExternalDocumentation $externalDocs = null, private ?array $parameters = null, private ?RequestBody $requestBody = null, private ?\ArrayObject $callbacks = null, private ?bool $deprecated = null, private ?array $security = null, private ?array $servers = null, array $extensionProperties = [])
  21.     {
  22.         $this->extensionProperties = $extensionProperties;
  23.     }
  25.     public function addResponse(Response $response, $status = 'default'): self
  26.     {
  27.         $this->responses[$status] = $response;
  29.         return $this;
  30.     }
  32.     public function getOperationId(): ?string
  33.     {
  34.         return $this->operationId;
  35.     }
  37.     public function getTags(): ?array
  38.     {
  39.         return $this->tags;
  40.     }
  42.     public function getResponses(): ?array
  43.     {
  44.         return $this->responses;
  45.     }
  47.     public function getSummary(): ?string
  48.     {
  49.         return $this->summary;
  50.     }
  52.     public function getDescription(): ?string
  53.     {
  54.         return $this->description;
  55.     }
  57.     public function getExternalDocs(): ?ExternalDocumentation
  58.     {
  59.         return $this->externalDocs;
  60.     }
  62.     public function getParameters(): ?array
  63.     {
  64.         return $this->parameters;
  65.     }
  67.     public function getRequestBody(): ?RequestBody
  68.     {
  69.         return $this->requestBody;
  70.     }
  72.     public function getCallbacks(): ?\ArrayObject
  73.     {
  74.         return $this->callbacks;
  75.     }
  77.     public function getDeprecated(): ?bool
  78.     {
  79.         return $this->deprecated;
  80.     }
  82.     public function getSecurity(): ?array
  83.     {
  84.         return $this->security;
  85.     }
  87.     public function getServers(): ?array
  88.     {
  89.         return $this->servers;
  90.     }
  92.     public function withOperationId(string $operationId): self
  93.     {
  94.         $clone = clone $this;
  95.         $clone->operationId = $operationId;
  97.         return $clone;
  98.     }
  100.     public function withTags(array $tags): self
  101.     {
  102.         $clone = clone $this;
  103.         $clone->tags = $tags;
  105.         return $clone;
  106.     }
  108.     public function withResponses(array $responses): self
  109.     {
  110.         $clone = clone $this;
  111.         $clone->responses = $responses;
  113.         return $clone;
  114.     }
  116.     public function withResponse(int|string $status, Response $response): self
  117.     {
  118.         $clone = clone $this;
  119.         if (!\is_array($clone->responses)) {
  120.             $clone->responses = [];
  121.         }
  122.         $clone->responses[(string) $status] = $response;
  124.         return $clone;
  125.     }
  127.     public function withSummary(string $summary): self
  128.     {
  129.         $clone = clone $this;
  130.         $clone->summary = $summary;
  132.         return $clone;
  133.     }
  135.     public function withDescription(string $description): self
  136.     {
  137.         $clone = clone $this;
  138.         $clone->description = $description;
  140.         return $clone;
  141.     }
  143.     public function withExternalDocs(ExternalDocumentation $externalDocs): self
  144.     {
  145.         $clone = clone $this;
  146.         $clone->externalDocs = $externalDocs;
  148.         return $clone;
  149.     }
  151.     public function withParameters(array $parameters): self
  152.     {
  153.         $clone = clone $this;
  154.         $clone->parameters = $parameters;
  156.         return $clone;
  157.     }
  159.     public function withParameter(Parameter $parameter): self
  160.     {
  161.         $clone = clone $this;
  162.         if (!\is_array($clone->parameters)) {
  163.             $clone->parameters = [];
  164.         }
  165.         $clone->parameters[] = $parameter;
  167.         return $clone;
  168.     }
  170.     public function withRequestBody(RequestBody $requestBody = null): self
  171.     {
  172.         $clone = clone $this;
  173.         $clone->requestBody = $requestBody;
  175.         return $clone;
  176.     }
  178.     public function withCallbacks(\ArrayObject $callbacks): self
  179.     {
  180.         $clone = clone $this;
  181.         $clone->callbacks = $callbacks;
  183.         return $clone;
  184.     }
  186.     public function withDeprecated(bool $deprecated): self
  187.     {
  188.         $clone = clone $this;
  189.         $clone->deprecated = $deprecated;
  191.         return $clone;
  192.     }
  194.     public function withSecurity(array $security = null): self
  195.     {
  196.         $clone = clone $this;
  197.         $clone->security = $security;
  199.         return $clone;
  200.     }
  202.     public function withServers(array $servers = null): self
  203.     {
  204.         $clone = clone $this;
  205.         $clone->servers = $servers;
  207.         return $clone;
  208.     }
  209. }