\Guzzle\Parser\CookieCookieParser

Default Guzzle implementation of a Cookie parser

Summary

Methods
Properties
Constants
parseCookie()
No public properties found
No constants found
getDefaultPath()
$cookieParts
N/A
No private methods found
No private properties found
N/A

Properties

$cookieParts

$cookieParts : array

Type

array — Cookie part names to snake_case array values

Methods

parseCookie()

parseCookie(string  $cookie, string  $host = null, string  $path = null, boolean  $decode = false) : array|boolean

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

Parameters

string $cookie

Cookie header value to parse

string $host

Host of an associated request

string $path

Path of an associated request

boolean $decode

Set to TRUE to urldecode cookie values

Returns

array|boolean —

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()

getDefaultPath(string  $path) : string

Get default cookie path according to RFC 6265 http://tools.ietf.org/search/rfc6265#section-5.1.4 Paths and Path-Match

Parameters

string $path

Request uri-path

Returns

string