GuzzleHttp\Psr7\AppendStream Class Reference

Reads from multiple streams, one after the other. More...

Inheritance diagram for GuzzleHttp\Psr7\AppendStream:

Collaboration diagram for GuzzleHttp\Psr7\AppendStream:

Public Member Functions
	__construct (array $streams=[])
	__toString ()
	Reads all data from the stream into a string, from the beginning to end. More...
	addStream (StreamInterface $stream)
	Add a stream to the AppendStream. More...
	getContents ()
	Returns the remaining contents in a string. More...
	close ()
	Closes each attached stream. More...
	detach ()
	Detaches each attached stream. More...
	tell ()
	Returns the current position of the file read/write pointer. More...
	getSize ()
	Tries to calculate the size by adding the size of each stream. More...
	eof ()
	Returns true if the stream is at the end of the stream. More...
	rewind ()
	Seek to the beginning of the stream. More...
	seek ($offset, $whence=SEEK_SET)
	Attempts to seek to the given position. More...
	read ($length)
	Reads from all of the appended streams until the length is met or EOF. More...
	isReadable ()
	Returns whether or not the stream is readable. More...
	isWritable ()
	Returns whether or not the stream is writable. More...
	isSeekable ()
	Returns whether or not the stream is seekable. More...
	write ($string)
	Write data to the stream. More...
	getMetadata ($key=null)
	Get stream metadata as an associative array or retrieve a specific key. More...

Private Attributes
	$streams = []
	$seekable = true
	$current = 0
	$pos = 0
	$detached = false

Detailed Description

Reads from multiple streams, one after the other.

This is a read-only stream decorator.

Definition at line 11 of file AppendStream.php.

Constructor & Destructor Documentation

__construct()

GuzzleHttp\Psr7\AppendStream::__construct

(

array

$streams = []

)

Parameters

StreamInterface[]

$streams Streams to decorate. Each stream must be readable.

Definition at line 25 of file AppendStream.php.

References GuzzleHttp\Psr7\$stream, GuzzleHttp\Psr7\AppendStream\$streams, and GuzzleHttp\Psr7\AppendStream\addStream().

    {
        foreach ($streams as $stream) {
            $this->addStream($stream);
        }
    }

Here is the call graph for this function:

Member Function Documentation

__toString()

GuzzleHttp\Psr7\AppendStream::__toString

(

)

Reads all data from the stream into a string, from the beginning to end.

This method MUST attempt to seek to the beginning of the stream before reading data and read the stream until the end is reached.

Warning: This could attempt to load a large amount of data into memory.

This method MUST NOT raise an exception in order to conform with PHP's string casting operations.

See also

http://php.net/manual/en/language.oop5.magic.php#object.tostring

Returns

string

Implements Psr\Http\Message\StreamInterface.

Definition at line 32 of file AppendStream.php.

References GuzzleHttp\Psr7\AppendStream\getContents(), and GuzzleHttp\Psr7\AppendStream\rewind().

    {
        try {
            $this->rewind();
            return $this->getContents();
        } catch (\Exception $e) {
            return '';
        }
    }

Here is the call graph for this function:

addStream()

GuzzleHttp\Psr7\AppendStream::addStream

(

StreamInterface

$stream

)

Add a stream to the AppendStream.

Parameters

StreamInterface

$stream

Stream to append. Must be readable.

Exceptions

Definition at line 49 of file AppendStream.php.

References GuzzleHttp\Psr7\$stream, Psr\Http\Message\StreamInterface\isReadable(), and Psr\Http\Message\StreamInterface\isSeekable().

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

    {
        if (!$stream->isReadable()) {
            throw new \InvalidArgumentException('Each stream must be readable');
        }

        // The stream is only seekable if all streams are seekable
        if (!$stream->isSeekable()) {
            $this->seekable = false;
        }

        $this->streams[] = $stream;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

close()

GuzzleHttp\Psr7\AppendStream::close

(

)

Closes each attached stream.

{Closes the stream and any underlying resources.

Returns

void

}

Implements Psr\Http\Message\StreamInterface.

Definition at line 73 of file AppendStream.php.

References GuzzleHttp\Psr7\$stream.

Referenced by GuzzleHttp\Psr7\AppendStream\detach().

    {
        $this->pos = $this->current = 0;

        foreach ($this->streams as $stream) {
            $stream->close();
        }

        $this->streams = [];
    }

Here is the caller graph for this function:

detach()

GuzzleHttp\Psr7\AppendStream::detach

(

)

Detaches each attached stream.

{Separates any underlying resources from the stream.After the stream has been detached, the stream is in an unusable state.

Returns

resource|null Underlying PHP stream, if any

}

Implements Psr\Http\Message\StreamInterface.

Definition at line 89 of file AppendStream.php.

References GuzzleHttp\Psr7\AppendStream\close().

    {
        $this->close();
        $this->detached = true;
    }

Here is the call graph for this function:

eof()

GuzzleHttp\Psr7\AppendStream::eof

(

)

Returns true if the stream is at the end of the stream.

Returns

bool

Implements Psr\Http\Message\StreamInterface.

Definition at line 123 of file AppendStream.php.

References GuzzleHttp\Psr7\AppendStream\$current.

Referenced by GuzzleHttp\Psr7\AppendStream\read(), and GuzzleHttp\Psr7\AppendStream\seek().

    {
        return !$this->streams ||
            ($this->current >= count($this->streams) - 1 &&
             $this->streams[$this->current]->eof());
    }

Here is the caller graph for this function:

getContents()

GuzzleHttp\Psr7\AppendStream::getContents

(

)

Returns the remaining contents in a string.

Returns

string

Exceptions

Implements Psr\Http\Message\StreamInterface.

Definition at line 63 of file AppendStream.php.

References GuzzleHttp\Psr7\copy_to_string().

Referenced by GuzzleHttp\Psr7\AppendStream\__toString().

    {
        return copy_to_string($this);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMetadata()

GuzzleHttp\Psr7\AppendStream::getMetadata

(

$key = null

)

Get stream metadata as an associative array or retrieve a specific key.

The keys returned are identical to the keys returned from PHP's stream_get_meta_data() function.

string $key Specific metadata to retrieve. array|mixed|null Returns an associative array if no key is provided. Returns a specific key value if a key is provided and the value is found, or null if the key is not found.

Implements Psr\Http\Message\StreamInterface.

Definition at line 229 of file AppendStream.php.

References $key.

    {
        return $key ? null : [];
    }

getSize()

GuzzleHttp\Psr7\AppendStream::getSize

(

)

Tries to calculate the size by adding the size of each stream.

If any of the streams do not return a valid number, then the size of the append stream cannot be determined and null is returned.

{Get the size of the stream if known.

Returns

int|null Returns the size in bytes if known, or null if unknown.

}

Implements Psr\Http\Message\StreamInterface.

Definition at line 108 of file AppendStream.php.

References $s, $size, and GuzzleHttp\Psr7\$stream.

    {
        $size = 0;

        foreach ($this->streams as $stream) {
            $s = $stream->getSize();
            if ($s === null) {
                return null;
            }
            $size += $s;
        }

        return $size;
    }

isReadable()

GuzzleHttp\Psr7\AppendStream::isReadable

(

)

Returns whether or not the stream is readable.

Returns

bool

Implements Psr\Http\Message\StreamInterface.

Definition at line 209 of file AppendStream.php.

    {
        return true;
    }

isSeekable()

GuzzleHttp\Psr7\AppendStream::isSeekable

(

)

Returns whether or not the stream is seekable.

Returns

bool

Implements Psr\Http\Message\StreamInterface.

Definition at line 219 of file AppendStream.php.

References GuzzleHttp\Psr7\AppendStream\$seekable.

    {
        return $this->seekable;
    }

isWritable()

GuzzleHttp\Psr7\AppendStream::isWritable

(

)

Returns whether or not the stream is writable.

Returns

bool

Implements Psr\Http\Message\StreamInterface.

Definition at line 214 of file AppendStream.php.

    {
        return false;
    }

read()

GuzzleHttp\Psr7\AppendStream::read

(

$length

)

Reads from all of the appended streams until the length is met or EOF.

{Read data from the stream.

Parameters

int

$length

Read up to $length bytes from the object and return them. Fewer than $length bytes may be returned if underlying stream call returns fewer bytes.

Returns

string Returns the data read from the stream, or an empty string if no bytes are available.

Exceptions

}

Implements Psr\Http\Message\StreamInterface.

Definition at line 174 of file AppendStream.php.

References GuzzleHttp\Psr7\AppendStream\$current, $remaining, $result, $total, and GuzzleHttp\Psr7\AppendStream\eof().

Referenced by GuzzleHttp\Psr7\AppendStream\seek().

    {
        $buffer = '';
        $total = count($this->streams) - 1;
        $remaining = $length;
        $progressToNext = false;

        while ($remaining > 0) {

            // Progress to the next stream if needed.
            if ($progressToNext || $this->streams[$this->current]->eof()) {
                $progressToNext = false;
                if ($this->current === $total) {
                    break;
                }
                $this->current++;
            }

            $result = $this->streams[$this->current]->read($remaining);

            // Using a loose comparison here to match on '', false, and null
            if ($result == null) {
                $progressToNext = true;
                continue;
            }

            $buffer .= $result;
            $remaining = $length - strlen($buffer);
        }

        $this->pos += strlen($buffer);

        return $buffer;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

rewind()

GuzzleHttp\Psr7\AppendStream::rewind

(

)

Seek to the beginning of the stream.

If the stream is not seekable, this method will raise an exception; otherwise, it will perform a seek(0).

See also

seek() on failure.

Implements Psr\Http\Message\StreamInterface.

Definition at line 130 of file AppendStream.php.

References GuzzleHttp\Psr7\AppendStream\seek().

Referenced by GuzzleHttp\Psr7\AppendStream\__toString().

    {
        $this->seek(0);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

seek()

GuzzleHttp\Psr7\AppendStream::seek	(		$offset,
			$whence = SEEK_SET
	)

Attempts to seek to the given position.

Only supports SEEK_SET.

{Seek to a position in the stream.int $offset Stream offset int $whence Specifies how the cursor position will be calculated based on the seek offset. Valid values are identical to the built-in PHP $whence values for fseek(). SEEK_SET: Set position equal to offset bytes SEEK_CUR: Set position to current location plus offset SEEK_END: Set position to end-of-stream plus offset. on failure.}

Implements Psr\Http\Message\StreamInterface.

Definition at line 140 of file AppendStream.php.

References $i, $result, GuzzleHttp\Psr7\$stream, GuzzleHttp\Psr7\AppendStream\eof(), and GuzzleHttp\Psr7\AppendStream\read().

Referenced by GuzzleHttp\Psr7\AppendStream\rewind().

    {
        if (!$this->seekable) {
            throw new \RuntimeException('This AppendStream is not seekable');
        } elseif ($whence !== SEEK_SET) {
            throw new \RuntimeException('The AppendStream can only seek with SEEK_SET');
        }

        $this->pos = $this->current = 0;

        // Rewind each stream
        foreach ($this->streams as $i => $stream) {
            try {
                $stream->rewind();
            } catch (\Exception $e) {
                throw new \RuntimeException('Unable to seek stream '
                    . $i . ' of the AppendStream', 0, $e);
            }
        }

        // Seek to the actual position by reading from each stream
        while ($this->pos < $offset && !$this->eof()) {
            $result = $this->read(min(8096, $offset - $this->pos));
            if ($result === '') {
                break;
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

tell()

GuzzleHttp\Psr7\AppendStream::tell

(

)

Returns the current position of the file read/write pointer.

Returns

int Position of the file pointer

Exceptions

Implements Psr\Http\Message\StreamInterface.

Definition at line 95 of file AppendStream.php.

References GuzzleHttp\Psr7\AppendStream\$pos.

    {
        return $this->pos;
    }

write()

GuzzleHttp\Psr7\AppendStream::write

(

$string

)

Write data to the stream.

Parameters

string

$string

The string that is to be written.

Returns

int Returns the number of bytes written to the stream.

Exceptions

Implements Psr\Http\Message\StreamInterface.

Definition at line 224 of file AppendStream.php.

    {
        throw new \RuntimeException('Cannot write to an AppendStream');
    }

Field Documentation

$current

GuzzleHttp\Psr7\AppendStream::$current = 0

private

Definition at line 17 of file AppendStream.php.

Referenced by GuzzleHttp\Psr7\AppendStream\eof(), and GuzzleHttp\Psr7\AppendStream\read().

$detached

GuzzleHttp\Psr7\AppendStream::$detached = false

private

Definition at line 19 of file AppendStream.php.

$pos

GuzzleHttp\Psr7\AppendStream::$pos = 0

private

Definition at line 18 of file AppendStream.php.

Referenced by GuzzleHttp\Psr7\AppendStream\tell().

$seekable

GuzzleHttp\Psr7\AppendStream::$seekable = true

private

Definition at line 16 of file AppendStream.php.

Referenced by GuzzleHttp\Psr7\AppendStream\isSeekable().

$streams

GuzzleHttp\Psr7\AppendStream::$streams = []

private

Definition at line 14 of file AppendStream.php.

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

---

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

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