PHP Class yii\web\Cookie

For more details and usage information on Cookie, see the guide article on handling cookies.
Since: 2.0
Author: Qiang Xue ([email protected])
Inheritance: extends yii\base\Object
ファイルを表示 Open project: yiisoft/yii2 Class Usage Examples

Public Properties

Property Type Description
$domain domain of the cookie
$expire the timestamp at which the cookie expires. This is the server timestamp. Defaults to 0, meaning "until the browser is closed".
$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.
$name name of the cookie
$path the path on the server in which the cookie will be available on. The default is '/'.
$secure whether cookie should be sent via secure connection
$value value of the cookie

Public Methods

Method Description
__toString ( ) : string Magic method to turn a cookie object into a string without having to explicitly access [[value]].

Method Details

__toString() public method

php if (isset($request->cookies['name'])) { $value = (string) $request->cookies['name']; }
public __toString ( ) : string
return string The value of the cookie. If the value property is null, an empty string will be returned.

Property Details

$domain public_oe property

domain of the cookie
public $domain

$expire public_oe property

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

$httpOnly public_oe 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 $httpOnly

$name public_oe property

name of the cookie
public $name

$path public_oe property

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

$secure public_oe property

whether cookie should be sent via secure connection
public $secure

$value public_oe property

value of the cookie
public $value