Cookie

Cookie-based session token transport.

Handles extracting and persisting tokens via HTTP cookies.

Properties

cookieName

The name of the cookie used for session transport.

private string $cookieName

options

private array $options

Methods

__construct

CookieTransport constructor.

public __construct(array $cookieOptions): void

Parameters

Parameter	Type	Description
$cookieOptions	array

extractToken

Extracts the authentication token from the cookie.

public extractToken(): ?string

Retrieves the value of the cookie specified by $this->cookieName from the $_COOKIE superglobal. Returns the token as a string if the cookie exists, or null if it does not.

persistToken

Persists the authentication token in a cookie with the specified options.

public persistToken(Response $response, string $token, array $options): void

Parameters

Parameter	Type	Description
$response	Response
$token	string	the authentication token to be stored in the cookie
$options	array

clearToken

Clears the authentication token by removing the corresponding cookie.

public clearToken(Response $response, array $options): void

Parameters

Parameter	Type	Description
$response	Response
$options	array

---

Generated by Hazaar API Doc Generator on Sun, 01 Mar 2026 09:22:26 +0000