Overview

Namespaces

  • Contrib
    • Bundle
      • CoverallsBundle
        • Console
        • Entity
      • CoverallsV1Bundle
        • Api
        • Collector
        • Command
        • Config
        • Entity
          • Git
    • Component
      • File
      • Log
      • System
        • Git
  • Guzzle
    • Batch
      • Exception
    • Cache
    • Common
      • Exception
    • Http
      • Curl
      • Exception
      • Message
      • QueryAggregator
    • Inflection
    • Iterator
    • Log
    • Parser
      • Cookie
      • Message
      • UriTemplate
      • Url
    • Plugin
      • Async
      • Backoff
      • Cache
      • Cookie
        • CookieJar
        • Exception
      • CurlAuth
      • ErrorResponse
        • Exception
      • History
      • Log
      • Md5
      • Mock
      • Oauth
    • Service
      • Builder
      • Command
        • Factory
        • LocationVisitor
          • Request
          • Response
      • Description
      • Exception
      • Resource
    • Stream
  • PHP
  • Psr
    • Log
  • Symfony
    • Component
      • Config
        • Definition
          • Builder
          • Exception
        • Exception
        • Loader
        • Resource
        • Util
      • Console
        • Command
        • Formatter
        • Helper
        • Input
        • Output
        • Tester
      • EventDispatcher
        • Debug
      • Finder
        • Adapter
        • Comparator
        • Exception
        • Expression
        • Iterator
        • Shell
      • Stopwatch
      • Yaml
        • Exception

Classes

  • AbstractEntityBodyDecorator
  • CachingEntityBody
  • Client
  • EntityBody
  • IoEmittingEntityBody
  • Mimetypes
  • QueryString
  • ReadLimitEntityBody
  • RedirectPlugin
  • Url

Interfaces

  • ClientInterface
  • EntityBodyInterface
  • Overview
  • Namespace
  • Class
  • Tree
  • Todo

Interface EntityBodyInterface

Entity body used with an HTTP request or response

Guzzle\Http\EntityBodyInterface implements Guzzle\Stream\StreamInterface

Direct known implementers

Guzzle\Http\AbstractEntityBodyDecorator, Guzzle\Http\EntityBody

Indirect known implementers

Guzzle\Http\CachingEntityBody, Guzzle\Http\IoEmittingEntityBody, Guzzle\Http\ReadLimitEntityBody
Namespace: Guzzle\Http
Located at Guzzle/Http/EntityBodyInterface.php
Methods summary
public Guzzle\Http\EntityBodyInterface
# 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

Guzzle\Http\EntityBodyInterface
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
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
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
public string|null
# getContentType( )

Guess the Content-Type of a local stream

Guess the Content-Type of a local stream

Returns

string|null

See

http://www.php.net/manual/en/function.finfo-open.php
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
public boolean|string
# getContentEncoding( )

Get the Content-Encoding of the EntityBody

Get the Content-Encoding of the EntityBody

Returns

boolean|string
Methods inherited from Guzzle\Stream\StreamInterface
__toString(), close(), feof(), ftell(), getCustomData(), getMetaData(), getSize(), getStream(), getStreamType(), getUri(), getWrapper(), getWrapperData(), isConsumed(), isLocal(), isReadable(), isSeekable(), isWritable(), read(), readLine(), rewind(), seek(), setCustomData(), setSize(), setStream(), write()
php-coveralls API documentation generated by ApiGen 2.8.0