Overview
  • Namespace
  • Class

Namespaces

  • Slim
    • Exception
    • Handlers
      • Strategies
    • Http
    • Interfaces
      • Http

Classes

  • Body
  • Cookies
  • Environment
  • Headers
  • Message
  • Request
  • RequestBody
  • Response
  • Stream
  • UploadedFile
  • Uri

Class Cookies

Cookie helper

Slim\Http\Cookies implements Slim\Interfaces\Http\CookiesInterface
Namespace: Slim\Http
Located at Http/Cookies.php

Methods summary

public
# __construct( array $cookies = [] )

Create new cookies helper

Create new cookies helper

Parameters

$cookies
public
# setDefaults( array $settings )

Set default cookie properties

Set default cookie properties

Parameters

$settings
public mixed
# get( string $name, mixed $default = null )

Get request cookie

Get request cookie

Parameters

$name
Cookie name
$default
Cookie default value

Returns

mixed
Cookie value if present, else default

Implementation of

Slim\Interfaces\Http\CookiesInterface::get()
public
# set( string $name, string|array $value )

Set response cookie

Set response cookie

Parameters

$name
Cookie name
$value
Cookie value, or cookie properties

Implementation of

Slim\Interfaces\Http\CookiesInterface::set()
public string[]
# toHeaders( )

Convert to Set-Cookie headers

Convert to Set-Cookie headers

Returns

string[]

Implementation of

Slim\Interfaces\Http\CookiesInterface::toHeaders()
protected string
# toHeader( string $name, array $properties )

Convert to Set-Cookie header

Convert to Set-Cookie header

Parameters

$name
Cookie name
$properties
Cookie properties

Returns

string
public static array
# parseHeader( string $header )

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

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

Parameters

$header
The raw HTTP request Cookie: header

Returns

array
Associative array of cookie names and values

Throws

InvalidArgumentException
if the cookie data cannot be parsed

Implementation of

Slim\Interfaces\Http\CookiesInterface::parseHeader()

Properties summary

protected array $requestCookies

Cookies from HTTP request

Cookies from HTTP request

# []
protected array $responseCookies

Cookies for HTTP response

Cookies for HTTP response

# []
protected array $defaults

Default cookie properties

Default cookie properties

# [ 'value' => '', 'domain' => null, 'hostonly' => null, 'path' => null, 'expires' => null, 'secure' => false, 'httponly' => false ]
API documentation generated by ApiGen