PhpCookieManager Class Reference

Inheritance diagram for PhpCookieManager:

Public Member Functions
	__construct (CookieScopeInterface $scope, CookieReaderInterface $reader, LoggerInterface $logger=null, HttpHeader $httpHeader=null)
	setSensitiveCookie ($name, $value, SensitiveCookieMetadata $metadata=null)
	setPublicCookie ($name, $value, PublicCookieMetadata $metadata=null)
	getCookie ($name, $default=null)
	deleteCookie ($name, CookieMetadata $metadata=null)

Data Fields
const	MAX_NUM_COOKIES = 50
const	MAX_COOKIE_SIZE = 4096
const	EXPIRE_NOW_TIME = 1
const	EXPIRE_AT_END_OF_SESSION_TIME = 0
const	KEY_EXPIRE_TIME = 'expiry'

Protected Member Functions
	setCookie ($name, $value, array $metadataArray)

Detailed Description

CookieManager helps manage the setting, retrieving and deleting of cookies.

To aid in security, the cookie manager will make it possible for the application to indicate if the cookie contains sensitive data so that extra protection can be added to the contents of the cookie as well as how the browser stores the cookie.

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 25 of file PhpCookieManager.php.

Constructor & Destructor Documentation

__construct()

__construct	(	CookieScopeInterface	$scope,
		CookieReaderInterface	$reader,
		LoggerInterface	$logger = null,
		HttpHeader	$httpHeader = null
	)

Parameters

CookieScopeInterface	$scope
CookieReaderInterface	$reader
LoggerInterface	$logger
HttpHeader	$httpHeader

Definition at line 72 of file PhpCookieManager.php.

      {
        $this->scope = $scope;
        $this->reader = $reader;
        $this->logger = $logger ?: ObjectManager::getInstance()->get(LoggerInterface::class);
        $this->httpHeader = $httpHeader ?: ObjectManager::getInstance()->get(HttpHeader::class);
    }

Member Function Documentation

deleteCookie()

deleteCookie	(		$name,
		CookieMetadata	$metadata = null
	)

Deletes a cookie with the given name.

Parameters

string	$name
CookieMetadata	$metadata

Returns

void

Exceptions

FailureToSendException	If cookie couldn't be sent to the browser. If this exception isn't thrown, there is still no guarantee that the browser received and accepted the request to delete this cookie.
InputException	If the cookie name is empty or contains invalid characters.

Implements CookieManagerInterface.

Definition at line 291 of file PhpCookieManager.php.

    {
        $metadataArray = $this->scope->getCookieMetadata($metadata)->__toArray();

        // explicitly set an expiration time in the metadataArray.
        $metadataArray[PhpCookieManager::KEY_EXPIRE_TIME] = PhpCookieManager::EXPIRE_NOW_TIME;

        $this->checkAbilityToSendCookie($name, '');

        // cookie value set to empty string to delete from the remote client
        $this->setCookie($name, '', $metadataArray);

        // Remove the cookie
        unset($_COOKIE[$name]);
    }

getCookie()

getCookie	(		$name,
			$default = null
	)

Retrieve a value from a cookie.

Parameters

string	$name
string | null	$default	The default value to return if no value could be found for the given $name.

Returns

string|null

Implements CookieReaderInterface.

Definition at line 275 of file PhpCookieManager.php.

    {
        return $this->reader->getCookie($name, $default);
    }

setCookie()

setCookie (   $name,   $value, array  $metadataArray  )

protected

Set a value in a cookie with the given $name $value pairing.

Parameters

string	$name
string	$value
array	$metadataArray

Returns

void

Exceptions

FailureToSendException	If cookie couldn't be sent to the browser.
CookieSizeLimitReachedException	Thrown when the cookie is too big to store any additional data.
InputException	If the cookie name is empty or contains invalid characters.

Definition at line 135 of file PhpCookieManager.php.

    {
        $expire = $this->computeExpirationTime($metadataArray);

        $this->checkAbilityToSendCookie($name, $value);

        $phpSetcookieSuccess = setcookie(
            $name,
            $value,
            $expire,
            $this->extractValue(CookieMetadata::KEY_PATH, $metadataArray, ''),
            $this->extractValue(CookieMetadata::KEY_DOMAIN, $metadataArray, ''),
            $this->extractValue(CookieMetadata::KEY_SECURE, $metadataArray, false),
            $this->extractValue(CookieMetadata::KEY_HTTP_ONLY, $metadataArray, false)
        );

        if (!$phpSetcookieSuccess) {
            $params['name'] = $name;
            if ($value == '') {
                throw new FailureToSendException(
                    new Phrase('The cookie with "%name" cookieName couldn\'t be deleted.', $params)
                );
            } else {
                throw new FailureToSendException(
                    new Phrase('The cookie with "%name" cookieName couldn\'t be sent. Please try again later.', $params)
                );
            }
        }
    }

setPublicCookie()

setPublicCookie	(		$name,
			$value,
		PublicCookieMetadata	$metadata = null
	)

Set a value in a public cookie with the given $name $value pairing.

Public cookies can be accessed by JS. HttpOnly will be set to false by default for these cookies, but can be changed to true.

Parameters

string	$name
string	$value
PublicCookieMetadata	$metadata

Returns

void

Exceptions

FailureToSendException	If cookie couldn't be sent to the browser.
CookieSizeLimitReachedException	Thrown when the cookie is too big to store any additional data.
InputException	If the cookie name is empty or contains invalid characters.

Implements CookieManagerInterface.

Definition at line 118 of file PhpCookieManager.php.

    {
        $metadataArray = $this->scope->getPublicCookieMetadata($metadata)->__toArray();
        $this->setCookie($name, $value, $metadataArray);
    }

setSensitiveCookie()

setSensitiveCookie	(		$name,
			$value,
		SensitiveCookieMetadata	$metadata = null
	)

Set a value in a private cookie with the given $name $value pairing.

Sensitive cookies cannot be accessed by JS. HttpOnly will always be set to true for these cookies.

Parameters

string	$name
string	$value
SensitiveCookieMetadata	$metadata

Returns

void

Exceptions

FailureToSendException	Cookie couldn't be sent to the browser. If this exception isn't thrown, there is still no guarantee that the browser received and accepted the cookie.
CookieSizeLimitReachedException	Thrown when the cookie is too big to store any additional data.
InputException	If the cookie name is empty or contains invalid characters.

Implements CookieManagerInterface.

Definition at line 98 of file PhpCookieManager.php.

    {
        $metadataArray = $this->scope->getSensitiveCookieMetadata($metadata)->__toArray();
        $this->setCookie($name, $value, $metadataArray);
    }

Field Documentation

EXPIRE_AT_END_OF_SESSION_TIME

const EXPIRE_AT_END_OF_SESSION_TIME = 0

Definition at line 35 of file PhpCookieManager.php.

EXPIRE_NOW_TIME

const EXPIRE_NOW_TIME = 1

Definition at line 34 of file PhpCookieManager.php.

KEY_EXPIRE_TIME

const KEY_EXPIRE_TIME = 'expiry'

#- #+ Constant for metadata array key

Definition at line 41 of file PhpCookieManager.php.

MAX_COOKIE_SIZE

const MAX_COOKIE_SIZE = 4096

Definition at line 33 of file PhpCookieManager.php.

MAX_NUM_COOKIES

const MAX_NUM_COOKIES = 50

#+ Constants for Cookie manager. RFC 2109 - Page 15 http://www.ietf.org/rfc/rfc6265.txt

Definition at line 32 of file PhpCookieManager.php.

---

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

• vendor/magento/framework/Stdlib/Cookie/PhpCookieManager.php