vendor/nelmio/api-doc-bundle/PropertyDescriber/ArrayPropertyDescriber.php line 33

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of the NelmioApiDocBundle package.
  5. *
  6. * (c) Nelmio
  7. *
  8. * For the full copyright and license information, please view the LICENSE
  9. * file that was distributed with this source code.
  10. */
  12. namespace Nelmio\ApiDocBundle\PropertyDescriber;
  14. use Nelmio\ApiDocBundle\Describer\ModelRegistryAwareInterface;
  15. use Nelmio\ApiDocBundle\Describer\ModelRegistryAwareTrait;
  16. use Nelmio\ApiDocBundle\Exception\UndocumentedArrayItemsException;
  17. use Nelmio\ApiDocBundle\OpenApiPhp\Util;
  18. use OpenApi\Annotations as OA;
  20. class ArrayPropertyDescriber implements PropertyDescriberInterface, ModelRegistryAwareInterface
  21. {
  22. use ModelRegistryAwareTrait;
  23. use NullablePropertyTrait;
  25. /** @var PropertyDescriberInterface[] */
  26. private $propertyDescribers;
  28. public function __construct(iterable $propertyDescribers = [])
  29. {
  30. $this->propertyDescribers = $propertyDescribers;
  31. }
  33. public function describe(array $types, OA\Schema $property, array $groups = null)
  34. {
  35. // BC layer for symfony < 5.3
  36. $type = method_exists($types[0], 'getCollectionValueTypes') ?
  37. ($types[0]->getCollectionValueTypes()[0] ?? null) :
  38. $types[0]->getCollectionValueType();
  39. if (null === $type) {
  40. throw new UndocumentedArrayItemsException();
  41. }
  43. $property->type = 'array';
  44. $this->setNullableProperty($types[0], $property);
  45. $property = Util::getChild($property, OA\Items::class);
  47. foreach ($this->propertyDescribers as $propertyDescriber) {
  48. if ($propertyDescriber instanceof ModelRegistryAwareInterface) {
  49. $propertyDescriber->setModelRegistry($this->modelRegistry);
  50. }
  51. if ($propertyDescriber->supports([$type])) {
  52. try {
  53. $propertyDescriber->describe([$type], $property, $groups);
  54. } catch (UndocumentedArrayItemsException $e) {
  55. if (null !== $e->getClass()) {
  56. throw $e; // This exception is already complete
  57. }
  59. throw new UndocumentedArrayItemsException(null, sprintf('%s[]', $e->getPath()));
  60. }
  62. break;
  63. }
  64. }
  65. }
  67. public function supports(array $types): bool
  68. {
  69. return 1 === count($types) && $types[0]->isCollection();
  70. }
  71. }