Stream
in package
implements
StreamInterface, Stringable
Implementation of PSR HTTP streams
Table of Contents
Interfaces
- StreamInterface
- Describes a data stream.
- Stringable
Constants
- ALLOWED_STREAM_RESOURCE_TYPES = ['gd', 'stream']
- A list of allowed stream resource types that are allowed to instantiate a Stream
Properties
Methods
- __construct() : mixed
- __toString() : string
- Reads all data from the stream into a string, from the beginning to end.
- attach() : void
- Attach a new stream/resource to the instance.
- close() : void
- Closes the stream and any underlying resources.
- detach() : resource|null
- Separates any underlying resources from the stream.
- eof() : bool
- Returns true if the stream is at the end of the stream.
- getContents() : string
- Returns the remaining contents in a string
- getMetadata() : array<string|int, mixed>|mixed|null
- Get stream metadata as an associative array or retrieve a specific key.
- getSize() : int|null
- Get the size of the stream if known.
- isReadable() : bool
- Returns whether or not the stream is readable.
- isSeekable() : bool
- Returns whether or not the stream is seekable.
- isWritable() : bool
- Returns whether or not the stream is writable.
- read() : string
- Read data from the stream.
- rewind() : void
- Seek to the beginning of the stream.
- seek() : void
- Seek to a position in the stream.
- tell() : int
- Returns the current position of the file read/write pointer
- write() : int
- Write data to the stream.
- isValidStreamResourceType() : bool
- Determine if a resource is one of the resource types allowed to instantiate a Stream
- setStream() : void
- Set the internal stream resource.
Constants
ALLOWED_STREAM_RESOURCE_TYPES
A list of allowed stream resource types that are allowed to instantiate a Stream
private
mixed
ALLOWED_STREAM_RESOURCE_TYPES
= ['gd', 'stream']
Properties
$resource
protected
resource|null
$resource
$stream
protected
string|object|resource|null
$stream
Methods
__construct()
public
__construct(string|object|resource $stream[, string $mode = 'r' ]) : mixed
Parameters
- $stream : string|object|resource
- $mode : string = 'r'
-
Mode with which to open stream
Tags
__toString()
Reads all data from the stream into a string, from the beginning to end.
public
__toString() : string
Return values
stringattach()
Attach a new stream/resource to the instance.
public
attach(string|object|resource $resource[, string $mode = 'r' ]) : void
Parameters
- $resource : string|object|resource
- $mode : string = 'r'
Tags
close()
Closes the stream and any underlying resources.
public
close() : void
detach()
Separates any underlying resources from the stream.
public
detach() : resource|null
Return values
resource|null —Underlying PHP stream, if any
eof()
Returns true if the stream is at the end of the stream.
public
eof() : bool
Return values
boolgetContents()
Returns the remaining contents in a string
public
getContents() : string
Return values
stringgetMetadata()
Get stream metadata as an associative array or retrieve a specific key.
public
getMetadata([mixed $key = null ]) : array<string|int, mixed>|mixed|null
Parameters
- $key : mixed = null
-
Specific metadata to retrieve.
Return values
array<string|int, mixed>|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()
Get the size of the stream if known.
public
getSize() : int|null
Return values
int|null —Returns the size in bytes if known, or null if unknown.
isReadable()
Returns whether or not the stream is readable.
public
isReadable() : bool
Return values
boolisSeekable()
Returns whether or not the stream is seekable.
public
isSeekable() : bool
Return values
boolisWritable()
Returns whether or not the stream is writable.
public
isWritable() : bool
Return values
boolread()
Read data from the stream.
public
read(mixed $length) : string
Parameters
- $length : mixed
-
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 values
string —Returns the data read from the stream, or an empty string if no bytes are available.
rewind()
Seek to the beginning of the stream.
public
rewind() : void
seek()
Seek to a position in the stream.
public
seek(mixed $offset[, mixed $whence = SEEK_SET ]) : void
Parameters
- $offset : mixed
-
Stream offset
- $whence : mixed = SEEK_SET
-
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.
tell()
Returns the current position of the file read/write pointer
public
tell() : int
Return values
int —Position of the file pointer
write()
Write data to the stream.
public
write(mixed $string) : int
Parameters
- $string : mixed
-
The string that is to be written.
Return values
int —Returns the number of bytes written to the stream.
isValidStreamResourceType()
Determine if a resource is one of the resource types allowed to instantiate a Stream
private
isValidStreamResourceType(mixed $resource) : bool
Parameters
- $resource : mixed
-
Stream resource.
Tags
Return values
boolsetStream()
Set the internal stream resource.
private
setStream(string|object|resource $stream[, string $mode = 'r' ]) : void
Parameters
- $stream : string|object|resource
-
String stream target or stream resource.
- $mode : string = 'r'
-
Resource mode for stream target.