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

  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;
  18. use Symfony\Component\WebLink\Link as WebLink;
  20. class HttpOperation extends Operation
  21. {
  22.     public const METHOD_GET = 'GET';
  23.     public const METHOD_POST = 'POST';
  24.     public const METHOD_PUT = 'PUT';
  25.     public const METHOD_PATCH = 'PATCH';
  26.     public const METHOD_DELETE = 'DELETE';
  27.     public const METHOD_HEAD = 'HEAD';
  28.     public const METHOD_OPTIONS = 'OPTIONS';
  30.     /**
  31.      * @param string[]|null                                  $types         the RDF types of this property
  32.      * @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}
  33.      * @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}
  34.      * @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}
  35.      * @param array<string,array{
  36.      *     0: string,
  37.      *     1: string
  38.      * }|array{
  39.      *     from_property?: string,
  40.      *     to_property?: string,
  41.      *     from_class?: string,
  42.      *     to_class?: string,
  43.      *     identifiers?: string[],
  44.      *     composite_identifier?: bool,
  45.      *     expanded_value?: string,
  46.      * }|Link>|string[]|string|null $uriVariables {@see https://api-platform.com/docs/core/subresources/}
  47.      * @param string|null     $routePrefix {@see https://api-platform.com/docs/core/operations/#prefixing-all-routes-of-all-operations}
  48.      * @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}
  49.      * @param string|int|null $status      {@see https://api-platform.com/docs/core/operations/#configuring-operations}
  50.      * @param array{
  51.      *     max_age?: int,
  52.      *     vary?: string|string[],
  53.      *     public?: bool,
  54.      *     shared_max_age?: int,
  55.      *     stale_while_revalidate?: int,
  56.      *     stale-if-error?: int,
  57.      * }|null $cacheHeaders {@see https://api-platform.com/docs/core/performance/#setting-custom-http-cache-headers}
  58.      * @param array{
  59.      *     field: string,
  60.      *     direction: string,
  61.      * }|null $paginationViaCursor {@see https://api-platform.com/docs/core/pagination/#cursor-based-pagination}
  62.      * @param array|null $normalizationContext   {@see https://api-platform.com/docs/core/serialization/#using-serialization-groups}
  63.      * @param array|null $denormalizationContext {@see https://api-platform.com/docs/core/serialization/#using-serialization-groups}
  64.      * @param array|null $hydraContext           {@see https://api-platform.com/docs/core/extending-jsonld-context/#hydra}
  65.      * @param array|null $openapiContext         {@see https://api-platform.com/docs/core/openapi/#using-the-openapi-and-swagger-contexts}
  66.      * @param array{
  67.      *     class?: string|null,
  68.      *     name?: string,
  69.      * }|string|false|null $input {@see https://api-platform.com/docs/core/dto/#specifying-an-input-or-an-output-data-representation}
  70.      * @param array{
  71.      *     class?: string|null,
  72.      *     name?: string,
  73.      * }|string|false|null $output {@see https://api-platform.com/docs/core/dto/#specifying-an-input-or-an-output-data-representation}
  74.      * @param string|array|bool|null $mercure   {@see https://api-platform.com/docs/core/mercure}
  75.      * @param string|bool|null       $messenger {@see https://api-platform.com/docs/core/messenger/#dispatching-a-resource-through-the-message-bus}
  76.      * @param string|callable|null   $provider  {@see https://api-platform.com/docs/core/state-providers/#state-providers}
  77.      * @param string|callable|null   $processor {@see https://api-platform.com/docs/core/state-processors/#state-processors}
  78.      * @param WebLink[]|null         $links
  79.      */
  80.     public function __construct(
  81.         protected string $method = 'GET',
  82.         protected ?string $uriTemplate = null,
  83.         protected ?array $types = null,
  84.         protected $formats = null,
  85.         protected $inputFormats = null,
  86.         protected $outputFormats = null,
  87.         protected $uriVariables = null,
  88.         protected ?string $routePrefix = null,
  89.         protected ?string $routeName = null,
  90.         protected ?array $defaults = null,
  91.         protected ?array $requirements = null,
  92.         protected ?array $options = null,
  93.         protected ?bool $stateless = null,
  94.         /**
  95.          * The `sunset` option indicates when a deprecated operation will be removed.
  96.          *
  97.          * <div data-code-selector>
  98.          *
  99.          * ```php
  100.          * <?php
  101.          * // api/src/Entity/Parchment.php
  102.          * use ApiPlatform\Metadata\Get;
  103.          *
  104.          * #[Get(deprecationReason: 'Create a Book instead', sunset: '01/01/2020')]
  105.          * class Parchment
  106.          * {
  107.          *     // ...
  108.          * }
  109.          * ```
  110.          *
  111.          * ```yaml
  112.          * # api/config/api_platform/resources.yaml
  113.          * resources:
  114.          *     App\Entity\Parchment:
  115.          *         - operations:
  116.          *               ApiPlatform\Metadata\Get:
  117.          *                   deprecationReason: 'Create a Book instead'
  118.          *                   sunset: '01/01/2020'
  119.          * ```
  120.          *
  121.          * ```xml
  122.          * <?xml version="1.0" encoding="UTF-8" ?>
  123.          * <!-- api/config/api_platform/resources.xml -->
  124.          *
  125.          * <resources
  126.          *         xmlns="https://api-platform.com/schema/metadata/resources-3.0"
  127.          *         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  128.          *         xsi:schemaLocation="https://api-platform.com/schema/metadata/resources-3.0
  129.          *         https://api-platform.com/schema/metadata/resources-3.0.xsd">
  130.          *     <resource class="App\Entity\Parchment">
  131.          *         <operations>
  132.          *             <operation class="ApiPlatform\Metadata\Get" deprecationReason="Create a Book instead" sunset="01/01/2020" />
  133.          *         <operations>
  134.          *     </resource>
  135.          * </resources>
  136.          * ```
  137.          *
  138.          * </div>
  139.          */
  140.         protected ?string $sunset = null,
  141.         protected ?string $acceptPatch = null,
  142.         protected $status = null,
  143.         protected ?string $host = null,
  144.         protected ?array $schemes = null,
  145.         protected ?string $condition = null,
  146.         protected ?string $controller = null,
  147.         protected ?array $cacheHeaders = null,
  148.         protected ?array $paginationViaCursor = null,
  149.         protected ?array $hydraContext = null,
  150.         protected ?array $openapiContext = null, // TODO Remove in 4.0
  151.         protected bool|OpenApiOperation|null $openapi = null,
  152.         protected ?array $exceptionToStatus = null,
  153.         protected ?bool $queryParameterValidationEnabled = null,
  154.         protected ?array $links = null,
  156.         string $shortName = null,
  157.         string $class = null,
  158.         bool $paginationEnabled = null,
  159.         string $paginationType = null,
  160.         int $paginationItemsPerPage = null,
  161.         int $paginationMaximumItemsPerPage = null,
  162.         bool $paginationPartial = null,
  163.         bool $paginationClientEnabled = null,
  164.         bool $paginationClientItemsPerPage = null,
  165.         bool $paginationClientPartial = null,
  166.         bool $paginationFetchJoinCollection = null,
  167.         bool $paginationUseOutputWalkers = null,
  168.         array $order = null,
  169.         string $description = null,
  170.         array $normalizationContext = null,
  171.         array $denormalizationContext = null,
  172.         bool $collectDenormalizationErrors = null,
  173.         string $security = null,
  174.         string $securityMessage = null,
  175.         string $securityPostDenormalize = null,
  176.         string $securityPostDenormalizeMessage = null,
  177.         string $securityPostValidation = null,
  178.         string $securityPostValidationMessage = null,
  179.         string $deprecationReason = null,
  180.         array $filters = null,
  181.         array $validationContext = null,
  182.         $input = null,
  183.         $output = null,
  184.         $mercure = null,
  185.         $messenger = null,
  186.         bool $elasticsearch = null,
  187.         int $urlGenerationStrategy = null,
  188.         bool $read = null,
  189.         bool $deserialize = null,
  190.         bool $validate = null,
  191.         bool $write = null,
  192.         bool $serialize = null,
  193.         bool $fetchPartial = null,
  194.         bool $forceEager = null,
  195.         int $priority = null,
  196.         string $name = null,
  197.         $provider = null,
  198.         $processor = null,
  199.         OptionsInterface $stateOptions = null,
  200.         array $extraProperties = [],
  201.     ) {
  202.         parent::__construct(
  203.             shortName: $shortName,
  204.             class: $class,
  205.             paginationEnabled: $paginationEnabled,
  206.             paginationType: $paginationType,
  207.             paginationItemsPerPage: $paginationItemsPerPage,
  208.             paginationMaximumItemsPerPage: $paginationMaximumItemsPerPage,
  209.             paginationPartial: $paginationPartial,
  210.             paginationClientEnabled: $paginationClientEnabled,
  211.             paginationClientItemsPerPage: $paginationClientItemsPerPage,
  212.             paginationClientPartial: $paginationClientPartial,
  213.             paginationFetchJoinCollection: $paginationFetchJoinCollection,
  214.             paginationUseOutputWalkers: $paginationUseOutputWalkers,
  215.             order: $order,
  216.             description: $description,
  217.             normalizationContext: $normalizationContext,
  218.             denormalizationContext: $denormalizationContext,
  219.             collectDenormalizationErrors: $collectDenormalizationErrors,
  220.             security: $security,
  221.             securityMessage: $securityMessage,
  222.             securityPostDenormalize: $securityPostDenormalize,
  223.             securityPostDenormalizeMessage: $securityPostDenormalizeMessage,
  224.             securityPostValidation: $securityPostValidation,
  225.             securityPostValidationMessage: $securityPostValidationMessage,
  226.             deprecationReason: $deprecationReason,
  227.             filters: $filters,
  228.             validationContext: $validationContext,
  229.             input: $input,
  230.             output: $output,
  231.             mercure: $mercure,
  232.             messenger: $messenger,
  233.             elasticsearch: $elasticsearch,
  234.             urlGenerationStrategy: $urlGenerationStrategy,
  235.             read: $read,
  236.             deserialize: $deserialize,
  237.             validate: $validate,
  238.             write: $write,
  239.             serialize: $serialize,
  240.             fetchPartial: $fetchPartial,
  241.             forceEager: $forceEager,
  242.             priority: $priority,
  243.             name: $name,
  244.             provider: $provider,
  245.             processor: $processor,
  246.             stateOptions: $stateOptions,
  247.             extraProperties: $extraProperties
  248.         );
  249.     }
  251.     public function getMethod(): string
  252.     {
  253.         return $this->method;
  254.     }
  256.     public function withMethod(string $method): self
  257.     {
  258.         $self = clone $this;
  259.         $self->method = $method;
  261.         return $self;
  262.     }
  264.     public function getUriTemplate(): ?string
  265.     {
  266.         return $this->uriTemplate;
  267.     }
  269.     public function withUriTemplate(string $uriTemplate = null)
  270.     {
  271.         $self = clone $this;
  272.         $self->uriTemplate = $uriTemplate;
  274.         return $self;
  275.     }
  277.     public function getTypes(): ?array
  278.     {
  279.         return $this->types;
  280.     }
  282.     /**
  283.      * @param string[]|string $types
  284.      */
  285.     public function withTypes($types): self
  286.     {
  287.         $self = clone $this;
  288.         $self->types = (array) $types;
  290.         return $self;
  291.     }
  293.     public function getFormats()
  294.     {
  295.         return $this->formats;
  296.     }
  298.     public function withFormats($formats = null): self
  299.     {
  300.         $self = clone $this;
  301.         $self->formats = $formats;
  303.         return $self;
  304.     }
  306.     public function getInputFormats()
  307.     {
  308.         return $this->inputFormats;
  309.     }
  311.     public function withInputFormats($inputFormats = null): self
  312.     {
  313.         $self = clone $this;
  314.         $self->inputFormats = $inputFormats;
  316.         return $self;
  317.     }
  319.     public function getOutputFormats()
  320.     {
  321.         return $this->outputFormats;
  322.     }
  324.     public function withOutputFormats($outputFormats = null): self
  325.     {
  326.         $self = clone $this;
  327.         $self->outputFormats = $outputFormats;
  329.         return $self;
  330.     }
  332.     public function getUriVariables()
  333.     {
  334.         return $this->uriVariables;
  335.     }
  337.     public function withUriVariables($uriVariables): self
  338.     {
  339.         $self = clone $this;
  340.         $self->uriVariables = $uriVariables;
  342.         return $self;
  343.     }
  345.     public function getRoutePrefix(): ?string
  346.     {
  347.         return $this->routePrefix;
  348.     }
  350.     public function withRoutePrefix(string $routePrefix): self
  351.     {
  352.         $self = clone $this;
  353.         $self->routePrefix = $routePrefix;
  355.         return $self;
  356.     }
  358.     public function getRouteName(): ?string
  359.     {
  360.         return $this->routeName;
  361.     }
  363.     public function withRouteName(?string $routeName): self
  364.     {
  365.         $self = clone $this;
  366.         $self->routeName = $routeName;
  368.         return $self;
  369.     }
  371.     public function getDefaults(): ?array
  372.     {
  373.         return $this->defaults;
  374.     }
  376.     public function withDefaults(array $defaults): self
  377.     {
  378.         $self = clone $this;
  379.         $self->defaults = $defaults;
  381.         return $self;
  382.     }
  384.     public function getRequirements(): ?array
  385.     {
  386.         return $this->requirements;
  387.     }
  389.     public function withRequirements(array $requirements): self
  390.     {
  391.         $self = clone $this;
  392.         $self->requirements = $requirements;
  394.         return $self;
  395.     }
  397.     public function getOptions(): ?array
  398.     {
  399.         return $this->options;
  400.     }
  402.     public function withOptions(array $options): self
  403.     {
  404.         $self = clone $this;
  405.         $self->options = $options;
  407.         return $self;
  408.     }
  410.     public function getStateless(): ?bool
  411.     {
  412.         return $this->stateless;
  413.     }
  415.     public function withStateless($stateless): self
  416.     {
  417.         $self = clone $this;
  418.         $self->stateless = $stateless;
  420.         return $self;
  421.     }
  423.     public function getSunset(): ?string
  424.     {
  425.         return $this->sunset;
  426.     }
  428.     public function withSunset(string $sunset): self
  429.     {
  430.         $self = clone $this;
  431.         $self->sunset = $sunset;
  433.         return $self;
  434.     }
  436.     public function getAcceptPatch(): ?string
  437.     {
  438.         return $this->acceptPatch;
  439.     }
  441.     public function withAcceptPatch(string $acceptPatch): self
  442.     {
  443.         $self = clone $this;
  444.         $self->acceptPatch = $acceptPatch;
  446.         return $self;
  447.     }
  449.     public function getStatus(): ?int
  450.     {
  451.         return $this->status;
  452.     }
  454.     public function withStatus(int $status): self
  455.     {
  456.         $self = clone $this;
  457.         $self->status = $status;
  459.         return $self;
  460.     }
  462.     public function getHost(): ?string
  463.     {
  464.         return $this->host;
  465.     }
  467.     public function withHost(string $host): self
  468.     {
  469.         $self = clone $this;
  470.         $self->host = $host;
  472.         return $self;
  473.     }
  475.     public function getSchemes(): ?array
  476.     {
  477.         return $this->schemes;
  478.     }
  480.     public function withSchemes(array $schemes): self
  481.     {
  482.         $self = clone $this;
  483.         $self->schemes = $schemes;
  485.         return $self;
  486.     }
  488.     public function getCondition(): ?string
  489.     {
  490.         return $this->condition;
  491.     }
  493.     public function withCondition(string $condition): self
  494.     {
  495.         $self = clone $this;
  496.         $self->condition = $condition;
  498.         return $self;
  499.     }
  501.     public function getController(): ?string
  502.     {
  503.         return $this->controller;
  504.     }
  506.     public function withController(string $controller): self
  507.     {
  508.         $self = clone $this;
  509.         $self->controller = $controller;
  511.         return $self;
  512.     }
  514.     public function getCacheHeaders(): ?array
  515.     {
  516.         return $this->cacheHeaders;
  517.     }
  519.     public function withCacheHeaders(array $cacheHeaders): self
  520.     {
  521.         $self = clone $this;
  522.         $self->cacheHeaders = $cacheHeaders;
  524.         return $self;
  525.     }
  527.     public function getPaginationViaCursor(): ?array
  528.     {
  529.         return $this->paginationViaCursor;
  530.     }
  532.     public function withPaginationViaCursor(array $paginationViaCursor): self
  533.     {
  534.         $self = clone $this;
  535.         $self->paginationViaCursor = $paginationViaCursor;
  537.         return $self;
  538.     }
  540.     public function getHydraContext(): ?array
  541.     {
  542.         return $this->hydraContext;
  543.     }
  545.     public function withHydraContext(array $hydraContext): self
  546.     {
  547.         $self = clone $this;
  548.         $self->hydraContext = $hydraContext;
  550.         return $self;
  551.     }
  553.     public function getOpenapiContext(): ?array
  554.     {
  555.         return $this->openapiContext;
  556.     }
  558.     public function withOpenapiContext(array $openapiContext): self
  559.     {
  560.         $self = clone $this;
  561.         $self->openapiContext = $openapiContext;
  563.         return $self;
  564.     }
  566.     public function getOpenapi(): bool|OpenApiOperation|null
  567.     {
  568.         return $this->openapi;
  569.     }
  571.     public function withOpenapi(bool|OpenApiOperation $openapi): self
  572.     {
  573.         $self = clone $this;
  574.         $self->openapi = $openapi;
  576.         return $self;
  577.     }
  579.     public function getExceptionToStatus(): ?array
  580.     {
  581.         return $this->exceptionToStatus;
  582.     }
  584.     public function withExceptionToStatus(array $exceptionToStatus): self
  585.     {
  586.         $self = clone $this;
  587.         $self->exceptionToStatus = $exceptionToStatus;
  589.         return $self;
  590.     }
  592.     public function getQueryParameterValidationEnabled(): ?bool
  593.     {
  594.         return $this->queryParameterValidationEnabled;
  595.     }
  597.     public function withQueryParameterValidationEnabled(bool $queryParameterValidationEnabled): self
  598.     {
  599.         $self = clone $this;
  600.         $self->queryParameterValidationEnabled = $queryParameterValidationEnabled;
  602.         return $self;
  603.     }
  605.     public function getLinks(): ?array
  606.     {
  607.         return $this->links;
  608.     }
  610.     /**
  611.      * @param WebLink[] $links
  612.      */
  613.     public function withLinks(array $links): self
  614.     {
  615.         $self = clone $this;
  616.         $self->links = $links;
  618.         return $self;
  619.     }
  620. }