Class Stream
PHP stream implementation
- Guzzle\Stream\Stream implements Guzzle\Stream\StreamInterface
Direct known subclasses
Methods summary
-
public__construct ( resource $stream, int $size = null ) -
public__destruct ( )Closes the stream when the helper is destructed
-
public__toString ( )Convert the stream to a string if the stream is readable and the stream is seekable.
-
publicclose ( )Close the underlying stream
-
public staticgetHash ( Guzzle\Stream\StreamInterface $stream, string $algo, bool $rawOutput = false )Calculate a hash of a 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
-
protectedrebuildCache ( )Reprocess stream metadata
Methods detail
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.
Throws
Closes the stream when the helper is destructed
Convert the stream to a string if the stream is readable and the stream is seekable.
Returns
stringImplementation of
public static
boolean|string
getHash( Guzzle\Stream\StreamInterface $stream, string $algo, boolean $rawOutput = false )
Calculate a hash of a Stream
Parameters
- $stream
Guzzle\Stream\StreamInterface
$stream Stream to calculate the hash for- $algo
string
$algo Hash algorithm (e.g. md5, crc32, etc)- $rawOutput
boolean
$rawOutput Whether or not to use raw output
Returns
boolean|stringReturns false on failure or a hash string on success
Get stream metadata
Parameters
- $key
string
$key Specific metadata to retrieve
Returns
array|mixed|nullImplementation of
Get the stream resource
Returns
resourceImplementation of
Set 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
Implementation of
Detach the current stream resource
Returns
Implementation of
Get the stream wrapper type
Returns
stringImplementation of
Wrapper specific data attached to this stream.
Returns
arrayImplementation of
Get a label describing the underlying implementation of the stream
Returns
stringImplementation of
Get the URI/filename associated with this stream
Returns
stringImplementation of
Get the size of the stream if able
Returns
integer|booleanImplementation of
Check if the stream is readable
Returns
booleanImplementation of
Check if the stream is repeatable
Returns
booleanImplementation of
Check if the stream is writable
Returns
booleanImplementation of
Check if the stream has been consumed
Returns
booleanImplementation of
Check if the stream is a local stream vs a remote stream
Returns
booleanImplementation of
Check if the string is repeatable
Returns
booleanImplementation of
Specify the size of the stream in bytes
Parameters
- $size
integer
$size Size of the stream contents in bytes
Returns
Implementation of
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
Implementation of
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
Implementation of
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.
Implementation of
Returns the current position of the file read/write pointer
Returns
integer|booleanReturns the position of the file pointer or false on error
Implementation of
Rewind to the beginning of the stream
Returns
booleanReturns true on success or false on failure
Implementation of
Read a line from the stream up to the maximum allowed buffer length
Parameters
- $maxLength
integer
$maxLength Maximum buffer length
Returns
string|booleanImplementation of
Set custom data on the stream
Parameters
- $key
string
$key Key to set- $value
mixed
$value Value to set
Returns
Implementation of
Get custom data from the stream
Parameters
- $key
string
$key Key to retrieve
Returns
null|mixedImplementation of
Reprocess stream metadata
Magic methods summary
Constants summary
string |
STREAM_TYPE |
'stream_type' |
|
string |
WRAPPER_TYPE |
'wrapper_type' |
|
string |
IS_LOCAL |
'is_local' |
|
string |
IS_READABLE |
'is_readable' |
|
string |
IS_WRITABLE |
'is_writable' |
|
string |
SEEKABLE |
'seekable' |
Properties summary
protected
resource
|
$stream |
#
Stream resource |
protected
integer
|
$size |
#
Size of the stream contents in bytes |
protected
array
|
$cache |
#
Stream cached data |
protected
array
|
$customData |
#
Custom stream data |
protected static
array
|
$readWriteHash |
#
Hash table of readable and writeable stream types for fast lookups |