namespace GuzzleHttp\Cookie;
private static $defaults = [
/** @var array Cookie data */
* Create a new SetCookie object from a string
* @param string $cookie Set-Cookie header string
public static function fromString($cookie)
// Create the default return array
// Explode the cookie string using a series of semicolons
$pieces = array_filter(array_map('trim', explode(';', $cookie)));
// The name of the cookie (first kvp) must exist and include an equal sign.
if (empty($pieces[0]) || !strpos($pieces[0], '=')) {
// Add the cookie pieces into the parsed data array
foreach ($pieces as $part) {
$cookieParts = explode('=', $part, 2);
$key = trim($cookieParts[0]);
$value = isset($cookieParts[1])
? trim($cookieParts[1], " \n\r\t\0\x0B")
// Only check for non-cookies when cookies have been found
if (empty($data['Name'])) {
foreach (array_keys(self::$defaults) as $search) {
if (!strcasecmp($search, $key)) {
* @param array $data Array of cookie data provided by a Cookie parser
public function __construct(array $data = [])
$this->data = array_replace(self::$defaults, $data);
// Extract the Expires value and turn it into a UNIX timestamp if needed
if (!$this->getExpires() && $this->getMaxAge()) {
// Calculate the Expires date
$this->setExpires(time() + $this->getMaxAge());
} elseif ($this->getExpires() && !is_numeric($this->getExpires())) {
$this->setExpires($this->getExpires());
public function __toString()
$str = $this->data['Name'] . '=' . $this->data['Value'] . '; ';
foreach ($this->data as $k => $v) {
if ($k !== 'Name' && $k !== 'Value' && $v !== null && $v !== false) {
$str .= 'Expires=' . gmdate('D, d M Y H:i:s \G\M\T', $v) . '; ';
$str .= ($v === true ? $k : "{$k}={$v}") . '; ';
return rtrim($str, '; ');
public function toArray()
public function getName()
return $this->data['Name'];
* @param string $name Cookie name
public function setName($name)
$this->data['Name'] = $name;
public function getValue()
return $this->data['Value'];
* @param string $value Cookie value
public function setValue($value)
$this->data['Value'] = $value;
public function getDomain()
return $this->data['Domain'];
* Set the domain of the cookie
public function setDomain($domain)
$this->data['Domain'] = $domain;
public function getPath()
return $this->data['Path'];
* Set the path of the cookie
* @param string $path Path of the cookie
public function setPath($path)
$this->data['Path'] = $path;
* Maximum lifetime of the cookie in seconds
public function getMaxAge()
return $this->data['Max-Age'];
* Set the max-age of the cookie
* @param int $maxAge Max age of the cookie in seconds
public function setMaxAge($maxAge)
$this->data['Max-Age'] = $maxAge;
* The UNIX timestamp when the cookie Expires
public function getExpires()
return $this->data['Expires'];
* Set the unix timestamp for which the cookie will expire
* @param int $timestamp Unix timestamp
public function setExpires($timestamp)
$this->data['Expires'] = is_numeric($timestamp)
* Get whether or not this is a secure cookie
public function getSecure()
return $this->data['Secure'];
* Set whether or not the cookie is secure
* @param bool $secure Set to true or false if secure
public function setSecure($secure)
$this->data['Secure'] = $secure;
* Get whether or not this is a session cookie
public function getDiscard()
return $this->data['Discard'];
* Set whether or not this is a session cookie
* @param bool $discard Set to true or false if this is a session cookie
public function setDiscard($discard)
$this->data['Discard'] = $discard;
* Get whether or not this is an HTTP only cookie
public function getHttpOnly()
return $this->data['HttpOnly'];
* Set whether or not this is an HTTP only cookie
* @param bool $httpOnly Set to true or false if this is HTTP only
public function setHttpOnly($httpOnly)
$this->data['HttpOnly'] = $httpOnly;
* Check if the cookie matches a path value.
* A request-path path-matches a given cookie-path if at least one of
* the following conditions holds:
* - The cookie-path and the request-path are identical.
* - The cookie-path is a prefix of the request-path, and the last
* character of the cookie-path is %x2F ("/").
* - The cookie-path is a prefix of the request-path, and the first
* character of the request-path that is not included in the cookie-
* path is a %x2F ("/") character.
* @param string $requestPath Path to check against
public function matchesPath($requestPath)
$cookiePath = $this->getPath();
// Match on exact matches or when path is the default empty "/"
if ($cookiePath === '/' || $cookiePath == $requestPath) {
// Ensure that the cookie-path is a prefix of the request path.
if (0 !== strpos($requestPath, $cookiePath)) {
// Match if the last character of the cookie-path is "/"
if (substr($cookiePath, -1, 1) === '/') {
// Match if the first character not included in cookie path is "/"
return substr($requestPath, strlen($cookiePath), 1) === '/';
* Check if the cookie matches a domain value
* @param string $domain Domain to check against
public function matchesDomain($domain)
// Remove the leading '.' as per spec in RFC 6265.
// http://tools.ietf.org/html/rfc6265#section-5.2.3
$cookieDomain = ltrim($this->getDomain(), '.');
// Domain not set or exact match.
if (!$cookieDomain || !strcasecmp($domain, $cookieDomain)) {
// Matching the subdomain according to RFC 6265.
// http://tools.ietf.org/html/rfc6265#section-5.1.3
if (filter_var($domain, FILTER_VALIDATE_IP)) {
return (bool) preg_match('/\.' . preg_quote($cookieDomain, '/') . '$/', $domain);
* Check if the cookie is expired
public function isExpired()
return $this->getExpires() !== null && time() > $this->getExpires();
* Check if the cookie is valid according to RFC 6265
* @return bool|string Returns true if valid or an error message if invalid
public function validate()
// Names must not be empty, but can be 0
$name = $this->getName();
if (empty($name) && !is_numeric($name)) {
return 'The cookie name must not be empty';
// Check if any of the invalid characters are present in the cookie name
'/[\x00-\x20\x22\x28-\x29\x2c\x2f\x3a-\x40\x5c\x7b\x7d\x7f]/',
return 'Cookie name must not contain invalid characters: ASCII '
. 'Control characters (0-31;127), space, tab and the '
. 'following characters: ()<>@,;:\"/?={}';
// Value must not be empty, but can be 0
$value = $this->getValue();
if (empty($value) && !is_numeric($value)) {
return 'The cookie value must not be empty';
// Domains must not be empty, but can be 0
// A "0" is not a valid internet domain, but may be used as server name
$domain = $this->getDomain();
if (empty($domain) && !is_numeric($domain)) {
return 'The cookie domain must not be empty';
It is recommended that you Edit text format, this type of Fix handles quite a lot in one request
