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 Header

Represents a header and all of the values stored by that header

Guzzle\Http\Message\Header implements Guzzle\Http\Message\Header\HeaderInterface

Direct known subclasses

Guzzle\Http\Message\Header\CacheControl, Guzzle\Http\Message\Header\Link
Namespace: Guzzle\Http\Message
Located at src/Guzzle/Http/Message/Header.php
Methods summary
public
# __construct( string $header, array|string $values = array(), string $glue = ',' )

Parameters

$header
Name of the header
$values
Values of the header as an array or a scalar
$glue
Glue used to combine multiple values into a string
public string
# __toString( )

Convert the header to a string

Convert the header to a string

Returns

string

Implementation of

Guzzle\Http\Message\Header\HeaderInterface::__toString()
public Guzzle\Http\Message\Header
# add( string $value )

Add a value to the list of header values

Add a value to the list of header values

Parameters

$value
Value to add to the header

Returns

Guzzle\Http\Message\Header

Implementation of

Guzzle\Http\Message\Header\HeaderInterface::add()
public string
# getName( )

Get the name of the header

Get the name of the header

Returns

string

Implementation of

Guzzle\Http\Message\Header\HeaderInterface::getName()
public Guzzle\Http\Message\Header
# setName( string $name )

Change the name of the header

Change the name of the header

Parameters

$name
Name to change to

Returns

Guzzle\Http\Message\Header

Implementation of

Guzzle\Http\Message\Header\HeaderInterface::setName()
public Guzzle\Http\Message\Header
# setGlue( string $glue )

Change the glue used to implode the values

Change the glue used to implode the values

Parameters

$glue
Glue used to implode multiple values

Returns

Guzzle\Http\Message\Header

Implementation of

Guzzle\Http\Message\Header\HeaderInterface::setGlue()
public string
# getGlue( )

Get the glue used to implode multiple values into a string

Get the glue used to implode multiple values into a string

Returns

string

Implementation of

Guzzle\Http\Message\Header\HeaderInterface::getGlue()
public Guzzle\Http\Message\Header
# normalize( )

Normalize the header to be a single header with an array of values.

Normalize the header to be a single header with an array of values.

If any values of the header contains the glue string value (e.g. ","), then the value will be exploded into multiple entries in the header.

Returns

Guzzle\Http\Message\Header
public boolean
# hasValue( string $searchValue )

Check if the collection of headers has a particular value

Check if the collection of headers has a particular value

Parameters

$searchValue
Value to search for

Returns

boolean

Implementation of

Guzzle\Http\Message\Header\HeaderInterface::hasValue()
public Guzzle\Http\Message\Header
# removeValue( string $searchValue )

Remove a specific value from the header

Remove a specific value from the header

Parameters

$searchValue
Value to remove

Returns

Guzzle\Http\Message\Header

Implementation of

Guzzle\Http\Message\Header\HeaderInterface::removeValue()
public array
# toArray( )

Get the array representation of an object

Get the array representation of an object

Returns

array

Implementation of

Guzzle\Common\ToArrayInterface::toArray()
public
# count( )

Implementation of

Countable::count()
public
# getIterator( )

Implementation of

IteratorAggregate::getIterator()
public array
# parseParams( )

Parse a header containing ";" separated data into an array of associative arrays representing the header key value pair data of the header. When a parameter does not contain a value, but just contains a key, this function will inject a key with a '' string value.

Parse a header containing ";" separated data into an array of associative arrays representing the header key value pair data of the header. When a parameter does not contain a value, but just contains a key, this function will inject a key with a '' string value.

Returns

array

Implementation of

Guzzle\Http\Message\Header\HeaderInterface::parseParams()
public
# hasExactHeader( $header )

Deprecated

Codecoverageignore

public
# raw( )

Deprecated

Codecoverageignore

protected string
# trimHeader( $str )

Trim a header by removing excess spaces and wrapping quotes

Trim a header by removing excess spaces and wrapping quotes

Parameters

$str

Returns

string
Properties summary
protected array $values
# array()
protected $header
#
protected $glue
#
Omnipay Viva Payments Gateway Module API Documentation API documentation generated by ApiGen