New in Symfony 7.1: MapUploadedFile Attribute
In Symfony 6.3 we introduced a way to map Request data to typed objects. We’ve
improved and expanded that feature in the following versions and that’s why in
Symfony 7.1 we’re introducing a new #[MapUploadedFile] attribute to
map uploaded files to controller arguments.
The following example shows the simplest use case, where the attribute is applied
(without any options) to some controller argument to tell Symfony to inject an
UploadedFile object in it:
namespace AppController;
use SymfonyBundleFrameworkBundleControllerAbstractController;
use SymfonyComponentHttpFoundationFileUploadedFile;
use SymfonyComponentHttpFoundationResponse;
use SymfonyComponentHttpKernelAttributeMapUploadedFile;
use SymfonyComponentRoutingAttributeRoute;
class UserController extends AbstractController
{
// …
#[Route(‚/user/picture‘, methods: [‚PUT‘])]
public function changeUserPicture(
#[MapUploadedFile] UploadedFile $picture,
): Response
{
// …
}
}
A common need when uploading files is to validate the file types and other file
characteristics such as its dimensions. The #[MapUploadedFile] attribute allows
to pass a list of constraints to apply to the file:
use SymfonyComponentValidatorConstraints as Assert;
// …
#[Route(‚/user/picture‘, methods: [‚PUT‘])]
public function changeUserPicture(
#[MapUploadedFile([
new AssertFile(mimeTypes: [‚image/png‘, ‚image/jpeg‘]),
new AssertImage(maxWidth: 3840, maxHeight: 2160)
])]
UploadedFile $picture
): Response {
// …
}
The given constraints are checked before injecting the UploadedFile into the
controller argument. If there’s any constraint violation, an HttpException is
thrown and the controller’s action is not executed.
Lastly, you can inject a collection of files by using a variadic argument:
#[MapUploadedFile(new AssertFile(mimeTypes: [‚application/pdf‘]))]
UploadedFile …$documents
Symfony Blog