Add cookie header

Adds the relevant cookie header to the request message

• object $request:

  request object

Clear session cookies

Clears cookies which have no expiry time set

Extract cookies - extracts cookies from the HTTP response message.

• object $response

Get option value

• return:

  false if option not found

• string $option:

  option name

Parse Set-Cookie values.

Only use this method if you cannot use extract_cookies(), for example, if you want to use this cookie jar class without using the response class.

• see: Cookie_Jar::extract_cookies()

• array $set_cookies:

  array holding 1 or more "Set-Cookie" header values

• array $param:

  associative array containing 'host', 'path' keys

Save persistent cookies

• string $file:

  file to save to, leave out to use the "file_persistent" option value

Scan

Goes through all cookies passing the values through the callback function.

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 cookie jar object (&$jar)
2. An array holding all cookie parts, array is associative with the following keys: ('domain','path','name','value','expires','secure')
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)

The callback function should return a boolean, a value of 'true' will tell scan() you want it to continue with the rest of the cookies, 'false' will tell scan() to not send any more cookies to your callback function.

Example:

1        // $jar is our cookie jar with some cookies loaded
2        $name_to_delete = 'bla';
3        $jar->scan('delete_name', $name_to_delete);
4     
5        // our callback function defined here
6        function delete_name(&$jar, $cookie_parts, $name_to_delete) {
7            if ($cookie_parts['name'] == $name_to_delete) {
8                $jar->clear($cookie_parts['domain'], $cookie_parts['path'], $cookie_parts['name']);
9            }
10           // must return true to tell scan() to continue with cookies
11           return true;
12       }

• mixed $callback:

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

• mixed $param:

  passed as the 3rd argument to $callback

Set option - set cookie jar options.

RECOGNISED OPTIONS:

  - option name              values(s)          description
  ------------------------------------------------------------------------------
  - file_persistent          string             persistent cookie file location
  - file_session             string             session cookie file location
  - autosave                 bool               save cookies when destroy() is called
 

• mixed $option:

  option name to set, or associative array to replace all existing options

• string $value:

  option value, null to delete option