vendor/api-platform/core/src/Core/Annotation/ApiProperty.php line 110

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. * ApiProperty annotation.
  20. *
  21. * @author Kévin Dunglas <dunglas@gmail.com>
  22. *
  23. * @Annotation
  24. *
  25. * @Target({"METHOD", "PROPERTY"})
  26. *
  27. * @Attributes(
  28. *
  29. * @Attribute("deprecationReason", type="string"),
  30. * @Attribute("fetchable", type="bool"),
  31. * @Attribute("fetchEager", type="bool"),
  32. * @Attribute("openapiContext", type="array"),
  33. * @Attribute("jsonldContext", type="array"),
  34. * @Attribute("push", type="bool"),
  35. * @Attribute("security", type="string"),
  36. * @Attribute("securityPostDenormalize", type="string"),
  37. * @Attribute("swaggerContext", type="array")
  38. * )
  39. */
  40. #[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::TARGET_PARAMETER)]
  41. final class ApiProperty
  42. {
  43. use AttributesHydratorTrait;
  45. /**
  46. * @var array<string, array>
  47. */
  48. private static $deprecatedAttributes = [];
  50. /**
  51. * @var string
  52. */
  53. public $description;
  55. /**
  56. * @var bool
  57. */
  58. public $readable;
  60. /**
  61. * @var bool
  62. */
  63. public $writable;
  65. /**
  66. * @var bool
  67. */
  68. public $readableLink;
  70. /**
  71. * @var bool
  72. */
  73. public $writableLink;
  75. /**
  76. * @var bool
  77. */
  78. public $required;
  80. /**
  81. * @var string
  82. */
  83. public $iri;
  85. /**
  86. * @var bool
  87. */
  88. public $identifier;
  90. /**
  91. * @var string|int|float|bool|array|null
  92. */
  93. public $default;
  95. /**
  96. * @var string|int|float|bool|array|null
  97. */
  98. public $example;
  100. public $types;
  101. public $builtinTypes;
  103. /**
  104. * @param string $description
  105. * @param string|int|float|bool|array $default
  106. * @param string|int|float|bool|array|null $example
  107. *
  108. * @throws InvalidArgumentException
  109. */
  110. public function __construct(
  111. $description = null,
  112. bool $readable = null,
  113. bool $writable = null,
  114. bool $readableLink = null,
  115. bool $writableLink = null,
  116. bool $required = null,
  117. string $iri = null,
  118. bool $identifier = null,
  119. $default = null,
  120. $example = null,
  122. // attributes
  123. array $attributes = null,
  124. string $deprecationReason = null,
  125. bool $fetchable = null,
  126. bool $fetchEager = null,
  127. array $jsonldContext = null,
  128. array $openapiContext = null,
  129. bool $push = null,
  130. string $security = null,
  131. array $swaggerContext = null,
  132. string $securityPostDenormalize = null,
  134. ?array $types = [],
  135. ?array $builtinTypes = []
  136. ) {
  137. if (!\is_array($description)) { // @phpstan-ignore-line Doctrine annotations support
  138. [$publicProperties, $configurableAttributes] = self::getConfigMetadata();
  140. foreach ($publicProperties as $prop => $_) {
  141. $this->{$prop} = ${$prop};
  142. }
  144. $description = [];
  145. foreach ($configurableAttributes as $attribute => $_) {
  146. $description[$attribute] = ${$attribute};
  147. }
  148. }
  150. $this->hydrateAttributes($description);
  151. }
  152. }