Doc broken with Validator Constraints in FOSRestBundle requirements

[pyrech]

I just used a new feature of the FOSRestBundle (FriendsOfSymfony/FOSRestBundle#700). This PR allow to use Constraints from the sf validator as (Query|Request)Param's requirement, not just a string containing the regex. We can now do:

use FOS\RestBundle\Controller\Annotations as Rest;
use Symfony\Component\Validator\Constraints as Assert;
...
@Rest\QueryParam(name="foo", requirements=@Assert\Regex("#bar#u"), description="toto")

Howewer, there is an issue in the rendering of the doc. A Twig_Error_Runtime exception is thrown in "NelmioApiDocBundle::method.html.twig" at line 71:

{{ infos.requirement is defined ? infos.requirement : ''}}

I suppose this is due to the fact that requirement is not printable as this is a Constraint. Is this confirmed?

[pyrech]

I tried to a add a method handleRequirements in Nelmio\ApiDocBundle\Extractor\Handle\FosRestHandler which displayed the pattern if it's a Regex constraint, or the name of the class if it's a Constraint, or the requirements if not. It's not really nice but I don't see another simple way to display useful information.

private function handleRequirements($requirements)
{
    if (is_object($requirements) && $requirements instanceof Constraint) {
        if ($requirements instanceof Regex) {
            return $requirements->getHtmlPattern();
        }
        $class = get_class($requirements);
        return substr($class, strrpos($class, '\\')+1);
    }
    return $requirements;
}

Example of use in the handle method:

$annotation->addRequirement($annot->name, array(
    'requirement'   => $this->handleRequirements($annot->requirements),
    'dataType'      => '',
    'description'   => $annot->description,
));

[willdurand]

Your solution is interesting. Would you mind create a PR?

[pyrech]

Of course. I'm doing it right now! :)

[pyrech]

Oups, I thought the PR would be referenced, not the commit. So here is the PR #365