Documentation

Cookie extends BaseConfig
in package

Table of Contents

Properties

$domain  : string
-------------------------------------------------------------------------- Cookie Domain --------------------------------------------------------------------------
$expires  : DateTimeInterface|int|string
-------------------------------------------------------------------------- Cookie Expires Timestamp --------------------------------------------------------------------------
$httponly  : bool
-------------------------------------------------------------------------- Cookie HTTPOnly --------------------------------------------------------------------------
$path  : string
-------------------------------------------------------------------------- Cookie Path --------------------------------------------------------------------------
$prefix  : string
-------------------------------------------------------------------------- Cookie Prefix --------------------------------------------------------------------------
$raw  : bool
-------------------------------------------------------------------------- Cookie Raw --------------------------------------------------------------------------
$samesite  : ""|"Lax"|"None"|"Strict"
-------------------------------------------------------------------------- Cookie SameSite --------------------------------------------------------------------------
$secure  : bool
-------------------------------------------------------------------------- Cookie Secure --------------------------------------------------------------------------

Properties

$domain

-------------------------------------------------------------------------- Cookie Domain --------------------------------------------------------------------------

public string $domain = ''

Set to .your-domain.com for site-wide cookies.

$expires

-------------------------------------------------------------------------- Cookie Expires Timestamp --------------------------------------------------------------------------

public DateTimeInterface|int|string $expires = 0

Default expires timestamp for cookies. Setting this to 0 will mean the cookie will not have the Expires attribute and will behave as a session cookie.

$httponly

-------------------------------------------------------------------------- Cookie HTTPOnly --------------------------------------------------------------------------

public bool $httponly = true

Cookie will only be accessible via HTTP(S) (no JavaScript).

$path

-------------------------------------------------------------------------- Cookie Path --------------------------------------------------------------------------

public string $path = '/'

Typically will be a forward slash.

$prefix

-------------------------------------------------------------------------- Cookie Prefix --------------------------------------------------------------------------

public string $prefix = ''

Set a cookie name prefix if you need to avoid collisions.

$raw

-------------------------------------------------------------------------- Cookie Raw --------------------------------------------------------------------------

public bool $raw = false

This flag allows setting a "raw" cookie, i.e., its name and value are not URL encoded using rawurlencode().

If this is set to true, cookie names should be compliant of RFC 2616's list of allowed characters.

Tags
see
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#attributes
see
https://tools.ietf.org/html/rfc2616#section-2.2

$samesite

-------------------------------------------------------------------------- Cookie SameSite --------------------------------------------------------------------------

public ""|"Lax"|"None"|"Strict" $samesite = 'Lax'

Configure cookie SameSite setting. Allowed values are:

  • None
  • Lax
  • Strict
  • ''

Alternatively, you can use the constant names:

  • Cookie::SAMESITE_NONE
  • Cookie::SAMESITE_LAX
  • Cookie::SAMESITE_STRICT

Defaults to Lax for compatibility with modern browsers. Setting '' (empty string) means default SameSite attribute set by browsers (Lax) will be set on cookies. If set to None, $secure must also be set.

$secure

-------------------------------------------------------------------------- Cookie Secure --------------------------------------------------------------------------

public bool $secure = false

Cookie will only be set if a secure HTTPS connection exists.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results