api-platform / core / 6067528200

<?php

/*

 * This file is part of the API Platform project.

 *

 * (c) Kévin Dunglas <dunglas@gmail.com>

 *

 * For the full copyright and license information, please view the LICENSE

 * file that was distributed with this source code.

 */

declare(strict_types=1);

namespace ApiPlatform\Metadata;

use ApiPlatform\State\OptionsInterface;

/**

 * ⚠ This class and its children offer no backward compatibility regarding positional parameters.

 */

abstract class Operation extends Metadata

{

    use WithResourceTrait;

    /**

     * @param bool|null                           $paginationEnabled              {@see https://api-platform.com/docs/core/pagination/#for-a-specific-resource}

     * @param string|null                         $paginationType                 {@see https://api-platform.com/docs/core/graphql/#using-the-page-based-pagination}

     * @param int|null                            $paginationItemsPerPage         {@see https://api-platform.com/docs/core/pagination/#changing-the-number-of-items-per-page}

     * @param int|null                            $paginationMaximumItemsPerPage  {@see https://api-platform.com/docs/core/pagination/#changing-maximum-items-per-page}

     * @param bool|null                           $paginationPartial              {@see https://api-platform.com/docs/core/performance/#partial-pagination}

     * @param bool|null                           $paginationClientEnabled        {@see https://api-platform.com/docs/core/pagination/#for-a-specific-resource-1}

     * @param bool|null                           $paginationClientItemsPerPage   {@see https://api-platform.com/docs/core/pagination/#for-a-specific-resource-3}

     * @param bool|null                           $paginationClientPartial        {@see https://api-platform.com/docs/core/pagination/#for-a-specific-resource-6}

     * @param bool|null                           $paginationFetchJoinCollection  {@see https://api-platform.com/docs/core/pagination/#controlling-the-behavior-of-the-doctrine-orm-paginator}

     * @param array<string, string>|string[]|null $order                          {@see https://api-platform.com/docs/core/default-order/#overriding-default-order}

     * @param string|null                         $security                       {@see https://api-platform.com/docs/core/security}

     * @param string|null                         $securityMessage                {@see https://api-platform.com/docs/core/security/#configuring-the-access-control-error-message}

     * @param string|null                         $securityPostDenormalize        {@see https://api-platform.com/docs/core/security/#executing-access-control-rules-after-denormalization}

     * @param string|null                         $securityPostDenormalizeMessage {@see https://api-platform.com/docs/core/security/#configuring-the-access-control-error-message}

     * @param string|null                         $deprecationReason              {@see https://api-platform.com/docs/core/deprecations/#deprecating-resource-classes-operations-and-properties}

     * @param string[]|null                       $filters                        {@see https://api-platform.com/docs/core/filters/#doctrine-orm-and-mongodb-odm-filters}

     * @param array{

     *     class?: string|null,

     *     name?: string,

     * }|string|false|null $input {@see https://api-platform.com/docs/core/dto/#specifying-an-input-or-an-output-data-representation}

     * @param array{

     *     class?: string|null,

     *     name?: string,

     * }|string|false|null $output {@see https://api-platform.com/docs/core/dto/#specifying-an-input-or-an-output-data-representation}

     * @param string|array|bool|null $mercure       {@see https://api-platform.com/docs/core/mercure}

     * @param string|bool|null       $messenger     {@see https://api-platform.com/docs/core/messenger/#dispatching-a-resource-through-the-message-bus}

     * @param bool|null              $elasticsearch {@see https://api-platform.com/docs/core/elasticsearch/}

     * @param bool|null              $read          {@see https://api-platform.com/docs/core/events/#the-event-system}

     * @param bool|null              $deserialize   {@see https://api-platform.com/docs/core/events/#the-event-system}

     * @param bool|null              $validate      {@see https://api-platform.com/docs/core/events/#the-event-system}

     * @param bool|null              $write         {@see https://api-platform.com/docs/core/events/#the-event-system}

     * @param bool|null              $serialize     {@see https://api-platform.com/docs/core/events/#the-event-system}

     * @param bool|null              $fetchPartial  {@see https://api-platform.com/docs/core/performance/#fetch-partial}

     * @param bool|null              $forceEager    {@see https://api-platform.com/docs/core/performance/#force-eager}

     * @param string|callable|null   $provider      {@see https://api-platform.com/docs/core/state-providers/#state-providers}

     * @param string|callable|null   $processor     {@see https://api-platform.com/docs/core/state-processors/#state-processors}

     */

    public function __construct(

        protected ?string $shortName = null,

        protected ?string $class = null,

        /**

         * The `paginationEnabled` option enables (or disables) the pagination for the current collection operation.

         *

         * <CodeSelector>

         * ```php

         * <?php

         * // api/src/Entity/Book.php

         * use ApiPlatform\Metadata\GetCollection;

         *

         * #[GetCollection(paginationEnabled: true)]

         * class Book

         * {

         *     // ...

         * }

         * ```

         *

         * ```yaml

         * # api/config/api_platform/resources.yaml

         * resources:

         *     App\Entity\Book:

         *         - operations:

         *               ApiPlatform\Metadata\GetCollection:

         *                   paginationEnabled: true

         * ```

         *

         * ```xml

         * <?xml version="1.0" encoding="UTF-8" ?>

         * <!-- api/config/api_platform/resources.xml -->

         *

         * <resources

         *         xmlns="https://api-platform.com/schema/metadata/resources-3.0"

         *         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

         *         xsi:schemaLocation="https://api-platform.com/schema/metadata/resources-3.0

         *         https://api-platform.com/schema/metadata/resources-3.0.xsd">

         *     <resource class="App\Entity\Book">

         *         <operations>

         *             <operation class="ApiPlatform\Metadata\GetCollection" paginationEnabled=true />

         *         </operations>

         *     </resource>

         * </resources>

         * ```

         * </CodeSelector>

         */

        protected ?bool $paginationEnabled = null,

        /**

         * The `paginationType` option defines the type of pagination (`page` or `cursor`) to use for the current collection operation.

         *

         * <CodeSelector>

         * ```php

         * <?php

         * // api/src/Entity/Book.php

         * use ApiPlatform\Metadata\GetCollection;

         *

         * #[GetCollection(paginationType: 'page')]

         * class Book

         * {

         *     // ...

         * }

         * ```

         *

         * ```yaml

         * # api/config/api_platform/resources.yaml

         * resources:

         *     App\Entity\Book:

         *         - operations:

         *               ApiPlatform\Metadata\GetCollection:

         *                   paginationType: page

         * ```

         *

         * ```xml

         * <?xml version="1.0" encoding="UTF-8" ?>

         * <!-- api/config/api_platform/resources.xml -->

         *

         * <resources

         *         xmlns="https://api-platform.com/schema/metadata/resources-3.0"

         *         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

         *         xsi:schemaLocation="https://api-platform.com/schema/metadata/resources-3.0

         *         https://api-platform.com/schema/metadata/resources-3.0.xsd">

         *     <resource class="App\Entity\Book">

         *         <operations>

         *             <operation class="ApiPlatform\Metadata\GetCollection" paginationType="page" />

         *         </operations>

         *     </resource>

         * </resources>

         * ```

         * </CodeSelector>

         */

        protected ?string $paginationType = null,

        /**

         * The `paginationItemsPerPage` option defines the number of items per page for the current collection operation.

         *

         * <CodeSelector>

         * ```php

         * <?php

         * // api/src/Entity/Book.php

         * use ApiPlatform\Metadata\GetCollection;

         *

         * #[GetCollection(paginationItemsPerPage: 30)]

         * class Book

         * {

         *     // ...

         * }

         * ```

         *

         * ```yaml

         * # api/config/api_platform/resources.yaml

         * resources:

         *     App\Entity\Book:

         *         - operations:

         *               ApiPlatform\Metadata\GetCollection:

         *                   paginationItemsPerPage: 30

         * ```

         *

         * ```xml

         * <?xml version="1.0" encoding="UTF-8" ?>

         * <!-- api/config/api_platform/resources.xml -->

         * <resources

         *         xmlns="https://api-platform.com/schema/metadata/resources-3.0"

         *         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

         *         xsi:schemaLocation="https://api-platform.com/schema/metadata/resources-3.0

         *         https://api-platform.com/schema/metadata/resources-3.0.xsd">

         *     <resource class="App\Entity\Book">

         *         <operations>

         *             <operation class="ApiPlatform\Metadata\GetCollection" paginationItemsPerPage=30 />

         *         </operations>

         *     </resource>

         * </resources>

         * ```

         * </CodeSelector>

         */

        protected ?int $paginationItemsPerPage = null,

        /**

         * The `paginationMaximumItemsPerPage` option defines the maximum number of items per page for the current resource.

         *

         * <CodeSelector>

         * ```php

         * <?php

         * // api/src/Entity/Book.php

         * use ApiPlatform\Metadata\GetCollection;

         *

         * #[GetCollection(paginationMaximumItemsPerPage: 50)]

         * class Book

         * {

         *     // ...

         * }

         * ```

         *

         * ```yaml

         * # api/config/api_platform/resources.yaml

         * resources:

         *     App\Entity\Book:

         *         - operations:

         *               ApiPlatform\Metadata\GetCollection:

         *                   paginationMaximumItemsPerPage: 50

         * ```

         *

         * ```xml

         * <?xml version="1.0" encoding="UTF-8" ?>

         * <!-- api/config/api_platform/resources.xml -->

         * <resources

         *         xmlns="https://api-platform.com/schema/metadata/resources-3.0"

         *         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

         *         xsi:schemaLocation="https://api-platform.com/schema/metadata/resources-3.0

         *         https://api-platform.com/schema/metadata/resources-3.0.xsd">

         *     <resource class="App\Entity\Book">

         *         <operations>

         *             <operation class="ApiPlatform\Metadata\GetCollection" paginationMaximumItemsPerPage=50 />

         *         </operations>

         *     </resource>

         * </resources>

         * ```

         * </CodeSelector>

         */

        protected ?int $paginationMaximumItemsPerPage = null,

        /**

         * The `paginationPartial` option enables (or disables) the partial pagination for the current collection operation.

         *

         * <CodeSelector>

         * ```php

         * <?php

         * // api/src/Entity/Book.php

         * use ApiPlatform\Metadata\GetCollection;

         *

         * #[GetCollection(paginationPartial: true)]

         * class Book

         * {

         *     // ...

         * }

         * ```

         *

         * ```yaml

         * # api/config/api_platform/resources.yaml

         * resources:

         *     App\Entity\Book:

         *         - operations:

         *               ApiPlatform\Metadata\GetCollection:

         *                   paginationPartial: true

         * ```

         *

         * ```xml

         * <?xml version="1.0" encoding="UTF-8" ?>

         * <!-- api/config/api_platform/resources.xml -->

         * <resources

         *         xmlns="https://api-platform.com/schema/metadata/resources-3.0"

         *         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

         *         xsi:schemaLocation="https://api-platform.com/schema/metadata/resources-3.0

         *         https://api-platform.com/schema/metadata/resources-3.0.xsd">

         *     <resource class="App\Entity\Book">

         *         <operations>

         *             <operation class="ApiPlatform\Metadata\GetCollection" paginationPartial=true />

         *         </operations>

         *     </resource>

         * </resources>

         * ```

         * </CodeSelector>

         */

        protected ?bool $paginationPartial = null,

        /**

         * The `paginationClientEnabled` option allows (or disallows) the client to enable (or disable) the pagination for the current collection operation.

         *

         * <CodeSelector>

         * ```php

         * <?php

         * // api/src/Entity/Book.php

         * use ApiPlatform\Metadata\GetCollection;

         *

         * #[GetCollection(paginationClientEnabled: true)]

         * class Book

         * {

         *     // ...

         * }

         * ```

         *

         * ```yaml

         * # api/config/api_platform/resources.yaml

         * resources:

         *     App\Entity\Book:

         *         - operations:

         *               ApiPlatform\Metadata\GetCollection:

         *                   paginationClientEnabled: true

         * ```

         *

         * ```xml

         * <?xml version="1.0" encoding="UTF-8" ?>

         * <!-- api/config/api_platform/resources.xml -->

         * <resources

         *         xmlns="https://api-platform.com/schema/metadata/resources-3.0"

         *         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

         *         xsi:schemaLocation="https://api-platform.com/schema/metadata/resources-3.0

         *         https://api-platform.com/schema/metadata/resources-3.0.xsd">

         *     <resource class="App\Entity\Book">

         *         <operations>

         *             <operation class="ApiPlatform\Metadata\GetCollection" paginationClientEnabled=true />

         *         </operations>

         *     </resource>

         * </resources>

         * ```

         * </CodeSelector>

         *

         * The pagination can now be enabled (or disabled) by adding a query parameter named `pagination`:

         * - `GET /books?pagination=false`: disabled

         * - `GET /books?pagination=true`: enabled

         */

        protected ?bool $paginationClientEnabled = null,

        /**

         * The `paginationClientItemsPerPage` option allows (or disallows) the client to set the number of items per page for the current collection operation.

         *

         * <CodeSelector>

         * ```php

         * <?php

         * // api/src/Entity/Book.php

         * use ApiPlatform\Metadata\GetCollection;

         *

         * #[GetCollection(paginationClientItemsPerPage: true)]

         * class Book

         * {

         *     // ...

         * }

         * ```

         *

         * ```yaml

         * # api/config/api_platform/resources.yaml

         * resources:

         *     App\Entity\Book:

         *         - operations:

         *               ApiPlatform\Metadata\GetCollection:

         *                   paginationClientItemsPerPage: true

         * ```

         *

         * ```xml

         * <?xml version="1.0" encoding="UTF-8" ?>

         * <!-- api/config/api_platform/resources.xml -->

         * <resources

         *         xmlns="https://api-platform.com/schema/metadata/resources-3.0"

         *         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

         *         xsi:schemaLocation="https://api-platform.com/schema/metadata/resources-3.0

         *         https://api-platform.com/schema/metadata/resources-3.0.xsd">

         *     <resource class="App\Entity\Book">

         *         <operations>

         *             <operation class="ApiPlatform\Metadata\GetCollection" paginationClientItemsPerPage=true />

         *         </operations>

         *     </resource>

         * </resources>

         * ```

         * </CodeSelector>

         *

         * The number of items can now be set by adding a query parameter named `itemsPerPage`:

         * - `GET /books?itemsPerPage=50`

         */

        protected ?bool $paginationClientItemsPerPage = null,

        /**

         * The `paginationClientPartial` option allows (or disallows) the client to enable (or disable) the partial pagination for the current collection operation.

         *

         * <CodeSelector>

         * ```php

         * <?php

         * // api/src/Entity/Book.php

         * use ApiPlatform\Metadata\GetCollection;

         *

         * #[GetCollection(paginationClientPartial: true)]

         * class Book

         * {

         *     // ...

         * }

         * ```

         *

         * ```yaml

         * # api/config/api_platform/resources.yaml

         * resources:

         *     App\Entity\Book:

         *         - operations:

         *               ApiPlatform\Metadata\GetCollection:

         *                   paginationClientPartial: true

         * ```

         *

         * ```xml

         * <?xml version="1.0" encoding="UTF-8" ?>

         * <!-- api/config/api_platform/resources.xml -->

         * <resources

         *         xmlns="https://api-platform.com/schema/metadata/resources-3.0"

         *         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

         *         xsi:schemaLocation="https://api-platform.com/schema/metadata/resources-3.0

         *         https://api-platform.com/schema/metadata/resources-3.0.xsd">

         *     <resource class="App\Entity\Book">

         *         <operations>

         *             <operation class="ApiPlatform\Metadata\GetCollection" paginationClientPartial=true />

         *         </operations>

         *     </resource>

         * </resources>

         * ```

         * </CodeSelector>

         *

         * The partial pagination can now be enabled (or disabled) by adding a query parameter named `partial`:

         * - `GET /books?partial=false`: disabled

         * - `GET /books?partial=true`: enabled

         */

        protected ?bool $paginationClientPartial = null,

        /**

         * The PaginationExtension of API Platform performs some checks on the `QueryBuilder` to guess, in most common

         * cases, the correct values to use when configuring the Doctrine ORM Paginator: `$fetchJoinCollection`

         * argument, whether there is a join to a collection-valued association.

         *

         * When set to `true`, the Doctrine ORM Paginator will perform an additional query, in order to get the

         * correct number of results. You can configure this using the `paginationFetchJoinCollection` option:

         *

         * <CodeSelector>

         * ```php

         * <?php

         * // api/src/Entity/Book.php

         * use ApiPlatform\Metadata\GetCollection;

         *

         * #[GetCollection(paginationFetchJoinCollection: false)]

         * class Book

         * {

         *     // ...

         * }

         * ```

         *

         * ```yaml

         * # api/config/api_platform/resources.yaml

         * resources:

         *     App\Entity\Book:

         *         - operations:

         *               ApiPlatform\Metadata\GetCollection:

         *                   paginationFetchJoinCollection: false

         * ```

         *

         * ```xml

         * <?xml version="1.0" encoding="UTF-8" ?>

         * <!-- api/config/api_platform/resources.xml -->

         * <resources

         *         xmlns="https://api-platform.com/schema/metadata/resources-3.0"

         *         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

         *         xsi:schemaLocation="https://api-platform.com/schema/metadata/resources-3.0

         *         https://api-platform.com/schema/metadata/resources-3.0.xsd">

         *     <resource class="App\Entity\Book">

         *         <operations>

         *             <operation class="ApiPlatform\Metadata\GetCollection" paginationFetchJoinCollection=false />

         *         </operations>

         *     </resource>

         * </resources>

         * ```

         * </CodeSelector>

         *

         * 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.

         */

        protected ?bool $paginationFetchJoinCollection = null,

        /**

         * The PaginationExtension of API Platform performs some checks on the `QueryBuilder` to guess, in most common

         * cases, the correct values to use when configuring the Doctrine ORM Paginator: `$setUseOutputWalkers` setter,

         * whether to use output walkers.

         *

         * When set to `true`, the Doctrine ORM Paginator will use output walkers, which are compulsory for some types

         * of queries. You can configure this using the `paginationUseOutputWalkers` option:

         *

         * <CodeSelector>

         * ```php

         * <?php

         * // api/src/Entity/Book.php

         * use ApiPlatform\Metadata\GetCollection;

         *

         * #[GetCollection(paginationUseOutputWalkers: false)]

         * class Book

         * {

         *     // ...

         * }

         * ```

         *

         * ```yaml

         * # api/config/api_platform/resources.yaml

         * resources:

         *     App\Entity\Book:

         *         - operations:

         *               ApiPlatform\Metadata\GetCollection:

         *                   paginationUseOutputWalkers: false

         * ```

         *

         * ```xml

         * <?xml version="1.0" encoding="UTF-8" ?>

         * <!-- api/config/api_platform/resources.xml -->

         * <resources

         *         xmlns="https://api-platform.com/schema/metadata/resources-3.0"

         *         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

         *         xsi:schemaLocation="https://api-platform.com/schema/metadata/resources-3.0

         *         https://api-platform.com/schema/metadata/resources-3.0.xsd">

         *     <resource class="App\Entity\Book">

         *         <operations>

         *             <operation class="ApiPlatform\Metadata\GetCollection" paginationUseOutputWalkers=false />

         *         </operations>

         *     </resource>

         * </resources>

         * ```

         * </CodeSelector>

         *

         * 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.

         */

        protected ?bool $paginationUseOutputWalkers = null,

        /**

         * The `paginationViaCursor` option configures the cursor-based pagination for the current resource.

         * Select your unique sorted field as well as the direction you'll like the pagination to go via filters.

         * Note that for now you have to declare a `RangeFilter` and an `OrderFilter` on the property used for the cursor-based pagination:.

         *

         * <CodeSelector>

         * ```php

         * <?php

         * // api/src/Entity/Book.php

         * use ApiPlatform\Metadata\ApiFilter;

         * use ApiPlatform\Metadata\GetCollection;

         * use ApiPlatform\Doctrine\Odm\Filter\OrderFilter;

         * use ApiPlatform\Doctrine\Odm\Filter\RangeFilter;

         *

         * #[GetCollection(paginationPartial: true, paginationViaCursor: [['field' => 'id', 'direction' => 'DESC']])]

         * #[ApiFilter(RangeFilter::class, properties: ["id"])]

         * #[ApiFilter(OrderFilter::class, properties: ["id" => "DESC"])]

         * class Book

         * {

         *     // ...

         * }

         * ```

         *

         * ```yaml

         * # api/config/api_platform/resources.yaml

         * resources:

         *     App\Entity\Book:

         *         - operations:

         *               ApiPlatform\Metadata\GetCollection:

         *                   paginationPartial: true

         *                   paginationViaCursor:

         *                       - { field: 'id', direction: 'DESC' }

         *                   filters: [ 'app.filters.book.range', 'app.filters.book.order' ]

         * ```

         *

         * ```xml

         * <?xml version="1.0" encoding="UTF-8" ?>

         * <!-- api/config/api_platform/resources.xml -->

         *

         * <resources

         *         xmlns="https://api-platform.com/schema/metadata/resources-3.0"

         *         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

         *         xsi:schemaLocation="https://api-platform.com/schema/metadata/resources-3.0

         *         https://api-platform.com/schema/metadata/resources-3.0.xsd">

         *     <resource class="App\Entity\Book">

         *         <operations>

         *             <operation class="ApiPlatform\Metadata\GetCollection" paginationPartial=true>

         *                 <filters>

         *                     <filter>app.filters.book.range</filter>

         *                     <filter>app.filters.book.order</filter>

         *                 </filters>

         *                 <paginationViaCursor>

         *                     <paginationField field="id" direction="DESC" />

         *                 </paginationViaCursor>

         *             </operation>

         *         </operations>

         *     </resource>

         * </resources>

         * ```

         * </CodeSelector>

         *

         * To know more about cursor-based pagination take a look at [this blog post on medium (draft)](https://medium.com/@sroze/74fd1d324723).

         */

        protected ?array $paginationViaCursor = null,

        protected ?array $order = null,

        protected ?string $description = null,

        protected ?array $normalizationContext = null,

        protected ?array $denormalizationContext = null,

        protected ?bool $collectDenormalizationErrors = null,

        protected ?string $security = null,

        protected ?string $securityMessage = null,

        protected ?string $securityPostDenormalize = null,

        protected ?string $securityPostDenormalizeMessage = null,

        protected ?string $securityPostValidation = null,

        protected ?string $securityPostValidationMessage = null,

        /**

         * The `deprecationReason` option deprecates the current operation with a deprecation message.

         *

         * <CodeSelector>

         * ```php

         * <?php

         * // api/src/Entity/Parchment.php

         * use ApiPlatform\Metadata\Get;

         *

         * #[Get(deprecationReason: 'Create a Book instead')]

         * class Parchment

         * {

         *     // ...

         * }

         * ```

         *

         * ```yaml

         * # api/config/api_platform/resources.yaml

         * resources:

         *     App\Entity\Parchment:

         *         - operations:

         *               ApiPlatform\Metadata\Get:

         *                   deprecationReason: 'Create a Book instead'

         * ```

         *

         * ```xml

         * <?xml version="1.0" encoding="UTF-8" ?>

         * <!-- api/config/api_platform/resources.xml -->

         *

         * <resources

         *         xmlns="https://api-platform.com/schema/metadata/resources-3.0"

         *         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

         *         xsi:schemaLocation="https://api-platform.com/schema/metadata/resources-3.0

         *         https://api-platform.com/schema/metadata/resources-3.0.xsd">

         *     <resource class="App\Entity\Parchment">

         *         <operations>

         *             <operation class="ApiPlatform\Metadata\Get" deprecationReason="Create a Book instead" />

         *         <operations>

         *     </resource>

         * </resources>

         * ```

         * </CodeSelector>

         *

         * - 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

         * - With Swagger / OpenAPI, [a `deprecated` property](https://swagger.io/docs/specification/2-0/paths-and-operations/) will be added

         * - With GraphQL, the [`isDeprecated` and `deprecationReason` properties](https://facebook.github.io/graphql/June2018/#sec-Deprecation) will be added to the schema

         */

        protected ?string $deprecationReason = null,

        /**

         * The `filters` option configures the filters (declared as services) available on the collection routes for the current resource.

         *

         * <CodeSelector>

         * ```php

         * <?php

         * // api/src/Entity/Book.php

         * use ApiPlatform\Metadata\GetCollection;

         *

         * #[GetCollection(filters: ['app.filters.book.search'])]

         * class Book

         * {

         *     // ...

         * }

         * ```

         *

         * ```yaml

         * # api/config/api_platform/resources.yaml

         * resources:

         *     App\Entity\Book:

         *         - operations:

         *               ApiPlatform\Metadata\GetCollection:

         *                   filters: ['app.filters.book.search']

         * ```

         *

         * ```xml

         * <?xml version="1.0" encoding="UTF-8" ?>

         * <!-- api/config/api_platform/resources.xml -->

         * <resources

         *         xmlns="https://api-platform.com/schema/metadata/resources-3.0"

         *         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

         *         xsi:schemaLocation="https://api-platform.com/schema/metadata/resources-3.0

         *         https://api-platform.com/schema/metadata/resources-3.0.xsd">

         *     <resource class="App\Entity\Book">

         *         <operations>

         *             <operation class="ApiPlatform\Metadata\GetCollection">

         *                 <filters>

         *                     <filter>app.filters.book.search</filter>

         *                 </filters>

         *             </operation>

         *         </operations>

         *     </resource>

         * </resources>

         * ```

         * </CodeSelector>

         */

        protected ?array $filters = null,

        /**

         * The `validationContext` option configure the context of validation for the current Operation.

         * You can, for instance, describe the validation groups that will be used :.

         *

         * ```php

         *   #[Put(validationContext: ['groups' => ['Default', 'putValidation']])]

         *   #[Post(validationContext: ['groups' => ['Default', 'postValidation']])]

         * ```

         *

         * For more examples, read our guide on [validation](/guides/validation).

         */

        protected ?array $validationContext = null,

        protected $input = null,

        protected $output = null,

        protected $mercure = null,

        /**

         * The `messenger` option dispatches the current resource through the Message Bus.

         *

         * <CodeSelector>

         * ```php

         * <?php

         * // api/src/Entity/Book.php

         * use ApiPlatform\Metadata\Post;

         *

         * #[Post(messenger: true)]

         * class Book

         * {

         *     // ...

         * }

         * ```

         *

         * ```yaml

         * # api/config/api_platform/resources.yaml

         * resources:

         *     App\Entity\Book:

         *         - operations:

         *               ApiPlatform\Metadata\Post:

         *                   messenger: true

         * ```

         *

         * ```xml

         * <?xml version="1.0" encoding="UTF-8" ?>

         * <!-- api/config/api_platform/resources.xml -->

         *

         * <resources

         *         xmlns="https://api-platform.com/schema/metadata/resources-3.0"

         *         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

         *         xsi:schemaLocation="https://api-platform.com/schema/metadata/resources-3.0

         *         https://api-platform.com/schema/metadata/resources-3.0.xsd">

         *     <resource class="App\Entity\Book">

         *         <operations>

         *             <operation class="ApiPlatform\Metadata\Post" messenger=true />

         *         </operations>

         *     </resource>

         * </resources>

         * ```

         * </CodeSelector>

         *

         * Note: when using `messenger=true` on a Doctrine entity, the Doctrine Processor is not called. If you want it

         * to be called, you should [decorate a built-in state processor](/docs/guide/hook-a-persistence-layer-with-a-processor)

         * and implement your own logic.

         *

         * Read [how to use Messenger with an Input object](/docs/guide/using-messenger-with-an-input-object).

         *

         * @var string|bool|null

         */

        protected $messenger = null,

        protected ?bool $elasticsearch = null,

        protected ?int $urlGenerationStrategy = null,

        protected ?bool $read = null,

        protected ?bool $deserialize = null,

        protected ?bool $validate = null,

        protected ?bool $write = null,

        protected ?bool $serialize = null,

        protected ?bool $fetchPartial = null,

        protected ?bool $forceEager = null,

        protected ?int $priority = null,

        protected ?string $name = null,

        protected $provider = null,

        protected $processor = null,

        protected ?OptionsInterface $stateOptions = null,

        protected array $extraProperties = [],

    ) {

    }

    public function withOperation($operation)

    {

    }

    public function canRead(): ?bool

    {

    }

    public function withRead(bool $read = true): self

    {

    }

    public function canDeserialize(): ?bool

    {

    }

    public function withDeserialize(bool $deserialize = true): self

    {

    }

    public function canValidate(): ?bool

    {

    }

    public function withValidate(bool $validate = true): self

    {

    }

    public function canWrite(): ?bool

    {

    }

    public function withWrite(bool $write = true): self

    {

    }

    public function canSerialize(): ?bool

    {

    }

    public function withSerialize(bool $serialize = true): self

    {

    }

    public function getPriority(): ?int

    {

    }

    public function withPriority(int $priority = 0): self

    {

    }

    public function getName(): ?string

    {

    }

    public function withName(string $name = ''): self

    {

    }

}