CookieParser
in package
implements
CookieParserInterface
Default Guzzle implementation of a Cookie parser
Table of Contents
Interfaces
- CookieParserInterface
- Cookie parser interface
Properties
- $cookieParts : array<string|int, mixed>
Methods
- parseCookie() : array<string|int, mixed>|bool
- Parse a cookie string as set in a Set-Cookie HTTP header and return an associative array of data.
- getDefaultPath() : string
- Get default cookie path according to RFC 6265 http://tools.ietf.org/search/rfc6265#section-5.1.4 Paths and Path-Match
Properties
$cookieParts
protected
static array<string|int, mixed>
$cookieParts
= array('domain' => 'Domain', 'path' => 'Path', 'max_age' => 'Max-Age', 'expires' => 'Expires', 'version' => 'Version', 'secure' => 'Secure', 'port' => 'Port', 'discard' => 'Discard', 'comment' => 'Comment', 'comment_url' => 'Comment-Url', 'http_only' => 'HttpOnly')
Cookie part names to snake_case array values
Methods
parseCookie()
Parse a cookie string as set in a Set-Cookie HTTP header and return an associative array of data.
public
parseCookie(mixed $cookie[, mixed $host = null ][, mixed $path = null ][, mixed $decode = false ]) : array<string|int, mixed>|bool
Parameters
- $cookie : mixed
-
Cookie header value to parse
- $host : mixed = null
-
Host of an associated request
- $path : mixed = null
-
Path of an associated request
- $decode : mixed = false
-
Set to TRUE to urldecode cookie values
Return values
array<string|int, mixed>|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
getDefaultPath()
Get default cookie path according to RFC 6265 http://tools.ietf.org/search/rfc6265#section-5.1.4 Paths and Path-Match
protected
getDefaultPath(string $path) : string
Parameters
- $path : string
-
Request uri-path