Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/goetas/multipartuploadbundle
Symfony multipart/related/mixed/alternative content type handler (rfc1341).
https://github.com/goetas/multipartuploadbundle
http multipart-uploads php symfony symfony-bundle
Last synced: 2 months ago
JSON representation
Symfony multipart/related/mixed/alternative content type handler (rfc1341).
- Host: GitHub
- URL: https://github.com/goetas/multipartuploadbundle
- Owner: goetas
- License: mit
- Created: 2018-12-12T08:42:33.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-06T15:58:22.000Z (11 months ago)
- Last Synced: 2024-09-30T17:23:10.002Z (3 months ago)
- Topics: http, multipart-uploads, php, symfony, symfony-bundle
- Language: PHP
- Homepage:
- Size: 94.7 KB
- Stars: 22
- Watchers: 3
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GoetasMultipartUploadBundle
[](https://travis-ci.org/goetas/MultipartUploadBundle)
[](https://packagist.org/packages/goetas/multipart-upload-bundle)
[](https://scrutinizer-ci.com/g/goetas/MultipartUploadBundle/)
[](https://scrutinizer-ci.com/g/goetas/MultipartUploadBundle/?branch=master)
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](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
--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](https://github.com/FriendsOfSymfony/FOSRestBundle) to handle it transparently
```php
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.
```php
$html = $request->request->get('content');
```
Can be used with Symfony's form builder
```php
$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.
```php
$file = $request->files->get('image');
```
Can be used with Symfony's form builder
```php
$builder->add('image', FileType::class);
```
### Attachment Files
Parts with `attachment; filename=` in `Content-Disposition` part's headers
will be treated as an attachment file.
```php
$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.
```php
$part = $request->attributes->get('related-parts')[0];
```
- Get part's headers
```php
$headers = $part->getHeaders()->all();
```
- Get part's content
```php
$content = $part->getContent();
```
- Get part's content as resource
```php
$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`.
```php
$content = $request->getContent(); // content of the first part, not the whole message
```
## Configurations
```yaml
goetas_multipart_upload:
first_part_as_default: true
```
## Note
The code in this project is provided under the
[MIT](https://opensource.org/licenses/MIT) license.
For professional support
contact [[email protected]](mailto:[email protected])
or visit [https://www.goetas.com](https://www.goetas.com)