RetailCRM-Mirror/NelmioApiDocBundle
1
0
Fork 0
mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-03-12 10:36:09 +03:00
Code Issues Projects Releases Wiki Activity

[JMSModelDescriber] Update JMSModelDescriber in order to iterate over nested array definitions (#1365)

Browse Source
This commit is contained in:
Javier Spagnoletti 2018-07-23 13:35:05 -03:00 committed by Guilhem N
parent 9ca68b426c
commit 1063972c27
3 changed files with 45 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
ModelDescriber/JMSModelDescriber.php
View File

@ -14,7 +14,6 @@ namespace Nelmio\ApiDocBundle\ModelDescriber;
use Doctrine\Common\Annotations\Reader;
use EXSyst\Component\Swagger\Schema;
use JMS\Serializer\Exclusion\GroupsExclusionStrategy;
use JMS\Serializer\Metadata\PropertyMetadata;
use JMS\Serializer\Naming\PropertyNamingStrategyInterface;
use JMS\Serializer\SerializationContext;
use Metadata\MetadataFactoryInterface;
@ -92,33 +91,7 @@ class JMSModelDescriber implements ModelDescriberInterface, ModelRegistryAwareIn
continue;
}
if ($nestedType = $this->getNestedTypeInArray($item)) {
list($type, $isHash) = $nestedType;
if ($isHash) {
$property->setType('object');
$typeDef = $this->findPropertyType($type, $groups);
// in the case of a virtual property, set it as free object type
$property->merge(['additionalProperties' => $typeDef ?: []]);
continue;
} else {
$property->setType('array');
$property = $property->getItems();
}
} else {
$type = $item->type['name'];
}
$typeDef = $this->findPropertyType($type, $groups);
// virtual property
if (!$typeDef) {
continue;
}
$this->registerPropertyType($typeDef, $property);
$this->describeItem($item->type, $property, $groups);
}
}
@ -186,25 +159,40 @@ class JMSModelDescriber implements ModelDescriberInterface, ModelRegistryAwareIn
}
}
/**
* @param PropertyMetadata $item
*
* @return array|null
*/
private function getNestedTypeInArray(PropertyMetadata $item)
private function describeItem(array $type, $property, array $groups = null)
{
if ('array' !== $item->type['name'] && 'ArrayCollection' !== $item->type['name']) {
if (list($nestedType, $isHash) = $this->getNestedTypeInArray($type)) { // @ todo update a bit getNestedTypeInArray and describe ($type = $item->type)
if ($isHash) {
$property->setType('object');
// in the case of a virtual property, set it as free object type
$property->merge(['additionalProperties' => []]);
$this->describeItem($nestedType, $property->getAdditionalProperties(), $groups);
return;
}
$property->setType('array');
$this->describeItem($nestedType, $property->getItems(), $groups);
}
if ($typeDef = $this->findPropertyType($type['name'], $groups)) {
$this->registerPropertyType($typeDef, $property);
}
}
private function getNestedTypeInArray(array $type)
{
if ('array' !== $type['name'] && 'ArrayCollection' !== $type['name']) {
return null;
}
// array<string, MyNamespaceMyObject>
if (isset($item->type['params'][1]['name'])) {
return [$item->type['params'][1]['name'], true];
if (isset($type['params'][1]['name'])) {
return [$type['params'][1], true];
}
// array<MyNamespaceMyObject>
if (isset($item->type['params'][0]['name'])) {
return [$item->type['params'][0]['name'], false];
if (isset($type['params'][0]['name'])) {
return [$type['params'][0], false];
}
return null;

6
Tests/Functional/Entity/JMSUser.php
View File

@ -126,6 +126,12 @@ class JMSUser
*/
private $status;
/**
* @Serializer\Type("array<array<float>>")
* @Serializer\Expose
*/
private $latLonHistory;
public function setRoles($roles)
{
}

10
Tests/Functional/JMSFunctionalTest.php
View File

@ -83,6 +83,16 @@ class JMSFunctionalTest extends WebTestCase
'last_update' => [
'type' => 'date',
],
'lat_lon_history' => [
'type' => 'array',
'items' => [
'type' => 'array',
'items' => [
'type' => 'number',
'format' => 'float',
],
],
],
],
], $this->getModel('JMSUser')->toArray());
}