vendor/nelmio/api-doc-bundle/src/PropertyDescriber/RequiredPropertyDescriber.php line 24

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 OpenApi\Annotations as OA;
  15. use OpenApi\Generator;
  17. /**
  18. * Mark a property as required if it is not nullable.
  19. */
  20. final class RequiredPropertyDescriber implements PropertyDescriberInterface, PropertyDescriberAwareInterface
  21. {
  22. use PropertyDescriberAwareTrait;
  24. public function describe(array $types, OA\Schema $property, array $groups = null, ?OA\Schema $schema = null, array $context = [])
  25. {
  26. $this->propertyDescriber->describe($types, $property, $groups, $schema, $context);
  28. if (!$property instanceof OA\Property) {
  29. return;
  30. }
  32. if (null === $schema) {
  33. return;
  34. }
  36. if (true === $property->nullable || !Generator::isDefault($property->default)) {
  37. return;
  38. }
  40. $existingRequiredFields = Generator::UNDEFINED !== $schema->required ? $schema->required : [];
  41. $existingRequiredFields[] = $property->property;
  43. $schema->required = array_values(array_unique($existingRequiredFields));
  44. }
  46. public function supports(array $types): bool
  47. {
  48. return true;
  49. }
  50. }