sunrise-php / http-router

src/OpenApi/OperationEnricher/RequestHeadersOperationEnricher.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\OperationEnricher;

use ReflectionAttribute;
use ReflectionClass;
use ReflectionMethod;
use Sunrise\Http\Router\Annotation\RequestHeader;
use Sunrise\Http\Router\OpenApi\OpenApiOperationEnricherInterface;
use Sunrise\Http\Router\OpenApi\OpenApiPhpTypeSchemaResolverManagerAwareInterface;
use Sunrise\Http\Router\OpenApi\OpenApiPhpTypeSchemaResolverManagerInterface;
use Sunrise\Http\Router\OpenApi\TypeFactory;
use Sunrise\Http\Router\RouteInterface;

/**
 * @since 3.0.0
 */
final class RequestHeadersOperationEnricher implements
    OpenApiOperationEnricherInterface,
    OpenApiPhpTypeSchemaResolverManagerAwareInterface
{
    private readonly OpenApiPhpTypeSchemaResolverManagerInterface $openApiPhpTypeSchemaResolverManager;

    public function setOpenApiPhpTypeSchemaResolverManager(
        OpenApiPhpTypeSchemaResolverManagerInterface $openApiPhpTypeSchemaResolverManager,
    ): void {
        $this->openApiPhpTypeSchemaResolverManager = $openApiPhpTypeSchemaResolverManager;

The property openApiPhpTypeSchemaResolverManager is declared read-only in Sunrise\Http\Router\OpenApi\OperationEnricher\RequestHeadersOperationEnricher.

    }

    /**
     * @inheritDoc
     */
    public function enrichOperation(
        RouteInterface $route,
        ReflectionClass|ReflectionMethod $requestHandler,
        array &$operation,
    ): void {
        if (! $requestHandler instanceof ReflectionMethod) {
            return;
        }

        foreach ($requestHandler->getParameters() as $requestHandlerParameter) {
            /** @var list<ReflectionAttribute<RequestHeader>> $annotations */
            $annotations = $requestHandlerParameter->getAttributes(RequestHeader::class);
            if (isset($annotations[0])) {
                $requestHeader = $annotations[0]->newInstance();
                $requestHeaderType = TypeFactory::fromPhpTypeReflection($requestHandlerParameter->getType());
                $requestHeaderSchema = $this->openApiPhpTypeSchemaResolverManager
                    ->resolvePhpTypeSchema($requestHeaderType, $requestHandlerParameter);

                $operation['parameters'][] = [
                    'in' => 'header',
                    'name' => $requestHeader->name,
                    'schema' => $requestHeaderSchema,
                    'required' => !$requestHandlerParameter->isDefaultValueAvailable(),
                ];
            }
        }
    }

    public function getWeight(): int
    {
        return 20;
    }
}