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

  1. <?php
  3. /*
  4.  * This file is part of the API Platform project.
  5.  *
  6.  * (c) Kévin Dunglas <[email protected]>
  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\Metadata\GraphQl\Operation as GraphQlOperation;
  17. use ApiPlatform\OpenApi\Model\Operation as OpenApiOperation;
  18. use ApiPlatform\State\OptionsInterface;
  20. /**
  21.  * Resource metadata attribute.
  22.  *
  23.  * The API Resource attribute declares the behaviors attached to a Resource inside API Platform.
  24.  * This class is immutable, and if you set a value yourself, API Platform will not override the value.
  25.  * The API Resource helps sharing options with operations.
  26.  *
  27.  * Read more about how metadata works [here](/docs/in-depth/metadata).
  28.  *
  29.  * @author Antoine Bluchet <[email protected]>
  30.  */
  31. #[\Attribute(\Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
  32. class ApiResource
  33. {
  34.     use WithResourceTrait;
  36.     protected ?Operations $operations;
  38.     /**
  39.      * @var string|callable|null
  40.      */
  41.     protected $provider;
  43.     /**
  44.      * @var string|callable|null
  45.      */
  46.     protected $processor;
  48.     /**
  49.      * @param array<int, HttpOperation>|array<string, HttpOperation>|Operations|null $operations   Operations is a list of HttpOperation
  50.      * @param array<string, Link>|array<string, mixed[]>|string[]|string|null        $uriVariables
  51.      * @param string|callable|null                                                   $provider
  52.      * @param string|callable|null                                                   $processor
  53.      * @param mixed|null                                                             $mercure
  54.      * @param mixed|null                                                             $messenger
  55.      * @param mixed|null                                                             $input
  56.      * @param mixed|null                                                             $output
  57.      */
  58.     public function __construct(
  59.         /**
  60.          * The URI template represents your resource IRI with optional variables. It follows [RFC 6570](https://www.rfc-editor.org/rfc/rfc6570.html).
  61.          * API Platform generates this URL for you if you leave this empty.
  62.          */
  63.         protected ?string $uriTemplate = null,
  65.         /**
  66.          * The short name of your resource is a unique name that identifies your resource.
  67.          * It is used within the documentation and for url generation if the `uriTemplate` is not filled. By default, this will be the name of your PHP class.
  68.          */
  69.         protected ?string $shortName = null,
  71.         /**
  72.          * A description for this resource that will show on documentations.
  73.          */
  74.         protected ?string $description = null,
  76.         /**
  77.          * The RDF types of this resource.
  78.          * An RDF type is usually a URI referencing how your resource is structured for the outside world. Values can be a string `https://schema.org/Book`
  79.          * or an array of string `['https://schema.org/Flight', 'https://schema.org/BusTrip']`.
  80.          */
  81.         protected string|array|null $types = null,
  83.         /**
  84.          * Operations is a list of [HttpOperation](./HttpOperation).
  85.          *
  86.          * By default API Platform declares operations representing CRUD routes if you don't specify this parameter:
  87.          *
  88.          * ```php
  89.          * #[ApiResource(
  90.          *     operations: [
  91.          *         new Get(uriTemplate: '/books/{id}'),
  92.          *         // The GetCollection operation returns a list of Books.
  93.          *         new GetCollection(uriTemplate: '/books'),
  94.          *         new Post(uriTemplate: '/books'),
  95.          *         new Patch(uriTemplate: '/books/{id}'),
  96.          *         new Delete(uriTemplate: '/books/{id}'),
  97.          *     ]
  98.          * )]
  99.          *
  100.          * ```
  101.          *
  102.          * Try this live at [play.api-platform.com/api-resource](play.api-platform.com).
  103.          */
  104.         $operations = null,
  106.         /**
  107.          * The `formats` option allows you to customize content negotiation. By default API Platform supports JsonLd, Hal, JsonAPI.
  108.          * For other formats we use the Symfony Serializer.
  109.          *
  110.          * ```php
  111.          * #[ApiResource(
  112.          *   formats: [
  113.          *       'jsonld' => ['application/ld+json'],
  114.          *       'jsonhal' => ['application/hal+json'],
  115.          *       'jsonapi' => ['application/vnd.api+json'],
  116.          *       'json' =>    ['application/json'],
  117.          *       'xml' =>     ['application/xml', 'text/xml'],
  118.          *       'yaml' =>    ['application/x-yaml'],
  119.          *       'csv' =>     ['text/csv'],
  120.          *       'html' =>    ['text/html'],
  121.          *       'myformat' =>['application/vnd.myformat'],
  122.          *   ]
  123.          * )]
  124.          * ```
  125.          *
  126.          * Learn more about custom formats in the [dedicated guide](/guides/custom-formats).
  127.          */
  128.         protected array|string|null $formats = null,
  129.         /**
  130.          * The `inputFormats` option allows you to customize content negotiation for HTTP bodies:.
  131.          *
  132.          * ```php
  133.          *  #[ApiResource(formats: ['jsonld', 'csv' => ['text/csv']], operations: [
  134.          *      new Patch(inputFormats: ['json' => ['application/merge-patch+json']]),
  135.          *      new GetCollection(),
  136.          *      new Post(),
  137.          *  ])]
  138.          * ```
  139.          */
  140.         protected array|string|null $inputFormats = null,
  141.         /**
  142.          * The `outputFormats` option allows you to customize content negotiation for HTTP responses.
  143.          */
  144.         protected array|string|null $outputFormats = null,
  145.         /**
  146.          * The `uriVariables` configuration allows to configure to what each URI Variable.
  147.          * With [simple string expansion](https://www.rfc-editor.org/rfc/rfc6570.html#section-3.2.2), we read the input
  148.          * value and match this to the given `Link`. Note that this setting is usually used on an operation directly:.
  149.          *
  150.          * ```php
  151.          *   #[ApiResource(
  152.          *       uriTemplate: '/companies/{companyId}/employees/{id}',
  153.          *       uriVariables: [
  154.          *           'companyId' => new Link(fromClass: Company::class, toProperty: 'company']),
  155.          *           'id' => new Link(fromClass: Employee::class)
  156.          *       ],
  157.          *       operations: [new Get()]
  158.          *   )]
  159.          * ```
  160.          *
  161.          * For more examples, read our guide on [subresources](/guides/subresources).
  162.          */
  163.         protected $uriVariables = null,
  164.         /**
  165.          * The `routePrefix` allows you to configure a prefix that will apply to this resource.
  166.          *
  167.          * ```php
  168.          *   #[ApiResource(
  169.          *       routePrefix: '/books',
  170.          *       operations: [new Get(uriTemplate: '/{id}')]
  171.          *   )]
  172.          * ```
  173.          *
  174.          * This resource will be accessible through `/books/{id}`.
  175.          */
  176.         protected ?string $routePrefix = null,
  177.         /**
  178.          * The `defaults` option adds up to [Symfony's route defaults](https://github.com/symfony/routing/blob/8f068b792e515b25e26855ac8dc7fe800399f3e5/Route.php#L41). You can override [API Platform's defaults](https://github.com/api-platform/core/blob/6abd0fe0a69d4842eb6d5c31ef2bd6dce0e1d372/src/Symfony/Routing/ApiLoader.php#L87) if needed.
  179.          */
  180.         protected ?array $defaults = null,
  181.         /**
  182.          * The `requirements` option configures the Symfony's Route requirements.
  183.          */
  184.         protected ?array $requirements = null,
  185.         /**
  186.          * The `options` option configures the Symfony's Route options.
  187.          */
  188.         protected ?array $options = null,
  189.         /**
  190.          * The `stateless` option configures the Symfony's Route stateless option.
  191.          */
  192.         protected ?bool $stateless = null,
  193.         /**
  194.          * The `sunset` option indicates when a deprecated operation will be removed.
  195.          *
  196.          * <CodeSelector>
  197.          *
  198.          * ```php
  199.          * <?php
  200.          * // api/src/Entity/Parchment.php
  201.          * use ApiPlatform\Metadata\ApiResource;
  202.          *
  203.          * #[ApiResource(deprecationReason: 'Create a Book instead', sunset: '01/01/2020')]
  204.          * class Parchment
  205.          * {
  206.          *     // ...
  207.          * }
  208.          * ```
  209.          *
  210.          * ```yaml
  211.          * # api/config/api_platform/resources.yaml
  212.          * resources:
  213.          *     App\Entity\Parchment:
  214.          *         - deprecationReason: 'Create a Book instead'
  215.          *           sunset: '01/01/2020'
  216.          * ```
  217.          *
  218.          * ```xml
  219.          * <?xml version="1.0" encoding="UTF-8" ?>
  220.          * <!-- api/config/api_platform/resources.xml -->
  221.          *
  222.          * <resources
  223.          *         xmlns="https://api-platform.com/schema/metadata/resources-3.0"
  224.          *         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  225.          *         xsi:schemaLocation="https://api-platform.com/schema/metadata/resources-3.0
  226.          *         https://api-platform.com/schema/metadata/resources-3.0.xsd">
  227.          *     <resource class="App\Entity\Parchment" deprecationReason="Create a Book instead" sunset="01/01/2020" />
  228.          * </resources>
  229.          * ```
  230.          *
  231.          * </CodeSelector>
  232.          */
  233.         protected ?string $sunset = null,
  234.         protected ?string $acceptPatch = null,
  235.         protected ?int $status = null,
  236.         protected ?string $host = null,
  237.         protected ?array $schemes = null,
  238.         protected ?string $condition = null,
  239.         protected ?string $controller = null,
  240.         protected ?string $class = null,
  241.         /**
  242.          * The `urlGenerationStrategy` option configures the url generation strategy.
  243.          *
  244.          * See: [UrlGeneratorInterface::class](/reference/Api/UrlGeneratorInterface)
  245.          *
  246.          * <CodeSelector>
  247.          * ```php
  248.          * <?php
  249.          * // api/src/Entity/Book.php
  250.          * use ApiPlatform\Metadata\ApiResource;
  251.          * use ApiPlatform\Api\UrlGeneratorInterface;
  252.          *
  253.          * #[ApiResource(urlGenerationStrategy: UrlGeneratorInterface::ABS_URL)]
  254.          * class Book
  255.          * {
  256.          *     // ...
  257.          * }
  258.          * ```
  259.          *
  260.          * ```yaml
  261.          * # api/config/api_platform/resources.yaml
  262.          * App\Entity\Book:
  263.          *     urlGenerationStrategy: !php/const ApiPlatform\Api\UrlGeneratorInterface::ABS_URL
  264.          * ```
  265.          *
  266.          * ```xml
  267.          * <?xml version="1.0" encoding="UTF-8" ?>
  268.          * <!-- api/config/api_platform/resources.xml -->
  269.          *
  270.          * <resources
  271.          *         xmlns="https://api-platform.com/schema/metadata/resources-3.0"
  272.          *         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  273.          *         xsi:schemaLocation="https://api-platform.com/schema/metadata/resources-3.0
  274.          *         https://api-platform.com/schema/metadata/resources-3.0.xsd">
  275.          *     <resource class="App\Entity\Book" urlGenerationStrategy="0" />
  276.          * </resources>
  277.          * ```
  278.          * </CodeSelector>
  279.          */
  280.         protected ?int $urlGenerationStrategy = null,
  281.         /**
  282.          * The `deprecationReason` option deprecates the current resource with a deprecation message.
  283.          *
  284.          * <CodeSelector>
  285.          * ```php
  286.          * <?php
  287.          * // api/src/Entity/Parchment.php
  288.          * use ApiPlatform\Metadata\ApiResource;
  289.          *
  290.          * #[ApiResource(deprecationReason: 'Create a Book instead')]
  291.          * class Parchment
  292.          * {
  293.          *     // ...
  294.          * }
  295.          * ```
  296.          *
  297.          * ```yaml
  298.          * # api/config/api_platform/resources.yaml
  299.          * resources:
  300.          *     App\Entity\Parchment:
  301.          *         - deprecationReason: 'Create a Book instead'
  302.          * ```
  303.          *
  304.          * ```xml
  305.          * <?xml version="1.0" encoding="UTF-8" ?>
  306.          * <!-- api/config/api_platform/resources.xml -->
  307.          *
  308.          * <resources
  309.          *         xmlns="https://api-platform.com/schema/metadata/resources-3.0"
  310.          *         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  311.          *         xsi:schemaLocation="https://api-platform.com/schema/metadata/resources-3.0
  312.          *         https://api-platform.com/schema/metadata/resources-3.0.xsd">
  313.          *     <resource class="App\Entity\Parchment" deprecationReason="Create a Book instead" />
  314.          * </resources>
  315.          * ```
  316.          * </CodeSelector>
  317.          *
  318.          * - With JSON-lD / Hydra, [an `owl:deprecated` annotation property](https://www.w3.org/TR/owl2-syntax/#Annotation_Properties) will be added to the appropriate data structure
  319.          * - With Swagger / OpenAPI, [a `deprecated` property](https://swagger.io/docs/specification/2-0/paths-and-operations/) will be added
  320.          * - With GraphQL, the [`isDeprecated` and `deprecationReason` properties](https://facebook.github.io/graphql/June2018/#sec-Deprecation) will be added to the schema
  321.          */
  322.         protected ?string $deprecationReason = null,
  323.         protected ?array $cacheHeaders = null,
  324.         protected ?array $normalizationContext = null,
  325.         protected ?array $denormalizationContext = null,
  326.         protected ?bool $collectDenormalizationErrors = null,
  327.         protected ?array $hydraContext = null,
  328.         protected ?array $openapiContext = null, // TODO Remove in 4.0
  329.         protected bool|OpenApiOperation|null $openapi = null,
  330.         /**
  331.          * The `validationContext` option configures the context of validation for the current ApiResource.
  332.          * You can, for instance, describe the validation groups that will be used:.
  333.          *
  334.          * ```php
  335.          * #[ApiResource(validationContext: ['groups' => ['a', 'b']])]
  336.          * ```
  337.          *
  338.          * For more examples, read our guide on [validation](/guides/validation).
  339.          */
  340.         protected ?array $validationContext = null,
  341.         /**
  342.          * The `filters` option configures the filters (declared as services) available on the collection routes for the current resource.
  343.          *
  344.          * <CodeSelector>
  345.          * ```php
  346.          * <?php
  347.          * // api/src/Entity/Book.php
  348.          * use ApiPlatform\Metadata\ApiResource;
  349.          *
  350.          * #[ApiResource(filters: ['app.filters.book.search'])]
  351.          * class Book
  352.          * {
  353.          *     // ...
  354.          * }
  355.          * ```
  356.          *
  357.          * ```yaml
  358.          * # api/config/api_platform/resources.yaml
  359.          * resources:
  360.          *     App\Entity\Book:
  361.          *         - filters: ['app.filters.book.search']
  362.          * ```
  363.          *
  364.          * ```xml
  365.          * <?xml version="1.0" encoding="UTF-8" ?>
  366.          * <!-- api/config/api_platform/resources.xml -->
  367.          * <resources
  368.          *         xmlns="https://api-platform.com/schema/metadata/resources-3.0"
  369.          *         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  370.          *         xsi:schemaLocation="https://api-platform.com/schema/metadata/resources-3.0
  371.          *         https://api-platform.com/schema/metadata/resources-3.0.xsd">
  372.          *     <resource class="App\Entity\Book">
  373.          *         <filters>
  374.          *             <filter>app.filters.book.search</filter>
  375.          *         </filters>
  376.          *     </resource>
  377.          * </resources>
  378.          * ```
  379.          * </CodeSelector>
  380.          */
  381.         protected ?array $filters = null,
  382.         protected ?bool $elasticsearch = null,
  383.         protected $mercure = null,
  384.         /**
  385.          * The `messenger` option dispatches the current resource through the Message Bus.
  386.          *
  387.          * <CodeSelector>
  388.          * ```php
  389.          * <?php
  390.          * // api/src/Entity/Book.php
  391.          * use ApiPlatform\Metadata\ApiResource;
  392.          *
  393.          * #[ApiResource(messenger: true)]
  394.          * class Book
  395.          * {
  396.          *     // ...
  397.          * }
  398.          * ```
  399.          *
  400.          * ```yaml
  401.          * # api/config/api_platform/resources.yaml
  402.          * resources:
  403.          *     App\Entity\Book:
  404.          *         - messenger: true
  405.          * ```
  406.          *
  407.          * ```xml
  408.          * <?xml version="1.0" encoding="UTF-8" ?>
  409.          * <!-- api/config/api_platform/resources.xml -->
  410.          *
  411.          * <resources
  412.          *         xmlns="https://api-platform.com/schema/metadata/resources-3.0"
  413.          *         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  414.          *         xsi:schemaLocation="https://api-platform.com/schema/metadata/resources-3.0
  415.          *         https://api-platform.com/schema/metadata/resources-3.0.xsd">
  416.          *     <resource class="App\Entity\Book" messenger=true />
  417.          * </resources>
  418.          * ```
  419.          * </CodeSelector>
  420.          *
  421.          * Note: when using `messenger=true` on a Doctrine entity, the Doctrine Processor is not called. If you want it
  422.          * to be called, you should [decorate a built-in state processor](/docs/guide/hook-a-persistence-layer-with-a-processor)
  423.          * and implement your own logic.
  424.          *
  425.          * Read [how to use Messenger with an Input object](/docs/guide/using-messenger-with-an-input-object).
  426.          *
  427.          * @var string|bool|null
  428.          */
  429.         protected $messenger = null,
  430.         protected $input = null,
  431.         protected $output = null,
  432.         /**
  433.          * Override the default order of items in your collection. Note that this is handled by our doctrine filters such as
  434.          * the [OrderFilter](/docs/reference/Doctrine/Orm/Filter/OrderFilter).
  435.          *
  436.          * By default, items in the collection are ordered in ascending (ASC) order by their resource identifier(s). If you want to
  437.          * customize this order, you must add an `order` attribute on your ApiResource annotation:
  438.          *
  439.          * <CodeSelector>
  440.          *
  441.          * ```php
  442.          * <?php
  443.          * // api/src/Entity/Book.php
  444.          * namespace App\Entity;
  445.          *
  446.          * use ApiPlatform\Metadata\ApiResource;
  447.          *
  448.          * #[ApiResource(order: ['foo' => 'ASC'])]
  449.          * class Book
  450.          * {
  451.          * }
  452.          * ```
  453.          *
  454.          * ```yaml
  455.          * # api/config/api_platform/resources/Book.yaml
  456.          * App\Entity\Book:
  457.          *     order:
  458.          *         foo: ASC
  459.          * ```
  460.          *
  461.          * </CodeSelector>
  462.          *
  463.          * This `order` attribute is used as an array: the key defines the order field, the values defines the direction.
  464.          * If you only specify the key, `ASC` direction will be used as default.
  465.          */
  466.         protected ?array $order = null,
  467.         protected ?bool $fetchPartial = null,
  468.         protected ?bool $forceEager = null,
  469.         /**
  470.          * The `paginationClientEnabled` option allows (or disallows) the client to enable (or disable) the pagination for the current resource.
  471.          *
  472.          * <CodeSelector>
  473.          * ```php
  474.          * <?php
  475.          * // api/src/Entity/Book.php
  476.          * use ApiPlatform\Metadata\ApiResource;
  477.          *
  478.          * #[ApiResource(paginationClientEnabled: true)]
  479.          * class Book
  480.          * {
  481.          *     // ...
  482.          * }
  483.          * ```
  484.          *
  485.          * ```yaml
  486.          * # api/config/api_platform/resources.yaml
  487.          * resources:
  488.          *     App\Entity\Book:
  489.          *         - paginationClientEnabled: true
  490.          * ```
  491.          *
  492.          * ```xml
  493.          * <?xml version="1.0" encoding="UTF-8" ?>
  494.          * <!-- api/config/api_platform/resources.xml -->
  495.          *
  496.          * <resources
  497.          *         xmlns="https://api-platform.com/schema/metadata/resources-3.0"
  498.          *         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  499.          *         xsi:schemaLocation="https://api-platform.com/schema/metadata/resources-3.0
  500.          *         https://api-platform.com/schema/metadata/resources-3.0.xsd">
  501.          *     <resource class="App\Entity\Book" paginationClientEnabled=true />
  502.          * </resources>
  503.          * ```
  504.          * </CodeSelector>
  505.          *
  506.          * The pagination can now be enabled (or disabled) by adding a query parameter named `pagination`:
  507.          * - `GET /books?pagination=false`: disabled
  508.          * - `GET /books?pagination=true`: enabled
  509.          */
  510.         protected ?bool $paginationClientEnabled = null,
  511.         /**
  512.          * The `paginationClientItemsPerPage` option allows (or disallows) the client to set the number of items per page for the current resource.
  513.          *
  514.          * <CodeSelector>
  515.          * ```php
  516.          * <?php
  517.          * // api/src/Entity/Book.php
  518.          * use ApiPlatform\Metadata\ApiResource;
  519.          *
  520.          * #[ApiResource(paginationClientItemsPerPage: true)]
  521.          * class Book
  522.          * {
  523.          *     // ...
  524.          * }
  525.          * ```
  526.          *
  527.          * ```yaml
  528.          * # api/config/api_platform/resources.yaml
  529.          * resources:
  530.          *     App\Entity\Book:
  531.          *         - paginationClientItemsPerPage: true
  532.          * ```
  533.          *
  534.          * ```xml
  535.          * <?xml version="1.0" encoding="UTF-8" ?>
  536.          * <!-- api/config/api_platform/resources.xml -->
  537.          *
  538.          * <resources
  539.          *         xmlns="https://api-platform.com/schema/metadata/resources-3.0"
  540.          *         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  541.          *         xsi:schemaLocation="https://api-platform.com/schema/metadata/resources-3.0
  542.          *         https://api-platform.com/schema/metadata/resources-3.0.xsd">
  543.          *     <resource class="App\Entity\Book" paginationClientItemsPerPage=true />
  544.          * </resources>
  545.          * ```
  546.          * </CodeSelector>
  547.          *
  548.          * The number of items can now be set by adding a query parameter named `itemsPerPage`:
  549.          * - `GET /books?itemsPerPage=50`
  550.          */
  551.         protected ?bool $paginationClientItemsPerPage = null,
  552.         /**
  553.          * The `paginationClientPartial` option allows (or disallows) the client to enable (or disable) the partial pagination for the current resource.
  554.          *
  555.          * <CodeSelector>
  556.          *
  557.          * ```php
  558.          * <?php
  559.          * // api/src/Entity/Book.php
  560.          * use ApiPlatform\Metadata\ApiResource;
  561.          *
  562.          * #[ApiResource(paginationClientPartial: true)]
  563.          * class Book
  564.          * {
  565.          *     // ...
  566.          * }
  567.          * ```
  568.          *
  569.          * ```yaml
  570.          * # api/config/api_platform/resources.yaml
  571.          * resources:
  572.          *     App\Entity\Book:
  573.          *         - paginationClientPartial: true
  574.          * ```
  575.          *
  576.          * ```xml
  577.          * <?xml version="1.0" encoding="UTF-8" ?>
  578.          * <!-- api/config/api_platform/resources.xml -->
  579.          *
  580.          * <resources
  581.          *         xmlns="https://api-platform.com/schema/metadata/resources-3.0"
  582.          *         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  583.          *         xsi:schemaLocation="https://api-platform.com/schema/metadata/resources-3.0
  584.          *         https://api-platform.com/schema/metadata/resources-3.0.xsd">
  585.          *     <resource class="App\Entity\Book" paginationClientPartial=true />
  586.          * </resources>
  587.          * ```
  588.          * </CodeSelector>
  589.          *
  590.          * The partial pagination can now be enabled (or disabled) by adding a query parameter named `partial`:
  591.          * - `GET /books?partial=false`: disabled
  592.          * - `GET /books?partial=true`: enabled
  593.          */
  594.         protected ?bool $paginationClientPartial = null,
  595.         /**
  596.          * The `paginationViaCursor` option configures the cursor-based pagination for the current resource.
  597.          * Select your unique sorted field as well as the direction you'll like the pagination to go via filters.
  598.          * Note that for now you have to declare a `RangeFilter` and an `OrderFilter` on the property used for the cursor-based pagination:.
  599.          *
  600.          * <CodeSelector>
  601.          * ```php
  602.          * <?php
  603.          * // api/src/Entity/Book.php
  604.          * use ApiPlatform\Metadata\ApiFilter;
  605.          * use ApiPlatform\Metadata\ApiResource;
  606.          * use ApiPlatform\Doctrine\Odm\Filter\OrderFilter;
  607.          * use ApiPlatform\Doctrine\Odm\Filter\RangeFilter;
  608.          *
  609.          * #[ApiResource(paginationPartial: true, paginationViaCursor: [['field' => 'id', 'direction' => 'DESC']])]
  610.          * #[ApiFilter(RangeFilter::class, properties: ["id"])]
  611.          * #[ApiFilter(OrderFilter::class, properties: ["id" => "DESC"])]
  612.          * class Book
  613.          * {
  614.          *     // ...
  615.          * }
  616.          * ```
  617.          *
  618.          * ```yaml
  619.          * # api/config/api_platform/resources.yaml
  620.          * resources:
  621.          *     App\Entity\Book:
  622.          *         - paginationPartial: true
  623.          *           paginationViaCursor:
  624.          *               - { field: 'id', direction: 'DESC' }
  625.          *           filters: [ 'app.filters.book.range', 'app.filters.book.order' ]
  626.          * ```
  627.          *
  628.          * ```xml
  629.          * <?xml version="1.0" encoding="UTF-8" ?>
  630.          * <!-- api/config/api_platform/resources.xml -->
  631.          *
  632.          * <resources
  633.          *         xmlns="https://api-platform.com/schema/metadata/resources-3.0"
  634.          *         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  635.          *         xsi:schemaLocation="https://api-platform.com/schema/metadata/resources-3.0
  636.          *         https://api-platform.com/schema/metadata/resources-3.0.xsd">
  637.          *     <resource class="App\Entity\Book" paginationPartial=true>
  638.          *         <filters>
  639.          *             <filter>app.filters.book.range</filter>
  640.          *             <filter>app.filters.book.order</filter>
  641.          *         </filters>
  642.          *         <paginationViaCursor>
  643.          *             <paginationField field="id" direction="DESC" />
  644.          *         </paginationViaCursor>
  645.          *     </resource>
  646.          * </resources>
  647.          * ```
  648.          * </CodeSelector>
  649.          *
  650.          * To know more about cursor-based pagination take a look at [this blog post on medium (draft)](https://medium.com/@sroze/74fd1d324723).
  651.          */
  652.         protected ?array $paginationViaCursor = null,
  653.         /**
  654.          * The `paginationEnabled` option enables (or disables) the pagination for the current resource.
  655.          *
  656.          * <CodeSelector>
  657.          * ```php
  658.          * <?php
  659.          * // api/src/Entity/Book.php
  660.          * use ApiPlatform\Metadata\ApiResource;
  661.          *
  662.          * #[ApiResource(paginationEnabled: true)]
  663.          * class Book
  664.          * {
  665.          *     // ...
  666.          * }
  667.          * ```
  668.          *
  669.          * ```yaml
  670.          * # api/config/api_platform/resources.yaml
  671.          * resources:
  672.          *     App\Entity\Book:
  673.          *         - paginationEnabled: true
  674.          * ```
  675.          *
  676.          * ```xml
  677.          * <?xml version="1.0" encoding="UTF-8" ?>
  678.          * <!-- api/config/api_platform/resources.xml -->
  679.          *
  680.          * <resources
  681.          *         xmlns="https://api-platform.com/schema/metadata/resources-3.0"
  682.          *         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  683.          *         xsi:schemaLocation="https://api-platform.com/schema/metadata/resources-3.0
  684.          *         https://api-platform.com/schema/metadata/resources-3.0.xsd">
  685.          *     <resource class="App\Entity\Book" paginationEnabled=true />
  686.          * </resources>
  687.          * ```
  688.          * </CodeSelector>
  689.          */
  690.         protected ?bool $paginationEnabled = null,
  691.         /**
  692.          * The PaginationExtension of API Platform performs some checks on the `QueryBuilder` to guess, in most common
  693.          * cases, the correct values to use when configuring the Doctrine ORM Paginator: `$fetchJoinCollection`
  694.          * argument, whether there is a join to a collection-valued association.
  695.          *
  696.          * When set to `true`, the Doctrine ORM Paginator will perform an additional query, in order to get the
  697.          * correct number of results. You can configure this using the `paginationFetchJoinCollection` option:
  698.          *
  699.          * <CodeSelector>
  700.          * ```php
  701.          * <?php
  702.          * // api/src/Entity/Book.php
  703.          * use ApiPlatform\Metadata\ApiResource;
  704.          *
  705.          * #[ApiResource(paginationFetchJoinCollection: false)]
  706.          * class Book
  707.          * {
  708.          *     // ...
  709.          * }
  710.          * ```
  711.          *
  712.          * ```yaml
  713.          * # api/config/api_platform/resources.yaml
  714.          * resources:
  715.          *     App\Entity\Book:
  716.          *         - paginationFetchJoinCollection: false
  717.          * ```
  718.          *
  719.          * ```xml
  720.          * <?xml version="1.0" encoding="UTF-8" ?>
  721.          * <!-- api/config/api_platform/resources.xml -->
  722.          *
  723.          * <resources
  724.          *         xmlns="https://api-platform.com/schema/metadata/resources-3.0"
  725.          *         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  726.          *         xsi:schemaLocation="https://api-platform.com/schema/metadata/resources-3.0
  727.          *         https://api-platform.com/schema/metadata/resources-3.0.xsd">
  728.          *     <resource class="App\Entity\Book" paginationFetchJoinCollection=false />
  729.          * </resources>
  730.          * ```
  731.          * </CodeSelector>
  732.          *
  733.          * For more information, please see the [Pagination](https://www.doctrine-project.org/projects/doctrine-orm/en/current/tutorials/pagination.html) entry in the Doctrine ORM documentation.
  734.          */
  735.         protected ?bool $paginationFetchJoinCollection = null,
  736.         /**
  737.          * The PaginationExtension of API Platform performs some checks on the `QueryBuilder` to guess, in most common
  738.          * cases, the correct values to use when configuring the Doctrine ORM Paginator: `$setUseOutputWalkers` setter,
  739.          * whether to use output walkers.
  740.          *
  741.          * When set to `true`, the Doctrine ORM Paginator will use output walkers, which are compulsory for some types
  742.          * of queries. You can configure this using the `paginationUseOutputWalkers` option:
  743.          *
  744.          * <CodeSelector>
  745.          * ```php
  746.          * <?php
  747.          * // api/src/Entity/Book.php
  748.          * use ApiPlatform\Metadata\ApiResource;
  749.          *
  750.          * #[ApiResource(paginationUseOutputWalkers: false)]
  751.          * class Book
  752.          * {
  753.          *     // ...
  754.          * }
  755.          * ```
  756.          *
  757.          * ```yaml
  758.          * # api/config/api_platform/resources.yaml
  759.          * resources:
  760.          *     App\Entity\Book:
  761.          *         - paginationUseOutputWalkers: false
  762.          * ```
  763.          *
  764.          * ```xml
  765.          * <?xml version="1.0" encoding="UTF-8" ?>
  766.          * <!-- api/config/api_platform/resources.xml -->
  767.          * <resources
  768.          *         xmlns="https://api-platform.com/schema/metadata/resources-3.0"
  769.          *         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  770.          *         xsi:schemaLocation="https://api-platform.com/schema/metadata/resources-3.0
  771.          *         https://api-platform.com/schema/metadata/resources-3.0.xsd">
  772.          *     <resource class="App\Entity\Book" paginationUseOutputWalkers=false />
  773.          * </resources>
  774.          * ```
  775.          * </CodeSelector>
  776.          *
  777.          * For more information, please see the [Pagination](https://www.doctrine-project.org/projects/doctrine-orm/en/current/tutorials/pagination.html) entry in the Doctrine ORM documentation.
  778.          */
  779.         protected ?bool $paginationUseOutputWalkers = null,
  780.         /**
  781.          * The `paginationItemsPerPage` option defines the number of items per page for the current resource.
  782.          *
  783.          * <CodeSelector>
  784.          * ```php
  785.          * <?php
  786.          * // api/src/Entity/Book.php
  787.          * use ApiPlatform\Metadata\ApiResource;
  788.          *
  789.          * #[ApiResource(paginationItemsPerPage: 30)]
  790.          * class Book
  791.          * {
  792.          *     // ...
  793.          * }
  794.          * ```
  795.          *
  796.          * ```yaml
  797.          * # api/config/api_platform/resources.yaml
  798.          * resources:
  799.          *     App\Entity\Book:
  800.          *         - paginationItemsPerPage: 30
  801.          * ```
  802.          *
  803.          * ```xml
  804.          * <?xml version="1.0" encoding="UTF-8" ?>
  805.          * <!-- api/config/api_platform/resources.xml -->
  806.          * <resources
  807.          *         xmlns="https://api-platform.com/schema/metadata/resources-3.0"
  808.          *         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  809.          *         xsi:schemaLocation="https://api-platform.com/schema/metadata/resources-3.0
  810.          *         https://api-platform.com/schema/metadata/resources-3.0.xsd">
  811.          *     <resource class="App\Entity\Book" paginationItemsPerPage=30 />
  812.          * </resources>
  813.          * ```
  814.          * </CodeSelector>
  815.          */
  816.         protected ?int $paginationItemsPerPage = null,
  817.         /**
  818.          * The `paginationMaximumItemsPerPage` option defines the maximum number of items per page for the current resource.
  819.          *
  820.          * <CodeSelector>
  821.          * ```php
  822.          * <?php
  823.          * // api/src/Entity/Book.php
  824.          * use ApiPlatform\Metadata\ApiResource;
  825.          *
  826.          * #[ApiResource(paginationMaximumItemsPerPage: 50)]
  827.          * class Book
  828.          * {
  829.          *     // ...
  830.          * }
  831.          * ```
  832.          *
  833.          * ```yaml
  834.          * # api/config/api_platform/resources.yaml
  835.          * resources:
  836.          *     App\Entity\Book:
  837.          *         - paginationMaximumItemsPerPage: 50
  838.          * ```
  839.          *
  840.          * ```xml
  841.          * <?xml version="1.0" encoding="UTF-8" ?>
  842.          * <!-- api/config/api_platform/resources.xml -->
  843.          * <resources
  844.          *         xmlns="https://api-platform.com/schema/metadata/resources-3.0"
  845.          *         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  846.          *         xsi:schemaLocation="https://api-platform.com/schema/metadata/resources-3.0
  847.          *         https://api-platform.com/schema/metadata/resources-3.0.xsd">
  848.          *     <resource class="App\Entity\Book" paginationMaximumItemsPerPage=50 />
  849.          * </resources>
  850.          * ```
  851.          *
  852.          * </CodeSelector>
  853.          */
  854.         protected ?int $paginationMaximumItemsPerPage = null,
  855.         /**
  856.          * The `paginationPartial` option enables (or disables) the partial pagination for the current resource.
  857.          *
  858.          * <CodeSelector>
  859.          * ```php
  860.          * <?php
  861.          * // api/src/Entity/Book.php
  862.          * use ApiPlatform\Metadata\ApiResource;
  863.          *
  864.          * #[ApiResource(paginationPartial: true)]
  865.          * class Book
  866.          * {
  867.          *     // ...
  868.          * }
  869.          * ```
  870.          *
  871.          * ```yaml
  872.          * # api/config/api_platform/resources.yaml
  873.          * resources:
  874.          *     App\Entity\Book:
  875.          *         - paginationPartial: true
  876.          * ```
  877.          *
  878.          * ```xml
  879.          * <?xml version="1.0" encoding="UTF-8" ?>
  880.          * <!-- api/config/api_platform/resources.xml -->
  881.          * <resources
  882.          *         xmlns="https://api-platform.com/schema/metadata/resources-3.0"
  883.          *         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  884.          *         xsi:schemaLocation="https://api-platform.com/schema/metadata/resources-3.0
  885.          *         https://api-platform.com/schema/metadata/resources-3.0.xsd">
  886.          *     <resource class="App\Entity\Book" paginationPartial=true />
  887.          * </resources>
  888.          * ```
  889.          * </CodeSelector>
  890.          */
  891.         protected ?bool $paginationPartial = null,
  892.         /**
  893.          * The `paginationType` option defines the type of pagination (`page` or `cursor`) to use for the current resource.
  894.          *
  895.          * <CodeSelector>
  896.          * ```php
  897.          * <?php
  898.          * // api/src/Entity/Book.php
  899.          * use ApiPlatform\Metadata\ApiResource;
  900.          *
  901.          * #[ApiResource(paginationType: 'page')]
  902.          * class Book
  903.          * {
  904.          *     // ...
  905.          * }
  906.          * ```
  907.          *
  908.          * ```yaml
  909.          * # api/config/api_platform/resources.yaml
  910.          * resources:
  911.          *     App\Entity\Book:
  912.          *         - paginationType: page
  913.          * ```
  914.          *
  915.          * ```xml
  916.          * <?xml version="1.0" encoding="UTF-8" ?>
  917.          * <!-- api/config/api_platform/resources.xml -->
  918.          * <resources
  919.          *         xmlns="https://api-platform.com/schema/metadata/resources-3.0"
  920.          *         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  921.          *         xsi:schemaLocation="https://api-platform.com/schema/metadata/resources-3.0
  922.          *         https://api-platform.com/schema/metadata/resources-3.0.xsd">
  923.          *     <resource class="App\Entity\Book" paginationType="page" />
  924.          * </resources>
  925.          * ```
  926.          * </CodeSelector>
  927.          */
  928.         protected ?string $paginationType = null,
  929.         protected ?string $security = null,
  930.         protected ?string $securityMessage = null,
  931.         protected ?string $securityPostDenormalize = null,
  932.         protected ?string $securityPostDenormalizeMessage = null,
  933.         protected ?string $securityPostValidation = null,
  934.         protected ?string $securityPostValidationMessage = null,
  935.         protected ?bool $compositeIdentifier = null,
  936.         protected ?array $exceptionToStatus = null,
  937.         protected ?bool $queryParameterValidationEnabled = null,
  938.         protected ?array $graphQlOperations = null,
  939.         $provider = null,
  940.         $processor = null,
  941.         protected ?OptionsInterface $stateOptions = null,
  942.         protected array $extraProperties = [],
  943.     ) {
  944.         $this->operations = null === $operations ? null : new Operations($operations);
  945.         $this->provider = $provider;
  946.         $this->processor = $processor;
  947.         if (\is_string($types)) {
  948.             $this->types = (array) $types;
  949.         }
  950.     }
  952.     public function getOperations(): ?Operations
  953.     {
  954.         return $this->operations;
  955.     }
  957.     public function withOperations(Operations $operations): self
  958.     {
  959.         $self = clone $this;
  960.         $self->operations = $operations;
  962.         return $self;
  963.     }
  965.     public function getUriTemplate(): ?string
  966.     {
  967.         return $this->uriTemplate;
  968.     }
  970.     public function withUriTemplate(string $uriTemplate): self
  971.     {
  972.         $self = clone $this;
  973.         $self->uriTemplate = $uriTemplate;
  975.         return $self;
  976.     }
  978.     public function getShortName(): ?string
  979.     {
  980.         return $this->shortName;
  981.     }
  983.     public function withShortName(string $shortName): self
  984.     {
  985.         $self = clone $this;
  986.         $self->shortName = $shortName;
  988.         return $self;
  989.     }
  991.     public function getDescription(): ?string
  992.     {
  993.         return $this->description;
  994.     }
  996.     public function withDescription(string $description): self
  997.     {
  998.         $self = clone $this;
  999.         $self->description = $description;
  1001.         return $self;
  1002.     }
  1004.     public function getTypes(): ?array
  1005.     {
  1006.         return $this->types;
  1007.     }
  1009.     /**
  1010.      * @param string[]|string $types
  1011.      */
  1012.     public function withTypes(array|string $types): self
  1013.     {
  1014.         $self = clone $this;
  1015.         $self->types = (array) $types;
  1017.         return $self;
  1018.     }
  1020.     /**
  1021.      * @return array|mixed|string|null
  1022.      */
  1023.     public function getFormats()
  1024.     {
  1025.         return $this->formats;
  1026.     }
  1028.     public function withFormats(mixed $formats): self
  1029.     {
  1030.         $self = clone $this;
  1031.         $self->formats = $formats;
  1033.         return $self;
  1034.     }
  1036.     /**
  1037.      * @return array|mixed|string|null
  1038.      */
  1039.     public function getInputFormats()
  1040.     {
  1041.         return $this->inputFormats;
  1042.     }
  1044.     /**
  1045.      * @param mixed|null $inputFormats
  1046.      */
  1047.     public function withInputFormats($inputFormats): self
  1048.     {
  1049.         $self = clone $this;
  1050.         $self->inputFormats = $inputFormats;
  1052.         return $self;
  1053.     }
  1055.     /**
  1056.      * @return array|mixed|string|null
  1057.      */
  1058.     public function getOutputFormats()
  1059.     {
  1060.         return $this->outputFormats;
  1061.     }
  1063.     /**
  1064.      * @param mixed|null $outputFormats
  1065.      */
  1066.     public function withOutputFormats($outputFormats): self
  1067.     {
  1068.         $self = clone $this;
  1069.         $self->outputFormats = $outputFormats;
  1071.         return $self;
  1072.     }
  1074.     /**
  1075.      * @return array<string, Link>|array<string, array>|string[]|string|null
  1076.      */
  1077.     public function getUriVariables()
  1078.     {
  1079.         return $this->uriVariables;
  1080.     }
  1082.     /**
  1083.      * @param array<string, Link>|array<string, array>|string[]|string|null $uriVariables
  1084.      */
  1085.     public function withUriVariables($uriVariables): self
  1086.     {
  1087.         $self = clone $this;
  1088.         $self->uriVariables = $uriVariables;
  1090.         return $self;
  1091.     }
  1093.     public function getRoutePrefix(): ?string
  1094.     {
  1095.         return $this->routePrefix;
  1096.     }
  1098.     public function withRoutePrefix(string $routePrefix): self
  1099.     {
  1100.         $self = clone $this;
  1101.         $self->routePrefix = $routePrefix;
  1103.         return $self;
  1104.     }
  1106.     public function getDefaults(): ?array
  1107.     {
  1108.         return $this->defaults;
  1109.     }
  1111.     public function withDefaults(array $defaults): self
  1112.     {
  1113.         $self = clone $this;
  1114.         $self->defaults = $defaults;
  1116.         return $self;
  1117.     }
  1119.     public function getRequirements(): ?array
  1120.     {
  1121.         return $this->requirements;
  1122.     }
  1124.     public function withRequirements(array $requirements): self
  1125.     {
  1126.         $self = clone $this;
  1127.         $self->requirements = $requirements;
  1129.         return $self;
  1130.     }
  1132.     public function getOptions(): ?array
  1133.     {
  1134.         return $this->options;
  1135.     }
  1137.     public function withOptions(array $options): self
  1138.     {
  1139.         $self = clone $this;
  1140.         $self->options = $options;
  1142.         return $self;
  1143.     }
  1145.     public function getStateless(): ?bool
  1146.     {
  1147.         return $this->stateless;
  1148.     }
  1150.     public function withStateless(bool $stateless): self
  1151.     {
  1152.         $self = clone $this;
  1153.         $self->stateless = $stateless;
  1155.         return $self;
  1156.     }
  1158.     public function getSunset(): ?string
  1159.     {
  1160.         return $this->sunset;
  1161.     }
  1163.     public function withSunset(string $sunset): self
  1164.     {
  1165.         $self = clone $this;
  1166.         $self->sunset = $sunset;
  1168.         return $self;
  1169.     }
  1171.     public function getAcceptPatch(): ?string
  1172.     {
  1173.         return $this->acceptPatch;
  1174.     }
  1176.     public function withAcceptPatch(string $acceptPatch): self
  1177.     {
  1178.         $self = clone $this;
  1179.         $self->acceptPatch = $acceptPatch;
  1181.         return $self;
  1182.     }
  1184.     public function getStatus(): ?int
  1185.     {
  1186.         return $this->status;
  1187.     }
  1189.     public function withStatus($status): self
  1190.     {
  1191.         $self = clone $this;
  1192.         $self->status = $status;
  1194.         return $self;
  1195.     }
  1197.     public function getHost(): ?string
  1198.     {
  1199.         return $this->host;
  1200.     }
  1202.     public function withHost(string $host): self
  1203.     {
  1204.         $self = clone $this;
  1205.         $self->host = $host;
  1207.         return $self;
  1208.     }
  1210.     public function getSchemes(): ?array
  1211.     {
  1212.         return $this->schemes;
  1213.     }
  1215.     public function withSchemes(array $schemes): self
  1216.     {
  1217.         $self = clone $this;
  1218.         $self->schemes = $schemes;
  1220.         return $self;
  1221.     }
  1223.     public function getCondition(): ?string
  1224.     {
  1225.         return $this->condition;
  1226.     }
  1228.     public function withCondition(string $condition): self
  1229.     {
  1230.         $self = clone $this;
  1231.         $self->condition = $condition;
  1233.         return $self;
  1234.     }
  1236.     public function getController(): ?string
  1237.     {
  1238.         return $this->controller;
  1239.     }
  1241.     public function withController(string $controller): self
  1242.     {
  1243.         $self = clone $this;
  1244.         $self->controller = $controller;
  1246.         return $self;
  1247.     }
  1249.     public function getClass(): ?string
  1250.     {
  1251.         return $this->class;
  1252.     }
  1254.     public function withClass(string $class): self
  1255.     {
  1256.         $self = clone $this;
  1257.         $self->class = $class;
  1259.         return $self;
  1260.     }
  1262.     public function getUrlGenerationStrategy(): ?int
  1263.     {
  1264.         return $this->urlGenerationStrategy;
  1265.     }
  1267.     public function withUrlGenerationStrategy(int $urlGenerationStrategy): self
  1268.     {
  1269.         $self = clone $this;
  1270.         $self->urlGenerationStrategy = $urlGenerationStrategy;
  1272.         return $self;
  1273.     }
  1275.     public function getDeprecationReason(): ?string
  1276.     {
  1277.         return $this->deprecationReason;
  1278.     }
  1280.     public function withDeprecationReason(string $deprecationReason): self
  1281.     {
  1282.         $self = clone $this;
  1283.         $self->deprecationReason = $deprecationReason;
  1285.         return $self;
  1286.     }
  1288.     public function getCacheHeaders(): ?array
  1289.     {
  1290.         return $this->cacheHeaders;
  1291.     }
  1293.     public function withCacheHeaders(array $cacheHeaders): self
  1294.     {
  1295.         $self = clone $this;
  1296.         $self->cacheHeaders = $cacheHeaders;
  1298.         return $self;
  1299.     }
  1301.     public function getNormalizationContext(): ?array
  1302.     {
  1303.         return $this->normalizationContext;
  1304.     }
  1306.     public function withNormalizationContext(array $normalizationContext): self
  1307.     {
  1308.         $self = clone $this;
  1309.         $self->normalizationContext = $normalizationContext;
  1311.         return $self;
  1312.     }
  1314.     public function getDenormalizationContext(): ?array
  1315.     {
  1316.         return $this->denormalizationContext;
  1317.     }
  1319.     public function withDenormalizationContext(array $denormalizationContext): self
  1320.     {
  1321.         $self = clone $this;
  1322.         $self->denormalizationContext = $denormalizationContext;
  1324.         return $self;
  1325.     }
  1327.     public function getCollectDenormalizationErrors(): ?bool
  1328.     {
  1329.         return $this->collectDenormalizationErrors;
  1330.     }
  1332.     public function withCollectDenormalizationErrors(bool $collectDenormalizationErrors = null): self
  1333.     {
  1334.         $self = clone $this;
  1335.         $self->collectDenormalizationErrors = $collectDenormalizationErrors;
  1337.         return $self;
  1338.     }
  1340.     /**
  1341.      * @return string[]|null
  1342.      */
  1343.     public function getHydraContext(): ?array
  1344.     {
  1345.         return $this->hydraContext;
  1346.     }
  1348.     public function withHydraContext(array $hydraContext): self
  1349.     {
  1350.         $self = clone $this;
  1351.         $self->hydraContext = $hydraContext;
  1353.         return $self;
  1354.     }
  1356.     /**
  1357.      * TODO Remove in 4.0.
  1358.      *
  1359.      * @deprecated
  1360.      */
  1361.     public function getOpenapiContext(): ?array
  1362.     {
  1363.         return $this->openapiContext;
  1364.     }
  1366.     /**
  1367.      * TODO Remove in 4.0.
  1368.      *
  1369.      * @deprecated
  1370.      */
  1371.     public function withOpenapiContext(array $openapiContext): self
  1372.     {
  1373.         $self = clone $this;
  1374.         $self->openapiContext = $openapiContext;
  1376.         return $self;
  1377.     }
  1379.     public function getOpenapi(): bool|OpenApiOperation|null
  1380.     {
  1381.         return $this->openapi;
  1382.     }
  1384.     public function withOpenapi(bool|OpenApiOperation $openapi): self
  1385.     {
  1386.         $self = clone $this;
  1387.         $self->openapi = $openapi;
  1389.         return $self;
  1390.     }
  1392.     public function getValidationContext(): ?array
  1393.     {
  1394.         return $this->validationContext;
  1395.     }
  1397.     public function withValidationContext(array $validationContext): self
  1398.     {
  1399.         $self = clone $this;
  1400.         $self->validationContext = $validationContext;
  1402.         return $self;
  1403.     }
  1405.     /**
  1406.      * @return string[]|null
  1407.      */
  1408.     public function getFilters(): ?array
  1409.     {
  1410.         return $this->filters;
  1411.     }
  1413.     public function withFilters(array $filters): self
  1414.     {
  1415.         $self = clone $this;
  1416.         $self->filters = $filters;
  1418.         return $self;
  1419.     }
  1421.     /**
  1422.      * @deprecated this will be removed in v4
  1423.      */
  1424.     public function getElasticsearch(): ?bool
  1425.     {
  1426.         return $this->elasticsearch;
  1427.     }
  1429.     /**
  1430.      * @deprecated this will be removed in v4
  1431.      */
  1432.     public function withElasticsearch(bool $elasticsearch): self
  1433.     {
  1434.         $self = clone $this;
  1435.         $self->elasticsearch = $elasticsearch;
  1437.         return $self;
  1438.     }
  1440.     /**
  1441.      * @return array|bool|mixed|null
  1442.      */
  1443.     public function getMercure()
  1444.     {
  1445.         return $this->mercure;
  1446.     }
  1448.     public function withMercure($mercure): self
  1449.     {
  1450.         $self = clone $this;
  1451.         $self->mercure = $mercure;
  1453.         return $self;
  1454.     }
  1456.     public function getMessenger()
  1457.     {
  1458.         return $this->messenger;
  1459.     }
  1461.     public function withMessenger($messenger): self
  1462.     {
  1463.         $self = clone $this;
  1464.         $self->messenger = $messenger;
  1466.         return $self;
  1467.     }
  1469.     public function getInput()
  1470.     {
  1471.         return $this->input;
  1472.     }
  1474.     public function withInput($input): self
  1475.     {
  1476.         $self = clone $this;
  1477.         $self->input = $input;
  1479.         return $self;
  1480.     }
  1482.     public function getOutput()
  1483.     {
  1484.         return $this->output;
  1485.     }
  1487.     public function withOutput($output): self
  1488.     {
  1489.         $self = clone $this;
  1490.         $self->output = $output;
  1492.         return $self;
  1493.     }
  1495.     public function getOrder(): ?array
  1496.     {
  1497.         return $this->order;
  1498.     }
  1500.     public function withOrder(array $order): self
  1501.     {
  1502.         $self = clone $this;
  1503.         $self->order = $order;
  1505.         return $self;
  1506.     }
  1508.     public function getFetchPartial(): ?bool
  1509.     {
  1510.         return $this->fetchPartial;
  1511.     }
  1513.     public function withFetchPartial(bool $fetchPartial): self
  1514.     {
  1515.         $self = clone $this;
  1516.         $self->fetchPartial = $fetchPartial;
  1518.         return $self;
  1519.     }
  1521.     public function getForceEager(): ?bool
  1522.     {
  1523.         return $this->forceEager;
  1524.     }
  1526.     public function withForceEager(bool $forceEager): self
  1527.     {
  1528.         $self = clone $this;
  1529.         $self->forceEager = $forceEager;
  1531.         return $self;
  1532.     }
  1534.     public function getPaginationClientEnabled(): ?bool
  1535.     {
  1536.         return $this->paginationClientEnabled;
  1537.     }
  1539.     public function withPaginationClientEnabled(bool $paginationClientEnabled): self
  1540.     {
  1541.         $self = clone $this;
  1542.         $self->paginationClientEnabled = $paginationClientEnabled;
  1544.         return $self;
  1545.     }
  1547.     public function getPaginationClientItemsPerPage(): ?bool
  1548.     {
  1549.         return $this->paginationClientItemsPerPage;
  1550.     }
  1552.     public function withPaginationClientItemsPerPage(bool $paginationClientItemsPerPage): self
  1553.     {
  1554.         $self = clone $this;
  1555.         $self->paginationClientItemsPerPage = $paginationClientItemsPerPage;
  1557.         return $self;
  1558.     }
  1560.     public function getPaginationClientPartial(): ?bool
  1561.     {
  1562.         return $this->paginationClientPartial;
  1563.     }
  1565.     public function withPaginationClientPartial(bool $paginationClientPartial): self
  1566.     {
  1567.         $self = clone $this;
  1568.         $self->paginationClientPartial = $paginationClientPartial;
  1570.         return $self;
  1571.     }
  1573.     public function getPaginationViaCursor(): ?array
  1574.     {
  1575.         return $this->paginationViaCursor;
  1576.     }
  1578.     public function withPaginationViaCursor(array $paginationViaCursor): self
  1579.     {
  1580.         $self = clone $this;
  1581.         $self->paginationViaCursor = $paginationViaCursor;
  1583.         return $self;
  1584.     }
  1586.     public function getPaginationEnabled(): ?bool
  1587.     {
  1588.         return $this->paginationEnabled;
  1589.     }
  1591.     public function withPaginationEnabled(bool $paginationEnabled): self
  1592.     {
  1593.         $self = clone $this;
  1594.         $self->paginationEnabled = $paginationEnabled;
  1596.         return $self;
  1597.     }
  1599.     public function getPaginationFetchJoinCollection(): ?bool
  1600.     {
  1601.         return $this->paginationFetchJoinCollection;
  1602.     }
  1604.     public function withPaginationFetchJoinCollection(bool $paginationFetchJoinCollection): self
  1605.     {
  1606.         $self = clone $this;
  1607.         $self->paginationFetchJoinCollection = $paginationFetchJoinCollection;
  1609.         return $self;
  1610.     }
  1612.     public function getPaginationUseOutputWalkers(): ?bool
  1613.     {
  1614.         return $this->paginationUseOutputWalkers;
  1615.     }
  1617.     public function withPaginationUseOutputWalkers(bool $paginationUseOutputWalkers): self
  1618.     {
  1619.         $self = clone $this;
  1620.         $self->paginationUseOutputWalkers = $paginationUseOutputWalkers;
  1622.         return $self;
  1623.     }
  1625.     public function getPaginationItemsPerPage(): ?int
  1626.     {
  1627.         return $this->paginationItemsPerPage;
  1628.     }
  1630.     public function withPaginationItemsPerPage(int $paginationItemsPerPage): self
  1631.     {
  1632.         $self = clone $this;
  1633.         $self->paginationItemsPerPage = $paginationItemsPerPage;
  1635.         return $self;
  1636.     }
  1638.     public function getPaginationMaximumItemsPerPage(): ?int
  1639.     {
  1640.         return $this->paginationMaximumItemsPerPage;
  1641.     }
  1643.     public function withPaginationMaximumItemsPerPage(int $paginationMaximumItemsPerPage): self
  1644.     {
  1645.         $self = clone $this;
  1646.         $self->paginationMaximumItemsPerPage = $paginationMaximumItemsPerPage;
  1648.         return $self;
  1649.     }
  1651.     public function getPaginationPartial(): ?bool
  1652.     {
  1653.         return $this->paginationPartial;
  1654.     }
  1656.     public function withPaginationPartial(bool $paginationPartial): self
  1657.     {
  1658.         $self = clone $this;
  1659.         $self->paginationPartial = $paginationPartial;
  1661.         return $self;
  1662.     }
  1664.     public function getPaginationType(): ?string
  1665.     {
  1666.         return $this->paginationType;
  1667.     }
  1669.     public function withPaginationType(string $paginationType): self
  1670.     {
  1671.         $self = clone $this;
  1672.         $self->paginationType = $paginationType;
  1674.         return $self;
  1675.     }
  1677.     public function getSecurity(): ?string
  1678.     {
  1679.         return $this->security;
  1680.     }
  1682.     public function withSecurity(string $security): self
  1683.     {
  1684.         $self = clone $this;
  1685.         $self->security = $security;
  1687.         return $self;
  1688.     }
  1690.     public function getSecurityMessage(): ?string
  1691.     {
  1692.         return $this->securityMessage;
  1693.     }
  1695.     public function withSecurityMessage(string $securityMessage): self
  1696.     {
  1697.         $self = clone $this;
  1698.         $self->securityMessage = $securityMessage;
  1700.         return $self;
  1701.     }
  1703.     public function getSecurityPostDenormalize(): ?string
  1704.     {
  1705.         return $this->securityPostDenormalize;
  1706.     }
  1708.     public function withSecurityPostDenormalize(string $securityPostDenormalize): self
  1709.     {
  1710.         $self = clone $this;
  1711.         $self->securityPostDenormalize = $securityPostDenormalize;
  1713.         return $self;
  1714.     }
  1716.     public function getSecurityPostDenormalizeMessage(): ?string
  1717.     {
  1718.         return $this->securityPostDenormalizeMessage;
  1719.     }
  1721.     public function withSecurityPostDenormalizeMessage(string $securityPostDenormalizeMessage): self
  1722.     {
  1723.         $self = clone $this;
  1724.         $self->securityPostDenormalizeMessage = $securityPostDenormalizeMessage;
  1726.         return $self;
  1727.     }
  1729.     public function getSecurityPostValidation(): ?string
  1730.     {
  1731.         return $this->securityPostValidation;
  1732.     }
  1734.     public function withSecurityPostValidation(string $securityPostValidation = null): self
  1735.     {
  1736.         $self = clone $this;
  1737.         $self->securityPostValidation = $securityPostValidation;
  1739.         return $self;
  1740.     }
  1742.     public function getSecurityPostValidationMessage(): ?string
  1743.     {
  1744.         return $this->securityPostValidationMessage;
  1745.     }
  1747.     public function withSecurityPostValidationMessage(string $securityPostValidationMessage = null): self
  1748.     {
  1749.         $self = clone $this;
  1750.         $self->securityPostValidationMessage = $securityPostValidationMessage;
  1752.         return $self;
  1753.     }
  1755.     public function getExceptionToStatus(): ?array
  1756.     {
  1757.         return $this->exceptionToStatus;
  1758.     }
  1760.     public function withExceptionToStatus(array $exceptionToStatus): self
  1761.     {
  1762.         $self = clone $this;
  1763.         $self->exceptionToStatus = $exceptionToStatus;
  1765.         return $self;
  1766.     }
  1768.     public function getQueryParameterValidationEnabled(): ?bool
  1769.     {
  1770.         return $this->queryParameterValidationEnabled;
  1771.     }
  1773.     public function withQueryParameterValidationEnabled(bool $queryParameterValidationEnabled): self
  1774.     {
  1775.         $self = clone $this;
  1776.         $self->queryParameterValidationEnabled = $queryParameterValidationEnabled;
  1778.         return $self;
  1779.     }
  1781.     /**
  1782.      * @return GraphQlOperation[]
  1783.      */
  1784.     public function getGraphQlOperations(): ?array
  1785.     {
  1786.         return $this->graphQlOperations;
  1787.     }
  1789.     public function withGraphQlOperations(array $graphQlOperations): self
  1790.     {
  1791.         $self = clone $this;
  1792.         $self->graphQlOperations = $graphQlOperations;
  1794.         return $self;
  1795.     }
  1797.     /**
  1798.      * @return string|callable|null
  1799.      */
  1800.     public function getProcessor()
  1801.     {
  1802.         return $this->processor;
  1803.     }
  1805.     public function withProcessor($processor): self
  1806.     {
  1807.         $self = clone $this;
  1808.         $self->processor = $processor;
  1810.         return $self;
  1811.     }
  1813.     /**
  1814.      * @return string|callable|null
  1815.      */
  1816.     public function getProvider()
  1817.     {
  1818.         return $this->provider;
  1819.     }
  1821.     public function withProvider($provider): self
  1822.     {
  1823.         $self = clone $this;
  1824.         $self->provider = $provider;
  1826.         return $self;
  1827.     }
  1829.     public function getExtraProperties(): array
  1830.     {
  1831.         return $this->extraProperties;
  1832.     }
  1834.     public function withExtraProperties(array $extraProperties): self
  1835.     {
  1836.         $self = clone $this;
  1837.         $self->extraProperties = $extraProperties;
  1839.         return $self;
  1840.     }
  1842.     public function getStateOptions(): ?OptionsInterface
  1843.     {
  1844.         return $this->stateOptions;
  1845.     }
  1847.     public function withStateOptions(?OptionsInterface $stateOptions): self
  1848.     {
  1849.         $self = clone $this;
  1850.         $self->stateOptions = $stateOptions;
  1852.         return $self;
  1853.     }
  1854. }