thecodingmachine / graphql-controllers

src/Reflection/CachedDocBlockFactory.php

<?php


namespace TheCodingMachine\GraphQL\Controllers\Reflection;

use function filemtime;
use phpDocumentor\Reflection\DocBlock;
use phpDocumentor\Reflection\DocBlockFactory;
use phpDocumentor\Reflection\Types\Context;
use phpDocumentor\Reflection\Types\ContextFactory;
use Psr\SimpleCache\CacheInterface;
use ReflectionMethod;

/**
 * Creates DocBlocks and puts these in cache.
 */
class CachedDocBlockFactory
{
    /**
     * @var CacheInterface
     */
    private $cache;
    /**
     * @var DocBlockFactory|null
     */
    private $docBlockFactory;
    /**
     * @var array<string, DocBlock>
     */
    private $docBlockArrayCache = [];
    /**
     * @var array<string, Context>
     */
    private $contextArrayCache = [];
    /**
     * @var ContextFactory
     */
    private $contextFactory;

    /**
     * @param CacheInterface $cache The cache we fetch data from. Note this is a SAFE cache. It does not need to be purged.
     * @param DocBlockFactory|null $docBlockFactory
     */
    public function __construct(CacheInterface $cache, ?DocBlockFactory $docBlockFactory = null)
    {
        $this->cache = $cache;
        $this->docBlockFactory = $docBlockFactory ?: DocBlockFactory::createInstance();
        $this->contextFactory = new ContextFactory();
    }

    /**
     * Fetches a DocBlock object from a ReflectionMethod
     *
     * @param ReflectionMethod $refMethod
     * @return DocBlock
     */
    public function getDocBlock(ReflectionMethod $refMethod): DocBlock
    {
        $key = 'docblock_'.md5($refMethod->getDeclaringClass()->getName().'::'.$refMethod->getName());
        if (isset($this->docBlockArrayCache[$key])) {
            return $this->docBlockArrayCache[$key];
        }

        if ($cacheItem = $this->cache->get($key)) {
            [
                'time' => $time,
                'docblock' => $docBlock
            ] = $cacheItem;

            if (filemtime($refMethod->getFileName()) === $time) {
                $this->docBlockArrayCache[$key] = $docBlock;
                return $docBlock;
            }
        }

        $docBlock = $this->doGetDocBlock($refMethod);

        $this->cache->set($key, [
            'time' => filemtime($refMethod->getFileName()),
            'docblock' => $docBlock
        ]);
        $this->docBlockArrayCache[$key] = $docBlock;

        return $docBlock;
    }

    private function doGetDocBlock(ReflectionMethod $refMethod): DocBlock
    {
        $docComment = $refMethod->getDocComment() ?: '/** */';

        $refClass = $refMethod->getDeclaringClass();
        $refClassName = $refClass->getName();

        if (!isset($this->contextArrayCache[$refClassName])) {
            $this->contextArrayCache[$refClassName] = $this->contextFactory->createFromReflector($refMethod);
        }

        return $this->docBlockFactory->create($docComment, $this->contextArrayCache[$refClassName]);

It seems like $docComment can also be of type true; however, parameter $docblock of phpDocumentor\Reflection\DocBlockFactory::create() does only seem to accept object|string, maybe add an additional type check?

The method create() does not exist on null.

    }
}