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

  • CacheControl
  • HeaderCollection
  • HeaderFactory
  • Link

Interfaces

  • HeaderFactoryInterface
  • HeaderInterface
  • Overview
  • Namespace
  • Class
  • Tree

Interface HeaderInterface

An object that can be represented as an array

Guzzle\Http\Message\Header\HeaderInterface implements Guzzle\Common\ToArrayInterface, Countable, IteratorAggregate

Direct known implementers

Guzzle\Http\Message\Header

Indirect known implementers

Guzzle\Http\Message\Header\CacheControl, Guzzle\Http\Message\Header\Link
Namespace: Guzzle\Http\Message\Header
Located at src/Guzzle/Http/Message/Header/HeaderInterface.php
Methods summary
public string
# __toString( )

Convert the header to a string

Convert the header to a string

Returns

string
public Guzzle\Http\Message\Header\HeaderInterface
# 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\HeaderInterface
public string
# getName( )

Get the name of the header

Get the name of the header

Returns

string
public Guzzle\Http\Message\Header\HeaderInterface
# 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\HeaderInterface
public Guzzle\Http\Message\Header\HeaderInterface
# 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\HeaderInterface
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
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
public Guzzle\Http\Message\Header\HeaderInterface
# 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\HeaderInterface
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
Methods inherited from Guzzle\Common\ToArrayInterface
toArray()
Methods inherited from Countable
count()
Methods inherited from IteratorAggregate
getIterator()
Omnipay Viva Payments Gateway Module API Documentation API documentation generated by ApiGen