<?php declare(strict_types=1); namespace GuzzleHttp\Psr7; use Psr\Http\Message\StreamInterface; /** * Stream that when read returns bytes for a streaming multipart or * multipart/form-data stream. */ final class MultipartStream implements StreamInterface { use StreamDecoratorTrait; /** @var string */ private $boundary; /** @var StreamInterface */ private $stream; /** * @param array $elements Array of associative arrays, each containing a * required "name" key mapping to the form field, * name, a required "contents" key mapping to a * StreamInterface/resource/string, an optional * "headers" associative array of custom headers, * and an optional "filename" key mapping to a * string to send as the filename in the part. * @param string $boundary You can optionally provide a specific boundary * * @throws \InvalidArgumentException */ public function __construct(array $elements = [], string $boundary = null) { $this->boundary = $boundary ?: bin2hex(random_bytes(20)); $this->stream = $this->createStream($elements); } public function getBoundary(): string { return $this->boundary; } public function isWritable(): bool { return false; } /** * Get the headers needed before transferring the content of a POST file * * @param array<string, string> $headers */ private function getHeaders(array $headers): string { $str = ''; foreach ($headers as $key => $value) { $str .= "{$key}: {$value}\r\n"; } return "--{$this->boundary}\r\n" . trim($str) . "\r\n\r\n"; } /** * Create the aggregate stream that will be used to upload the POST data */ protected function createStream(array $elements = []): StreamInterface { $stream = new AppendStream(); foreach ($elements as $element) { if (!is_array($element)) { throw new \UnexpectedValueException("An array is expected"); } $this->addElement($stream, $element); } // Add the trailing boundary with CRLF $stream->addStream(Utils::streamFor("--{$this->boundary}--\r\n")); return $stream; } private function addElement(AppendStream $stream, array $element): void { foreach (['contents', 'name'] as $key) { if (!array_key_exists($key, $element)) { throw new \InvalidArgumentException("A '{$key}' key is required"); } } $element['contents'] = Utils::streamFor($element['contents']); if (empty($element['filename'])) { $uri = $element['contents']->getMetadata('uri'); if ($uri && \is_string($uri) && \substr($uri, 0, 6) !== 'php://' && \substr($uri, 0, 7) !== 'data://') { $element['filename'] = $uri; } } [$body, $headers] = $this->createElement( $element['name'], $element['contents'], $element['filename'] ?? null, $element['headers'] ?? [] ); $stream->addStream(Utils::streamFor($this->getHeaders($headers))); $stream->addStream($body); $stream->addStream(Utils::streamFor("\r\n")); } private function createElement(string $name, StreamInterface $stream, ?string $filename, array $headers): array { // Set a default content-disposition header if one was no provided $disposition = $this->getHeader($headers, 'content-disposition'); if (!$disposition) { $headers['Content-Disposition'] = ($filename === '0' || $filename) ? sprintf( 'form-data; name="%s"; filename="%s"', $name, basename($filename) ) : "form-data; name=\"{$name}\""; } // Set a default content-length header if one was no provided $length = $this->getHeader($headers, 'content-length'); if (!$length) { if ($length = $stream->getSize()) { $headers['Content-Length'] = (string) $length; } } // Set a default Content-Type if one was not supplied $type = $this->getHeader($headers, 'content-type'); if (!$type && ($filename === '0' || $filename)) { if ($type = MimeType::fromFilename($filename)) { $headers['Content-Type'] = $type; } } return [$stream, $headers]; } private function getHeader(array $headers, string $key) { $lowercaseHeader = strtolower($key); foreach ($headers as $k => $v) { if (strtolower($k) === $lowercaseHeader) { return $v; } } return null; } }
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
Exception | Folder | 0755 |
|
|
AppendStream.php | File | 5.84 KB | 0644 |
|
BufferStream.php | File | 3.17 KB | 0644 |
|
CachingStream.php | File | 4.48 KB | 0644 |
|
DroppingStream.php | File | 1.17 KB | 0644 |
|
FnStream.php | File | 4.4 KB | 0644 |
|
Header.php | File | 3.84 KB | 0644 |
|
HttpFactory.php | File | 3.02 KB | 0644 |
|
InflateStream.php | File | 1.36 KB | 0644 |
|
LazyOpenStream.php | File | 926 B | 0644 |
|
LimitStream.php | File | 4.2 KB | 0644 |
|
Message.php | File | 8.13 KB | 0644 |
|
MessageTrait.php | File | 7.6 KB | 0644 |
|
MimeType.php | File | 52.9 KB | 0644 |
|
MultipartStream.php | File | 4.92 KB | 0644 |
|
NoSeekStream.php | File | 524 B | 0644 |
|
PumpStream.php | File | 4.5 KB | 0644 |
|
Query.php | File | 3.57 KB | 0644 |
|
Request.php | File | 3.81 KB | 0644 |
|
Response.php | File | 4.79 KB | 0644 |
|
Rfc7230.php | File | 665 B | 0644 |
|
ServerRequest.php | File | 9.37 KB | 0644 |
|
Stream.php | File | 7.23 KB | 0644 |
|
StreamDecoratorTrait.php | File | 3.28 KB | 0644 |
|
StreamWrapper.php | File | 4.01 KB | 0644 |
|
UploadedFile.php | File | 4.75 KB | 0644 |
|
Uri.php | File | 21.36 KB | 0644 |
|
UriComparator.php | File | 1.12 KB | 0644 |
|
UriNormalizer.php | File | 8.22 KB | 0644 |
|
UriResolver.php | File | 8.36 KB | 0644 |
|
Utils.php | File | 15.2 KB | 0644 |
|