NelmioApiDocBundle/ModelDescriber/Annotations/OpenApiAnnotationsReader.php

<?php

/*
 * This file is part of the NelmioApiDocBundle package.
 *
 * (c) Nelmio
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Nelmio\ApiDocBundle\ModelDescriber\Annotations;

use Doctrine\Common\Annotations\Reader;
use Nelmio\ApiDocBundle\Model\ModelRegistry;
use Nelmio\ApiDocBundle\OpenApiPhp\ModelRegister;
use Nelmio\ApiDocBundle\OpenApiPhp\Util;
use Nelmio\ApiDocBundle\Util\SetsContextTrait;
use OpenApi\Analysis;
use OpenApi\Annotations as OA;
use OpenApi\Generator;

/**
 * @internal
 */
class OpenApiAnnotationsReader
{
    use SetsContextTrait;

    private $annotationsReader;
    private $modelRegister;

    public function __construct(Reader $annotationsReader, ModelRegistry $modelRegistry, array $mediaTypes)
    {
        $this->annotationsReader = $annotationsReader;
        $this->modelRegister = new ModelRegister($modelRegistry, $mediaTypes);
    }

    public function updateSchema(\ReflectionClass $reflectionClass, OA\Schema $schema): void
    {
        $this->setContext(Util::createContext([], $schema->_context));

        /** @var OA\Schema|null $oaSchema */
        if (!$oaSchema = $this->getAnnotation($reflectionClass, OA\Schema::class)) {
            return;
        }

        $this->setContext(null);

        // Read @Model annotations
        $this->modelRegister->__invoke(new Analysis([$oaSchema], Util::createContext()));

        if (!$oaSchema->validate()) {
            return;
        }

        $schema->mergeProperties($oaSchema);
    }

    public function getPropertyName($reflection, string $default): string
    {
        /** @var OA\Property|null $oaProperty */
        if (!$oaProperty = $this->getAnnotation($reflection, OA\Property::class)) {
            return $default;
        }

        return Generator::UNDEFINED !== $oaProperty->property ? $oaProperty->property : $default;
    }

    public function updateProperty($reflection, OA\Property $property, array $serializationGroups = null): void
    {
        // In order to have nicer errors
        $declaringClass = $reflection->getDeclaringClass();

        $this->setContext(Util::createContext([
            'namespace' => $declaringClass->getNamespaceName(),
            'class' => $declaringClass->getShortName(),
            'property' => $reflection->name,
            'filename' => $declaringClass->getFileName(),
        ], $property->_context));

        /** @var OA\Property|null $oaProperty */
        if (!$oaProperty = $this->getAnnotation($reflection, OA\Property::class)) {
            return;
        }
        $this->setContext(null);

        // Read @Model annotations
        $this->modelRegister->__invoke(new Analysis([$oaProperty], Util::createContext()), $serializationGroups);

        if (!$oaProperty->validate()) {
            return;
        }

        $property->mergeProperties($oaProperty);
    }

    /**
     * @param \ReflectionClass|\ReflectionProperty|\ReflectionMethod $reflection
     *
     * @return mixed
     */
    private function getAnnotation($reflection, string $className)
    {
        if (\PHP_VERSION_ID >= 80100) {
            if (null !== $attribute = $reflection->getAttributes($className, \ReflectionAttribute::IS_INSTANCEOF)[0] ?? null) {
                return $attribute->newInstance();
            }
        }

        if ($reflection instanceof \ReflectionClass) {
            return $this->annotationsReader->getClassAnnotation($reflection, $className);
        } elseif ($reflection instanceof \ReflectionProperty) {
            return $this->annotationsReader->getPropertyAnnotation($reflection, $className);
        } elseif ($reflection instanceof \ReflectionMethod) {
            return $this->annotationsReader->getMethodAnnotation($reflection, $className);
        }

        return null;
    }
}