Interface StreamInterface
OO interface to PHP streams
Direct known implementers
Indirect known implementers
Guzzle\Http\AbstractEntityBodyDecorator,
Guzzle\Http\CachingEntityBody,
Guzzle\Http\EntityBody,
Guzzle\Http\IoEmittingEntityBody,
Guzzle\Http\ReadLimitEntityBody
Methods summary
-
public__toString ( )Convert the stream to a string if the stream is readable and the stream is seekable.
-
publicclose ( )Close the underlying stream
-
publicgetMetaData ( string $key = null )Get stream metadata
-
publicgetStream ( )Get the stream resource
-
publicsetStream ( resource $stream, int $size = null )Set the stream that is wrapped by the object
-
publicdetachStream ( )Detach the current stream resource
-
publicgetWrapper ( )Get the stream wrapper type
-
publicgetWrapperData ( )Wrapper specific data attached to this stream.
-
publicgetStreamType ( )Get a label describing the underlying implementation of the stream
-
publicgetUri ( )Get the URI/filename associated with this stream
-
publicgetSize ( )Get the size of the stream if able
-
publicisReadable ( )Check if the stream is readable
-
publicisRepeatable ( )Check if the stream is repeatable
-
publicisWritable ( )Check if the stream is writable
-
publicisConsumed ( )Check if the stream has been consumed
-
publicfeof ( )Alias of isConsumed
-
publicisLocal ( )Check if the stream is a local stream vs a remote stream
-
publicisSeekable ( )Check if the string is repeatable
-
publicsetSize ( int $size )Specify the size of the stream in bytes
-
publicseek ( int $offset, int $whence = SEEK_SET )Seek to a position in the stream
-
publicread ( int $length )Read data from the stream
-
publicwrite ( string $string )Write data to the stream
-
publicftell ( )Returns the current position of the file read/write pointer
-
publicrewind ( )Rewind to the beginning of the stream
-
publicreadLine ( int $maxLength = null )Read a line from the stream up to the maximum allowed buffer length
-
publicsetCustomData ( string $key, mixed $value )Set custom data on the stream
-
publicgetCustomData ( string $key )Get custom data from the stream
Methods detail
Convert the stream to a string if the stream is readable and the stream is seekable.
Returns
stringClose the underlying stream
Get stream metadata
Parameters
- $key
string
$key Specific metadata to retrieve
Returns
array|mixed|nullGet the stream resource
Returns
resourceSet the stream that is wrapped by the object
Parameters
- $stream
resource
$stream Stream resource to wrap- $size
integer
$size Size of the stream in bytes. Only pass if the size cannot be obtained from the stream.
Returns
Get the stream wrapper type
Returns
stringWrapper specific data attached to this stream.
Returns
arrayGet a label describing the underlying implementation of the stream
Returns
stringGet the URI/filename associated with this stream
Returns
stringGet the size of the stream if able
Returns
integer|booleanCheck if the stream is readable
Returns
booleanCheck if the stream is repeatable
Returns
booleanCheck if the stream is writable
Returns
booleanCheck if the stream has been consumed
Returns
booleanAlias of isConsumed
Returns
booleanCheck if the stream is a local stream vs a remote stream
Returns
booleanCheck if the string is repeatable
Returns
booleanSpecify the size of the stream in bytes
Parameters
- $size
integer
$size Size of the stream contents in bytes
Returns
Seek to a position in the stream
Parameters
- $offset
integer
$offset Stream offset- $whence
integer
$whence Where the offset is applied
Returns
booleanReturns TRUE on success or FALSE on failure
Link
Read data from the stream
Parameters
- $length
integer
$length Up to length number of bytes read.
Returns
string|booleanReturns the data read from the stream or FALSE on failure or EOF
Write data to the stream
Parameters
- $string
string
$string The string that is to be written.
Returns
integer|booleanReturns the number of bytes written to the stream on success or FALSE on failure.
Returns the current position of the file read/write pointer
Returns
integer|booleanReturns the position of the file pointer or false on error
Rewind to the beginning of the stream
Returns
booleanReturns true on success or false on failure
Read a line from the stream up to the maximum allowed buffer length
Parameters
- $maxLength
integer
$maxLength Maximum buffer length
Returns
string|booleanSet custom data on the stream
Parameters
- $key
string
$key Key to set- $value
mixed
$value Value to set
Returns
Get custom data from the stream
Parameters
- $key
string
$key Key to retrieve
Returns
null|mixed