EntityType field type renders as entire namespace instead of just the class name

[DoobleD]

When I use as a model a form type containing an EntityType field, the rendered doc shows the whole entity class namespace instead of just the class name.

In my form type:

use App\Entity\User;

...

public function buildForm(FormBuilderInterface $builder, array $options)
{
      $builder
      ->add('users', EntityType::class, [
          'class' => User::class,
          'query_builder' => function (UserRepository $repository) {
              return $repository->findAll();
          },
          'choice_value' => function ($entity = null) {
              if (is_string($entity)) return $entity;
              if ($entity instanceof User) return $entity->getEmail();
              return '';
          },
      ]);
}

Generates the following for the field in the schema description of the documentation:

users string($App\Entity\User id)

This is probably not really a bug, but I'd have expected to see:

users string($User id)

since model types otherwise have only their class names shown instead of the whole namespace. A way to show the actual id name (here email: users string($User email)) would have been great too, but that's perhaps asking too much.

I tried using model name aliases but this has no effect in that case.

[DoobleD]

I just realized I can kind of work around with the documentation type option, like so:

public function buildForm(FormBuilderInterface $builder, array $options)
{
      $builder
      ->add('users', EntityType::class, [
          'class' => User::class,
            'documentation' => [
                'type' => 'string',
            ],
          'query_builder' => function (UserRepository $repository) {
              return $repository->findAll();
          },
          'choice_value' => function ($entity = null) {
              if (is_string($entity)) return $entity;
              if ($entity instanceof User) return $entity->getEmail();
              return '';
          },
      ]);
}

This generates users string so at least the full namespace is not visible. Not exactly what I wanted but better for my case. This issue can be closed if nothing else can be easily done.

[chrisguitarguy]

Looks like this iscoming from here:

NelmioApiDocBundle/ModelDescriber/FormModelDescriber.php

Lines 251 to 258 in 0220f64

	if ($config->getOption('multiple')) {
	$property->format = sprintf('[%s id]', $entityClass);
	$property->type = 'array';
	$property->items = Util::createChild($property, OA\Items::class, ['type' => 'string']);
	} else {
	$property->type = 'string';
	$property->format = sprintf('%s id', $entityClass);
	}

That seems weird that it would have a format at all, to be honest.

[chrisguitarguy]

THough it looks like format is an open value https://swagger.io/docs/specification/data-models/data-types/#format so anything is acceptable.

FOr your uses case @DoobleD I'd suggest doing

'documentation' => [
  'format' => 'email',
]

[DoobleD]

Thanks for giving it a look @chrisguitarguy!