GuzzleHttp\Psr7\MultipartStream Class Reference

Stream that when read returns bytes for a streaming multipart or multipart/form-data stream. More...

Inheritance diagram for GuzzleHttp\Psr7\MultipartStream:

Collaboration diagram for GuzzleHttp\Psr7\MultipartStream:

Public Member Functions
	__construct (array $elements=[], $boundary=null)
	getBoundary ()
	Get the boundary. More...
	isWritable ()
	Returns whether or not the stream is writable. More...
Public Member Functions inherited from Psr\Http\Message\StreamInterface
	__toString ()
	Reads all data from the stream into a string, from the beginning to end. More...
	close ()
	Closes the stream and any underlying resources. More...
	detach ()
	Separates any underlying resources from the stream. More...
	getSize ()
	Get the size of the stream if known. More...
	tell ()
	Returns the current position of the file read/write pointer. More...
	eof ()
	Returns true if the stream is at the end of the stream. More...
	isSeekable ()
	Returns whether or not the stream is seekable. More...
	seek ($offset, $whence=SEEK_SET)
	Seek to a position in the stream. More...
	rewind ()
	Seek to the beginning of the stream. More...
	write ($string)
	Write data to the stream. More...
	isReadable ()
	Returns whether or not the stream is readable. More...
	read ($length)
	Read data from the stream. More...
	getContents ()
	Returns the remaining contents in a string. More...
	getMetadata ($key=null)
	Get stream metadata as an associative array or retrieve a specific key. More...

Protected Member Functions
	createStream (array $elements)
	Create the aggregate stream that will be used to upload the POST data. More...

Private Member Functions
	getHeaders (array $headers)
	Get the headers needed before transferring the content of a POST file. More...
	addElement (AppendStream $stream, array $element)
	createElement ($name, StreamInterface $stream, $filename, array $headers)
	getHeader (array $headers, $key)

Private Attributes
	$boundary

Detailed Description

Stream that when read returns bytes for a streaming multipart or multipart/form-data stream.

Definition at line 10 of file MultipartStream.php.

Constructor & Destructor Documentation

__construct()

GuzzleHttp\Psr7\MultipartStream::__construct	(	array	$elements = [],
			$boundary = null
	)

Parameters

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.
string	$boundary	You can optionally provide a specific boundary

Exceptions

Definition at line 28 of file MultipartStream.php.

References GuzzleHttp\Psr7\MultipartStream\$boundary, and GuzzleHttp\Psr7\MultipartStream\createStream().

    {
        $this->boundary = $boundary ?: sha1(uniqid('', true));
        $this->stream = $this->createStream($elements);
    }

Here is the call graph for this function:

Member Function Documentation

addElement()

GuzzleHttp\Psr7\MultipartStream::addElement ( AppendStream  $stream, array  $element  )

private

Definition at line 79 of file MultipartStream.php.

References $key, GuzzleHttp\Psr7\AppendStream\addStream(), GuzzleHttp\Psr7\MultipartStream\createElement(), GuzzleHttp\Psr7\MultipartStream\getHeaders(), and GuzzleHttp\Psr7\stream_for().

Referenced by GuzzleHttp\Psr7\MultipartStream\createStream().

    {
        foreach (['contents', 'name'] as $key) {
            if (!array_key_exists($key, $element)) {
                throw new \InvalidArgumentException("A '{$key}' key is required");
            }
        }

        $element['contents'] = stream_for($element['contents']);

        if (empty($element['filename'])) {
            $uri = $element['contents']->getMetadata('uri');
            if (substr($uri, 0, 6) !== 'php://') {
                $element['filename'] = $uri;
            }
        }

        list($body, $headers) = $this->createElement(
            $element['name'],
            $element['contents'],
            isset($element['filename']) ? $element['filename'] : null,
            isset($element['headers']) ? $element['headers'] : []
        );

        $stream->addStream(stream_for($this->getHeaders($headers)));
        $stream->addStream($body);
        $stream->addStream(stream_for("\r\n"));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createElement()

GuzzleHttp\Psr7\MultipartStream::createElement (   $name, StreamInterface  $stream,   $filename, array  $headers  )

private

Returns

array

Definition at line 111 of file MultipartStream.php.

References $filename, $name, GuzzleHttp\Psr7\$stream, $type, GuzzleHttp\Psr7\MultipartStream\getHeader(), Psr\Http\Message\StreamInterface\getSize(), and GuzzleHttp\Psr7\mimetype_from_filename().

Referenced by GuzzleHttp\Psr7\MultipartStream\addElement().

    {
        // 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_from_filename($filename)) {
                $headers['Content-Type'] = $type;
            }
        }

        return [$stream, $headers];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createStream()

GuzzleHttp\Psr7\MultipartStream::createStream ( array  $elements )

protected

Create the aggregate stream that will be used to upload the POST data.

Definition at line 65 of file MultipartStream.php.

References GuzzleHttp\Psr7\$stream, GuzzleHttp\Psr7\MultipartStream\addElement(), and GuzzleHttp\Psr7\stream_for().

Referenced by GuzzleHttp\Psr7\MultipartStream\__construct().

    {
        $stream = new AppendStream();

        foreach ($elements as $element) {
            $this->addElement($stream, $element);
        }

        // Add the trailing boundary with CRLF
        $stream->addStream(stream_for("--{$this->boundary}--\r\n"));

        return $stream;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getBoundary()

GuzzleHttp\Psr7\MultipartStream::getBoundary

(

)

Get the boundary.

Returns

string

Definition at line 39 of file MultipartStream.php.

References GuzzleHttp\Psr7\MultipartStream\$boundary.

    {
        return $this->boundary;
    }

getHeader()

GuzzleHttp\Psr7\MultipartStream::getHeader ( array  $headers,   $key  )

private

Definition at line 142 of file MultipartStream.php.

References $key.

Referenced by GuzzleHttp\Psr7\MultipartStream\createElement().

    {
        $lowercaseHeader = strtolower($key);
        foreach ($headers as $k => $v) {
            if (strtolower($k) === $lowercaseHeader) {
                return $v;
            }
        }

        return null;
    }

Here is the caller graph for this function:

getHeaders()

GuzzleHttp\Psr7\MultipartStream::getHeaders ( array  $headers )

private

Get the headers needed before transferring the content of a POST file.

Definition at line 52 of file MultipartStream.php.

References $key.

Referenced by GuzzleHttp\Psr7\MultipartStream\addElement().

    {
        $str = '';
        foreach ($headers as $key => $value) {
            $str .= "{$key}: {$value}\r\n";
        }

        return "--{$this->boundary}\r\n" . trim($str) . "\r\n\r\n";
    }

Here is the caller graph for this function:

isWritable()

GuzzleHttp\Psr7\MultipartStream::isWritable

(

)

Returns whether or not the stream is writable.

Returns

bool

Implements Psr\Http\Message\StreamInterface.

Definition at line 44 of file MultipartStream.php.

    {
        return false;
    }

Field Documentation

$boundary

GuzzleHttp\Psr7\MultipartStream::$boundary

private

Definition at line 14 of file MultipartStream.php.

Referenced by GuzzleHttp\Psr7\MultipartStream\__construct(), and GuzzleHttp\Psr7\MultipartStream\getBoundary().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/guzzlehttp/psr7/src/MultipartStream.php