Class GuzzleHttp\Cookie\SetCookie


					
	public
					static

fromString(string $cookie): self

Create a new SetCookie object from a string.

Parameters

$cookie

Set-Cookie header string

#


					
	public

__construct(array $data = [])

Parameters

$data

Array of cookie data provided by a Cookie parser

#


					
	public

__toString(): string

#


					
	public

toArray(): array

#


					
	public

getName(): ?string

Get the cookie name.

#


					
	public

setName(string $name): void

Set the cookie name.

Parameters

$name

Cookie name

#


					
	public

getValue(): ?string

Get the cookie value.

#


					
	public

setValue(string $value): void

Set the cookie value.

Parameters

$value

Cookie value

#


					
	public

getDomain(): ?string

Get the domain.

#


					
	public

setDomain(string|null $domain): void

Set the domain of the cookie.

Parameters

$domain

Domain of the cookie

#


					
	public

getHostOnly(): bool

Get whether this cookie is scoped to the origin host only.

#


					
	public

setHostOnly(bool $hostOnly): void

Set whether this cookie is scoped to the origin host only.

Parameters

$hostOnly

Set to true for host-only cookies

#


					
	public

getPath(): string

Get the path.

#


					
	public

setPath(string $path): void

Set the path of the cookie.

Parameters

$path

Path of the cookie

#


					
	public

getMaxAge(): ?int

Maximum lifetime of the cookie in seconds.

#


					
	public

setMaxAge(int|null $maxAge): void

Set the max-age of the cookie.

Parameters

$maxAge

Max age of the cookie in seconds

#


					
	public

getExpires(): ?int

The UNIX timestamp when the cookie Expires.

#


					
	public

setExpires(int|string|null $timestamp): void

Set the unix timestamp for which the cookie will expire.

Parameters

$timestamp

Unix timestamp or any English textual datetime description.

#


					
	public

getSecure(): bool

Get whether or not this is a secure cookie.

#


					
	public

setSecure(bool $secure): void

Set whether or not the cookie is secure.

Parameters

$secure

Set to true or false if secure

#


					
	public

getDiscard(): bool

Get whether or not this is a session cookie.

#


					
	public

setDiscard(bool $discard): void

Set whether or not this is a session cookie.

Parameters

$discard

Set to true or false if this is a session cookie

#


					
	public

getHttpOnly(): bool

Get whether or not this is an HTTP only cookie.

#


					
	public

setHttpOnly(bool $httpOnly): void

Set whether or not this is an HTTP only cookie.

Parameters

$httpOnly

Set to true or false if this is HTTP only

#


					
	public

matchesPath(string $requestPath): bool

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.

Parameters

$requestPath

Path to check against

#


					
	public

matchesDomain(string $domain): bool

Check if the cookie matches a domain value.

Parameters

$domain

Domain to check against

#


					
	public

isExpired(): bool

Check if the cookie is expired.

#


					
	public

validate(): string|true

Check if the cookie is valid according to RFC 6265.

Returns

Returns true if valid or an error message if invalid

#

Namespaces

Classes

Interfaces

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Returns