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

Merge pull request #1522 from ahilles107/port/options_support_in_model

Browse Source 
Port/options support in model
This commit is contained in:
Paweł Mikołajczuk 2019-06-01 15:31:09 +02:00 committed by Guilhem N
parent 846e2e3ae4
commit 14e4eedbad
6 changed files with 29 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Annotation/Model.php
View File

@ -22,6 +22,7 @@ final class Model extends AbstractAnnotation
public static $_types = [
'type' => 'string',
'groups' => '[string]',
'options' => '[mixed]',
];
public static $_required = ['type'];
@ -40,4 +41,9 @@ final class Model extends AbstractAnnotation
* @var string[]
*/
public $groups;
/**
* @var mixed[]
*/
public $options;
}

13
Model/Model.php
View File

@ -19,13 +19,16 @@ final class Model
private $groups;
private $options;
/**
* @param string[]|null $groups
*/
public function __construct(Type $type, array $groups = null)
public function __construct(Type $type, array $groups = null, array $options = null)
{
$this->type = $type;
$this->groups = $groups;
$this->options = $options;
}
/**
@ -48,4 +51,12 @@ final class Model
{
return md5(serialize([$this->type, $this->groups]));
}
/**
* @return mixed[]|null
*/
public function getOptions()
{
return $this->options;
}
}

8
ModelDescriber/FormModelDescriber.php
View File

@ -51,7 +51,7 @@ final class FormModelDescriber implements ModelDescriberInterface, ModelRegistry
$class = $model->getType()->getClassName();
$form = $this->formFactory->create($class, null, []);
$form = $this->formFactory->create($class, null, $model->getOptions() ?? []);
$this->parseForm($schema, $form);
}
@ -101,7 +101,11 @@ final class FormModelDescriber implements ModelDescriberInterface, ModelRegistry
if (!$builtinFormType = $this->getBuiltinFormType($type)) {
// if form type is not builtin in Form component.
$model = new Model(new Type(Type::BUILTIN_TYPE_OBJECT, false, get_class($type->getInnerType())));
$model = new Model(
new Type(Type::BUILTIN_TYPE_OBJECT, false, get_class($type->getInnerType())),
null,
$config->getOptions()
);
$property->setRef($this->modelRegistry->register($model));
return;

4
SwaggerPhp/ModelRegister.php
View File

@ -44,7 +44,7 @@ final class ModelRegister
if ($annotation instanceof Schema && $annotation->ref instanceof ModelAnnotation) {
$model = $annotation->ref;
$annotation->ref = $this->modelRegistry->register(new Model($this->createType($model->type), $this->getGroups($model, $parentGroups)));
$annotation->ref = $this->modelRegistry->register(new Model($this->createType($model->type), $this->getGroups($model, $parentGroups), $model->options));
// It is no longer an unmerged annotation
$this->detach($model, $annotation, $analysis);
@ -90,7 +90,7 @@ final class ModelRegister
}
$annotation->merge([new $annotationClass([
'ref' => $this->modelRegistry->register(new Model($this->createType($model->type), $this->getGroups($model, $parentGroups))),
'ref' => $this->modelRegistry->register(new Model($this->createType($model->type), $this->getGroups($model, $parentGroups), $model->options)),
])]);
// It is no longer an unmerged annotation

2
Tests/Functional/Controller/ApiController.php
View File

@ -91,7 +91,7 @@ class ApiController
* name="foo",
* in="body",
* description="This is a parameter",
* @SWG\Schema(ref=@Model(type=UserType::class))
* @SWG\Schema(ref=@Model(type=UserType::class, options={"bar": "baz"}))
* )
*/
public function submitUserTypeAction()

2
Tests/Functional/Form/UserType.php
View File

@ -50,5 +50,7 @@ class UserType extends AbstractType
$resolver->setDefaults([
'data_class' => User::class,
]);
$resolver->setRequired('bar');
}
}