Methods summary
public
|
|
public
string
|
#
__toString( )
Convert the stream to a string if the stream is readable and the stream is
seekable.
Convert the stream to a string if the stream is readable and the stream is
seekable.
Returns
string
Implementation of
|
public
mixed
|
#
__call( string $method, array $args = null )
Allow decorators to implement custom methods
Allow decorators to implement custom methods
Parameters
- $method
string
$method Missing method name- $args
array
$args Method arguments Returns
mixed
|
public
|
#
close( )
Close the underlying stream
Close the underlying stream
Implementation of
|
public
Guzzle\Http\AbstractEntityBodyDecorator
|
#
setRewindFunction( mixed $callable )
Specify a custom callback used to rewind a non-seekable stream. This can be
useful entity enclosing requests that are redirected.
Specify a custom callback used to rewind a non-seekable stream. This can be
useful entity enclosing requests that are redirected.
Parameters
- $callable
mixed
$callable Callable to invoke to rewind a non-seekable stream. The callback must
accept an EntityBodyInterface object, perform the rewind if possible, and return
a boolean representing whether or not the rewind was successful. Returns
Implementation of
|
public
boolean
|
#
rewind( )
Rewind to the beginning of the stream
Rewind to the beginning of the stream
Returns
boolean
Returns true on success or false on failure
Implementation of
|
public
boolean
|
#
compress( string $filter = 'zlib.deflate' )
If the stream is readable, compress the data in the stream using deflate
compression. The uncompressed stream is then closed, and the compressed stream
then becomes the wrapped stream.
If the stream is readable, compress the data in the stream using deflate
compression. The uncompressed stream is then closed, and the compressed stream
then becomes the wrapped stream.
Parameters
- $filter
string
$filter Compression filter Returns
boolean
Returns TRUE on success or FALSE on failure
Implementation of
|
public
boolean
|
#
uncompress( string $filter = 'zlib.inflate' )
Decompress a deflated string. Once uncompressed, the uncompressed string is
then used as the wrapped stream.
Decompress a deflated string. Once uncompressed, the uncompressed string is
then used as the wrapped stream.
Parameters
- $filter
string
$filter De-compression filter Returns
boolean
Returns TRUE on success or FALSE on failure
Implementation of
|
public
integer|boolean
|
#
getContentLength( )
Get the Content-Length of the entity body if possible (alias of getSize)
Get the Content-Length of the entity body if possible (alias of getSize)
Returns
integer|boolean
Returns the Content-Length or false on failure
Implementation of
|
public
string|null
|
#
getContentType( )
Guess the Content-Type of a local stream
Guess the Content-Type of a local stream
Returns
string|null
Implementation of
|
public
boolean|string
|
#
getContentMd5( boolean $rawOutput = false, boolean $base64Encode = false )
Get an MD5 checksum of the stream's contents
Get an MD5 checksum of the stream's contents
Parameters
- $rawOutput
boolean
$rawOutput Whether or not to use raw output- $base64Encode
boolean
$base64Encode Whether or not to base64 encode raw output (only if raw output is
true) Returns
boolean|string
Returns an MD5 string on success or FALSE on failure
Implementation of
|
public
boolean|string
|
#
getContentEncoding( )
Get the Content-Encoding of the EntityBody
Get the Content-Encoding of the EntityBody
Returns
boolean|string
Implementation of
|
public
array|mixed|null
|
#
getMetaData( string $key = null )
Get stream metadata
Parameters
- $key
string
$key Specific metadata to retrieve Returns
array|mixed|null
Implementation of
|
public
resource
|
#
getStream( )
Get the stream resource
Returns
resource
Implementation of
|
public
Guzzle\Http\AbstractEntityBodyDecorator
|
#
setStream( resource $stream, integer $size = 0 )
Set the stream that is wrapped by the object
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
|
public
string
|
#
getWrapper( )
Get the stream wrapper type
Get the stream wrapper type
Returns
string
Implementation of
|
public
array
|
#
getWrapperData( )
Wrapper specific data attached to this stream.
Wrapper specific data attached to this stream.
Returns
array
Implementation of
|
public
string
|
#
getStreamType( )
Get a label describing the underlying implementation of the stream
Get a label describing the underlying implementation of the stream
Returns
string
Implementation of
|
public
string
|
#
getUri( )
Get the URI/filename associated with this stream
Get the URI/filename associated with this stream
Returns
string
Implementation of
|
public
integer|boolean
|
#
getSize( )
Get the size of the stream if able
Get the size of the stream if able
Returns
integer|boolean
Implementation of
|
public
boolean
|
#
isReadable( )
Check if the stream is readable
Check if the stream is readable
Returns
boolean
Implementation of
|
public
boolean
|
#
isWritable( )
Check if the stream is writable
Check if the stream is writable
Returns
boolean
Implementation of
|
public
boolean
|
#
isConsumed( )
Check if the stream has been consumed
Check if the stream has been consumed
Returns
boolean
Implementation of
|
public
boolean
|
#
feof( )
Alias of isConsumed() Alias of isConsumed
Alias of isConsumed() Alias of isConsumed
Returns
boolean
Implementation of
|
public
boolean
|
#
isLocal( )
Check if the stream is a local stream vs a remote stream
Check if the stream is a local stream vs a remote stream
Returns
boolean
Implementation of
|
public
boolean
|
#
isSeekable( )
Check if the string is repeatable
Check if the string is repeatable
Returns
boolean
Implementation of
|
public
Guzzle\Http\AbstractEntityBodyDecorator
|
#
setSize( integer $size )
Specify the size of the stream in bytes
Specify the size of the stream in bytes
Parameters
- $size
integer
$size Size of the stream contents in bytes Returns
Implementation of
|
public
boolean
|
#
seek( integer $offset, integer $whence = SEEK_SET )
Seek to a position in the stream
Seek to a position in the stream
Parameters
- $offset
integer
$offset Stream offset- $whence
integer
$whence Where the offset is applied Returns
boolean
Returns TRUE on success or FALSE on failure
Implementation of
|
public
string|boolean
|
#
read( integer $length )
Read data from the stream
Read data from the stream
Parameters
- $length
integer
$length Up to length number of bytes read. Returns
string|boolean
Returns the data read from the stream or FALSE on failure or EOF
Implementation of
|
public
integer|boolean
|
#
write( string $string )
Write data to the stream
Parameters
- $string
string
$string The string that is to be written. Returns
integer|boolean
Returns the number of bytes written to the stream on success or FALSE on
failure.
Implementation of
|
public
string|boolean
|
#
readLine( integer $maxLength = null )
Read a line from the stream up to the maximum allowed buffer length
Read a line from the stream up to the maximum allowed buffer length
Parameters
- $maxLength
integer
$maxLength Maximum buffer length Returns
string|boolean
Implementation of
|
public
integer|boolean
|
#
ftell( )
Returns the current position of the file read/write pointer
Returns the current position of the file read/write pointer
Returns
integer|boolean
Returns the position of the file pointer or false on error
Implementation of
|
public
null|mixed
|
#
getCustomData( string $key )
Get custom data from the stream
Get custom data from the stream
Parameters
- $key
string
$key Key to retrieve Returns
null|mixed
Implementation of
|
public
Guzzle\Http\AbstractEntityBodyDecorator
|
#
setCustomData( string $key, mixed $value )
Set custom data on the stream
Set custom data on the stream
Parameters
- $key
string
$key Key to set- $value
mixed
$value Value to set Returns
Implementation of
|