vendor/nelmio/api-doc-bundle/ApiDocGenerator.php line 50

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;
  14. use EXSyst\Component\Swagger\Swagger;
  15. use Nelmio\ApiDocBundle\Describer\DescriberInterface;
  16. use Nelmio\ApiDocBundle\Describer\ModelRegistryAwareInterface;
  17. use Nelmio\ApiDocBundle\Model\ModelRegistry;
  18. use Nelmio\ApiDocBundle\ModelDescriber\ModelDescriberInterface;
  19. use Psr\Cache\CacheItemPoolInterface;
  21. final class ApiDocGenerator
  22. {
  23.     private $swagger;
  25.     private $describers;
  27.     private $modelDescribers;
  29.     private $cacheItemPool;
  31.     private $alternativeNames = [];
  33.     /**
  34.      * @param DescriberInterface[]|iterable      $describers
  35.      * @param ModelDescriberInterface[]|iterable $modelDescribers
  36.      */
  37.     public function __construct($describers, $modelDescribers, CacheItemPoolInterface $cacheItemPool = null, string $cacheItemId = null)
  38.     {
  39.         $this->describers = $describers;
  40.         $this->modelDescribers = $modelDescribers;
  41.         $this->cacheItemPool = $cacheItemPool;
  42.         $this->cacheItemId = $cacheItemId;
  43.     }
  45.     public function setAlternativeNames(array $alternativeNames)
  46.     {
  47.         $this->alternativeNames = $alternativeNames;
  48.     }
  50.     public function generate(): Swagger
  51.     {
  52.         if (null !== $this->swagger) {
  53.             return $this->swagger;
  54.         }
  56.         if ($this->cacheItemPool) {
  57.             $item = $this->cacheItemPool->getItem($this->cacheItemId ?? 'swagger_doc');
  58.             if ($item->isHit()) {
  59.                 return $this->swagger = $item->get();
  60.             }
  61.         }
  63.         $this->swagger = new Swagger();
  64.         $modelRegistry = new ModelRegistry($this->modelDescribers, $this->swagger, $this->alternativeNames);
  65.         foreach ($this->describers as $describer) {
  66.             if ($describer instanceof ModelRegistryAwareInterface) {
  67.                 $describer->setModelRegistry($modelRegistry);
  68.             }
  70.             $describer->describe($this->swagger);
  71.         }
  72.         $modelRegistry->registerDefinitions();
  74.         if (isset($item)) {
  75.             $this->cacheItemPool->save($item->set($this->swagger));
  76.         }
  78.         return $this->swagger;
  79.     }
  80. }