RetailCRM-Mirror/NelmioApiDocBundle
1
0
Fork 0
mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-02-02 15:51:48 +03:00
Code Issues Projects Releases Wiki Activity

Add methods metadata support for models (#1678)

Browse Source 
* Add methods metadata support for models

* fix cs
This commit is contained in:
Guilhem Niot 2020-07-12 14:54:39 +02:00 committed by GitHub
parent f998c1632f
commit 8948d5418b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 80 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
ModelDescriber/Annotations/AnnotationsReader.php
View File

@ -43,15 +43,15 @@ class AnnotationsReader
$this->symfonyConstraintAnnotationReader->setSchema($schema);
}
public function getPropertyName(\ReflectionProperty $reflectionProperty, string $default): string
public function getPropertyName($reflection, string $default): string
{
return $this->swgAnnotationsReader->getPropertyName($reflectionProperty, $default);
return $this->swgAnnotationsReader->getPropertyName($reflection, $default);
}
public function updateProperty(\ReflectionProperty $reflectionProperty, Schema $property, array $serializationGroups = null)
public function updateProperty($reflection, Schema $property, array $serializationGroups = null)
{
$this->phpDocReader->updateProperty($reflectionProperty, $property);
$this->swgAnnotationsReader->updateProperty($reflectionProperty, $property, $serializationGroups);
$this->symfonyConstraintAnnotationReader->updateProperty($reflectionProperty, $property);
$this->phpDocReader->updateProperty($reflection, $property);
$this->swgAnnotationsReader->updateProperty($reflection, $property, $serializationGroups);
$this->symfonyConstraintAnnotationReader->updateProperty($reflection, $property);
}
}

4
ModelDescriber/Annotations/PropertyPhpDocReader.php
View File

@ -33,10 +33,10 @@ class PropertyPhpDocReader
/**
* Update the Swagger information with information from the DocBlock comment.
*/
public function updateProperty(\ReflectionProperty $reflectionProperty, Schema $property)
public function updateProperty($reflection, Schema $property)
{
try {
$docBlock = $this->docBlockFactory->create($reflectionProperty);
$docBlock = $this->docBlockFactory->create($reflection);
} catch (\Exception $e) {
// ignore
return;

20
ModelDescriber/Annotations/SwgAnnotationsReader.php
View File

@ -52,27 +52,35 @@ class SwgAnnotationsReader
$schema->merge(json_decode(json_encode($swgDefinition)));
}
public function getPropertyName(\ReflectionProperty $reflectionProperty, string $default): string
public function getPropertyName($reflection, string $default): string
{
/** @var SwgProperty $swgProperty */
if (!$swgProperty = $this->annotationsReader->getPropertyAnnotation($reflectionProperty, SwgProperty::class)) {
if ($reflection instanceof \ReflectionProperty && !$swgProperty = $this->annotationsReader->getPropertyAnnotation($reflection, SwgProperty::class)) {
return $default;
} elseif ($reflection instanceof \ReflectionMethod && !$swgProperty = $this->annotationsReader->getMethodAnnotation($reflection, SwgProperty::class)) {
return $default;
}
return $swgProperty->property ?? $default;
}
public function updateProperty(\ReflectionProperty $reflectionProperty, Schema $property, array $serializationGroups = null)
public function updateProperty($reflection, Schema $property, array $serializationGroups = null)
{
if (!$swgProperty = $this->annotationsReader->getPropertyAnnotation($reflectionProperty, SwgProperty::class)) {
if ($reflection instanceof \ReflectionProperty) {
$swgProperty = $this->annotationsReader->getPropertyAnnotation($reflection, SwgProperty::class);
} else {
$swgProperty = $this->annotationsReader->getMethodAnnotation($reflection, SwgProperty::class);
}
if (!$swgProperty) {
return;
}
$declaringClass = $reflectionProperty->getDeclaringClass();
$declaringClass = $reflection->getDeclaringClass();
$context = new Context([
'namespace' => $declaringClass->getNamespaceName(),
'class' => $declaringClass->getShortName(),
'property' => $reflectionProperty->name,
'property' => $reflection->name,
'filename' => $declaringClass->getFileName(),
]);
$swgProperty->_context = $context;

10
ModelDescriber/Annotations/SymfonyConstraintAnnotationReader.php
View File

@ -38,9 +38,13 @@ class SymfonyConstraintAnnotationReader
/**
* Update the given property and schema with defined Symfony constraints.
*/
public function updateProperty(\ReflectionProperty $reflectionProperty, Schema $property)
public function updateProperty($reflection, Schema $property)
{
$annotations = $this->annotationsReader->getPropertyAnnotations($reflectionProperty);
if ($reflection instanceof \ReflectionProperty) {
$annotations = $this->annotationsReader->getPropertyAnnotations($reflection);
} else {
$annotations = $this->annotationsReader->getMethodAnnotations($reflection);
}
foreach ($annotations as $annotation) {
if ($annotation instanceof Assert\NotBlank || $annotation instanceof Assert\NotNull) {
@ -67,7 +71,7 @@ class SymfonyConstraintAnnotationReader
$property->setMinItems($annotation->min);
$property->setMaxItems($annotation->max);
} elseif ($annotation instanceof Assert\Choice) {
$values = $annotation->callback ? call_user_func(is_array($annotation->callback) ? $annotation->callback : [$reflectionProperty->class, $annotation->callback]) : $annotation->choices;
$values = $annotation->callback ? call_user_func(is_array($annotation->callback) ? $annotation->callback : [$reflection->class, $annotation->callback]) : $annotation->choices;
$property->setEnum(array_values($values));
} elseif ($annotation instanceof Assert\Range) {
$property->setMinimum($annotation->min);

57
ModelDescriber/ObjectModelDescriber.php
View File

@ -60,8 +60,10 @@ class ObjectModelDescriber implements ModelDescriberInterface, ModelRegistryAwar
$context['serializer_groups'] = array_filter($model->getGroups(), 'is_string');
}
$reflClass = new \ReflectionClass($class);
$annotationsReader = new AnnotationsReader($this->doctrineReader, $this->modelRegistry);
$annotationsReader->updateDefinition(new \ReflectionClass($class), $schema);
$annotationsReader->updateDefinition($reflClass, $schema);
$propertyInfoProperties = $this->propertyInfo->getProperties($class, $context);
if (null === $propertyInfoProperties) {
@ -71,19 +73,22 @@ class ObjectModelDescriber implements ModelDescriberInterface, ModelRegistryAwar
foreach ($propertyInfoProperties as $propertyName) {
$serializedName = null !== $this->nameConverter ? $this->nameConverter->normalize($propertyName, $class, null, null !== $model->getGroups() ? ['groups' => $model->getGroups()] : []) : $propertyName;
// read property options from Swagger Property annotation if it exists
if (property_exists($class, $propertyName)) {
$reflectionProperty = new \ReflectionProperty($class, $propertyName);
$property = $properties->get($annotationsReader->getPropertyName($reflectionProperty, $serializedName));
$reflections = $this->getReflections($reflClass, $propertyName);
$groups = $model->getGroups();
if (isset($groups[$propertyName]) && is_array($groups[$propertyName])) {
$groups = $model->getGroups()[$propertyName];
}
// Check if a custom name is set
foreach ($reflections as $reflection) {
$serializedName = $annotationsReader->getPropertyName($reflection, $serializedName);
}
$annotationsReader->updateProperty($reflectionProperty, $property, $groups);
} else {
$property = $properties->get($serializedName);
$property = $properties->get($serializedName);
// Interpret additional options
$groups = $model->getGroups();
if (isset($groups[$propertyName]) && is_array($groups[$propertyName])) {
$groups = $model->getGroups()[$propertyName];
}
foreach ($reflections as $reflection) {
$annotationsReader->updateProperty($reflection, $property, $groups);
}
// If type manually defined
@ -104,6 +109,34 @@ class ObjectModelDescriber implements ModelDescriberInterface, ModelRegistryAwar
}
}
/**
* @return \ReflectionProperty[]|\ReflectionMethod[]
*/
private function getReflections(\ReflectionClass $reflClass, string $propertyName): array
{
$reflections = [];
if ($reflClass->hasProperty($propertyName)) {
$reflections[] = $reflClass->getProperty($propertyName);
}
$camelProp = $this->camelize($propertyName);
foreach (['', 'get', 'is', 'has', 'can', 'add', 'remove', 'set'] as $prefix) {
if ($reflClass->hasMethod($prefix.$camelProp)) {
$reflections[] = $reflClass->getMethod($prefix.$camelProp);
}
}
return $reflections;
}
/**
* Camelizes a given string.
*/
private function camelize(string $string): string
{
return str_replace(' ', '', ucwords(str_replace('_', ' ', $string)));
}
private function describeProperty(Type $type, Model $model, Schema $property, string $propertyName)
{
foreach ($this->propertyDescribers as $propertyDescriber) {

2
Tests/Functional/Entity/SymfonyConstraints.php
View File

@ -103,6 +103,8 @@ class SymfonyConstraints
private $propertyLessThanOrEqual;
/**
* @Assert\Count(min="0", max="10")
*
* @param int $propertyNotBlank
*/
public function setPropertyNotBlank(int $propertyNotBlank): void

3
Tests/Functional/Entity/User.php
View File

@ -21,7 +21,7 @@ class User
/**
* @var int
*
* @SWG\Property(description = "User id", readOnly = true, title = "userid", example=1, default = null)
* @SWG\Property(description = "User id", readOnly = true, title = "userid", default = null)
*/
private $id;
@ -93,6 +93,7 @@ class User
/**
* @param int $id
* @SWG\Property(example=1)
*/
public function setId(int $id)
{

2
Tests/Functional/FunctionalTest.php
View File

@ -334,6 +334,8 @@ class FunctionalTest extends WebTestCase
'properties' => [
'propertyNotBlank' => [
'type' => 'integer',
'maxItems' => '10',
'minItems' => '0',
],
'propertyNotNull' => [
'type' => 'integer',