vendor/api-platform/core/src/Annotation/ApiResource.php line 237

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the API Platform project.
  5.  *
  6.  * (c) Kévin Dunglas <dunglas@gmail.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. declare(strict_types=1);
  14. namespace ApiPlatform\Core\Annotation;
  16. use ApiPlatform\Core\Exception\InvalidArgumentException;
  18. /**
  19.  * ApiResource annotation.
  20.  *
  21.  * @author Kévin Dunglas <dunglas@gmail.com>
  22.  *
  23.  * @Annotation
  24.  * @Target({"CLASS"})
  25.  * @Attributes(
  26.  *     @Attribute("accessControl", type="string"),
  27.  *     @Attribute("accessControlMessage", type="string"),
  28.  *     @Attribute("attributes", type="array"),
  29.  *     @Attribute("cacheHeaders", type="array"),
  30.  *     @Attribute("collectionOperations", type="array"),
  31.  *     @Attribute("compositeIdentifier", type="bool"),
  32.  *     @Attribute("denormalizationContext", type="array"),
  33.  *     @Attribute("deprecationReason", type="string"),
  34.  *     @Attribute("description", type="string"),
  35.  *     @Attribute("elasticsearch", type="bool"),
  36.  *     @Attribute("fetchPartial", type="bool"),
  37.  *     @Attribute("forceEager", type="bool"),
  38.  *     @Attribute("formats", type="array"),
  39.  *     @Attribute("filters", type="string[]"),
  40.  *     @Attribute("graphql", type="array"),
  41.  *     @Attribute("hydraContext", type="array"),
  42.  *     @Attribute("input", type="mixed"),
  43.  *     @Attribute("iri", type="string"),
  44.  *     @Attribute("itemOperations", type="array"),
  45.  *     @Attribute("mercure", type="mixed"),
  46.  *     @Attribute("messenger", type="mixed"),
  47.  *     @Attribute("normalizationContext", type="array"),
  48.  *     @Attribute("openapiContext", type="array"),
  49.  *     @Attribute("order", type="array"),
  50.  *     @Attribute("output", type="mixed"),
  51.  *     @Attribute("paginationClientEnabled", type="bool"),
  52.  *     @Attribute("paginationClientItemsPerPage", type="bool"),
  53.  *     @Attribute("paginationClientPartial", type="bool"),
  54.  *     @Attribute("paginationEnabled", type="bool"),
  55.  *     @Attribute("paginationFetchJoinCollection", type="bool"),
  56.  *     @Attribute("paginationItemsPerPage", type="int"),
  57.  *     @Attribute("maximumItemsPerPage", type="int"),
  58.  *     @Attribute("paginationMaximumItemsPerPage", type="int"),
  59.  *     @Attribute("paginationPartial", type="bool"),
  60.  *     @Attribute("paginationViaCursor", type="array"),
  61.  *     @Attribute("routePrefix", type="string"),
  62.  *     @Attribute("security", type="string"),
  63.  *     @Attribute("securityMessage", type="string"),
  64.  *     @Attribute("securityPostDenormalize", type="string"),
  65.  *     @Attribute("securityPostDenormalizeMessage", type="string"),
  66.  *     @Attribute("shortName", type="string"),
  67.  *     @Attribute("stateless", type="bool"),
  68.  *     @Attribute("subresourceOperations", type="array"),
  69.  *     @Attribute("sunset", type="string"),
  70.  *     @Attribute("swaggerContext", type="array"),
  71.  *     @Attribute("urlGenerationStrategy", type="int"),
  72.  *     @Attribute("validationGroups", type="mixed"),
  73.  * )
  74.  */
  75. #[\Attribute(\Attribute::TARGET_CLASS)]
  76. final class ApiResource
  77. {
  78.     use AttributesHydratorTrait;
  80.     /**
  81.      * @var array<string, array>
  82.      */
  83.     private static $deprecatedAttributes = [
  84.         'accessControl' => ['security', '2.5'],
  85.         'accessControlMessage' => ['securityMessage', '2.5'],
  86.         'maximumItemsPerPage' => ['paginationMaximumItemsPerPage', '2.6'],
  87.     ];
  89.     /**
  90.      * @see https://api-platform.com/docs/core/operations
  91.      *
  92.      * @var array
  93.      */
  94.     public $collectionOperations;
  96.     /**
  97.      * @var string
  98.      */
  99.     public $description;
  101.     /**
  102.      * @see https://api-platform.com/docs/core/graphql
  103.      *
  104.      * @var array
  105.      */
  106.     public $graphql;
  108.     /**
  109.      * @var string
  110.      */
  111.     public $iri;
  113.     /**
  114.      * @see https://api-platform.com/docs/core/operations
  115.      *
  116.      * @var array
  117.      */
  118.     public $itemOperations;
  120.     /**
  121.      * @var string
  122.      */
  123.     public $shortName;
  125.     /**
  126.      * @see https://api-platform.com/docs/core/subresources
  127.      *
  128.      * @var array
  129.      */
  130.     public $subresourceOperations;
  132.     /**
  133.      * @param string       $description
  134.      * @param array        $collectionOperations           https://api-platform.com/docs/core/operations
  135.      * @param array        $graphql                        https://api-platform.com/docs/core/graphql
  136.      * @param array        $itemOperations                 https://api-platform.com/docs/core/operations
  137.      * @param array        $subresourceOperations          https://api-platform.com/docs/core/subresources
  138.      * @param array        $cacheHeaders                   https://api-platform.com/docs/core/performance/#setting-custom-http-cache-headers
  139.      * @param array        $denormalizationContext         https://api-platform.com/docs/core/serialization/#using-serialization-groups
  140.      * @param string       $deprecationReason              https://api-platform.com/docs/core/deprecations/#deprecating-resource-classes-operations-and-properties
  141.      * @param bool         $elasticsearch                  https://api-platform.com/docs/core/elasticsearch/
  142.      * @param bool         $fetchPartial                   https://api-platform.com/docs/core/performance/#fetch-partial
  143.      * @param bool         $forceEager                     https://api-platform.com/docs/core/performance/#force-eager
  144.      * @param array        $formats                        https://api-platform.com/docs/core/content-negotiation/#configuring-formats-for-a-specific-resource-or-operation
  145.      * @param string[]     $filters                        https://api-platform.com/docs/core/filters/#doctrine-orm-and-mongodb-odm-filters
  146.      * @param string[]     $hydraContext                   https://api-platform.com/docs/core/extending-jsonld-context/#hydra
  147.      * @param string|false $input                          https://api-platform.com/docs/core/dto/#specifying-an-input-or-an-output-data-representation
  148.      * @param bool|array   $mercure                        https://api-platform.com/docs/core/mercure
  149.      * @param bool         $messenger                      https://api-platform.com/docs/core/messenger/#dispatching-a-resource-through-the-message-bus
  150.      * @param array        $normalizationContext           https://api-platform.com/docs/core/serialization/#using-serialization-groups
  151.      * @param array        $openapiContext                 https://api-platform.com/docs/core/openapi/#using-the-openapi-and-swagger-contexts
  152.      * @param array        $order                          https://api-platform.com/docs/core/default-order/#overriding-default-order
  153.      * @param string|false $output                         https://api-platform.com/docs/core/dto/#specifying-an-input-or-an-output-data-representation
  154.      * @param bool         $paginationClientEnabled        https://api-platform.com/docs/core/pagination/#for-a-specific-resource-1
  155.      * @param bool         $paginationClientItemsPerPage   https://api-platform.com/docs/core/pagination/#for-a-specific-resource-3
  156.      * @param bool         $paginationClientPartial        https://api-platform.com/docs/core/pagination/#for-a-specific-resource-6
  157.      * @param array        $paginationViaCursor            https://api-platform.com/docs/core/pagination/#cursor-based-pagination
  158.      * @param bool         $paginationEnabled              https://api-platform.com/docs/core/pagination/#for-a-specific-resource
  159.      * @param bool         $paginationFetchJoinCollection  https://api-platform.com/docs/core/pagination/#controlling-the-behavior-of-the-doctrine-orm-paginator
  160.      * @param int          $paginationItemsPerPage         https://api-platform.com/docs/core/pagination/#changing-the-number-of-items-per-page
  161.      * @param int          $paginationMaximumItemsPerPage  https://api-platform.com/docs/core/pagination/#changing-maximum-items-per-page
  162.      * @param bool         $paginationPartial              https://api-platform.com/docs/core/performance/#partial-pagination
  163.      * @param string       $routePrefix                    https://api-platform.com/docs/core/operations/#prefixing-all-routes-of-all-operations
  164.      * @param string       $security                       https://api-platform.com/docs/core/security
  165.      * @param string       $securityMessage                https://api-platform.com/docs/core/security/#configuring-the-access-control-error-message
  166.      * @param string       $securityPostDenormalize        https://api-platform.com/docs/core/security/#executing-access-control-rules-after-denormalization
  167.      * @param string       $securityPostDenormalizeMessage https://api-platform.com/docs/core/security/#configuring-the-access-control-error-message
  168.      * @param bool         $stateless
  169.      * @param string       $sunset                         https://api-platform.com/docs/core/deprecations/#setting-the-sunset-http-header-to-indicate-when-a-resource-or-an-operation-will-be-removed
  170.      * @param array        $swaggerContext                 https://api-platform.com/docs/core/openapi/#using-the-openapi-and-swagger-contexts
  171.      * @param array        $validationGroups               https://api-platform.com/docs/core/validation/#using-validation-groups
  172.      * @param int          $urlGenerationStrategy
  173.      *
  174.      * @throws InvalidArgumentException
  175.      */
  176.     public function __construct(
  177.         $description = null,
  178.         ?array $collectionOperations = null,
  179.         ?array $graphql = null,
  180.         ?string $iri = null,
  181.         ?array $itemOperations = null,
  182.         ?string $shortName = null,
  183.         ?array $subresourceOperations = null,
  185.         // attributes
  186.         ?array $attributes = null,
  187.         ?array $cacheHeaders = null,
  188.         ?array $denormalizationContext = null,
  189.         ?string $deprecationReason = null,
  190.         ?bool $elasticsearch = null,
  191.         ?bool $fetchPartial = null,
  192.         ?bool $forceEager = null,
  193.         ?array $formats = null,
  194.         ?array $filters = null,
  195.         ?array $hydraContext = null,
  196.         $input = null,
  197.         $mercure = null,
  198.         $messenger = null,
  199.         ?array $normalizationContext = null,
  200.         ?array $openapiContext = null,
  201.         ?array $order = null,
  202.         $output = null,
  203.         ?bool $paginationClientEnabled = null,
  204.         ?bool $paginationClientItemsPerPage = null,
  205.         ?bool $paginationClientPartial = null,
  206.         ?array $paginationViaCursor = null,
  207.         ?bool $paginationEnabled = null,
  208.         ?bool $paginationFetchJoinCollection = null,
  209.         ?int $paginationItemsPerPage = null,
  210.         ?int $paginationMaximumItemsPerPage = null,
  211.         ?bool $paginationPartial = null,
  212.         ?string $routePrefix = null,
  213.         ?string $security = null,
  214.         ?string $securityMessage = null,
  215.         ?string $securityPostDenormalize = null,
  216.         ?string $securityPostDenormalizeMessage = null,
  217.         ?bool $stateless = null,
  218.         ?string $sunset = null,
  219.         ?array $swaggerContext = null,
  220.         ?array $validationGroups = null,
  221.         ?int $urlGenerationStrategy = null,
  222.         ?bool $compositeIdentifier = null
  223.     ) {
  224.         if (!\is_array($description)) { // @phpstan-ignore-line Doctrine annotations support
  225.             [$publicProperties, $configurableAttributes] = self::getConfigMetadata();
  227.             foreach ($publicProperties as $prop => $_) {
  228.                 $this->{$prop} = ${$prop};
  229.             }
  231.             $description = [];
  232.             foreach ($configurableAttributes as $attribute => $_) {
  233.                 $description[$attribute] = ${$attribute};
  234.             }
  235.         }
  237.         $this->hydrateAttributes($description ?? []); // @phpstan-ignore-line
  238.     }
  239. }