Documentation

Stream
in package
implements StreamInterface

PHP stream implementation.

Interfaces, Classes and Traits

StreamInterface
Describes a data stream.

Table of Contents

READABLE_MODES  = '/r|a\+|ab\+|w\+|wb\+|x\+|xb\+|c\+|cb\+/'
Resource modes.
WRITABLE_MODES  = '/a|w|r\+|rb\+|rw|x|c/'
$customMetadata  : mixed
$readable  : mixed
$seekable  : mixed
$size  : mixed
$stream  : mixed
$uri  : mixed
$writable  : mixed
__construct()  : mixed
This constructor accepts an associative array of options.
__destruct()  : mixed
Closes the stream when the destructed
__toString()  : string
Reads all data from the stream into a string, from the beginning to end.
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()  : mixed
Seek to the beginning of the stream.
seek()  : mixed
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.

Constants

WRITABLE_MODES

public mixed WRITABLE_MODES = '/a|w|r\+|rb\+|rw|x|c/'

Properties

$customMetadata

private mixed $customMetadata

$readable

private mixed $readable

$seekable

private mixed $seekable

$writable

private mixed $writable

Methods

__construct()

This constructor accepts an associative array of options.

public __construct(resource $stream[, array<string|int, mixed> $options = [] ]) : mixed
  • size: (int) If a read stream would otherwise have an indeterminate size, but the size is known due to foreknowledge, then you can provide that size, in bytes.
  • metadata: (array) Any additional metadata to return when the metadata of the stream is accessed.
Parameters
$stream : resource

Stream resource to wrap.

$options : array<string|int, mixed> = []

Associative array of options.

Tags
throws
InvalidArgumentException

if the stream is not a stream resource

Return values
mixed —

__destruct()

Closes the stream when the destructed

public __destruct() : mixed
Return values
mixed —

__toString()

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

public __toString() : string

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.

Return values
string —

close()

Closes the stream and any underlying resources.

public close() : void
Return values
void —

detach()

Separates any underlying resources from the stream.

public detach() : resource|null

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

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
bool —

getContents()

Returns the remaining contents in a string

public getContents() : string
Return values
string —

getMetadata()

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

public getMetadata([mixed $key = null ]) : array<string|int, mixed>|mixed|null

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

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
bool —

isSeekable()

Returns whether or not the stream is seekable.

public isSeekable() : bool
Return values
bool —

isWritable()

Returns whether or not the stream is writable.

public isWritable() : bool
Return values
bool —

read()

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() : mixed

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

Return values
mixed —

seek()

Seek to a position in the stream.

public seek(mixed $offset[, mixed $whence = SEEK_SET ]) : mixed
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.

Return values
mixed —

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.

Search results