class ContentStream implements StreamInterface (View source)

Implementation of a PSR-7 HTTP stream

Properties

protected resource|null $resource
protected string|resource $stream
protected LoggerInterface $logger

Methods

__construct(string|resource $stream, string $mode = 'r')

No description

static ContentStream
fromContents(string $contents)

Creates an instance representing the given $contents string

void
close()

Closes the stream and any underlying resources.

resource|null
detach()

Separates any underlying resources from the stream.

replace(string|resource $stream, string $mode = 'r')

Attach a new stream/resource to the instance.

int|null
getSize()

Get the size of the stream if known.

int
tell()

Returns the current position of the file read/write pointer

bool
eof()

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

bool
isSeekable()

Returns whether or not the stream is seekable.

bool
seek(int $offset, int $whence = SEEK_SET)

Seek to a position in the stream.

rewind()

Seek to the beginning of the stream.

bool
isWritable()

Returns whether or not the stream is writable.

int
write(string $string)

Write data to the stream.

bool
isReadable()

Returns whether or not the stream is readable.

string
read(int $length)

Read data from the stream.

string
getContents()

Returns the remaining contents in a string

array|mixed|null
getMetadata(string $key = null)

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

ensureResourceReadable()

Throw an exception if the current resource is not readable.

ensureResourceOpen()

Throw an exception if the current resource is not valid.

bool
isValidResource($resource)

No description

string
__toString()

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

Details

__construct(string|resource $stream, string $mode = 'r')

No description

Parameters

string|resource $stream

a valid PHP resource or a filename supported by fopen (see http://php.net/manual/en/function.fopen.php)

string $mode

Mode with which to open stream

Exceptions

InvalidArgumentException

static ContentStream fromContents(string $contents)

Creates an instance representing the given $contents string

Parameters

string $contents

Return Value

ContentStream

void close()

Closes the stream and any underlying resources.

Return Value

void

resource|null detach()

Separates any underlying resources from the stream.

After the stream has been detached, the stream is in an unusable state.

Return Value

resource|null

Underlying PHP stream, if any

replace(string|resource $stream, string $mode = 'r')

Attach a new stream/resource to the instance.

Parameters

string|resource $stream
string $mode

int|null getSize()

Get the size of the stream if known.

Return Value

int|null

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

int tell()

Returns the current position of the file read/write pointer

Return Value

int

Position of the file pointer

Exceptions

RuntimeException

bool eof()

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

Return Value

bool

bool isSeekable()

Returns whether or not the stream is seekable.

Return Value

bool

bool seek(int $offset, int $whence = SEEK_SET)

Seek to a position in the stream.

Parameters

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.

Return Value

bool

Exceptions

RuntimeException

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).

Exceptions

RuntimeException

See also

seek()

bool isWritable()

Returns whether or not the stream is writable.

Return Value

bool

int write(string $string)

Write data to the stream.

Parameters

string $string

The string that is to be written.

Return Value

int

Returns the number of bytes written to the stream.

Exceptions

RuntimeException

bool isReadable()

Returns whether or not the stream is readable.

Return Value

bool

string read(int $length)

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.

Return Value

string

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

Exceptions

RuntimeException

string getContents()

Returns the remaining contents in a string

Return Value

string

Exceptions

RuntimeException

array|mixed|null getMetadata(string $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.

Parameters

string $key

Specific metadata to retrieve.

Return Value

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.

protected ensureResourceReadable()

Throw an exception if the current resource is not readable.

protected ensureResourceOpen()

Throw an exception if the current resource is not valid.

protected bool isValidResource($resource)

No description

Parameters

$resource

Return Value

bool

string __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.