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

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