Skip to content

[Mime] Add alternative FormDataPart array structure #14338

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 6, 2020
Merged

[Mime] Add alternative FormDataPart array structure #14338

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions http_client.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -619,6 +619,35 @@ according to the ``multipart/form-data`` content-type. The
'body' => $formData->bodyToIterable(),
]);

.. tip::

When using multidimensional arrays the :class:`Symfony\\Component\\Mime\\Part\\Multipart\\FormDataPart`
automatically appends ``[key]`` to the name of the field::

$formData = new FormDataPart([
'array_field' => [
'some value',
'other value',
],
]);

$formData->getParts(); // Returns two instances of TextPart
// with the names "array_field[0]" and "array_field[1]"

This behavior can be bypassed by using the following array structure::

$formData = new FormDataPart([
['array_field' => 'some value'],
['array_field' => 'other value'],
]);

$formData->getParts(); // Returns two instances of TextPart both
// with the name "array_field"

.. versionadded:: 5.2

The alternative array structure was introduced in Symfony 5.2.

By default, HttpClient streams the body contents when uploading them. This might
not work with all servers, resulting in HTTP status code 411 ("Length Required")
because there is no ``Content-Length`` header. The solution is to turn the body
Expand Down