yoanm / symfony-jsonrpc-http-server-openapi-doc

src/Provider/DocProvider.php

<?php
namespace Yoanm\SymfonyJsonRpcHttpServerOpenAPIDoc\Provider;

use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Yoanm\JsonRpcHttpServerOpenAPIDoc\Infra\Normalizer\DocNormalizer;
use Yoanm\SymfonyJsonRpcHttpServerDoc\Creator\HttpServerDocCreator;
use Yoanm\SymfonyJsonRpcHttpServerDoc\Provider\DocProviderInterface;
use Yoanm\SymfonyJsonRpcHttpServerOpenAPIDoc\Event\OpenAPIDocCreatedEvent;

/**
 * Class DocProvider
 */
class DocProvider implements DocProviderInterface
{
    /** @var EventDispatcherInterface */
    private $dispatcher;
    /** @var HttpServerDocCreator */
    private $httpServerDocCreator;
    /** @var DocNormalizer */
    private $docNormalizer;

    /**
     * @param EventDispatcherInterface $dispatcher
     * @param HttpServerDocCreator         $HttpServerDocCreator
     * @param DocNormalizer     $docNormalizer
     */
    public function __construct(
        EventDispatcherInterface $dispatcher,
        HttpServerDocCreator $HttpServerDocCreator,
        DocNormalizer $docNormalizer
    ) {
        $this->dispatcher = $dispatcher;
        $this->httpServerDocCreator = $HttpServerDocCreator;
        $this->docNormalizer = $docNormalizer;
    }

    /**
     * @param string|null $host
     *
     * @return array
     */
    public function getDoc($host = null) : array
    {
        $rawDoc = $this->httpServerDocCreator->create($host);

        $openApiDoc = $this->docNormalizer->normalize($rawDoc);

        $event = new OpenAPIDocCreatedEvent($openApiDoc, $rawDoc);
        $this->dispatcher->dispatch($event::EVENT_NAME, $event);

        return $event->getOpenAPIDoc();

The expression return $event->getOpenAPIDoc() returns the type Yoanm\JsonRpcServerDoc\Domain\Model\HttpServerDoc which is incompatible with the type-hinted return array.

    }

    /**
     * {@inheritdoc}
     */
    public function supports($filename, $host = null) : bool
    {
        return 'openapi.json' === $filename;
    }
}