Class yii\web\Cookie

All Classes | Properties | Methods

Inheritance	yii\web\Cookie » yii\base\Object
Implements	yii\base\Configurable
Available since version	2.0
Source Code	https://github.com/yiisoft/yii2/blob/master/framework/web/Cookie.php

Cookie represents information related with a cookie, such as $name, $value, $domain, etc.

For more details and usage information on Cookie, see the guide article on handling cookies.

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$domain	string	Domain of the cookie	yii\web\Cookie
$expire	integer	The timestamp at which the cookie expires.	yii\web\Cookie
$httpOnly	boolean	Whether the cookie should be accessible only through the HTTP protocol.	yii\web\Cookie
$name	string	Name of the cookie	yii\web\Cookie
$path	string	The path on the server in which the cookie will be available on.	yii\web\Cookie
$secure	boolean	Whether cookie should be sent via secure connection	yii\web\Cookie
$value	string	Value of the cookie	yii\web\Cookie

Public Methods

Hide inherited methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\Object
__construct()	Constructor.	yii\base\Object
__get()	Returns the value of an object property.	yii\base\Object
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\Object
__set()	Sets value of an object property.	yii\base\Object
__toString()	Magic method to turn a cookie object into a string without having to explicitly access $value.	yii\web\Cookie
__unset()	Sets an object property to null.	yii\base\Object
canGetProperty()	Returns a value indicating whether a property can be read.	yii\base\Object
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\Object
className()	Returns the fully qualified name of this class.	yii\base\Object
hasMethod()	Returns a value indicating whether a method is defined.	yii\base\Object
hasProperty()	Returns a value indicating whether a property is defined.	yii\base\Object
init()	Initializes the object.	yii\base\Object

Property Details

$domain public property

Domain of the cookie

public string $domain = ''

$expire public property

The timestamp at which the cookie expires. This is the server timestamp. Defaults to 0, meaning "until the browser is closed".

public integer $expire = 0

$httpOnly public property

Whether the cookie should be accessible only through the HTTP protocol. By setting this property to true, the cookie will not be accessible by scripting languages, such as JavaScript, which can effectively help to reduce identity theft through XSS attacks.

public boolean $httpOnly = true

$name public property

Name of the cookie

public string $name = null

$path public property

The path on the server in which the cookie will be available on. The default is '/'.

public string $path = '/'

$secure public property

Whether cookie should be sent via secure connection

public boolean $secure = false

$value public property

Value of the cookie

public string $value = ''

Method Details

__toString() public method

Magic method to turn a cookie object into a string without having to explicitly access $value.

if (isset($request->cookies['name'])) {
    $value = (string) $request->cookies['name'];
}

public string __toString ( )
return	string	The value of the cookie. If the value property is null, an empty string will be returned.