Yiisoft\Swagger\Middleware\SwaggerJson

Complexity

Total Complexity

5

Size/Duplication

Total Lines	54
Duplicated Lines	0 %

Test Coverage

Coverage

84.21%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
A	withAnnotationPaths()	0	5	1
A	withCache()	0	6	1
A	process()	0	10	2

<?php

declare(strict_types=1);

namespace Yiisoft\Swagger\Middleware;

use DateInterval;
use OpenApi\Annotations\OpenApi;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\MiddlewareInterface;
use Psr\Http\Server\RequestHandlerInterface;
use Yiisoft\Cache\CacheInterface;
use Yiisoft\DataResponse\DataResponseFactoryInterface;
use Yiisoft\Swagger\Service\SwaggerService;

final class SwaggerJson implements MiddlewareInterface
{
    private array $annotationPaths = [];
    private bool $enableCache = false;
    private CacheInterface $cache;
    private DataResponseFactoryInterface $responseFactory;
    private SwaggerService $swaggerService;
    private DateInterval|int|null $cacheTTL = null;

    public function __construct(
        CacheInterface $cache,
        DataResponseFactoryInterface $responseFactory,
        SwaggerService $swaggerService
    ) {
        $this->cache = $cache;
        $this->responseFactory = $responseFactory;
        $this->swaggerService = $swaggerService;
    }

    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
    {
        /** @var OpenApi $openApi */
        $openApi = !$this->enableCache ? $this->swaggerService->fetch($this->annotationPaths) : $this->cache->getOrSet(
            [self::class, $this->annotationPaths],
            fn () => $this->swaggerService->fetch($this->annotationPaths),
            $this->cacheTTL,
        );

        return $this->responseFactory->createResponse($openApi);
    }

    /**
     * @param string ...$annotationPaths
     *
     * @return self
     */
    public function withAnnotationPaths(string ...$annotationPaths): self
    {
        $new = clone $this;
        $new->annotationPaths = $annotationPaths;
        return $new;
    }

    /**
     * @param DateInterval|int|null $cacheTTL
     *
     * @return self
     */
    public function withCache(DateInterval|int $cacheTTL = null): self
    {
        $new = clone $this;
        $new->enableCache = true;
        $new->cacheTTL = $cacheTTL;
        return $new;
    }
}