sunrise-php / http-router

src/OpenApi/OpenApiOperationEnricherManager.php

<?php

/**
 * It's free open-source software released under the MIT License.
 *
 * @author Anatoly Nekhay <afenric@gmail.com>
 * @copyright Copyright (c) 2018, Anatoly Nekhay
 * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE
 * @link https://github.com/sunrise-php/http-router
 */

declare(strict_types=1);

namespace Sunrise\Http\Router\OpenApi;

use ReflectionClass;
use ReflectionMethod;
use Sunrise\Http\Router\OpenApi\OperationEnricher\EmptyResponseOperationEnricher;
use Sunrise\Http\Router\OpenApi\OperationEnricher\EncodableResponseOperationEnricher;
use Sunrise\Http\Router\OpenApi\OperationEnricher\RequestBodyOperationEnricher;
use Sunrise\Http\Router\OpenApi\OperationEnricher\RequestCookiesOperationEnricher;
use Sunrise\Http\Router\OpenApi\OperationEnricher\RequestHeadersOperationEnricher;
use Sunrise\Http\Router\OpenApi\OperationEnricher\RequestQueryOperationEnricher;
use Sunrise\Http\Router\OpenApi\OperationEnricher\RequestVariablesOperationEnricher;
use Sunrise\Http\Router\RouteInterface;

use function usort;

/**
 * @since 3.0.0
 */
final class OpenApiOperationEnricherManager implements OpenApiOperationEnricherManagerInterface
{
    /**
     * @var array<array-key, OpenApiOperationEnricherInterface>

The doc comment array<array-key, OpenApiOperationEnricherInterface> at position 2 could not be parsed: Unknown type name 'array-key' at position 2 in array<array-key, OpenApiOperationEnricherInterface>.

     */
    private array $operationEnrichers = [];

    private bool $isOperationEnrichersSorted = false;

    /**
     * @param array<array-key, OpenApiOperationEnricherInterface> $operationEnrichers

The doc comment array<array-key, OpenApiOperationEnricherInterface> at position 2 could not be parsed: Unknown type name 'array-key' at position 2 in array<array-key, OpenApiOperationEnricherInterface>.

     */
    public function __construct(
        private readonly OpenApiConfiguration $openApiConfiguration,
        private readonly OpenApiPhpTypeSchemaResolverManagerInterface $openApiPhpTypeSchemaResolverManager,
        array $operationEnrichers = [],
    ) {
        $this->setOperationEnrichers(self::getDefaultOperationEnrichers());
        $this->setOperationEnrichers($operationEnrichers);
    }

    /**
     * @inheritDoc
     */
    public function enrichOperation(
        RouteInterface $route,
        ReflectionMethod|ReflectionClass $requestHandler,
        array &$operation,
    ): void {
        $this->isOperationEnrichersSorted or $this->sortOperationEnrichers();
        foreach ($this->operationEnrichers as $operationEnricher) {
            $operationEnricher->enrichOperation($route, $requestHandler, $operation);
        }
    }

    /**
     * @param array<array-key, OpenApiOperationEnricherInterface> $operationEnrichers

The doc comment array<array-key, OpenApiOperationEnricherInterface> at position 2 could not be parsed: Unknown type name 'array-key' at position 2 in array<array-key, OpenApiOperationEnricherInterface>.

     */
    private function setOperationEnrichers(array $operationEnrichers): void
    {
        foreach ($operationEnrichers as $operationEnricher) {
            $this->operationEnrichers[] = $operationEnricher;

            if ($operationEnricher instanceof OpenApiConfigurationAwareInterface) {
                $operationEnricher->setOpenApiConfiguration($this->openApiConfiguration);
            }
            if ($operationEnricher instanceof OpenApiPhpTypeSchemaResolverManagerAwareInterface) {
                $operationEnricher->setOpenApiPhpTypeSchemaResolverManager($this->openApiPhpTypeSchemaResolverManager);
            }
        }
    }

    private function sortOperationEnrichers(): void
    {
        $this->isOperationEnrichersSorted = usort($this->operationEnrichers, static fn(
            OpenApiOperationEnricherInterface $a,
            OpenApiOperationEnricherInterface $b,
        ): int => $b->getWeight() <=> $a->getWeight());
    }

    /**
     * @return array<array-key, OpenApiOperationEnricherInterface>

The doc comment array<array-key, OpenApiOperationEnricherInterface> at position 2 could not be parsed: Unknown type name 'array-key' at position 2 in array<array-key, OpenApiOperationEnricherInterface>.

     */
    private static function getDefaultOperationEnrichers(): array
    {
        return [
            new EmptyResponseOperationEnricher(),
            new EncodableResponseOperationEnricher(),
            new RequestBodyOperationEnricher(),
            new RequestCookiesOperationEnricher(),
            new RequestHeadersOperationEnricher(),
            new RequestQueryOperationEnricher(),
            new RequestVariablesOperationEnricher(),
        ];
    }
}