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
    • VivaPayments
      • Message
  • PHP

Classes

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

Interfaces

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

Class AbstractMessage

Abstract HTTP request/response message

Guzzle\Http\Message\AbstractMessage implements Guzzle\Http\Message\MessageInterface

Direct known subclasses

Guzzle\Http\Message\Request, Guzzle\Http\Message\Response

Indirect known subclasses

Guzzle\Http\Message\EntityEnclosingRequest
Abstract
Namespace: Guzzle\Http\Message
Located at src/Guzzle/Http/Message/AbstractMessage.php
Methods summary
public
# __construct( )
public Guzzle\Http\Message\AbstractMessage
# setHeaderFactory( Guzzle\Http\Message\Header\HeaderFactoryInterface $factory )

Set the header factory to use to create headers

Set the header factory to use to create headers

Parameters

$factory

Returns

Guzzle\Http\Message\AbstractMessage
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

Implementation of

Guzzle\Http\Message\MessageInterface::getParams()
public Guzzle\Http\Message\AbstractMessage
# 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\AbstractMessage

Implementation of

Guzzle\Http\Message\MessageInterface::addHeader()
public Guzzle\Http\Message\AbstractMessage
# 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\AbstractMessage

Implementation of

Guzzle\Http\Message\MessageInterface::addHeaders()
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

Implementation of

Guzzle\Http\Message\MessageInterface::getHeader()
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

Implementation of

Guzzle\Http\Message\MessageInterface::getHeaders()
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

Implementation of

Guzzle\Http\Message\MessageInterface::getHeaderLines()
public Guzzle\Http\Message\AbstractMessage
# 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\AbstractMessage

Implementation of

Guzzle\Http\Message\MessageInterface::setHeader()
public Guzzle\Http\Message\AbstractMessage
# 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\AbstractMessage

Implementation of

Guzzle\Http\Message\MessageInterface::setHeaders()
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

Implementation of

Guzzle\Http\Message\MessageInterface::hasHeader()
public Guzzle\Http\Message\AbstractMessage
# removeHeader( string $header )

Remove a specific HTTP header.

Remove a specific HTTP header.

Parameters

$header
HTTP header to remove.

Returns

Guzzle\Http\Message\AbstractMessage

Implementation of

Guzzle\Http\Message\MessageInterface::removeHeader()
public
# getTokenizedHeader( $header, $token = ';' )

Deprecated

Use $message->getHeader()->parseParams()

Codecoverageignore

public
# setTokenizedHeader( $header, $data, $token = ';' )

Deprecated

Codecoverageignore

public
# getCacheControlDirective( $directive )

Deprecated

Codecoverageignore

public
# hasCacheControlDirective( $directive )

Deprecated

Codecoverageignore

public
# addCacheControlDirective( $directive, $value = true )

Deprecated

Codecoverageignore

public
# removeCacheControlDirective( $directive )

Deprecated

Codecoverageignore

Methods inherited from Guzzle\Http\Message\MessageInterface
getRawHeaders()
Properties summary
protected array $headers

HTTP header collection

HTTP header collection

#
protected Guzzle\Http\Message\Header\HeaderFactoryInterface $headerFactory

$headerFactory

$headerFactory

#
protected Guzzle\Common\Collection $params

Custom message parameters that are extendable by plugins

Custom message parameters that are extendable by plugins

#
protected string $protocol

Message protocol

Message protocol

# 'HTTP'
protected string $protocolVersion

HTTP protocol version of the message

HTTP protocol version of the message

# '1.1'
Omnipay Viva Payments Gateway Module API Documentation API documentation generated by ApiGen