welcome back to dyb-tech

2024-05-18 02:28:01 +02:00
parent 9513cdba09
commit 9f30bc98c7
6149 changed files with 668407 additions and 0 deletions
@@ -0,0 +1,164 @@
+<?php
+
+/*
+ * This file is part of the NelmioApiDocBundle package.
+ *
+ * (c) Nelmio
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Nelmio\ApiDocBundle;
+
+use Nelmio\ApiDocBundle\Describer\DescriberInterface;
+use Nelmio\ApiDocBundle\Describer\ModelRegistryAwareInterface;
+use Nelmio\ApiDocBundle\Model\ModelRegistry;
+use Nelmio\ApiDocBundle\ModelDescriber\ModelDescriberInterface;
+use Nelmio\ApiDocBundle\OpenApiPhp\ModelRegister;
+use Nelmio\ApiDocBundle\OpenApiPhp\Util;
+use OpenApi\Analysis;
+use OpenApi\Annotations\OpenApi;
+use OpenApi\Generator;
+use OpenApi\Processors\ProcessorInterface;
+use Psr\Cache\CacheItemPoolInterface;
+use Psr\Log\LoggerAwareTrait;
+
+final class ApiDocGenerator
+{
+    use LoggerAwareTrait;
+
+    /** @var OpenApi */
+    private $openApi;
+
+    /** @var iterable|DescriberInterface[] */
+    private $describers;
+
+    /** @var iterable|ModelDescriberInterface[] */
+    private $modelDescribers;
+
+    /** @var CacheItemPoolInterface|null */
+    private $cacheItemPool;
+
+    /** @var string|null */
+    private $cacheItemId;
+
+    /** @var string[] */
+    private $alternativeNames = [];
+
+    /** @var string[] */
+    private $mediaTypes = ['json'];
+    /**
+     * @var ?string
+     */
+    private $openApiVersion = null;
+
+    /** @var Generator */
+    private $generator;
+
+    /**
+     * @param DescriberInterface[]|iterable      $describers
+     * @param ModelDescriberInterface[]|iterable $modelDescribers
+     */
+    public function __construct($describers, $modelDescribers, CacheItemPoolInterface $cacheItemPool = null, string $cacheItemId = null, Generator $generator = null)
+    {
+        $this->describers = $describers;
+        $this->modelDescribers = $modelDescribers;
+        $this->cacheItemPool = $cacheItemPool;
+        $this->cacheItemId = $cacheItemId;
+        $this->generator = $generator ?? new Generator($this->logger);
+    }
+
+    public function setAlternativeNames(array $alternativeNames)
+    {
+        $this->alternativeNames = $alternativeNames;
+    }
+
+    public function setMediaTypes(array $mediaTypes)
+    {
+        $this->mediaTypes = $mediaTypes;
+    }
+
+    public function setOpenApiVersion(?string $openApiVersion)
+    {
+        $this->openApiVersion = $openApiVersion;
+    }
+
+    public function generate(): OpenApi
+    {
+        if (null !== $this->openApi) {
+            return $this->openApi;
+        }
+
+        if ($this->cacheItemPool) {
+            $item = $this->cacheItemPool->getItem($this->cacheItemId ?? 'openapi_doc');
+            if ($item->isHit()) {
+                return $this->openApi = $item->get();
+            }
+        }
+
+        if ($this->openApiVersion) {
+            $this->generator->setVersion($this->openApiVersion);
+        }
+
+        $this->generator->setProcessors($this->getProcessors($this->generator));
+
+        $context = Util::createContext(['version' => $this->generator->getVersion()]);
+
+        $this->openApi = new OpenApi(['_context' => $context]);
+        $modelRegistry = new ModelRegistry($this->modelDescribers, $this->openApi, $this->alternativeNames);
+        if (null !== $this->logger) {
+            $modelRegistry->setLogger($this->logger);
+        }
+        foreach ($this->describers as $describer) {
+            if ($describer instanceof ModelRegistryAwareInterface) {
+                $describer->setModelRegistry($modelRegistry);
+            }
+
+            $describer->describe($this->openApi);
+        }
+
+        $analysis = new Analysis([], $context);
+        $analysis->addAnnotation($this->openApi, $context);
+
+        // Register model annotations
+        $modelRegister = new ModelRegister($modelRegistry, $this->mediaTypes);
+        $modelRegister($analysis);
+
+        // Calculate the associated schemas
+        $modelRegistry->registerSchemas();
+
+        $analysis->process($this->generator->getProcessors());
+        $analysis->validate();
+
+        if (isset($item)) {
+            $this->cacheItemPool->save($item->set($this->openApi));
+        }
+
+        return $this->openApi;
+    }
+
+    /**
+     * Get an array of processors that will be used to process the OpenApi object.
+     *
+     * @param Generator $generator The generator instance to get the standard processors from
+     *
+     * @return array<ProcessorInterface|callable> The array of processors
+     */
+    private function getProcessors(Generator $generator): array
+    {
+        // Get the standard processors from the generator.
+        $processors = $generator->getProcessors();
+
+        // Remove OperationId processor as we use a lot of generated annotations which do not have enough information in their context
+        // to generate these ids properly.
+        // @see \Nelmio\ApiDocBundle\OpenApiPhp\Util::createContext
+        foreach ($processors as $key => $processor) {
+            if ($processor instanceof \OpenApi\Processors\OperationId) {
+                unset($processors[$key]);
+            }
+        }
+
+        return $processors;
+    }
+}