PHP Class Guzzle\Http\CachingEntityBody

Inheritance: extends Guzzle\Http\AbstractEntityBodyDecorator
Show file Open project: humanmade/aws-ses-wp-mail Class Usage Examples

Protected Properties

Property Type Description
$remoteStream Remote stream used to actually pull data onto the buffer
$skipReadBytes The number of bytes to skip reading due to a write on the temporary buffer

Public Methods

Method Description
__construct ( Guzzle\Http\EntityBodyInterface $body ) We will treat the buffer object as the body of the entity body {@inheritdoc}
__toString ( ) : string Will give the contents of the buffer followed by the exhausted remote stream.
close ( ) Close both the remote stream and buffer stream
getContentEncoding ( )
getContentType ( )
getCustomData ( $key ) Always retrieve custom data from the remote stream {@inheritdoc}
getMetaData ( $key = null )
getSize ( )
getStream ( )
getStreamType ( )
getUri ( )
getWrapper ( )
getWrapperData ( )
isConsumed ( )
read ( $length )
readLine ( $maxLength = null )
rewind ( )
seek ( $offset, $whence = SEEK_SET )
setCustomData ( $key, $value ) Always set custom data on the remote stream {@inheritdoc}
setRewindFunction ( $callable ) Does not support custom rewind functions
setStream ( $stream, $size )
write ( $string )

Method Details

__construct() public method

We will treat the buffer object as the body of the entity body {@inheritdoc}
public __construct ( Guzzle\Http\EntityBodyInterface $body )
$body Guzzle\Http\EntityBodyInterface

__toString() public method

Warning: Loads the entire stream into memory
public __toString ( ) : string
return string

close() public method

Close both the remote stream and buffer stream
public close ( )

getContentEncoding() public method

public getContentEncoding ( )

getContentType() public method

public getContentType ( )

getCustomData() public method

Always retrieve custom data from the remote stream {@inheritdoc}
public getCustomData ( $key )

getMetaData() public method

public getMetaData ( $key = null )

getSize() public method

public getSize ( )

getStream() public method

public getStream ( )

getStreamType() public method

public getStreamType ( )

getUri() public method

public getUri ( )

getWrapper() public method

public getWrapper ( )

getWrapperData() public method

public getWrapperData ( )

isConsumed() public method

public isConsumed ( )

read() public method

public read ( $length )

readLine() public method

public readLine ( $maxLength = null )

rewind() public method

public rewind ( )

seek() public method

public seek ( $offset, $whence = SEEK_SET )

setCustomData() public method

Always set custom data on the remote stream {@inheritdoc}
public setCustomData ( $key, $value )

setRewindFunction() public method

Does not support custom rewind functions
public setRewindFunction ( $callable )

setStream() public method

public setStream ( $stream, $size )

write() public method

public write ( $string )

Property Details

$remoteStream protected property

Remote stream used to actually pull data onto the buffer
protected $remoteStream

$skipReadBytes protected property

The number of bytes to skip reading due to a write on the temporary buffer
protected $skipReadBytes