Inheritance diagram for TYPO3\CMS\Core\Http\SetCookieService:

Public Member Functions
	setSessionCookie (UserSession $userSession, NormalizedParams $normalizedParams)

	isSetSessionCookie (UserSession $userSession, bool $forceSetCookie=false)

	isRefreshTimeBasedCookie (UserSession $userSession)

bool	isCookieSet (?ServerRequestInterface $request, ?UserSession $userSession)

	removeCookie (NormalizedParams $normalizedParams)

Static Public Member Functions
static	create (string $name, string $type)

Protected Attributes
readonly LoggerInterface	$logger

Private Member Functions
	__construct (protected readonly string $name, protected readonly string $loginType, protected readonly int $lifetime)

Detailed Description

Class that is used to apply a SetCookie to a response, based on the current (authenticated or stateful) session, in order to use the same session across multiple HTTP requests.

Definition at line 32 of file SetCookieService.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\Http\SetCookieService::__construct	(	protected readonly string	$name,
		protected readonly string	$loginType,
		protected readonly int	$lifetime
	)

private

Parameters

$lifetime ‪Lifetime for the session-cookie (on the client)

If >0: permanent cookie with given lifetime If 0: session-cookie Session-cookie means the browser will remove it when the browser is closed.

Definition at line 43 of file SetCookieService.php.

Member Function Documentation

◆ create()

static TYPO3\CMS\Core\Http\SetCookieService::create	(	string	$name,
		string	$type
	)

static

Definition at line 37 of file SetCookieService.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\appendCookieToResponse(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\isCookieSet(), TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication\isRefreshTimeBasedCookie(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\isRefreshTimeBasedCookie(), TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication\isSetSessionCookie(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\isSetSessionCookie(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\shallSetSessionCookie().

◆ isCookieSet()

bool TYPO3\CMS\Core\Http\SetCookieService::isCookieSet	(	?ServerRequestInterface	$request,
		?UserSession	$userSession
	)

Returns whether this request is going to set a cookie or a cookie was already found in the system

Returns: ‪bool Returns TRUE if a cookie is set

Definition at line 136 of file SetCookieService.php.

References TYPO3\CMS\Core\Http\SetCookieService\isRefreshTimeBasedCookie(), and TYPO3\CMS\Core\Http\SetCookieService\isSetSessionCookie().

◆ isRefreshTimeBasedCookie()

TYPO3\CMS\Core\Http\SetCookieService::isRefreshTimeBasedCookie ( UserSession $userSession )

Determine whether a non-session cookie needs to be set (lifetime>0)

Definition at line 122 of file SetCookieService.php.

References TYPO3\CMS\Core\Session\UserSession\isPermanent().

Referenced by TYPO3\CMS\Core\Http\SetCookieService\isCookieSet(), and TYPO3\CMS\Core\Http\SetCookieService\setSessionCookie().

◆ isSetSessionCookie()

TYPO3\CMS\Core\Http\SetCookieService::isSetSessionCookie	(	UserSession	$userSession,
		bool	$forceSetCookie = `false`
	)

Determine whether a session cookie needs to be set (lifetime=0)

Definition at line 108 of file SetCookieService.php.

References TYPO3\CMS\Core\Session\UserSession\isNew(), and TYPO3\CMS\Core\Session\UserSession\isPermanent().

Referenced by TYPO3\CMS\Core\Http\SetCookieService\isCookieSet(), and TYPO3\CMS\Core\Http\SetCookieService\setSessionCookie().

◆ removeCookie()

TYPO3\CMS\Core\Http\SetCookieService::removeCookie ( NormalizedParams $normalizedParams )

Empty / unset the cookie

Definition at line 151 of file SetCookieService.php.

References TYPO3\CMS\Core\Http\CookieScopeTrait\getCookieScope().

◆ setSessionCookie()

TYPO3\CMS\Core\Http\SetCookieService::setSessionCookie	(	UserSession	$userSession,
		NormalizedParams	$normalizedParams
	)

Sets the session cookie for the current disposal.

Definition at line 61 of file SetCookieService.php.

References $GLOBALS, TYPO3\CMS\Core\Http\CookieScopeTrait\getCookieScope(), TYPO3\CMS\Core\Session\UserSession\getIdentifier(), TYPO3\CMS\Core\Session\UserSession\getJwt(), TYPO3\CMS\Core\Http\NormalizedParams\isHttps(), TYPO3\CMS\Core\Http\SetCookieService\isRefreshTimeBasedCookie(), TYPO3\CMS\Core\Http\SetCookieService\isSetSessionCookie(), and TYPO3\CMS\Core\Http\CookieHeaderTrait\sanitizeSameSiteCookieValue().

Member Data Documentation

◆ $logger

readonly LoggerInterface TYPO3\CMS\Core\Http\SetCookieService::$logger

protected

Definition at line 35 of file SetCookieService.php.

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions