Overview

Namespaces

  • Guzzle
    • Batch
      • Exception
    • Cache
    • Common
      • Exception
    • Http
      • Curl
      • Exception
      • Message
        • Header
      • 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
    • Tests
      • Batch
      • Cache
      • Common
        • Cache
        • Exception
      • Http
        • Curl
        • Exception
        • Message
          • Header
      • Inflection
      • Iterator
      • Log
      • Message
      • Mock
      • Parser
        • Cookie
        • Message
      • Parsers
        • UriTemplate
      • Plugin
        • Async
        • Backoff
        • Cache
        • Cookie
          • CookieJar
        • CurlAuth
        • ErrorResponse
        • History
        • Log
        • Md5
        • Mock
        • Oauth
        • Redirect
      • Service
        • Builder
        • Command
          • LocationVisitor
            • Request
            • Response
        • Description
        • Exception
        • Mock
          • Command
            • Sub
          • Model
        • Resource
      • Stream
  • None
  • Omnipay
    • Common
      • Exception
      • Message
    • Dummy
      • Message
    • Fatzebra
      • Message
  • PHP

Classes

  • AbstractMessage
  • EntityEnclosingRequest
  • Header
  • PostFile
  • Request
  • RequestFactory
  • Response

Interfaces

  • EntityEnclosingRequestInterface
  • MessageInterface
  • PostFileInterface
  • RequestFactoryInterface
  • RequestInterface
  • Overview
  • Namespace
  • Class
  • Tree

Interface MessageInterface

Request and response message interface

Direct known implementers

Guzzle\Http\Message\AbstractMessage, Guzzle\Http\Message\RequestInterface

Indirect known implementers

Guzzle\Http\Message\EntityEnclosingRequest, Guzzle\Http\Message\EntityEnclosingRequestInterface, Guzzle\Http\Message\Request, Guzzle\Http\Message\Response
Namespace: Guzzle\Http\Message
Located at src/Guzzle/Http/Message/MessageInterface.php
Methods summary
public Guzzle\Common\Collection
# getParams( )

Get application and plugin specific parameters set on the message.

Get application and plugin specific parameters set on the message.

Returns

Guzzle\Common\Collection
public Guzzle\Http\Message\MessageInterface
# addHeader( string $header, string $value )

Add a header to an existing collection of headers.

Add a header to an existing collection of headers.

Parameters

$header
Header name to add
$value
Value of the header

Returns

Guzzle\Http\Message\MessageInterface
public Guzzle\Http\Message\MessageInterface
# addHeaders( array $headers )

Add and merge in an array of HTTP headers.

Add and merge in an array of HTTP headers.

Parameters

$headers
Associative array of header data.

Returns

Guzzle\Http\Message\MessageInterface
public Guzzle\Http\Message\Header|null
# getHeader( string $header )

Retrieve an HTTP header by name. Performs a case-insensitive search of all headers.

Retrieve an HTTP header by name. Performs a case-insensitive search of all headers.

Parameters

$header
Header to retrieve.

Returns

Guzzle\Http\Message\Header|null
public Guzzle\Http\Message\Header\HeaderCollection
# getHeaders( )

Get all headers as a collection

Get all headers as a collection

Returns

Guzzle\Http\Message\Header\HeaderCollection
public boolean
# hasHeader( string $header )

Check if the specified header is present.

Check if the specified header is present.

Parameters

$header
The header to check.

Returns

boolean
public Guzzle\Http\Message\MessageInterface
# removeHeader( string $header )

Remove a specific HTTP header.

Remove a specific HTTP header.

Parameters

$header
HTTP header to remove.

Returns

Guzzle\Http\Message\MessageInterface
public Guzzle\Http\Message\MessageInterface
# setHeader( string $header, mixed $value )

Set an HTTP header and overwrite any existing value for the header

Set an HTTP header and overwrite any existing value for the header

Parameters

$header
Name of the header to set.
$value
Value to set.

Returns

Guzzle\Http\Message\MessageInterface
public Guzzle\Http\Message\MessageInterface
# setHeaders( array $headers )

Overwrite all HTTP headers with the supplied array of headers

Overwrite all HTTP headers with the supplied array of headers

Parameters

$headers
Associative array of header data.

Returns

Guzzle\Http\Message\MessageInterface
public array
# getHeaderLines( )

Get an array of message header lines (e.g. ["Host: example.com", ...])

Get an array of message header lines (e.g. ["Host: example.com", ...])

Returns

array
public string
# getRawHeaders( )

Get the raw message headers as a string

Get the raw message headers as a string

Returns

string
Omnipay Fat Zebra / Paystream Gateway Module API Documentation API documentation generated by ApiGen