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

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