119 lines
3.7 KiB
PHP
119 lines
3.7 KiB
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\Context;
|
|
use OpenApi\Generator;
|
|
|
|
/**
|
|
* @internal
|
|
*/
|
|
class OpenApiAnnotationsReader
|
|
{
|
|
use SetsContextTrait;
|
|
|
|
/**
|
|
* @var Reader|null
|
|
*/
|
|
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
|
|
{
|
|
/** @var OA\Schema|null $oaSchema */
|
|
if (!$oaSchema = $this->getAnnotation($schema->_context, $reflectionClass, OA\Schema::class)) {
|
|
return;
|
|
}
|
|
|
|
// 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(new Context(), $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
|
|
{
|
|
/** @var OA\Property|null $oaProperty */
|
|
if (!$oaProperty = $this->getAnnotation($property->_context, $reflection, OA\Property::class)) {
|
|
return;
|
|
}
|
|
|
|
// 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(Context $parentContext, $reflection, string $className)
|
|
{
|
|
$this->setContextFromReflection($parentContext, $reflection);
|
|
|
|
try {
|
|
if (\PHP_VERSION_ID >= 80100) {
|
|
if (null !== $attribute = $reflection->getAttributes($className, \ReflectionAttribute::IS_INSTANCEOF)[0] ?? null) {
|
|
return $attribute->newInstance();
|
|
}
|
|
}
|
|
|
|
if (null !== $this->annotationsReader) {
|
|
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);
|
|
}
|
|
}
|
|
} finally {
|
|
$this->setContext(null);
|
|
}
|
|
|
|
return null;
|
|
}
|
|
}
|