goetas / multipart-upload-bundle
Goetas MultipartUploadBundle
Installs: 15 594
Dependents: 0
Suggesters: 0
Security: 0
Stars: 22
Watchers: 3
Forks: 5
Open Issues: 1
Type:symfony-bundle
Requires
- php: ^8.0
- riverline/multipart-parser: ^2.1
- symfony/dependency-injection: ^6.0|^7.0
- symfony/http-foundation: ^6.0|^7.0
- symfony/http-kernel: ^6.0|^7.0
Requires (Dev)
- matthiasnoback/symfony-dependency-injection-test: ^3.0|^4.0|^5.0
- phpunit/phpunit: ^9.5
README
Symfony multipart/related
, multipart/alternative
and multipart/mixed
content type handler.
This bundle implements a subset of the https://www.w3.org/Protocols/rfc1341/7_2_Multipart.html specifications
and allows you to deal with Content-Type: multipart/*;
requests with Symfony.
Install
Run composer require goetas/multipart-upload-bundle
Add bundle to symfony (if not using symfony/flex)
Request format
A multipart/related
request could look like this:
Host: localhost
Content-Type: multipart/related; boundary=19D523FB
--19D523FB
Content-Type: application/json
{
"content": "Some JSON content"
}
--19D523FB
Content-Type: image/png
Content-Disposition: form-data; name="image"; filename="image.jpg"
Content-MD5: 314ca078416a9b27efbe338ac5a2f727
... binary content...
Content-Type: text/html
Content-Disposition: form-data; name="content"
Content-MD5: 314ca078416a9b27efbe338ac5a2f727
<a href="https://github.com/goetas/MultipartUploadBundle">HTML content</a>
--19D523FB
Content-Type: image/png
Content-Disposition: attachment; filename="image.jpg"
Content-MD5: 314ca078416a9b27efbe338ac5a2f727
... binary content...
--19D523FB
Content-Type: octet/stream
X-Custom-Header: header value
... binary content...
--19D523FB--
Usage
Controller
Body will not be decoded automatically, you can decode it by yourself or use FOSRestBundle to handle it transparently
public function indexAction(Request $request) { if ('application/json' == $request->headers->get('content-type')) { $data = json_decode($request->getContent(), true); } }
Form Fields
Parts with form-data; name=
in Content-Disposition
part's headers
will be treated like an regular uploaded file.
$html = $request->request->get('content');
Can be used with Symfony's form builder
$builder->add('content', TextAreaType::class);
Uploaded Files
Parts with form-data; name=
and filename=
in Content-Disposition
part's headers
will be treated like an regular uploaded file.
$file = $request->files->get('image');
Can be used with Symfony's form builder
$builder->add('image', FileType::class);
Attachment Files
Parts with attachment; filename=
in Content-Disposition
part's headers
will be treated as an attachment file.
$attachment = $request->attributes->get('attachments')[0];
Related Parts
Parts without a filename
will be treated as Riverline\MultiPartParser\StreamedPart
object.
Will be possible to access as well all the parts trough the related-parts
attribute.
$part = $request->attributes->get('related-parts')[0];
- Get part's headers
$headers = $part->getHeaders()->all();
- Get part's content
$content = $part->getContent();
- Get part's content as resource
$content = stream_get_contents($part->getContent(true));
- First part injected
By default, when a message is multipart/*
, the first part will become the Symfony message content.
You can disable this by setting first_part_as_default
to false
.
$content = $request->getContent(); // content of the first part, not the whole message
Configurations
goetas_multipart_upload: first_part_as_default: true
Note
The code in this project is provided under the MIT license. For professional support contact goetas@gmail.com or visit https://www.goetas.com