Constructor

Optional parameter accepts an associative array of fields and values. Example:

1       $headers =& new HTTP_Headers(array(
2             'Content-Type' => 'text/plain',
3             'Date' => 'Thu, 03 Feb 1994 00:00:00 GMT'
4          ));

• array $headers:

  associative array holding field and value

As string - returns all headers to be used in a HTTP message.

Each header is seperated by a CRLF.

Clone - return a copy.

Date

Accepts a unix timestamp integer to set the date, or returns the date as a unix timestamp if no argument is passed.

• int $time

Get header array

Returns the header value(s) as an array

Example:

1        $cookies = $headers->get_header_array('Set-Cookie');

• return:

  false if $field is not found

• see: HTTP_Headers::get_header_string()

• string $field
• int $limit:

  specifies maximum number of headers to return (null = no limit (default))

Header exists

Example: if ($headers->header_exists('content-type')) { echo 'Oh no!'; }

• string $field

If-Unmodified-Since - see date()

• int $time

Last-Modified - see date()

• int $time

Push header

Add a new field value for the specified header field. previous values for the same field are retained.

Example:

1        $headers->push_header('Accept', 'image/jpeg');

• string $field
• mixed $value:

  array holding values, or string holding a single value

Referer

• string $string

Scan - goes through all headers passing the field and values through the callback function.

If a field has multiple values, each value will be passed seperately (not as an array).

The callback function can be a method from another object (eg. array(&$my_obj, 'my_method')). The callback function should accept 3 arguments:

1. A reference to the headers object (&$headers)
2. An array holding field name and value, array is associative with the following keys: 'field', 'value'
3. An optional parameter which can be used for whatever your function wants :), even though you might not have a use for this parameter, you need to define your function to accept it. (Note: you can have this parameter be passed by reference)

• mixed $callback:

  function name, or array holding an object and the method to call.

• mixed $param:

  passed as the 3rd argument to $callback

Set headers

Add multiple headers and values.

Example:

1        $headers->set_headers(array(
2             'Content-Type' => 'text/plain',
3             'Date' => 'Thu, 03 Feb 1994 00:00:00 GMT',
4             'Accept' => array('text/html', 'text/plain', 'image/*')
5          ));

• array $headers:

  associative array holding field and value