Slim\Http\Cookies Class Reference

Cookie helper. More...

Inheritance diagram for Slim\Http\Cookies:

Collaboration diagram for Slim\Http\Cookies:

Public Member Functions
	__construct (array $cookies=[])
	Create new cookies helper. More...
	setDefaults (array $settings)
	Set default cookie properties. More...
	get ($name, $default=null)
	Get request cookie. More...
	set ($name, $value)
	Set response cookie. More...
	toHeaders ()
	Convert to Set-Cookie headers. More...
	get ($name, $default=null)
	set ($name, $value)
	toHeaders ()

Static Public Member Functions
static	parseHeader ($header)
	Parse HTTP request Cookie: header and extract into a PHP associative array. More...
static	parseHeader ($header)

Protected Member Functions
	toHeader ($name, array $properties)
	Convert to Set-Cookie header. More...

Protected Attributes
	$requestCookies = []
	$responseCookies = []
	$defaults

Detailed Description

Cookie helper.

Definition at line 17 of file Cookies.php.

Constructor & Destructor Documentation

__construct()

Slim\Http\Cookies::__construct

(

array

$cookies = []

)

Create new cookies helper.

Parameters

array

$cookies

Definition at line 54 of file Cookies.php.

    {
        $this->requestCookies = $cookies;
    }

Member Function Documentation

get()

Slim\Http\Cookies::get	(		$name,
			$default = null
	)

Get request cookie.

Parameters

string	$name	Cookie name
mixed	$default	Cookie default value

Returns

mixed Cookie value if present, else default

Implements Slim\Interfaces\Http\CookiesInterface.

Definition at line 77 of file Cookies.php.

    {
        return isset($this->requestCookies[$name]) ? $this->requestCookies[$name] : $default;
    }

References $default, and $name.

parseHeader()

static Slim\Http\Cookies::parseHeader (   $header )

static

Parse HTTP request Cookie: header and extract into a PHP associative array.

Parameters

string

$header

The raw HTTP request Cookie: header

Returns

array Associative array of cookie names and values

Exceptions

InvalidArgumentException

if the cookie data cannot be parsed

Implements Slim\Interfaces\Http\CookiesInterface.

Definition at line 172 of file Cookies.php.

    {
        if (is_array($header) === true) {
            $header = isset($header[0]) ? $header[0] : '';
        }
 
        if (is_string($header) === false) {
            throw new InvalidArgumentException('Cannot parse Cookie data. Header value must be a string.');
        }
 
        $header = rtrim($header, "\r\n");
        $pieces = preg_split('@[;]\s*@', $header);
        $cookies = [];
 
        foreach ($pieces as $cookie) {
            $cookie = explode('=', $cookie, 2);
 
            if (count($cookie) === 2) {
                $key = urldecode($cookie[0]);
                $value = urldecode($cookie[1]);
 
                if (!isset($cookies[$key])) {
                    $cookies[$key] = $value;
                }
            }
        }
 
        return $cookies;
    }

References $header, and $key.

Referenced by Slim\Http\Request\createFromEnvironment().

Here is the caller graph for this function:

set()

Slim\Http\Cookies::set	(		$name,
			$value
	)

Set response cookie.

Parameters

string	$name	Cookie name
string | array	$value	Cookie value, or cookie properties

Implements Slim\Interfaces\Http\CookiesInterface.

Definition at line 88 of file Cookies.php.

    {
        if (!is_array($value)) {
            $value = ['value' => (string)$value];
        }
        $this->responseCookies[$name] = array_replace($this->defaults, $value);
    }

References $name.

setDefaults()

Slim\Http\Cookies::setDefaults

(

array

$settings

)

Set default cookie properties.

Parameters

array

$settings

Definition at line 64 of file Cookies.php.

    {
        $this->defaults = array_replace($this->defaults, $settings);
    }

toHeader()

Slim\Http\Cookies::toHeader (   $name, array  $properties  )

protected

Convert to Set-Cookie header.

Parameters

string	$name	Cookie name
array	$properties	Cookie properties

Returns

string

Definition at line 119 of file Cookies.php.

    {
        $result = urlencode($name) . '=' . urlencode($properties['value']);
 
        if (isset($properties['domain'])) {
            $result .= '; domain=' . $properties['domain'];
        }
 
        if (isset($properties['path'])) {
            $result .= '; path=' . $properties['path'];
        }
 
        if (isset($properties['expires'])) {
            if (is_string($properties['expires'])) {
                $timestamp = strtotime($properties['expires']);
            } else {
                $timestamp = (int)$properties['expires'];
            }
            if ($timestamp !== 0) {
                $result .= '; expires=' . gmdate('D, d-M-Y H:i:s e', $timestamp);
            }
        }
 
        if (isset($properties['secure']) && $properties['secure']) {
            $result .= '; secure';
        }
 
        if (isset($properties['hostonly']) && $properties['hostonly']) {
            $result .= '; HostOnly';
        }
 
        if (isset($properties['httponly']) && $properties['httponly']) {
            $result .= '; HttpOnly';
        }
 
        if (isset($properties['samesite']) && in_array(strtolower($properties['samesite']), ['lax', 'strict'], true)) {
            // While strtolower is needed for correct comparison, the RFC doesn't care about case
            $result .= '; SameSite=' . $properties['samesite'];
        }
 
        return $result;
    }

References $name, $result, and $timestamp.

Referenced by Slim\Http\Cookies\toHeaders().

Here is the caller graph for this function:

toHeaders()

Slim\Http\Cookies::toHeaders

(

)

Convert to Set-Cookie headers.

Returns

string[]

Implements Slim\Interfaces\Http\CookiesInterface.

Definition at line 101 of file Cookies.php.

    {
        $headers = [];
        foreach ($this->responseCookies as $name => $properties) {
            $headers[] = $this->toHeader($name, $properties);
        }
 
        return $headers;
    }

References $name, and Slim\Http\Cookies\toHeader().

Here is the call graph for this function:

Field Documentation

$defaults

Slim\Http\Cookies::$defaults

protected

Initial value:

= [
        'value' => '',
        'domain' => null,
        'hostonly' => null,
        'path' => null,
        'expires' => null,
        'secure' => false,
        'httponly' => false,
        'samesite' => null
    ]

Definition at line 38 of file Cookies.php.

$requestCookies

Slim\Http\Cookies::$requestCookies = []

protected

Definition at line 24 of file Cookies.php.

$responseCookies

Slim\Http\Cookies::$responseCookies = []

protected

Definition at line 31 of file Cookies.php.

---

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

• libs/composer/vendor/slim/slim/Slim/Http/Cookies.php