vendor/api-platform/core/src/Metadata/Metadata.php line 509

  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.  * @internal
  20.  */
  21. abstract class Metadata
  22. {
  23.     /**
  24.      * @param string|null $deprecationReason       https://api-platform.com/docs/core/deprecations/#deprecating-resource-classes-operations-and-properties
  25.      * @param string|null $security                https://api-platform.com/docs/core/security
  26.      * @param string|null $securityPostDenormalize https://api-platform.com/docs/core/security/#executing-access-control-rules-after-denormalization
  27.      * @param mixed|null  $mercure
  28.      * @param mixed|null  $messenger
  29.      * @param mixed|null  $input
  30.      * @param mixed|null  $output
  31.      * @param mixed|null  $provider
  32.      * @param mixed|null  $processor
  33.      */
  34.     public function __construct(
  35.         protected ?string $shortName = null,
  36.         protected ?string $class = null,
  37.         protected ?string $description = null,
  38.         protected ?int $urlGenerationStrategy = null,
  39.         protected ?string $deprecationReason = null,
  40.         protected ?array $normalizationContext = null,
  41.         protected ?array $denormalizationContext = null,
  42.         protected ?bool $collectDenormalizationErrors = null,
  43.         protected ?array $validationContext = null,
  44.         protected ?array $filters = null,
  45.         protected ?bool $elasticsearch = null,
  46.         protected $mercure = null,
  47.         protected $messenger = null,
  48.         protected $input = null,
  49.         protected $output = null,
  50.         protected ?array $order = null,
  51.         protected ?bool $fetchPartial = null,
  52.         protected ?bool $forceEager = null,
  53.         protected ?bool $paginationEnabled = null,
  54.         protected ?string $paginationType = null,
  55.         protected ?int $paginationItemsPerPage = null,
  56.         protected ?int $paginationMaximumItemsPerPage = null,
  57.         protected ?bool $paginationPartial = null,
  58.         protected ?bool $paginationClientEnabled = null,
  59.         protected ?bool $paginationClientItemsPerPage = null,
  60.         protected ?bool $paginationClientPartial = null,
  61.         protected ?bool $paginationFetchJoinCollection = null,
  62.         protected ?bool $paginationUseOutputWalkers = null,
  63.         protected ?string $security = null,
  64.         protected ?string $securityMessage = null,
  65.         protected ?string $securityPostDenormalize = null,
  66.         protected ?string $securityPostDenormalizeMessage = null,
  67.         protected ?string $securityPostValidation = null,
  68.         protected ?string $securityPostValidationMessage = null,
  69.         protected $provider = null,
  70.         protected $processor = null,
  71.         protected ?OptionsInterface $stateOptions = null,
  72.         protected array $extraProperties = []
  73.     ) {
  74.     }
  76.     public function getShortName(): ?string
  77.     {
  78.         return $this->shortName;
  79.     }
  81.     public function withShortName(string $shortName): static
  82.     {
  83.         $self = clone $this;
  84.         $self->shortName = $shortName;
  86.         return $self;
  87.     }
  89.     public function getClass(): ?string
  90.     {
  91.         return $this->class;
  92.     }
  94.     public function withClass(string $class): static
  95.     {
  96.         $self = clone $this;
  97.         $self->class = $class;
  99.         return $self;
  100.     }
  102.     public function getDescription(): ?string
  103.     {
  104.         return $this->description;
  105.     }
  107.     public function withDescription(string $description = null): static
  108.     {
  109.         $self = clone $this;
  110.         $self->description = $description;
  112.         return $self;
  113.     }
  115.     public function getUrlGenerationStrategy(): ?int
  116.     {
  117.         return $this->urlGenerationStrategy;
  118.     }
  120.     public function withUrlGenerationStrategy(int $urlGenerationStrategy): static
  121.     {
  122.         $self = clone $this;
  123.         $self->urlGenerationStrategy = $urlGenerationStrategy;
  125.         return $self;
  126.     }
  128.     public function getDeprecationReason(): ?string
  129.     {
  130.         return $this->deprecationReason;
  131.     }
  133.     public function withDeprecationReason($deprecationReason): static
  134.     {
  135.         $self = clone $this;
  136.         $self->deprecationReason = $deprecationReason;
  138.         return $self;
  139.     }
  141.     public function getNormalizationContext(): ?array
  142.     {
  143.         return $this->normalizationContext;
  144.     }
  146.     public function withNormalizationContext(array $normalizationContext): static
  147.     {
  148.         $self = clone $this;
  149.         $self->normalizationContext = $normalizationContext;
  151.         return $self;
  152.     }
  154.     public function getDenormalizationContext(): ?array
  155.     {
  156.         return $this->denormalizationContext;
  157.     }
  159.     public function withDenormalizationContext(array $denormalizationContext): static
  160.     {
  161.         $self = clone $this;
  162.         $self->denormalizationContext = $denormalizationContext;
  164.         return $self;
  165.     }
  167.     public function getCollectDenormalizationErrors(): ?bool
  168.     {
  169.         return $this->collectDenormalizationErrors;
  170.     }
  172.     public function withCollectDenormalizationErrors(bool $collectDenormalizationErrors = null): static
  173.     {
  174.         $self = clone $this;
  175.         $self->collectDenormalizationErrors = $collectDenormalizationErrors;
  177.         return $self;
  178.     }
  180.     public function getValidationContext(): ?array
  181.     {
  182.         return $this->validationContext;
  183.     }
  185.     public function withValidationContext(array $validationContext): static
  186.     {
  187.         $self = clone $this;
  188.         $self->validationContext = $validationContext;
  190.         return $self;
  191.     }
  193.     /**
  194.      * @return string[]|null
  195.      */
  196.     public function getFilters(): ?array
  197.     {
  198.         return $this->filters;
  199.     }
  201.     public function withFilters(array $filters): static
  202.     {
  203.         $self = clone $this;
  204.         $self->filters = $filters;
  206.         return $self;
  207.     }
  209.     /**
  210.      * @deprecated this will be removed in v4
  211.      */
  212.     public function getElasticsearch(): ?bool
  213.     {
  214.         return $this->elasticsearch;
  215.     }
  217.     /**
  218.      * @deprecated this will be removed in v4
  219.      */
  220.     public function withElasticsearch(bool $elasticsearch): static
  221.     {
  222.         $self = clone $this;
  223.         $self->elasticsearch = $elasticsearch;
  225.         return $self;
  226.     }
  228.     /**
  229.      * @return array|bool|mixed|null
  230.      */
  231.     public function getMercure()
  232.     {
  233.         return $this->mercure;
  234.     }
  236.     public function withMercure($mercure): static
  237.     {
  238.         $self = clone $this;
  239.         $self->mercure = $mercure;
  241.         return $self;
  242.     }
  244.     public function getMessenger()
  245.     {
  246.         return $this->messenger;
  247.     }
  249.     public function withMessenger($messenger): static
  250.     {
  251.         $self = clone $this;
  252.         $self->messenger = $messenger;
  254.         return $self;
  255.     }
  257.     public function getInput()
  258.     {
  259.         return $this->input;
  260.     }
  262.     public function withInput($input): static
  263.     {
  264.         $self = clone $this;
  265.         $self->input = $input;
  267.         return $self;
  268.     }
  270.     public function getOutput()
  271.     {
  272.         return $this->output;
  273.     }
  275.     public function withOutput($output): static
  276.     {
  277.         $self = clone $this;
  278.         $self->output = $output;
  280.         return $self;
  281.     }
  283.     public function getOrder(): ?array
  284.     {
  285.         return $this->order;
  286.     }
  288.     public function withOrder(array $order): static
  289.     {
  290.         $self = clone $this;
  291.         $self->order = $order;
  293.         return $self;
  294.     }
  296.     public function getFetchPartial(): ?bool
  297.     {
  298.         return $this->fetchPartial;
  299.     }
  301.     public function withFetchPartial(bool $fetchPartial): static
  302.     {
  303.         $self = clone $this;
  304.         $self->fetchPartial = $fetchPartial;
  306.         return $self;
  307.     }
  309.     public function getForceEager(): ?bool
  310.     {
  311.         return $this->forceEager;
  312.     }
  314.     public function withForceEager(bool $forceEager): static
  315.     {
  316.         $self = clone $this;
  317.         $self->forceEager = $forceEager;
  319.         return $self;
  320.     }
  322.     public function getPaginationEnabled(): ?bool
  323.     {
  324.         return $this->paginationEnabled;
  325.     }
  327.     public function withPaginationEnabled(bool $paginationEnabled): static
  328.     {
  329.         $self = clone $this;
  330.         $self->paginationEnabled = $paginationEnabled;
  332.         return $self;
  333.     }
  335.     public function getPaginationType(): ?string
  336.     {
  337.         return $this->paginationType;
  338.     }
  340.     public function withPaginationType(string $paginationType): static
  341.     {
  342.         $self = clone $this;
  343.         $self->paginationType = $paginationType;
  345.         return $self;
  346.     }
  348.     public function getPaginationItemsPerPage(): ?int
  349.     {
  350.         return $this->paginationItemsPerPage;
  351.     }
  353.     public function withPaginationItemsPerPage(int $paginationItemsPerPage): static
  354.     {
  355.         $self = clone $this;
  356.         $self->paginationItemsPerPage = $paginationItemsPerPage;
  358.         return $self;
  359.     }
  361.     public function getPaginationMaximumItemsPerPage(): ?int
  362.     {
  363.         return $this->paginationMaximumItemsPerPage;
  364.     }
  366.     public function withPaginationMaximumItemsPerPage(int $paginationMaximumItemsPerPage): static
  367.     {
  368.         $self = clone $this;
  369.         $self->paginationMaximumItemsPerPage = $paginationMaximumItemsPerPage;
  371.         return $self;
  372.     }
  374.     public function getPaginationPartial(): ?bool
  375.     {
  376.         return $this->paginationPartial;
  377.     }
  379.     public function withPaginationPartial(bool $paginationPartial): static
  380.     {
  381.         $self = clone $this;
  382.         $self->paginationPartial = $paginationPartial;
  384.         return $self;
  385.     }
  387.     public function getPaginationClientEnabled(): ?bool
  388.     {
  389.         return $this->paginationClientEnabled;
  390.     }
  392.     public function withPaginationClientEnabled(bool $paginationClientEnabled): static
  393.     {
  394.         $self = clone $this;
  395.         $self->paginationClientEnabled = $paginationClientEnabled;
  397.         return $self;
  398.     }
  400.     public function getPaginationClientItemsPerPage(): ?bool
  401.     {
  402.         return $this->paginationClientItemsPerPage;
  403.     }
  405.     public function withPaginationClientItemsPerPage(bool $paginationClientItemsPerPage): static
  406.     {
  407.         $self = clone $this;
  408.         $self->paginationClientItemsPerPage = $paginationClientItemsPerPage;
  410.         return $self;
  411.     }
  413.     public function getPaginationClientPartial(): ?bool
  414.     {
  415.         return $this->paginationClientPartial;
  416.     }
  418.     public function withPaginationClientPartial(bool $paginationClientPartial): static
  419.     {
  420.         $self = clone $this;
  421.         $self->paginationClientPartial = $paginationClientPartial;
  423.         return $self;
  424.     }
  426.     public function getPaginationFetchJoinCollection(): ?bool
  427.     {
  428.         return $this->paginationFetchJoinCollection;
  429.     }
  431.     public function withPaginationFetchJoinCollection(bool $paginationFetchJoinCollection): static
  432.     {
  433.         $self = clone $this;
  434.         $self->paginationFetchJoinCollection = $paginationFetchJoinCollection;
  436.         return $self;
  437.     }
  439.     public function getPaginationUseOutputWalkers(): ?bool
  440.     {
  441.         return $this->paginationUseOutputWalkers;
  442.     }
  444.     public function withPaginationUseOutputWalkers(bool $paginationUseOutputWalkers): static
  445.     {
  446.         $self = clone $this;
  447.         $self->paginationUseOutputWalkers = $paginationUseOutputWalkers;
  449.         return $self;
  450.     }
  452.     public function getSecurity(): ?string
  453.     {
  454.         return $this->security;
  455.     }
  457.     public function withSecurity($security): static
  458.     {
  459.         $self = clone $this;
  460.         $self->security = $security;
  462.         return $self;
  463.     }
  465.     public function getSecurityMessage(): ?string
  466.     {
  467.         return $this->securityMessage;
  468.     }
  470.     public function withSecurityMessage(string $securityMessage): static
  471.     {
  472.         $self = clone $this;
  473.         $self->securityMessage = $securityMessage;
  475.         return $self;
  476.     }
  478.     public function getSecurityPostDenormalize(): ?string
  479.     {
  480.         return $this->securityPostDenormalize;
  481.     }
  483.     public function withSecurityPostDenormalize($securityPostDenormalize): static
  484.     {
  485.         $self = clone $this;
  486.         $self->securityPostDenormalize = $securityPostDenormalize;
  488.         return $self;
  489.     }
  491.     public function getSecurityPostDenormalizeMessage(): ?string
  492.     {
  493.         return $this->securityPostDenormalizeMessage;
  494.     }
  496.     public function withSecurityPostDenormalizeMessage(string $securityPostDenormalizeMessage): static
  497.     {
  498.         $self = clone $this;
  499.         $self->securityPostDenormalizeMessage = $securityPostDenormalizeMessage;
  501.         return $self;
  502.     }
  504.     public function getSecurityPostValidation(): ?string
  505.     {
  506.         return $this->securityPostValidation;
  507.     }
  509.     public function withSecurityPostValidation(string $securityPostValidation = null): static
  510.     {
  511.         $self = clone $this;
  512.         $self->securityPostValidation = $securityPostValidation;
  514.         return $self;
  515.     }
  517.     public function getSecurityPostValidationMessage(): ?string
  518.     {
  519.         return $this->securityPostValidationMessage;
  520.     }
  522.     public function withSecurityPostValidationMessage(string $securityPostValidationMessage = null): static
  523.     {
  524.         $self = clone $this;
  525.         $self->securityPostValidationMessage = $securityPostValidationMessage;
  527.         return $self;
  528.     }
  530.     public function getProcessor(): callable|string|null
  531.     {
  532.         return $this->processor;
  533.     }
  535.     public function withProcessor(callable|string|null $processor): static
  536.     {
  537.         $self = clone $this;
  538.         $self->processor = $processor;
  540.         return $self;
  541.     }
  543.     public function getProvider(): callable|string|null
  544.     {
  545.         return $this->provider;
  546.     }
  548.     public function withProvider(callable|string|null $provider): static
  549.     {
  550.         $self = clone $this;
  551.         $self->provider = $provider;
  553.         return $self;
  554.     }
  556.     public function getStateOptions(): ?OptionsInterface
  557.     {
  558.         return $this->stateOptions;
  559.     }
  561.     public function withStateOptions(?OptionsInterface $stateOptions): static
  562.     {
  563.         $self = clone $this;
  564.         $self->stateOptions = $stateOptions;
  566.         return $self;
  567.     }
  569.     public function getExtraProperties(): ?array
  570.     {
  571.         return $this->extraProperties;
  572.     }
  574.     public function withExtraProperties(array $extraProperties = []): static
  575.     {
  576.         $self = clone $this;
  577.         $self->extraProperties = $extraProperties;
  579.         return $self;
  580.     }
  581. }