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

Public Member Functions

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

Detailed Description

Cookie parser interface

Definition at line 8 of file CookieParserInterface.php.

Member Function Documentation

◆ parseCookie()

Guzzle\Parser\Cookie\CookieParserInterface::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

Implemented in Guzzle\Parser\Cookie\CookieParser.


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