vendor/api-platform/core/src/Metadata/GetCollection.php line 20

  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. #[\Attribute(\Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
  20. final class GetCollection extends HttpOperation implements CollectionOperationInterface
  21. {
  22.     public function __construct(
  23.         ?string $uriTemplate = null,
  24.         ?array $types = null,
  25.         $formats = null,
  26.         $inputFormats = null,
  27.         $outputFormats = null,
  28.         $uriVariables = null,
  29.         ?string $routePrefix = null,
  30.         ?string $routeName = null,
  31.         ?array $defaults = null,
  32.         ?array $requirements = null,
  33.         ?array $options = null,
  34.         ?bool $stateless = null,
  35.         ?string $sunset = null,
  36.         ?string $acceptPatch = null,
  37.         $status = null,
  38.         ?string $host = null,
  39.         ?array $schemes = null,
  40.         ?string $condition = null,
  41.         ?string $controller = null,
  42.         ?array $cacheHeaders = null,
  43.         ?array $paginationViaCursor = null,
  44.         ?array $hydraContext = null,
  45.         ?array $openapiContext = null,
  46.         bool|OpenApiOperation|null $openapi = null,
  47.         ?array $exceptionToStatus = null,
  48.         ?bool $queryParameterValidationEnabled = null,
  50.         ?string $shortName = null,
  51.         ?string $class = null,
  52.         ?bool $paginationEnabled = null,
  53.         ?string $paginationType = null,
  54.         ?int $paginationItemsPerPage = null,
  55.         ?int $paginationMaximumItemsPerPage = null,
  56.         ?bool $paginationPartial = null,
  57.         ?bool $paginationClientEnabled = null,
  58.         ?bool $paginationClientItemsPerPage = null,
  59.         ?bool $paginationClientPartial = null,
  60.         ?bool $paginationFetchJoinCollection = null,
  61.         ?bool $paginationUseOutputWalkers = null,
  62.         ?array $order = null,
  63.         ?string $description = null,
  64.         ?array $normalizationContext = null,
  65.         ?array $denormalizationContext = null,
  66.         ?bool $collectDenormalizationErrors = null,
  67.         ?string $security = null,
  68.         ?string $securityMessage = null,
  69.         ?string $securityPostDenormalize = null,
  70.         ?string $securityPostDenormalizeMessage = null,
  71.         ?string $securityPostValidation = null,
  72.         ?string $securityPostValidationMessage = null,
  73.         ?string $deprecationReason = null,
  74.         ?array $filters = null,
  75.         ?array $validationContext = null,
  76.         $input = null,
  77.         $output = null,
  78.         $mercure = null,
  79.         $messenger = null,
  80.         ?bool $elasticsearch = null,
  81.         ?int $urlGenerationStrategy = null,
  82.         ?bool $read = null,
  83.         ?bool $deserialize = null,
  84.         ?bool $validate = null,
  85.         ?bool $write = null,
  86.         ?bool $serialize = null,
  87.         ?bool $fetchPartial = null,
  88.         ?bool $forceEager = null,
  89.         ?int $priority = null,
  90.         ?string $name = null,
  91.         $provider = null,
  92.         $processor = null,
  93.         ?OptionsInterface $stateOptions = null,
  94.         array $extraProperties = [],
  95.         private ?string $itemUriTemplate = null,
  96.     ) {
  97.         parent::__construct(
  98.             uriTemplate: $uriTemplate,
  99.             types: $types,
  100.             formats: $formats,
  101.             inputFormats: $inputFormats,
  102.             outputFormats: $outputFormats,
  103.             uriVariables: $uriVariables,
  104.             routePrefix: $routePrefix,
  105.             routeName: $routeName,
  106.             defaults: $defaults,
  107.             requirements: $requirements,
  108.             options: $options,
  109.             stateless: $stateless,
  110.             sunset: $sunset,
  111.             acceptPatch: $acceptPatch,
  112.             status: $status,
  113.             host: $host,
  114.             schemes: $schemes,
  115.             condition: $condition,
  116.             controller: $controller,
  117.             cacheHeaders: $cacheHeaders,
  118.             paginationViaCursor: $paginationViaCursor,
  119.             hydraContext: $hydraContext,
  120.             openapiContext: $openapiContext,
  121.             openapi: $openapi,
  122.             exceptionToStatus: $exceptionToStatus,
  123.             queryParameterValidationEnabled: $queryParameterValidationEnabled,
  124.             shortName: $shortName,
  125.             class: $class,
  126.             paginationEnabled: $paginationEnabled,
  127.             paginationType: $paginationType,
  128.             paginationItemsPerPage: $paginationItemsPerPage,
  129.             paginationMaximumItemsPerPage: $paginationMaximumItemsPerPage,
  130.             paginationPartial: $paginationPartial,
  131.             paginationClientEnabled: $paginationClientEnabled,
  132.             paginationClientItemsPerPage: $paginationClientItemsPerPage,
  133.             paginationClientPartial: $paginationClientPartial,
  134.             paginationFetchJoinCollection: $paginationFetchJoinCollection,
  135.             paginationUseOutputWalkers: $paginationUseOutputWalkers,
  136.             order: $order,
  137.             description: $description,
  138.             normalizationContext: $normalizationContext,
  139.             denormalizationContext: $denormalizationContext,
  140.             collectDenormalizationErrors: $collectDenormalizationErrors,
  141.             security: $security,
  142.             securityMessage: $securityMessage,
  143.             securityPostDenormalize: $securityPostDenormalize,
  144.             securityPostDenormalizeMessage: $securityPostDenormalizeMessage,
  145.             securityPostValidation: $securityPostValidation,
  146.             securityPostValidationMessage: $securityPostValidationMessage,
  147.             deprecationReason: $deprecationReason,
  148.             filters: $filters,
  149.             validationContext: $validationContext,
  150.             input: $input,
  151.             output: $output,
  152.             mercure: $mercure,
  153.             messenger: $messenger,
  154.             elasticsearch: $elasticsearch,
  155.             urlGenerationStrategy: $urlGenerationStrategy,
  156.             read: $read,
  157.             deserialize: $deserialize,
  158.             validate: $validate,
  159.             write: $write,
  160.             serialize: $serialize,
  161.             fetchPartial: $fetchPartial,
  162.             forceEager: $forceEager,
  163.             priority: $priority,
  164.             name: $name,
  165.             provider: $provider,
  166.             processor: $processor,
  167.             extraProperties: $extraProperties,
  168.             stateOptions: $stateOptions,
  169.         );
  170.     }
  172.     public function getItemUriTemplate(): ?string
  173.     {
  174.         return $this->itemUriTemplate;
  175.     }
  177.     public function withItemUriTemplate(string $itemUriTemplate): self
  178.     {
  179.         $self = clone $this;
  180.         $self->itemUriTemplate = $itemUriTemplate;
  182.         return $self;
  183.     }
  184. }