Open Journal Systems  3.3.0
Guzzle\Parser\Cookie\CookieParser Class Reference
Inheritance diagram for Guzzle\Parser\Cookie\CookieParser:
Guzzle\Parser\Cookie\CookieParserInterface

Public Member Functions

 parseCookie ($cookie, $host=null, $path=null, $decode=false)
 

Protected Member Functions

 getDefaultPath ($path)
 

Static Protected Attributes

static $cookieParts
 

Detailed Description

Default Guzzle implementation of a Cookie parser

Definition at line 8 of file CookieParser.php.

Member Function Documentation

◆ getDefaultPath()

Guzzle\Parser\Cookie\CookieParser::getDefaultPath (   $path)
protected

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

Parameters
string$pathRequest uri-path
Returns
string

Definition at line 105 of file CookieParser.php.

Referenced by Guzzle\Parser\Cookie\CookieParser\parseCookie().

◆ parseCookie()

Guzzle\Parser\Cookie\CookieParser::parseCookie (   $cookie,
  $host = null,
  $path = null,
  $decode = false 
)

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

Parameters
string$cookieCookie header value to parse
string$hostHost of an associated request
string$pathPath of an associated request
bool$decodeSet to TRUE to urldecode cookie values
Returns
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

Implements Guzzle\Parser\Cookie\CookieParserInterface.

Definition at line 25 of file CookieParser.php.

References Guzzle\Parser\Cookie\CookieParser\$cookieParts, and Guzzle\Parser\Cookie\CookieParser\getDefaultPath().

Field Documentation

◆ $cookieParts

Guzzle\Parser\Cookie\CookieParser::$cookieParts
staticprotected
Initial value:
= 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'
)

Definition at line 11 of file CookieParser.php.

Referenced by Guzzle\Parser\Cookie\CookieParser\parseCookie().


The documentation for this class was generated from the following file: