NOTE: For Version 3 of the AWS SDK for PHP, please see the V3 User Guide and V3 API Reference.

# 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 Guzzle/Http/Message/Header.php

## Methods summary

- `public` `__construct ( string $header, array|string $values = array(), string $glue = ',' )`
- `public` `__toString ( )`

  Convert the header to a string

- `public` `add ( string $value )`

  Add a value to the list of header values

- `public` `getName ( )`

  Get the name of the header

- `public` `setName ( string $name )`

  Change the name of the header

- `public` `setGlue ( string $glue )`

  Change the glue used to implode the values

- `public` `getGlue ( )`

  Get the glue used to implode multiple values into a string

- `public` `normalize ( )`

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

- `public` `hasValue ( string $searchValue )`

  Check if the collection of headers has a particular value

- `public` `removeValue ( string $searchValue )`

  Remove a specific value from the header

- `public` `toArray ( )`

  Get the array representation of an object

- `public` `count ( )`
- `public` `getIterator ( )`
- `public` `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.

- `protected` `trimHeader ( mixed $str )`

  Trim a header by removing excess spaces and wrapping quotes

## Methods detail

# `public`
`__construct( string $header, array|string $values = array(), string $glue = ',' )`

#### Parameters

$header
  `string`
  $header Name of the header
$values
  `array|string`
  $values Values of the header as an array or a scalar
$glue
  `string`
  $glue Glue used to combine multiple values into a string

# `public string`
`__toString( )`

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

#### Parameters

$value
  `string`
  $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

#### Returns

`string`

#### Implementation of

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

Change the name of the header

#### Parameters

$name
  `string`
  $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

#### Parameters

$glue
  `string`
  $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

#### 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.

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

#### Parameters

$searchValue
  `string`
  $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

#### Parameters

$searchValue
  `string`
  $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

#### 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.

#### Returns

`array`

#### Implementation of

`Guzzle\Http\Message\Header\HeaderInterface::parseParams()`
# `protected string`
`trimHeader( mixed $str )`

Trim a header by removing excess spaces and wrapping quotes

#### Parameters

$str
  `mixed`
  $str

#### Returns

`string`

### Magic methods summary

## Properties summary

`protected array` | $values | #
`protected mixed` | $header | #
`protected mixed` | $glue | #