Add file uploads support

[GuilhemN]

This PR add file uploads support. (#793)
Currently, there are no requirements supported.

<?php

use FOS\RestBundle\Controller\Annotations\QueryParam;

/**
 * @FileParam(
 *   name="foo_file",
 *   key=null,
 *   incompatibles={},
 *   default=null,
 *   description="",
 *   strict=false,
 *   nullable=false,
 *   requirements={},
 *   image=false
 * )
 */

I moved the scalar constraints (notBlank, array) in another abstract class ScalarParam, I don't know if this is a really good name ...

The requirements parameter of @FileParam must be a constraint or an array that can contain all the fields of http://symfony.com/doc/current/reference/constraints/File.html or http://symfony.com/doc/current/reference/constraints/Image.html. It depends of the image parameter.

[lsmith77]

please rebase on master

[lsmith77]

can you also add something to the docs?

[GuilhemN]

I add some examples in the ParamFetcher documentation.

[lsmith77]

and what happens now in this case .. we return null?

[GuilhemN]

Look the code, it's the same thing, I just removed an useless call to simplify.

[lsmith77]

needs a rebase

[GuilhemN]

done.

[lsmith77]

and another one :-/

[GuilhemN]

done :-)

[lsmith77]

please add an empty line between methods

[lsmith77]

actually .. I just activated styleci ..

#1115

[GuilhemN]

I'll wait that you merge #1115 to see if there is some standard mistakes related to this PR.

[lsmith77]

indeed .. needs another rebase :-/

form now on it should then also show you any CS violations automatically

[GuilhemN]

Yes, I fixed them.

[lsmith77]

awesome!

[ReservedDeveloper]

In attempting to test this out (specifically using the example with @QueryParam(name="page", requirements="\d+", default="1", description="Page of the overview."), I ran in to an issue with the annotations parser. Specifically Doctrine/Common/Annotations/DocParser.php:786:

} elseif (gettype($values[$property]) !== $type['type'] && !$values[$property] instanceof $type['type']) {

Note the gettype call when $values[$property] is a string will return string type, when only scalar|array|Constraint|null are supported.

Since string !== (scalar|array|Constraint|null)... 💥

The specific error I'm receiving is:

  [Doctrine\Common\Annotations\AnnotationException]                                                                                                                                                     
  [Type Error] Attribute "requirements" of @FOSRest\QueryParam declared on method AppBundle\Controller\XyzController::indexAction() expects a(n) scalar|array|Constraint|null, but got string.

I didn't see any changes to the dependencies that would suggest a different version of the Doctrine library. Am I missing something here?

[GuilhemN]

Hum so it seems that the doctrine annotations reader doesn't support the scalar type... If you have the time, can you change this doc and add a test for this case please?

Instead I'll fix this later, probably tomorrow.

[xabbuh]

@Ener-Getick @lsmith77 For some reason it seems that this change is not in the 1.8 branch. Do you now if that was intended?

[GuilhemN]

@xabbuh Yeah it needs a lot of changes to be backported this is why I didn't do it.

[xabbuh]

@Ener-Getick Alright, thanks for the confirmation.

[GuilhemN]

But at least we can backport the map option in Param. It should be pretty simple.