vendor/api-platform/core/src/Metadata/Operation.php line 226

  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\State\OptionsInterface;
  18. /**
  19.  * âš  This class and its children offer no backward compatibility regarding positional parameters.
  20.  */
  21. abstract class Operation
  22. {
  23.     use WithResourceTrait;
  25.     /**
  26.      * @param bool|null                           $paginationEnabled              {@see https://api-platform.com/docs/core/pagination/#for-a-specific-resource}
  27.      * @param string|null                         $paginationType                 {@see https://api-platform.com/docs/core/graphql/#using-the-page-based-pagination}
  28.      * @param int|null                            $paginationItemsPerPage         {@see https://api-platform.com/docs/core/pagination/#changing-the-number-of-items-per-page}
  29.      * @param int|null                            $paginationMaximumItemsPerPage  {@see https://api-platform.com/docs/core/pagination/#changing-maximum-items-per-page}
  30.      * @param bool|null                           $paginationPartial              {@see https://api-platform.com/docs/core/performance/#partial-pagination}
  31.      * @param bool|null                           $paginationClientEnabled        {@see https://api-platform.com/docs/core/pagination/#for-a-specific-resource-1}
  32.      * @param bool|null                           $paginationClientItemsPerPage   {@see https://api-platform.com/docs/core/pagination/#for-a-specific-resource-3}
  33.      * @param bool|null                           $paginationClientPartial        {@see https://api-platform.com/docs/core/pagination/#for-a-specific-resource-6}
  34.      * @param bool|null                           $paginationFetchJoinCollection  {@see https://api-platform.com/docs/core/pagination/#controlling-the-behavior-of-the-doctrine-orm-paginator}
  35.      * @param array<string, string>|string[]|null $order                          {@see https://api-platform.com/docs/core/default-order/#overriding-default-order}
  36.      * @param string|null                         $security                       {@see https://api-platform.com/docs/core/security}
  37.      * @param string|null                         $securityMessage                {@see https://api-platform.com/docs/core/security/#configuring-the-access-control-error-message}
  38.      * @param string|null                         $securityPostDenormalize        {@see https://api-platform.com/docs/core/security/#executing-access-control-rules-after-denormalization}
  39.      * @param string|null                         $securityPostDenormalizeMessage {@see https://api-platform.com/docs/core/security/#configuring-the-access-control-error-message}
  40.      * @param string|null                         $deprecationReason              {@see https://api-platform.com/docs/core/deprecations/#deprecating-resource-classes-operations-and-properties}
  41.      * @param string[]|null                       $filters                        {@see https://api-platform.com/docs/core/filters/#doctrine-orm-and-mongodb-odm-filters}
  42.      * @param array{
  43.      *     class?: string|null,
  44.      *     name?: string,
  45.      * }|string|false|null $input {@see https://api-platform.com/docs/core/dto/#specifying-an-input-or-an-output-data-representation}
  46.      * @param array{
  47.      *     class?: string|null,
  48.      *     name?: string,
  49.      * }|string|false|null $output {@see https://api-platform.com/docs/core/dto/#specifying-an-input-or-an-output-data-representation}
  50.      * @param string|array|bool|null $mercure       {@see https://api-platform.com/docs/core/mercure}
  51.      * @param string|bool|null       $messenger     {@see https://api-platform.com/docs/core/messenger/#dispatching-a-resource-through-the-message-bus}
  52.      * @param bool|null              $elasticsearch {@see https://api-platform.com/docs/core/elasticsearch/}
  53.      * @param bool|null              $read          {@see https://api-platform.com/docs/core/events/#the-event-system}
  54.      * @param bool|null              $deserialize   {@see https://api-platform.com/docs/core/events/#the-event-system}
  55.      * @param bool|null              $validate      {@see https://api-platform.com/docs/core/events/#the-event-system}
  56.      * @param bool|null              $write         {@see https://api-platform.com/docs/core/events/#the-event-system}
  57.      * @param bool|null              $serialize     {@see https://api-platform.com/docs/core/events/#the-event-system}
  58.      * @param bool|null              $fetchPartial  {@see https://api-platform.com/docs/core/performance/#fetch-partial}
  59.      * @param bool|null              $forceEager    {@see https://api-platform.com/docs/core/performance/#force-eager}
  60.      * @param string|callable|null   $provider      {@see https://api-platform.com/docs/core/state-providers/#state-providers}
  61.      * @param string|callable|null   $processor     {@see https://api-platform.com/docs/core/state-processors/#state-processors}
  62.      */
  63.     public function __construct(
  64.         protected ?string $shortName = null,
  65.         protected ?string $class = null,
  66.         protected ?bool $paginationEnabled = null,
  67.         protected ?string $paginationType = null,
  68.         protected ?int $paginationItemsPerPage = null,
  69.         protected ?int $paginationMaximumItemsPerPage = null,
  70.         protected ?bool $paginationPartial = null,
  71.         protected ?bool $paginationClientEnabled = null,
  72.         protected ?bool $paginationClientItemsPerPage = null,
  73.         protected ?bool $paginationClientPartial = null,
  74.         protected ?bool $paginationFetchJoinCollection = null,
  75.         protected ?bool $paginationUseOutputWalkers = null,
  76.         protected ?array $order = null,
  77.         protected ?string $description = null,
  78.         protected ?array $normalizationContext = null,
  79.         protected ?array $denormalizationContext = null,
  80.         protected ?bool $collectDenormalizationErrors = null,
  81.         protected ?string $security = null,
  82.         protected ?string $securityMessage = null,
  83.         protected ?string $securityPostDenormalize = null,
  84.         protected ?string $securityPostDenormalizeMessage = null,
  85.         protected ?string $securityPostValidation = null,
  86.         protected ?string $securityPostValidationMessage = null,
  87.         protected ?string $deprecationReason = null,
  88.         protected ?array $filters = null,
  89.         protected ?array $validationContext = null,
  90.         protected $input = null,
  91.         protected $output = null,
  92.         protected $mercure = null,
  93.         protected $messenger = null,
  94.         protected ?bool $elasticsearch = null,
  95.         protected ?int $urlGenerationStrategy = null,
  96.         protected ?bool $read = null,
  97.         protected ?bool $deserialize = null,
  98.         protected ?bool $validate = null,
  99.         protected ?bool $write = null,
  100.         protected ?bool $serialize = null,
  101.         protected ?bool $fetchPartial = null,
  102.         protected ?bool $forceEager = null,
  103.         protected ?int $priority = null,
  104.         protected ?string $name = null,
  105.         protected $provider = null,
  106.         protected $processor = null,
  107.         protected ?OptionsInterface $stateOptions = null,
  108.         protected array $extraProperties = [],
  109.     ) {
  110.     }
  112.     public function withOperation($operation)
  113.     {
  114.         return $this->copyFrom($operation);
  115.     }
  117.     public function getShortName(): ?string
  118.     {
  119.         return $this->shortName;
  120.     }
  122.     public function withShortName(string $shortName = null): self
  123.     {
  124.         $self = clone $this;
  125.         $self->shortName = $shortName;
  127.         return $self;
  128.     }
  130.     public function getClass(): ?string
  131.     {
  132.         return $this->class;
  133.     }
  135.     public function withClass(string $class = null): self
  136.     {
  137.         $self = clone $this;
  138.         $self->class = $class;
  140.         return $self;
  141.     }
  143.     public function getPaginationEnabled(): ?bool
  144.     {
  145.         return $this->paginationEnabled;
  146.     }
  148.     public function withPaginationEnabled(bool $paginationEnabled = null): self
  149.     {
  150.         $self = clone $this;
  151.         $self->paginationEnabled = $paginationEnabled;
  153.         return $self;
  154.     }
  156.     public function getPaginationType(): ?string
  157.     {
  158.         return $this->paginationType;
  159.     }
  161.     public function withPaginationType(string $paginationType = null): self
  162.     {
  163.         $self = clone $this;
  164.         $self->paginationType = $paginationType;
  166.         return $self;
  167.     }
  169.     public function getPaginationItemsPerPage(): ?int
  170.     {
  171.         return $this->paginationItemsPerPage;
  172.     }
  174.     public function withPaginationItemsPerPage(int $paginationItemsPerPage = null): self
  175.     {
  176.         $self = clone $this;
  177.         $self->paginationItemsPerPage = $paginationItemsPerPage;
  179.         return $self;
  180.     }
  182.     public function getPaginationMaximumItemsPerPage(): ?int
  183.     {
  184.         return $this->paginationMaximumItemsPerPage;
  185.     }
  187.     public function withPaginationMaximumItemsPerPage(int $paginationMaximumItemsPerPage = null): self
  188.     {
  189.         $self = clone $this;
  190.         $self->paginationMaximumItemsPerPage = $paginationMaximumItemsPerPage;
  192.         return $self;
  193.     }
  195.     public function getPaginationPartial(): ?bool
  196.     {
  197.         return $this->paginationPartial;
  198.     }
  200.     public function withPaginationPartial(bool $paginationPartial = null): self
  201.     {
  202.         $self = clone $this;
  203.         $self->paginationPartial = $paginationPartial;
  205.         return $self;
  206.     }
  208.     public function getPaginationClientEnabled(): ?bool
  209.     {
  210.         return $this->paginationClientEnabled;
  211.     }
  213.     public function withPaginationClientEnabled(bool $paginationClientEnabled = null): self
  214.     {
  215.         $self = clone $this;
  216.         $self->paginationClientEnabled = $paginationClientEnabled;
  218.         return $self;
  219.     }
  221.     public function getPaginationClientItemsPerPage(): ?bool
  222.     {
  223.         return $this->paginationClientItemsPerPage;
  224.     }
  226.     public function withPaginationClientItemsPerPage(bool $paginationClientItemsPerPage = null): self
  227.     {
  228.         $self = clone $this;
  229.         $self->paginationClientItemsPerPage = $paginationClientItemsPerPage;
  231.         return $self;
  232.     }
  234.     public function getPaginationClientPartial(): ?bool
  235.     {
  236.         return $this->paginationClientPartial;
  237.     }
  239.     public function withPaginationClientPartial(bool $paginationClientPartial = null): self
  240.     {
  241.         $self = clone $this;
  242.         $self->paginationClientPartial = $paginationClientPartial;
  244.         return $self;
  245.     }
  247.     public function getPaginationFetchJoinCollection(): ?bool
  248.     {
  249.         return $this->paginationFetchJoinCollection;
  250.     }
  252.     public function withPaginationFetchJoinCollection(bool $paginationFetchJoinCollection = null): self
  253.     {
  254.         $self = clone $this;
  255.         $self->paginationFetchJoinCollection = $paginationFetchJoinCollection;
  257.         return $self;
  258.     }
  260.     public function getPaginationUseOutputWalkers(): ?bool
  261.     {
  262.         return $this->paginationUseOutputWalkers;
  263.     }
  265.     public function withPaginationUseOutputWalkers(bool $paginationUseOutputWalkers = null): self
  266.     {
  267.         $self = clone $this;
  268.         $self->paginationUseOutputWalkers = $paginationUseOutputWalkers;
  270.         return $self;
  271.     }
  273.     public function getOrder(): ?array
  274.     {
  275.         return $this->order;
  276.     }
  278.     public function withOrder(array $order = []): self
  279.     {
  280.         $self = clone $this;
  281.         $self->order = $order;
  283.         return $self;
  284.     }
  286.     public function getDescription(): ?string
  287.     {
  288.         return $this->description;
  289.     }
  291.     public function withDescription(string $description = null): self
  292.     {
  293.         $self = clone $this;
  294.         $self->description = $description;
  296.         return $self;
  297.     }
  299.     public function getNormalizationContext(): ?array
  300.     {
  301.         return $this->normalizationContext;
  302.     }
  304.     public function withNormalizationContext(array $normalizationContext = []): self
  305.     {
  306.         $self = clone $this;
  307.         $self->normalizationContext = $normalizationContext;
  309.         return $self;
  310.     }
  312.     public function getDenormalizationContext(): ?array
  313.     {
  314.         return $this->denormalizationContext;
  315.     }
  317.     public function withDenormalizationContext(array $denormalizationContext = []): self
  318.     {
  319.         $self = clone $this;
  320.         $self->denormalizationContext = $denormalizationContext;
  322.         return $self;
  323.     }
  325.     public function getCollectDenormalizationErrors(): ?bool
  326.     {
  327.         return $this->collectDenormalizationErrors;
  328.     }
  330.     public function withCollectDenormalizationErrors(bool $collectDenormalizationErrors = null): self
  331.     {
  332.         $self = clone $this;
  333.         $self->collectDenormalizationErrors = $collectDenormalizationErrors;
  335.         return $self;
  336.     }
  338.     public function getSecurity(): ?string
  339.     {
  340.         return $this->security;
  341.     }
  343.     public function withSecurity(string $security = null): self
  344.     {
  345.         $self = clone $this;
  346.         $self->security = $security;
  348.         return $self;
  349.     }
  351.     public function getSecurityMessage(): ?string
  352.     {
  353.         return $this->securityMessage;
  354.     }
  356.     public function withSecurityMessage(string $securityMessage = null): self
  357.     {
  358.         $self = clone $this;
  359.         $self->securityMessage = $securityMessage;
  361.         return $self;
  362.     }
  364.     public function getSecurityPostDenormalize(): ?string
  365.     {
  366.         return $this->securityPostDenormalize;
  367.     }
  369.     public function withSecurityPostDenormalize(string $securityPostDenormalize = null): self
  370.     {
  371.         $self = clone $this;
  372.         $self->securityPostDenormalize = $securityPostDenormalize;
  374.         return $self;
  375.     }
  377.     public function getSecurityPostDenormalizeMessage(): ?string
  378.     {
  379.         return $this->securityPostDenormalizeMessage;
  380.     }
  382.     public function withSecurityPostDenormalizeMessage(string $securityPostDenormalizeMessage = null): self
  383.     {
  384.         $self = clone $this;
  385.         $self->securityPostDenormalizeMessage = $securityPostDenormalizeMessage;
  387.         return $self;
  388.     }
  390.     public function getSecurityPostValidation(): ?string
  391.     {
  392.         return $this->securityPostValidation;
  393.     }
  395.     public function withSecurityPostValidation(string $securityPostValidation = null): self
  396.     {
  397.         $self = clone $this;
  398.         $self->securityPostValidation = $securityPostValidation;
  400.         return $self;
  401.     }
  403.     public function getSecurityPostValidationMessage(): ?string
  404.     {
  405.         return $this->securityPostValidationMessage;
  406.     }
  408.     public function withSecurityPostValidationMessage(string $securityPostValidationMessage = null): self
  409.     {
  410.         $self = clone $this;
  411.         $self->securityPostValidationMessage = $securityPostValidationMessage;
  413.         return $self;
  414.     }
  416.     public function getDeprecationReason(): ?string
  417.     {
  418.         return $this->deprecationReason;
  419.     }
  421.     public function withDeprecationReason(string $deprecationReason = null): self
  422.     {
  423.         $self = clone $this;
  424.         $self->deprecationReason = $deprecationReason;
  426.         return $self;
  427.     }
  429.     public function getFilters(): ?array
  430.     {
  431.         return $this->filters;
  432.     }
  434.     public function withFilters(array $filters = []): self
  435.     {
  436.         $self = clone $this;
  437.         $self->filters = $filters;
  439.         return $self;
  440.     }
  442.     public function getValidationContext(): ?array
  443.     {
  444.         return $this->validationContext;
  445.     }
  447.     public function withValidationContext(array $validationContext = []): self
  448.     {
  449.         $self = clone $this;
  450.         $self->validationContext = $validationContext;
  452.         return $self;
  453.     }
  455.     public function getInput()
  456.     {
  457.         return $this->input;
  458.     }
  460.     public function withInput($input = null): self
  461.     {
  462.         $self = clone $this;
  463.         $self->input = $input;
  465.         return $self;
  466.     }
  468.     public function getOutput()
  469.     {
  470.         return $this->output;
  471.     }
  473.     public function withOutput($output = null): self
  474.     {
  475.         $self = clone $this;
  476.         $self->output = $output;
  478.         return $self;
  479.     }
  481.     public function getMercure()
  482.     {
  483.         return $this->mercure;
  484.     }
  486.     public function withMercure($mercure = null): self
  487.     {
  488.         $self = clone $this;
  489.         $self->mercure = $mercure;
  491.         return $self;
  492.     }
  494.     public function getMessenger()
  495.     {
  496.         return $this->messenger;
  497.     }
  499.     public function withMessenger($messenger = null): self
  500.     {
  501.         $self = clone $this;
  502.         $self->messenger = $messenger;
  504.         return $self;
  505.     }
  507.     public function getElasticsearch(): ?bool
  508.     {
  509.         return $this->elasticsearch;
  510.     }
  512.     public function withElasticsearch(bool $elasticsearch = null): self
  513.     {
  514.         $self = clone $this;
  515.         $self->elasticsearch = $elasticsearch;
  517.         return $self;
  518.     }
  520.     public function getUrlGenerationStrategy(): ?int
  521.     {
  522.         return $this->urlGenerationStrategy;
  523.     }
  525.     public function withUrlGenerationStrategy(int $urlGenerationStrategy = null): self
  526.     {
  527.         $self = clone $this;
  528.         $self->urlGenerationStrategy = $urlGenerationStrategy;
  530.         return $self;
  531.     }
  533.     public function canRead(): ?bool
  534.     {
  535.         return $this->read;
  536.     }
  538.     public function withRead(bool $read = true): self
  539.     {
  540.         $self = clone $this;
  541.         $self->read = $read;
  543.         return $self;
  544.     }
  546.     public function canDeserialize(): ?bool
  547.     {
  548.         return $this->deserialize;
  549.     }
  551.     public function withDeserialize(bool $deserialize = true): self
  552.     {
  553.         $self = clone $this;
  554.         $self->deserialize = $deserialize;
  556.         return $self;
  557.     }
  559.     public function canValidate(): ?bool
  560.     {
  561.         return $this->validate;
  562.     }
  564.     public function withValidate(bool $validate = true): self
  565.     {
  566.         $self = clone $this;
  567.         $self->validate = $validate;
  569.         return $self;
  570.     }
  572.     public function canWrite(): ?bool
  573.     {
  574.         return $this->write;
  575.     }
  577.     public function withWrite(bool $write = true): self
  578.     {
  579.         $self = clone $this;
  580.         $self->write = $write;
  582.         return $self;
  583.     }
  585.     public function canSerialize(): ?bool
  586.     {
  587.         return $this->serialize;
  588.     }
  590.     public function withSerialize(bool $serialize = true): self
  591.     {
  592.         $self = clone $this;
  593.         $self->serialize = $serialize;
  595.         return $self;
  596.     }
  598.     public function getFetchPartial(): ?bool
  599.     {
  600.         return $this->fetchPartial;
  601.     }
  603.     public function withFetchPartial(bool $fetchPartial = null): self
  604.     {
  605.         $self = clone $this;
  606.         $self->fetchPartial = $fetchPartial;
  608.         return $self;
  609.     }
  611.     public function getForceEager(): ?bool
  612.     {
  613.         return $this->forceEager;
  614.     }
  616.     public function withForceEager(bool $forceEager = null): self
  617.     {
  618.         $self = clone $this;
  619.         $self->forceEager = $forceEager;
  621.         return $self;
  622.     }
  624.     public function getPriority(): ?int
  625.     {
  626.         return $this->priority;
  627.     }
  629.     public function withPriority(int $priority = 0): self
  630.     {
  631.         $self = clone $this;
  632.         $self->priority = $priority;
  634.         return $self;
  635.     }
  637.     public function getName(): ?string
  638.     {
  639.         return $this->name;
  640.     }
  642.     public function withName(string $name = ''): self
  643.     {
  644.         $self = clone $this;
  645.         $self->name = $name;
  647.         return $self;
  648.     }
  650.     public function getProcessor(): callable|string|null
  651.     {
  652.         return $this->processor;
  653.     }
  655.     public function withProcessor(callable|string|null $processor): self
  656.     {
  657.         $self = clone $this;
  658.         $self->processor = $processor;
  660.         return $self;
  661.     }
  663.     public function getProvider(): callable|string|null
  664.     {
  665.         return $this->provider;
  666.     }
  668.     public function withProvider(callable|string|null $provider): self
  669.     {
  670.         $self = clone $this;
  671.         $self->provider = $provider;
  673.         return $self;
  674.     }
  676.     public function getExtraProperties(): array
  677.     {
  678.         return $this->extraProperties;
  679.     }
  681.     public function withExtraProperties(array $extraProperties = []): self
  682.     {
  683.         $self = clone $this;
  684.         $self->extraProperties = $extraProperties;
  686.         return $self;
  687.     }
  689.     public function getStateOptions(): ?OptionsInterface
  690.     {
  691.         return $this->stateOptions;
  692.     }
  694.     public function withStateOptions(?OptionsInterface $stateOptions): self
  695.     {
  696.         $self = clone $this;
  697.         $self->stateOptions = $stateOptions;
  699.         return $self;
  700.     }
  701. }