vendor/nelmio/api-doc-bundle/SwaggerPhp/ModelRegister.php line 89

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\SwaggerPhp;
  14. use Nelmio\ApiDocBundle\Annotation\Model as ModelAnnotation;
  15. use Nelmio\ApiDocBundle\Model\Model;
  16. use Nelmio\ApiDocBundle\Model\ModelRegistry;
  17. use Swagger\Analysis;
  18. use Swagger\Annotations\AbstractAnnotation;
  19. use Swagger\Annotations\Items;
  20. use Swagger\Annotations\Parameter;
  21. use Swagger\Annotations\Response;
  22. use Swagger\Annotations\Schema;
  23. use Symfony\Component\PropertyInfo\Type;
  25. /**
  26.  * Resolves the path in SwaggerPhp annotation when needed.
  27.  *
  28.  * @internal
  29.  */
  30. final class ModelRegister
  31. {
  32.     private $modelRegistry;
  34.     public function __construct(ModelRegistry $modelRegistry)
  35.     {
  36.         $this->modelRegistry = $modelRegistry;
  37.     }
  39.     public function __invoke(Analysis $analysis, array $parentGroups = null)
  40.     {
  41.         $modelsRegistered = [];
  42.         foreach ($analysis->annotations as $annotation) {
  43.             // @Model using the ref field
  44.             if ($annotation instanceof Schema && $annotation->ref instanceof ModelAnnotation) {
  45.                 $model = $annotation->ref;
  47.                 $annotation->ref = $this->modelRegistry->register(new Model($this->createType($model->type), $this->getGroups($model, $parentGroups), $model->options));
  49.                 // It is no longer an unmerged annotation
  50.                 $this->detach($model, $annotation, $analysis);
  52.                 continue;
  53.             }
  55.             // Implicit usages
  56.             if ($annotation instanceof Response) {
  57.                 $annotationClass = Schema::class;
  58.             } elseif ($annotation instanceof Parameter) {
  59.                 if ('array' === $annotation->type) {
  60.                     $annotationClass = Items::class;
  61.                 } else {
  62.                     $annotationClass = Schema::class;
  63.                 }
  64.             } elseif ($annotation instanceof Schema) {
  65.                 $annotationClass = Items::class;
  66.             } else {
  67.                 continue;
  68.             }
  70.             $model = null;
  71.             foreach ($annotation->_unmerged as $unmerged) {
  72.                 if ($unmerged instanceof ModelAnnotation) {
  73.                     $model = $unmerged;
  75.                     break;
  76.                 }
  77.             }
  79.             if (null === $model || !$model instanceof ModelAnnotation) {
  80.                 continue;
  81.             }
  83.             if (!is_string($model->type)) {
  84.                 // Ignore invalid annotations, they are validated later
  85.                 continue;
  86.             }
  88.             if ($annotation instanceof Schema) {
  89.                 @trigger_error(sprintf('Using `@Model` implicitly in a `@SWG\Schema`, `@SWG\Items` or `@SWG\Property` annotation in %s is deprecated since version 3.2 and won\'t be supported in 4.0. Use `ref=@Model()` instead.', $annotation->_context->getDebugLocation()), E_USER_DEPRECATED);
  90.             }
  92.             $annotation->merge([new $annotationClass([
  93.                 'ref' => $this->modelRegistry->register(new Model($this->createType($model->type), $this->getGroups($model, $parentGroups), $model->options)),
  94.             ])]);
  96.             // It is no longer an unmerged annotation
  97.             $this->detach($model, $annotation, $analysis);
  98.         }
  99.     }
  101.     private function getGroups(ModelAnnotation $model, array $parentGroups = null)
  102.     {
  103.         if (null === $model->groups) {
  104.             return $parentGroups;
  105.         }
  107.         return array_merge($parentGroups ?? [], $model->groups);
  108.     }
  110.     private function detach(ModelAnnotation $model, AbstractAnnotation $annotation, Analysis $analysis)
  111.     {
  112.         foreach ($annotation->_unmerged as $key => $unmerged) {
  113.             if ($unmerged === $model) {
  114.                 unset($annotation->_unmerged[$key]);
  116.                 break;
  117.             }
  118.         }
  119.         $analysis->annotations->detach($model);
  120.     }
  122.     private function createType(string $type): Type
  123.     {
  124.         if ('[]' === substr($type, -2)) {
  125.             return new Type(Type::BUILTIN_TYPE_ARRAY, false, null, true, null, $this->createType(substr($type, 0, -2)));
  126.         }
  128.         return new Type(Type::BUILTIN_TYPE_OBJECT, false, $type);
  129.     }
  130. }