vendor/api-platform/core/src/Metadata/NotExposed.php line 27

  1. <?php
  2. /*
  3.  * This file is part of the API Platform project.
  4.  *
  5.  * (c) Kévin Dunglas <dunglas@gmail.com>
  6.  *
  7.  * For the full copyright and license information, please view the LICENSE
  8.  * file that was distributed with this source code.
  9.  */
  10. declare(strict_types=1);
  11. namespace ApiPlatform\Metadata;
  12. use ApiPlatform\OpenApi\Model\Operation as OpenApiOperation;
  13. use ApiPlatform\State\OptionsInterface;
  14. /**
  15.  * A NotExposed operation is an operation declared for internal usage,
  16.  * for example to generate an IRI on a resource without item operations.
  17.  * It is ignored from OpenApi documentation and must return a HTTP 404.
  18.  *
  19.  * @author Vincent Chalamon <vincentchalamon@gmail.com>
  20.  */
  21. #[\Attribute(\Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
  22. final class NotExposed extends HttpOperation
  23. {
  24.     /**
  25.      * {@inheritdoc}
  26.      */
  27.     public function __construct(
  28.         string $method = 'GET',
  29.         ?string $uriTemplate = null,
  30.         ?array $types = null,
  31.         $formats = null,
  32.         $inputFormats = null,
  33.         $outputFormats = null,
  34.         $uriVariables = null,
  35.         ?string $routePrefix = null,
  36.         ?string $routeName = null,
  37.         ?array $defaults = null,
  38.         ?array $requirements = null,
  39.         ?array $options = null,
  40.         ?bool $stateless = null,
  41.         ?string $sunset = null,
  42.         ?string $acceptPatch = null,
  43.         $status = 404,
  44.         ?string $host = null,
  45.         ?array $schemes = null,
  46.         ?string $condition = null,
  47.         ?string $controller = 'api_platform.action.not_exposed',
  48.         ?array $cacheHeaders = null,
  49.         ?array $paginationViaCursor = null,
  50.         ?array $hydraContext = null,
  51.         ?array $openapiContext = null,
  52.         bool|OpenApiOperation|null $openapi = false,
  53.         ?array $exceptionToStatus = null,
  54.         ?bool $queryParameterValidationEnabled = null,
  55.         ?array $links = null,
  56.         ?string $shortName = null,
  57.         ?string $class = null,
  58.         ?bool $paginationEnabled = null,
  59.         ?string $paginationType = null,
  60.         ?int $paginationItemsPerPage = null,
  61.         ?int $paginationMaximumItemsPerPage = null,
  62.         ?bool $paginationPartial = null,
  63.         ?bool $paginationClientEnabled = null,
  64.         ?bool $paginationClientItemsPerPage = null,
  65.         ?bool $paginationClientPartial = null,
  66.         ?bool $paginationFetchJoinCollection = null,
  67.         ?bool $paginationUseOutputWalkers = null,
  68.         ?array $order = null,
  69.         ?string $description = null,
  70.         ?array $normalizationContext = null,
  71.         ?array $denormalizationContext = null,
  72.         ?bool $collectDenormalizationErrors = null,
  73.         ?string $security = null,
  74.         ?string $securityMessage = null,
  75.         ?string $securityPostDenormalize = null,
  76.         ?string $securityPostDenormalizeMessage = null,
  77.         ?string $securityPostValidation = null,
  78.         ?string $securityPostValidationMessage = null,
  79.         ?string $deprecationReason = null,
  80.         ?array $filters = null,
  81.         ?array $validationContext = null,
  82.         $input = null,
  83.         $output = false,
  84.         $mercure = null,
  85.         $messenger = null,
  86.         ?bool $elasticsearch = null,
  87.         ?int $urlGenerationStrategy = null,
  88.         ?bool $read = false,
  89.         ?bool $deserialize = null,
  90.         ?bool $validate = null,
  91.         ?bool $write = null,
  92.         ?bool $serialize = null,
  93.         ?bool $fetchPartial = null,
  94.         ?bool $forceEager = null,
  95.         ?int $priority = null,
  96.         ?string $name = null,
  97.         $provider = null,
  98.         $processor = null,
  99.         array $extraProperties = [],
  100.         ?OptionsInterface $stateOptions = null,
  101.     ) {
  102.         parent::__construct(
  103.             method: $method,
  104.             uriTemplate: $uriTemplate,
  105.             types: $types,
  106.             formats: $formats,
  107.             inputFormats: $inputFormats,
  108.             outputFormats: $outputFormats,
  109.             uriVariables: $uriVariables,
  110.             routePrefix: $routePrefix,
  111.             routeName: $routeName,
  112.             defaults: $defaults,
  113.             requirements: $requirements,
  114.             options: $options,
  115.             stateless: $stateless,
  116.             sunset: $sunset,
  117.             acceptPatch: $acceptPatch,
  118.             status: $status,
  119.             host: $host,
  120.             schemes: $schemes,
  121.             condition: $condition,
  122.             controller: $controller,
  123.             cacheHeaders: $cacheHeaders,
  124.             paginationViaCursor: $paginationViaCursor,
  125.             hydraContext: $hydraContext,
  126.             openapiContext: $openapiContext,
  127.             openapi: $openapi,
  128.             exceptionToStatus: $exceptionToStatus,
  129.             queryParameterValidationEnabled: $queryParameterValidationEnabled,
  130.             links: $links,
  131.             shortName: $shortName,
  132.             class: $class,
  133.             paginationEnabled: $paginationEnabled,
  134.             paginationType: $paginationType,
  135.             paginationItemsPerPage: $paginationItemsPerPage,
  136.             paginationMaximumItemsPerPage: $paginationMaximumItemsPerPage,
  137.             paginationPartial: $paginationPartial,
  138.             paginationClientEnabled: $paginationClientEnabled,
  139.             paginationClientItemsPerPage: $paginationClientItemsPerPage,
  140.             paginationClientPartial: $paginationClientPartial,
  141.             paginationFetchJoinCollection: $paginationFetchJoinCollection,
  142.             paginationUseOutputWalkers: $paginationUseOutputWalkers,
  143.             order: $order,
  144.             description: $description,
  145.             normalizationContext: $normalizationContext,
  146.             denormalizationContext: $denormalizationContext,
  147.             collectDenormalizationErrors: $collectDenormalizationErrors,
  148.             security: $security,
  149.             securityMessage: $securityMessage,
  150.             securityPostDenormalize: $securityPostDenormalize,
  151.             securityPostDenormalizeMessage: $securityPostDenormalizeMessage,
  152.             securityPostValidation: $securityPostValidation,
  153.             securityPostValidationMessage: $securityPostValidationMessage,
  154.             deprecationReason: $deprecationReason,
  155.             filters: $filters,
  156.             validationContext: $validationContext,
  157.             input: $input,
  158.             output: $output,
  159.             mercure: $mercure,
  160.             messenger: $messenger,
  161.             elasticsearch: $elasticsearch,
  162.             urlGenerationStrategy: $urlGenerationStrategy,
  163.             read: $read,
  164.             deserialize: $deserialize,
  165.             validate: $validate,
  166.             write: $write,
  167.             serialize: $serialize,
  168.             fetchPartial: $fetchPartial,
  169.             forceEager: $forceEager,
  170.             priority: $priority,
  171.             name: $name,
  172.             provider: $provider,
  173.             processor: $processor,
  174.             stateOptions: $stateOptions,
  175.             extraProperties: $extraProperties,
  176.         );
  177.     }
  178. }