Interface Guzzle\Parser\Cookie\CookieParserInterface

Implemented byGuzzle\Parser\Cookie\CookieParser

Cookie parser interface

Public Methods

Hide inherited methods

MethodDescriptionDefined By
parseCookie() Parse a cookie string as set in a Set-Cookie HTTP header and return an associative array of data. Guzzle\Parser\Cookie\CookieParserInterface

Method Details

parseCookie() public abstract method

Parse a cookie string as set in a Set-Cookie HTTP header and return an associative array of data.

public abstract array|bool parseCookie ( $cookie, $host null, $path null, $decode false )
$cookie string

Cookie header value to parse

$host string

Host of an associated request

$path string

Path of an associated request

$decode bool

Set to TRUE to urldecode cookie values

return array|bool

Returns FALSE on failure or returns an array of arrays, with each of the sub arrays including:

- domain  (string) - Domain of the cookie
- path    (string) - Path of the cookie
- cookies (array)  - Associative array of cookie names and values
- max_age (int)    - Lifetime of the cookie in seconds
- version (int)    - Version of the cookie specification. RFC 2965 is 1
- secure  (bool)   - Whether or not this is a secure cookie
- discard (bool)   - Whether or not this is a discardable cookie
- custom (string)  - Custom cookie data array
- comment (string) - How the cookie is intended to be used
- comment_url (str)- URL that contains info on how it will be used
- port (array|str) - Array of ports or null
- http_only (bool) - HTTP only cookie