vendor/api-platform/core/src/Metadata/HttpOperation.php line 220

  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\Metadata;
  16. use ApiPlatform\OpenApi\Model\Operation as OpenApiOperation;
  17. use ApiPlatform\State\OptionsInterface;
  19. class HttpOperation extends Operation
  20. {
  21.     public const METHOD_GET = 'GET';
  22.     public const METHOD_POST = 'POST';
  23.     public const METHOD_PUT = 'PUT';
  24.     public const METHOD_PATCH = 'PATCH';
  25.     public const METHOD_DELETE = 'DELETE';
  26.     public const METHOD_HEAD = 'HEAD';
  27.     public const METHOD_OPTIONS = 'OPTIONS';
  29.     /**
  30.      * @param string[]|null                                  $types         the RDF types of this property
  31.      * @param array<int|string, string|string[]>|string|null $formats       {@see https://api-platform.com/docs/core/content-negotiation/#configuring-formats-for-a-specific-resource-or-operation}
  32.      * @param array<int|string, string|string[]>|string|null $inputFormats  {@see https://api-platform.com/docs/core/content-negotiation/#configuring-formats-for-a-specific-resource-or-operation}
  33.      * @param array<int|string, string|string[]>|string|null $outputFormats {@see https://api-platform.com/docs/core/content-negotiation/#configuring-formats-for-a-specific-resource-or-operation}
  34.      * @param array<string,array{
  35.      *     0: string,
  36.      *     1: string
  37.      * }|array{
  38.      *     from_property?: string,
  39.      *     to_property?: string,
  40.      *     from_class?: string,
  41.      *     to_class?: string,
  42.      *     identifiers?: string[],
  43.      *     composite_identifier?: bool,
  44.      *     expanded_value?: string,
  45.      * }|Link>|string[]|string|null $uriVariables {@see https://api-platform.com/docs/core/subresources/}
  46.      * @param string|null     $routePrefix {@see https://api-platform.com/docs/core/operations/#prefixing-all-routes-of-all-operations}
  47.      * @param string|null     $sunset      {@see https://api-platform.com/docs/core/deprecations/#setting-the-sunset-http-header-to-indicate-when-a-resource-or-an-operation-will-be-removed}
  48.      * @param string|int|null $status      {@see https://api-platform.com/docs/core/operations/#configuring-operations}
  49.      * @param array{
  50.      *     max_age?: int,
  51.      *     vary?: string|string[],
  52.      *     public?: bool,
  53.      *     shared_max_age?: int,
  54.      *     stale_while_revalidate?: int,
  55.      *     stale-if-error?: int,
  56.      * }|null $cacheHeaders {@see https://api-platform.com/docs/core/performance/#setting-custom-http-cache-headers}
  57.      * @param array{
  58.      *     field: string,
  59.      *     direction: string,
  60.      * }|null $paginationViaCursor {@see https://api-platform.com/docs/core/pagination/#cursor-based-pagination}
  61.      * @param array|null $normalizationContext   {@see https://api-platform.com/docs/core/serialization/#using-serialization-groups}
  62.      * @param array|null $denormalizationContext {@see https://api-platform.com/docs/core/serialization/#using-serialization-groups}
  63.      * @param array|null $hydraContext           {@see https://api-platform.com/docs/core/extending-jsonld-context/#hydra}
  64.      * @param array|null $openapiContext         {@see https://api-platform.com/docs/core/openapi/#using-the-openapi-and-swagger-contexts}
  65.      * @param array{
  66.      *     class?: string|null,
  67.      *     name?: string,
  68.      * }|string|false|null $input {@see https://api-platform.com/docs/core/dto/#specifying-an-input-or-an-output-data-representation}
  69.      * @param array{
  70.      *     class?: string|null,
  71.      *     name?: string,
  72.      * }|string|false|null $output {@see https://api-platform.com/docs/core/dto/#specifying-an-input-or-an-output-data-representation}
  73.      * @param string|array|bool|null $mercure   {@see https://api-platform.com/docs/core/mercure}
  74.      * @param string|bool|null       $messenger {@see https://api-platform.com/docs/core/messenger/#dispatching-a-resource-through-the-message-bus}
  75.      * @param string|callable|null   $provider  {@see https://api-platform.com/docs/core/state-providers/#state-providers}
  76.      * @param string|callable|null   $processor {@see https://api-platform.com/docs/core/state-processors/#state-processors}
  77.      */
  78.     public function __construct(
  79.         protected string $method = self::METHOD_GET,
  80.         protected ?string $uriTemplate = null,
  81.         protected ?array $types = null,
  82.         protected $formats = null,
  83.         protected $inputFormats = null,
  84.         protected $outputFormats = null,
  85.         protected $uriVariables = null,
  86.         protected ?string $routePrefix = null,
  87.         protected ?string $routeName = null,
  88.         protected ?array $defaults = null,
  89.         protected ?array $requirements = null,
  90.         protected ?array $options = null,
  91.         protected ?bool $stateless = null,
  92.         protected ?string $sunset = null,
  93.         protected ?string $acceptPatch = null,
  94.         protected $status = null,
  95.         protected ?string $host = null,
  96.         protected ?array $schemes = null,
  97.         protected ?string $condition = null,
  98.         protected ?string $controller = null,
  99.         protected ?array $cacheHeaders = null,
  100.         protected ?array $paginationViaCursor = null,
  101.         protected ?array $hydraContext = null,
  102.         protected ?array $openapiContext = null, // TODO Remove in 4.0
  103.         protected bool|OpenApiOperation|null $openapi = null,
  104.         protected ?array $exceptionToStatus = null,
  105.         protected ?bool $queryParameterValidationEnabled = null,
  107.         string $shortName = null,
  108.         string $class = null,
  109.         bool $paginationEnabled = null,
  110.         string $paginationType = null,
  111.         int $paginationItemsPerPage = null,
  112.         int $paginationMaximumItemsPerPage = null,
  113.         bool $paginationPartial = null,
  114.         bool $paginationClientEnabled = null,
  115.         bool $paginationClientItemsPerPage = null,
  116.         bool $paginationClientPartial = null,
  117.         bool $paginationFetchJoinCollection = null,
  118.         bool $paginationUseOutputWalkers = null,
  119.         array $order = null,
  120.         string $description = null,
  121.         array $normalizationContext = null,
  122.         array $denormalizationContext = null,
  123.         bool $collectDenormalizationErrors = null,
  124.         string $security = null,
  125.         string $securityMessage = null,
  126.         string $securityPostDenormalize = null,
  127.         string $securityPostDenormalizeMessage = null,
  128.         string $securityPostValidation = null,
  129.         string $securityPostValidationMessage = null,
  130.         string $deprecationReason = null,
  131.         array $filters = null,
  132.         array $validationContext = null,
  133.         $input = null,
  134.         $output = null,
  135.         $mercure = null,
  136.         $messenger = null,
  137.         bool $elasticsearch = null,
  138.         int $urlGenerationStrategy = null,
  139.         bool $read = null,
  140.         bool $deserialize = null,
  141.         bool $validate = null,
  142.         bool $write = null,
  143.         bool $serialize = null,
  144.         bool $fetchPartial = null,
  145.         bool $forceEager = null,
  146.         int $priority = null,
  147.         string $name = null,
  148.         $provider = null,
  149.         $processor = null,
  150.         OptionsInterface $stateOptions = null,
  151.         array $extraProperties = [],
  152.     ) {
  153.         parent::__construct(
  154.             shortName: $shortName,
  155.             class: $class,
  156.             paginationEnabled: $paginationEnabled,
  157.             paginationType: $paginationType,
  158.             paginationItemsPerPage: $paginationItemsPerPage,
  159.             paginationMaximumItemsPerPage: $paginationMaximumItemsPerPage,
  160.             paginationPartial: $paginationPartial,
  161.             paginationClientEnabled: $paginationClientEnabled,
  162.             paginationClientItemsPerPage: $paginationClientItemsPerPage,
  163.             paginationClientPartial: $paginationClientPartial,
  164.             paginationFetchJoinCollection: $paginationFetchJoinCollection,
  165.             paginationUseOutputWalkers: $paginationUseOutputWalkers,
  166.             order: $order,
  167.             description: $description,
  168.             normalizationContext: $normalizationContext,
  169.             denormalizationContext: $denormalizationContext,
  170.             collectDenormalizationErrors: $collectDenormalizationErrors,
  171.             security: $security,
  172.             securityMessage: $securityMessage,
  173.             securityPostDenormalize: $securityPostDenormalize,
  174.             securityPostDenormalizeMessage: $securityPostDenormalizeMessage,
  175.             securityPostValidation: $securityPostValidation,
  176.             securityPostValidationMessage: $securityPostValidationMessage,
  177.             deprecationReason: $deprecationReason,
  178.             filters: $filters,
  179.             validationContext: $validationContext,
  180.             input: $input,
  181.             output: $output,
  182.             mercure: $mercure,
  183.             messenger: $messenger,
  184.             elasticsearch: $elasticsearch,
  185.             urlGenerationStrategy: $urlGenerationStrategy,
  186.             read: $read,
  187.             deserialize: $deserialize,
  188.             validate: $validate,
  189.             write: $write,
  190.             serialize: $serialize,
  191.             fetchPartial: $fetchPartial,
  192.             forceEager: $forceEager,
  193.             priority: $priority,
  194.             name: $name,
  195.             provider: $provider,
  196.             processor: $processor,
  197.             stateOptions: $stateOptions,
  198.             extraProperties: $extraProperties
  199.         );
  200.     }
  202.     public function getMethod(): string
  203.     {
  204.         return $this->method;
  205.     }
  207.     public function withMethod(string $method): self
  208.     {
  209.         $self = clone $this;
  210.         $self->method = $method;
  212.         return $self;
  213.     }
  215.     public function getUriTemplate(): ?string
  216.     {
  217.         return $this->uriTemplate;
  218.     }
  220.     public function withUriTemplate(string $uriTemplate = null)
  221.     {
  222.         $self = clone $this;
  223.         $self->uriTemplate = $uriTemplate;
  225.         return $self;
  226.     }
  228.     public function getTypes(): ?array
  229.     {
  230.         return $this->types;
  231.     }
  233.     /**
  234.      * @param string[]|string $types
  235.      */
  236.     public function withTypes($types): self
  237.     {
  238.         $self = clone $this;
  239.         $self->types = (array) $types;
  241.         return $self;
  242.     }
  244.     public function getFormats()
  245.     {
  246.         return $this->formats;
  247.     }
  249.     public function withFormats($formats = null): self
  250.     {
  251.         $self = clone $this;
  252.         $self->formats = $formats;
  254.         return $self;
  255.     }
  257.     public function getInputFormats()
  258.     {
  259.         return $this->inputFormats;
  260.     }
  262.     public function withInputFormats($inputFormats = null): self
  263.     {
  264.         $self = clone $this;
  265.         $self->inputFormats = $inputFormats;
  267.         return $self;
  268.     }
  270.     public function getOutputFormats()
  271.     {
  272.         return $this->outputFormats;
  273.     }
  275.     public function withOutputFormats($outputFormats = null): self
  276.     {
  277.         $self = clone $this;
  278.         $self->outputFormats = $outputFormats;
  280.         return $self;
  281.     }
  283.     public function getUriVariables()
  284.     {
  285.         return $this->uriVariables;
  286.     }
  288.     public function withUriVariables($uriVariables): self
  289.     {
  290.         $self = clone $this;
  291.         $self->uriVariables = $uriVariables;
  293.         return $self;
  294.     }
  296.     public function getRoutePrefix(): ?string
  297.     {
  298.         return $this->routePrefix;
  299.     }
  301.     public function withRoutePrefix(string $routePrefix): self
  302.     {
  303.         $self = clone $this;
  304.         $self->routePrefix = $routePrefix;
  306.         return $self;
  307.     }
  309.     public function getRouteName(): ?string
  310.     {
  311.         return $this->routeName;
  312.     }
  314.     public function withRouteName(?string $routeName): self
  315.     {
  316.         $self = clone $this;
  317.         $self->routeName = $routeName;
  319.         return $self;
  320.     }
  322.     public function getDefaults(): ?array
  323.     {
  324.         return $this->defaults;
  325.     }
  327.     public function withDefaults(array $defaults): self
  328.     {
  329.         $self = clone $this;
  330.         $self->defaults = $defaults;
  332.         return $self;
  333.     }
  335.     public function getRequirements(): ?array
  336.     {
  337.         return $this->requirements;
  338.     }
  340.     public function withRequirements(array $requirements): self
  341.     {
  342.         $self = clone $this;
  343.         $self->requirements = $requirements;
  345.         return $self;
  346.     }
  348.     public function getOptions(): ?array
  349.     {
  350.         return $this->options;
  351.     }
  353.     public function withOptions(array $options): self
  354.     {
  355.         $self = clone $this;
  356.         $self->options = $options;
  358.         return $self;
  359.     }
  361.     public function getStateless(): ?bool
  362.     {
  363.         return $this->stateless;
  364.     }
  366.     public function withStateless($stateless): self
  367.     {
  368.         $self = clone $this;
  369.         $self->stateless = $stateless;
  371.         return $self;
  372.     }
  374.     public function getSunset(): ?string
  375.     {
  376.         return $this->sunset;
  377.     }
  379.     public function withSunset(string $sunset): self
  380.     {
  381.         $self = clone $this;
  382.         $self->sunset = $sunset;
  384.         return $self;
  385.     }
  387.     public function getAcceptPatch(): ?string
  388.     {
  389.         return $this->acceptPatch;
  390.     }
  392.     public function withAcceptPatch(string $acceptPatch): self
  393.     {
  394.         $self = clone $this;
  395.         $self->acceptPatch = $acceptPatch;
  397.         return $self;
  398.     }
  400.     public function getStatus(): ?int
  401.     {
  402.         return $this->status;
  403.     }
  405.     public function withStatus(int $status): self
  406.     {
  407.         $self = clone $this;
  408.         $self->status = $status;
  410.         return $self;
  411.     }
  413.     public function getHost(): ?string
  414.     {
  415.         return $this->host;
  416.     }
  418.     public function withHost(string $host): self
  419.     {
  420.         $self = clone $this;
  421.         $self->host = $host;
  423.         return $self;
  424.     }
  426.     public function getSchemes(): ?array
  427.     {
  428.         return $this->schemes;
  429.     }
  431.     public function withSchemes(array $schemes): self
  432.     {
  433.         $self = clone $this;
  434.         $self->schemes = $schemes;
  436.         return $self;
  437.     }
  439.     public function getCondition(): ?string
  440.     {
  441.         return $this->condition;
  442.     }
  444.     public function withCondition(string $condition): self
  445.     {
  446.         $self = clone $this;
  447.         $self->condition = $condition;
  449.         return $self;
  450.     }
  452.     public function getController(): ?string
  453.     {
  454.         return $this->controller;
  455.     }
  457.     public function withController(string $controller): self
  458.     {
  459.         $self = clone $this;
  460.         $self->controller = $controller;
  462.         return $self;
  463.     }
  465.     public function getCacheHeaders(): ?array
  466.     {
  467.         return $this->cacheHeaders;
  468.     }
  470.     public function withCacheHeaders(array $cacheHeaders): self
  471.     {
  472.         $self = clone $this;
  473.         $self->cacheHeaders = $cacheHeaders;
  475.         return $self;
  476.     }
  478.     public function getPaginationViaCursor(): ?array
  479.     {
  480.         return $this->paginationViaCursor;
  481.     }
  483.     public function withPaginationViaCursor(array $paginationViaCursor): self
  484.     {
  485.         $self = clone $this;
  486.         $self->paginationViaCursor = $paginationViaCursor;
  488.         return $self;
  489.     }
  491.     public function getHydraContext(): ?array
  492.     {
  493.         return $this->hydraContext;
  494.     }
  496.     public function withHydraContext(array $hydraContext): self
  497.     {
  498.         $self = clone $this;
  499.         $self->hydraContext = $hydraContext;
  501.         return $self;
  502.     }
  504.     public function getOpenapiContext(): ?array
  505.     {
  506.         return $this->openapiContext;
  507.     }
  509.     public function withOpenapiContext(array $openapiContext): self
  510.     {
  511.         $self = clone $this;
  512.         $self->openapiContext = $openapiContext;
  514.         return $self;
  515.     }
  517.     public function getOpenapi(): bool|OpenApiOperation|null
  518.     {
  519.         return $this->openapi;
  520.     }
  522.     public function withOpenapi(bool|OpenApiOperation $openapi): self
  523.     {
  524.         $self = clone $this;
  525.         $self->openapi = $openapi;
  527.         return $self;
  528.     }
  530.     public function getExceptionToStatus(): ?array
  531.     {
  532.         return $this->exceptionToStatus;
  533.     }
  535.     public function withExceptionToStatus(array $exceptionToStatus): self
  536.     {
  537.         $self = clone $this;
  538.         $self->exceptionToStatus = $exceptionToStatus;
  540.         return $self;
  541.     }
  543.     public function getQueryParameterValidationEnabled(): ?bool
  544.     {
  545.         return $this->queryParameterValidationEnabled;
  546.     }
  548.     public function withQueryParameterValidationEnabled(bool $queryParameterValidationEnabled): self
  549.     {
  550.         $self = clone $this;
  551.         $self->queryParameterValidationEnabled = $queryParameterValidationEnabled;
  553.         return $self;
  554.     }
  555. }