mirror of
https://github.com/retailcrm/NelmioApiDocBundle.git
synced 2025-02-03 08:09:25 +03:00
78664ef9ec
* Initial pass for OA3 upgrade * Fix Util Tests * Fix first batch of Unit Tests. Up to Model * Another batch of fixed tests * Update annotations * Convert Model & Property Describers * Update tests, Fix RouteDescribers, FIx additional bugs * Another batch of updates * Another batch of fixed Functional Tests * Fix FunctionalTest tests * Fix Bazinga Tests * FIx FOS Rest * Fix JMS TEsts & describers * Fix all Tests * Fix few stuff from own CR * CS Fixes * CS Fixes 2 * CS Fixes 3 * CS Fixes 4 * Remove collection bug * Updates after first CRs * CS * Drop support for SF3 * Update the docs * Add an upgrade guide * misc doc fixes * Configurable media types * Code Style Fixes * Don't use ::$ref for @Response and @RequestBody * Fix upgrading guide * Fix OA case Co-authored-by: Filip Benčo <filip.benco@websupport.sk> Co-authored-by: Guilhem Niot <guilhem.niot@gmail.com> Co-authored-by: Mantis Development <mantis@users.noreply.github.com>
88 lines
2.7 KiB
PHP
88 lines
2.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 OpenApi\Analysis;
|
|
use OpenApi\Annotations as OA;
|
|
use OpenApi\Context;
|
|
|
|
/**
|
|
* @internal
|
|
*/
|
|
class OpenApiAnnotationsReader
|
|
{
|
|
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 $oaSchema */
|
|
if (!$oaSchema = $this->annotationsReader->getClassAnnotation($reflectionClass, OA\Schema::class)) {
|
|
return;
|
|
}
|
|
|
|
// Read @Model annotations
|
|
$this->modelRegister->__invoke(new Analysis([$oaSchema]));
|
|
|
|
if (!$oaSchema->validate()) {
|
|
return;
|
|
}
|
|
|
|
$schema->mergeProperties($oaSchema);
|
|
}
|
|
|
|
public function getPropertyName(\ReflectionProperty $reflectionProperty, string $default): string
|
|
{
|
|
/** @var OA\Property $oaProperty */
|
|
if (!$oaProperty = $this->annotationsReader->getPropertyAnnotation($reflectionProperty, OA\Property::class)) {
|
|
return $default;
|
|
}
|
|
|
|
return OA\UNDEFINED !== $oaProperty->property ? $oaProperty->property : $default;
|
|
}
|
|
|
|
public function updateProperty(\ReflectionProperty $reflectionProperty, OA\Property $property, array $serializationGroups = null): void
|
|
{
|
|
/** @var OA\Property $oaProperty */
|
|
if (!$oaProperty = $this->annotationsReader->getPropertyAnnotation($reflectionProperty, OA\Property::class)) {
|
|
return;
|
|
}
|
|
|
|
$declaringClass = $reflectionProperty->getDeclaringClass();
|
|
$context = new Context([
|
|
'namespace' => $declaringClass->getNamespaceName(),
|
|
'class' => $declaringClass->getShortName(),
|
|
'property' => $reflectionProperty->name,
|
|
'filename' => $declaringClass->getFileName(),
|
|
]);
|
|
$oaProperty->_context = $context;
|
|
|
|
// Read @Model annotations
|
|
$this->modelRegister->__invoke(new Analysis([$oaProperty]), $serializationGroups);
|
|
|
|
if (!$oaProperty->validate()) {
|
|
return;
|
|
}
|
|
|
|
$property->mergeProperties($oaProperty);
|
|
}
|
|
}
|