1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
<?php
/**
* @link http://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
namespace yii\web;
/**
* Cookie represents information related with a cookie, such as [[name]], [[value]], [[domain]], etc.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/
class Cookie extends \yii\base\Object
{
/**
* @var string name of the cookie
*/
public $name;
/**
* @var string value of the cookie
*/
public $value = '';
/**
* @var string domain of the cookie
*/
public $domain = '';
/**
* @var integer the timestamp at which the cookie expires. This is the server timestamp.
* Defaults to 0, meaning "until the browser is closed".
*/
public $expire = 0;
/**
* @var string the path on the server in which the cookie will be available on. The default is '/'.
*/
public $path = '/';
/**
* @var boolean whether cookie should be sent via secure connection
*/
public $secure = false;
/**
* @var boolean 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 = false;
/**
* 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'];
* }
* ~~~
*
* @return string The value of the cookie. If the value property is null, an empty string will be returned.
*/
public function __toString()
{
return (string)$this->value;
}
}