MongoDownloadStream

PSR-7 wrapper for MongoDB download stream

class MongoDownloadStream implements StreamInterface

Copyright: 2015-2016 Appertly

License: Apache-2.0

Constructors / Destructors

Public
Returns	Signature and Description
`void`	`__construct`(`ReadableStream $download`) Creates a new MongoDownloadStream

Instance Methods

Public
Returns	Signature and Description
`string`	`__toString`() Reads all data from the stream into a string, from the beginning to end.
`void`	`close`() Closes the stream and any underlying resources.
`?resource`	`detach`() Separates any underlying resources from the stream.
`bool`	`eof`() Returns true if the stream is at the end of 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.
`?int`	`getSize`() Get the size of the stream if known.
`bool`	`isReadable`() Returns whether or not the stream is readable.
`bool`	`isSeekable`() Returns whether or not the stream is seekable.
`bool`	`isWritable`() Returns whether or not the stream is writable.
`string`	`read`(`int $length`) Read data from the stream.
`void`	`rewind`() Seek to the beginning of the stream.
`void`	`seek`(`int $offset`, `int $whence = SEEK_SET`) Seek to a position in the stream.
`int`	`tell`() Returns the current position of the file read/write pointer
`int`	`write`(`string $string`) Write data to the stream.

Method Details

__construct

public function __construct(ReadableStream $download)

Creates a new MongoDownloadStream

Parameters
Name	Type	Description
`$download`	`ReadableStream`	The download object

__toString

public function __toString()

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

Returns
Type	Description
`string`

close

public function close()

Closes the stream and any underlying resources.

detach

public function detach()

Separates any underlying resources from the stream.

Returns
Type	Description
`?resource`	Underlying PHP stream, if any

eof

public function eof()

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

Returns
Type	Description
`bool`

getContents

public function getContents()

Returns the remaining contents in a string

Returns
Type	Description
`string`

Throws
Type	Conditions
`RuntimeException`	if unable to read or an error occurs while reading.

getMetadata

public function 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
Name	Type	Description
`$key`	`?string`	Specific metadata to retrieve.

Returns
Type	Description
`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.

getSize

public function getSize()

Get the size of the stream if known.

Returns
Type	Description
`?int`	Returns the size in bytes if known, or null if unknown.

isReadable

public function isReadable()

Returns whether or not the stream is readable.

Returns
Type	Description
`bool`

isSeekable

public function isSeekable()

Returns whether or not the stream is seekable.

Returns
Type	Description
`bool`

isWritable

public function isWritable()

Returns whether or not the stream is writable.

Returns
Type	Description
`bool`

read

public function read(int $length)

Read data from the stream.

Parameters
Name	Type	Description
`$length`	`int`	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
Type	Description
`string`	Returns the data read from the stream, or an empty string if no bytes are available.

Throws
Type	Conditions
`RuntimeException`	if an error occurs.

rewind

public function 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: seek()

Throws
Type	Conditions
`RuntimeException`	on failure.

seek

public function seek(int $offset, int $whence = SEEK_SET)

Seek to a position in the stream.

Parameters
Name	Type	Description
`$offset`	`int`	Stream offset
`$whence`	`int`	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.

Throws
Type	Conditions
`RuntimeException`	on failure.

tell

public function tell()

Returns the current position of the file read/write pointer

Returns
Type	Description
`int`	Position of the file pointer

Throws
Type	Conditions
`RuntimeException`	on error.

write

public function write(string $string)

Write data to the stream.

Parameters
Name	Type	Description
`$string`	`string`	The string that is to be written.

Returns
Type	Description
`int`	Returns the number of bytes written to the stream.

Throws
Type	Conditions
`RuntimeException`	on failure.