Class yii\web\Cookie

所有类 | 属性 | 方法

继承	yii\web\Cookie » yii\base\BaseObject
实现	yii\base\Configurable
可用版本自	2.0
源码	https://github.com/yiichina/yii2/blob/api/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.

公共属性

隐藏继承的属性

属性	类型	描述	被定义在
$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

公共方法

隐藏继承的方法

方法	描述	被定义在
__call()	Calls the named method which is not a class method.	yii\base\BaseObject
__construct()	Constructor.	yii\base\BaseObject
__get()	Returns the value of an object property.	yii\base\BaseObject
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\BaseObject
__set()	Sets value of an object property.	yii\base\BaseObject
__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\BaseObject
canGetProperty()	Returns a value indicating whether a property can be read.	yii\base\BaseObject
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\BaseObject
className()	Returns the fully qualified name of this class.	yii\base\BaseObject
hasMethod()	Returns a value indicating whether a method is defined.	yii\base\BaseObject
hasProperty()	Returns a value indicating whether a property is defined.	yii\base\BaseObject
init()	Initializes the object.	yii\base\BaseObject

属性详情

$domain 公共属性

Domain of the cookie

public string $domain = ''

$expire 公共属性

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 公共属性

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 公共属性

Name of the cookie

public string $name = null

$path 公共属性

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

public string $path = '/'

$secure 公共属性

Whether cookie should be sent via secure connection

public boolean $secure = false

$value 公共属性

Value of the cookie

public string $value = ''

方法详情

__toString() 公共方法

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.