vendor/api-platform/core/src/Core/Metadata/Property/PropertyMetadata.php line 419

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\Metadata\Property;
  16. use Symfony\Component\PropertyInfo\Type;
  18. /**
  19. * Property metadata.
  20. *
  21. * @author Kévin Dunglas <dunglas@gmail.com>
  22. */
  23. final class PropertyMetadata
  24. {
  25. /**
  26. * @deprecated since 2.7, to be removed in 3.0, renamed as builtinTypes
  27. */
  28. private $type;
  29. private $description;
  30. private $readable;
  31. private $writable;
  32. private $readableLink;
  33. private $writableLink;
  34. private $required;
  35. /**
  36. * @deprecated since 2.7, to be removed in 3.0, renamed as types
  37. */
  38. private $iri;
  39. private $identifier;
  40. /**
  41. * @deprecated since 2.6, to be removed in 3.0
  42. */
  43. private $childInherited;
  44. private $attributes;
  45. private $subresource;
  46. private $initializable;
  47. /**
  48. * @var null
  49. */
  50. private $default;
  51. /**
  52. * @var null
  53. */
  54. private $example;
  55. private $schema;
  57. public function __construct(Type $type = null, string $description = null, bool $readable = null, bool $writable = null, bool $readableLink = null, bool $writableLink = null, bool $required = null, bool $identifier = null, string $iri = null, $childInherited = null, array $attributes = null, SubresourceMetadata $subresource = null, bool $initializable = null, $default = null, $example = null, array $schema = null)
  58. {
  59. $this->type = $type;
  60. $this->description = $description;
  61. $this->readable = $readable;
  62. $this->writable = $writable;
  63. $this->readableLink = $readableLink;
  64. $this->writableLink = $writableLink;
  65. $this->required = $required;
  66. $this->identifier = $identifier;
  67. $this->iri = $iri;
  68. if (null !== $childInherited) {
  69. @trigger_error(sprintf('Providing a non-null value for the 10th argument ($childInherited) of the "%s" constructor is deprecated since 2.6 and will not be supported in 3.0.', __CLASS__), \E_USER_DEPRECATED);
  70. }
  71. $this->childInherited = $childInherited;
  72. $this->attributes = $attributes;
  73. $this->subresource = $subresource;
  74. $this->initializable = $initializable;
  75. $this->default = $default;
  76. $this->example = $example;
  77. $this->schema = $schema;
  78. }
  80. /**
  81. * Gets type.
  82. *
  83. * @deprecated since 2.7, to be removed in 3.0, renamed as getBuiltinTypes
  84. */
  85. public function getType(): ?Type
  86. {
  87. return $this->type;
  88. }
  90. /**
  91. * Returns a new instance with the given type.
  92. *
  93. * @deprecated since 2.7, to be removed in 3.0, renamed as withBuiltinTypes
  94. */
  95. public function withType(Type $type): self
  96. {
  97. $metadata = clone $this;
  98. $metadata->type = $type;
  100. return $metadata;
  101. }
  103. /**
  104. * Gets description.
  105. */
  106. public function getDescription(): ?string
  107. {
  108. return $this->description;
  109. }
  111. /**
  112. * Returns a new instance with the given description.
  113. */
  114. public function withDescription(string $description): self
  115. {
  116. $metadata = clone $this;
  117. $metadata->description = $description;
  119. return $metadata;
  120. }
  122. /**
  123. * Is readable?
  124. */
  125. public function isReadable(): ?bool
  126. {
  127. return $this->readable;
  128. }
  130. /**
  131. * Returns a new instance of Metadata with the given readable flag.
  132. */
  133. public function withReadable(bool $readable): self
  134. {
  135. $metadata = clone $this;
  136. $metadata->readable = $readable;
  138. return $metadata;
  139. }
  141. /**
  142. * Is writable?
  143. */
  144. public function isWritable(): ?bool
  145. {
  146. return $this->writable;
  147. }
  149. /**
  150. * Returns a new instance with the given writable flag.
  151. */
  152. public function withWritable(bool $writable): self
  153. {
  154. $metadata = clone $this;
  155. $metadata->writable = $writable;
  157. return $metadata;
  158. }
  160. /**
  161. * Is required?
  162. */
  163. public function isRequired(): ?bool
  164. {
  165. if (true === $this->required && false === $this->writable) {
  166. return false;
  167. }
  169. return $this->required;
  170. }
  172. /**
  173. * Returns a new instance with the given required flag.
  174. */
  175. public function withRequired(bool $required): self
  176. {
  177. $metadata = clone $this;
  178. $metadata->required = $required;
  180. return $metadata;
  181. }
  183. /**
  184. * Should an IRI or an object be provided in write context?
  185. */
  186. public function isWritableLink(): ?bool
  187. {
  188. return $this->writableLink;
  189. }
  191. /**
  192. * Returns a new instance with the given writable link flag.
  193. */
  194. public function withWritableLink(bool $writableLink): self
  195. {
  196. $metadata = clone $this;
  197. $metadata->writableLink = $writableLink;
  199. return $metadata;
  200. }
  202. /**
  203. * Is an IRI or an object generated in read context?
  204. */
  205. public function isReadableLink(): ?bool
  206. {
  207. return $this->readableLink;
  208. }
  210. /**
  211. * Returns a new instance with the given readable link flag.
  212. */
  213. public function withReadableLink(bool $readableLink): self
  214. {
  215. $metadata = clone $this;
  216. $metadata->readableLink = $readableLink;
  218. return $metadata;
  219. }
  221. /**
  222. * Gets IRI of this property.
  223. */
  224. public function getIri(): ?string
  225. {
  226. return $this->iri;
  227. }
  229. /**
  230. * Returns a new instance with the given IRI.
  231. */
  232. public function withIri(string $iri = null): self
  233. {
  234. $metadata = clone $this;
  235. $metadata->iri = $iri;
  237. return $metadata;
  238. }
  240. /**
  241. * Is this attribute an identifier?
  242. */
  243. public function isIdentifier(): ?bool
  244. {
  245. return $this->identifier;
  246. }
  248. /**
  249. * Returns a new instance with the given identifier flag.
  250. */
  251. public function withIdentifier(bool $identifier): self
  252. {
  253. $metadata = clone $this;
  254. $metadata->identifier = $identifier;
  256. return $metadata;
  257. }
  259. /**
  260. * Gets attributes.
  261. */
  262. public function getAttributes(): ?array
  263. {
  264. return $this->attributes;
  265. }
  267. /**
  268. * Gets an attribute.
  269. *
  270. * @param mixed|null $defaultValue
  271. */
  272. public function getAttribute(string $key, $defaultValue = null)
  273. {
  274. return $this->attributes[$key] ?? $defaultValue;
  275. }
  277. /**
  278. * Returns a new instance with the given attribute.
  279. */
  280. public function withAttributes(array $attributes): self
  281. {
  282. $metadata = clone $this;
  283. $metadata->attributes = $attributes;
  285. return $metadata;
  286. }
  288. /**
  289. * @deprecated since 2.6, to be removed in 3.0
  290. */
  291. public function getChildInherited(): ?string
  292. {
  293. return $this->childInherited;
  294. }
  296. /**
  297. * @deprecated since 2.6, to be removed in 3.0
  298. */
  299. public function hasChildInherited(): bool
  300. {
  301. return null !== $this->childInherited;
  302. }
  304. /**
  305. * @deprecated since 2.4, to be removed in 3.0
  306. */
  307. public function isChildInherited(): ?string
  308. {
  309. @trigger_error(sprintf('"%s::%s" is deprecated since 2.4 and will be removed in 3.0.', __CLASS__, __METHOD__), \E_USER_DEPRECATED);
  311. return $this->getChildInherited();
  312. }
  314. /**
  315. * @deprecated since 2.6, to be removed in 3.0
  316. */
  317. public function withChildInherited(string $childInherited): self
  318. {
  319. @trigger_error(sprintf('"%s::%s" is deprecated since 2.6 and will be removed in 3.0.', __CLASS__, __METHOD__), \E_USER_DEPRECATED);
  321. $metadata = clone $this;
  322. $metadata->childInherited = $childInherited;
  324. return $metadata;
  325. }
  327. /**
  328. * Represents whether the property has a subresource.
  329. */
  330. public function hasSubresource(): bool
  331. {
  332. return null !== $this->subresource;
  333. }
  335. /**
  336. * Gets the subresource metadata.
  337. */
  338. public function getSubresource(): ?SubresourceMetadata
  339. {
  340. return $this->subresource;
  341. }
  343. /**
  344. * Returns a new instance with the given subresource.
  345. */
  346. public function withSubresource(SubresourceMetadata $subresource = null): self
  347. {
  348. $metadata = clone $this;
  349. $metadata->subresource = $subresource;
  351. return $metadata;
  352. }
  354. /**
  355. * Is initializable?
  356. */
  357. public function isInitializable(): ?bool
  358. {
  359. return $this->initializable;
  360. }
  362. /**
  363. * Returns a new instance with the given initializable flag.
  364. */
  365. public function withInitializable(bool $initializable): self
  366. {
  367. $metadata = clone $this;
  368. $metadata->initializable = $initializable;
  370. return $metadata;
  371. }
  373. /**
  374. * Returns the default value of the property or NULL if the property doesn't have a default value.
  375. */
  376. public function getDefault()
  377. {
  378. return $this->default;
  379. }
  381. /**
  382. * Returns a new instance with the given default value for the property.
  383. */
  384. public function withDefault($default): self
  385. {
  386. $metadata = clone $this;
  387. $metadata->default = $default;
  389. return $metadata;
  390. }
  392. /**
  393. * Returns an example of the value of the property.
  394. */
  395. public function getExample()
  396. {
  397. return $this->example;
  398. }
  400. /**
  401. * Returns a new instance with the given example.
  402. */
  403. public function withExample($example): self
  404. {
  405. $metadata = clone $this;
  406. $metadata->example = $example;
  408. return $metadata;
  409. }
  411. public function getSchema(): ?array
  412. {
  413. return $this->schema;
  414. }
  416. /**
  417. * Returns a new instance with the given schema.
  418. */
  419. public function withSchema(array $schema = null): self
  420. {
  421. $metadata = clone $this;
  422. $metadata->schema = $schema;
  424. return $metadata;
  425. }
  426. }