CookieCollection.php 7.06 KB
Newer Older
Qiang Xue committed
1 2 3
<?php
/**
 * @link http://www.yiiframework.com/
Qiang Xue committed
4
 * @copyright Copyright (c) 2008 Yii Software LLC
Qiang Xue committed
5 6 7 8 9
 * @license http://www.yiiframework.com/license/
 */

namespace yii\web;

Qiang Xue committed
10
use Yii;
Qiang Xue committed
11
use yii\base\DictionaryIterator;
Qiang Xue committed
12
use yii\helpers\SecurityHelper;
Qiang Xue committed
13 14

/**
15
 * CookieCollection maintains the cookies available in the current request.
Qiang Xue committed
16
 *
17
 * @property integer $count the number of cookies in the collection
Qiang Xue committed
18 19 20 21 22 23
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
class CookieCollection extends \yii\base\Object implements \IteratorAggregate, \ArrayAccess, \Countable
{
Qiang Xue committed
24 25 26 27 28
	/**
	 * @var boolean whether to enable cookie validation. By setting this property to true,
	 * if a cookie is tampered on the client side, it will be ignored when received on the server side.
	 */
	public $enableValidation = true;
Qiang Xue committed
29 30 31 32
	/**
	 * @var string the secret key used for cookie validation. If not set, a random key will be generated and used.
	 */
	public $validationKey;
Qiang Xue committed
33

Qiang Xue committed
34
	/**
35
	 * @var Cookie[] the cookies in this collection (indexed by the cookie names)
Qiang Xue committed
36 37 38 39 40 41 42
	 */
	private $_cookies = array();

	/**
	 * Constructor.
	 * @param array $config name-value pairs that will be used to initialize the object properties
	 */
Qiang Xue committed
43
	public function __construct($config = array())
Qiang Xue committed
44 45
	{
		parent::__construct($config);
Qiang Xue committed
46
		$this->_cookies = $this->loadCookies();
Qiang Xue committed
47 48 49
	}

	/**
50
	 * Returns an iterator for traversing the cookies in the collection.
Qiang Xue committed
51
	 * This method is required by the SPL interface `IteratorAggregate`.
52 53
	 * It will be implicitly called when you use `foreach` to traverse the collection.
	 * @return DictionaryIterator an iterator for traversing the cookies in the collection.
Qiang Xue committed
54 55 56 57 58 59 60
	 */
	public function getIterator()
	{
		return new DictionaryIterator($this->_cookies);
	}

	/**
61
	 * Returns the number of cookies in the collection.
Qiang Xue committed
62
	 * This method is required by the SPL `Countable` interface.
63 64
	 * It will be implicitly called when you use `count($collection)`.
	 * @return integer the number of cookies in the collection.
Qiang Xue committed
65 66 67 68 69 70 71
	 */
	public function count()
	{
		return $this->getCount();
	}

	/**
72 73
	 * Returns the number of cookies in the collection.
	 * @return integer the number of cookies in the collection.
Qiang Xue committed
74 75 76 77 78 79 80
	 */
	public function getCount()
	{
		return count($this->_cookies);
	}

	/**
81 82 83 84
	 * Returns the cookie with the specified name.
	 * @param string $name the cookie name
	 * @return Cookie the cookie with the specified name. Null if the named cookie does not exist.
	 * @see getValue()
Qiang Xue committed
85
	 */
86
	public function get($name)
Qiang Xue committed
87
	{
88
		return isset($this->_cookies[$name]) ? $this->_cookies[$name] : null;
Qiang Xue committed
89 90 91
	}

	/**
92 93 94 95 96
	 * Returns the value of the named cookie.
	 * @param string $name the cookie name
	 * @param mixed $defaultValue the value that should be returned when the named cookie does not exist.
	 * @return mixed the value of the named cookie.
	 * @see get()
Qiang Xue committed
97
	 */
Qiang Xue committed
98
	public function getValue($name, $defaultValue = null)
Qiang Xue committed
99
	{
100
		return isset($this->_cookies[$name]) ? $this->_cookies[$name]->value : $defaultValue;
Qiang Xue committed
101 102 103
	}

	/**
104 105 106
	 * Adds a cookie to the collection.
	 * If there is already a cookie with the same name in the collection, it will be removed first.
	 * @param Cookie $cookie the cookie to be added
Qiang Xue committed
107
	 */
108
	public function add($cookie)
Qiang Xue committed
109 110
	{
		if (isset($this->_cookies[$cookie->name])) {
111
			$c = $this->_cookies[$cookie->name];
Qiang Xue committed
112
			setcookie($c->name, '', 0, $c->path, $c->domain, $c->secure, $c->httponly);
Qiang Xue committed
113
		}
Qiang Xue committed
114 115 116

		$value = $cookie->value;
		if ($this->enableValidation) {
Qiang Xue committed
117 118 119 120 121 122
			if ($this->validationKey === null) {
				$key = SecurityHelper::getSecretKey(__CLASS__ . '/' . Yii::$app->id);
			} else {
				$key = $this->validationKey;
			}
			$value = SecurityHelper::hashData(serialize($value), $key);
Qiang Xue committed
123 124
		}

Qiang Xue committed
125
		setcookie($cookie->name, $value, $cookie->expire, $cookie->path, $cookie->domain, $cookie->secure, $cookie->httponly);
Qiang Xue committed
126 127 128 129
		$this->_cookies[$cookie->name] = $cookie;
	}

	/**
130 131
	 * Removes a cookie from the collection.
	 * @param Cookie|string $cookie the cookie object or the name of the cookie to be removed.
Qiang Xue committed
132
	 */
133
	public function remove($cookie)
Qiang Xue committed
134
	{
135 136 137 138
		if (is_string($cookie) && isset($this->_cookies[$cookie])) {
			$cookie = $this->_cookies[$cookie];
		}
		if ($cookie instanceof Cookie) {
Qiang Xue committed
139
			setcookie($cookie->name, '', 0, $cookie->path, $cookie->domain, $cookie->secure, $cookie->httponly);
140 141
			unset($this->_cookies[$cookie->name]);
		}
Qiang Xue committed
142 143 144
	}

	/**
145
	 * Removes all cookies.
Qiang Xue committed
146
	 */
147
	public function removeAll()
Qiang Xue committed
148
	{
149
		foreach ($this->_cookies as $cookie) {
Qiang Xue committed
150
			setcookie($cookie->name, '', 0, $cookie->path, $cookie->domain, $cookie->secure, $cookie->httponly);
Qiang Xue committed
151
		}
152
		$this->_cookies = array();
Qiang Xue committed
153 154 155
	}

	/**
156 157 158 159
	 * Returns the collection as a PHP array.
	 * @return array the array representation of the collection.
	 * The array keys are cookie names, and the array values are the corresponding
	 * cookie objects.
Qiang Xue committed
160 161 162 163 164 165 166
	 */
	public function toArray()
	{
		return $this->_cookies;
	}

	/**
167
	 * Returns whether there is a cookie with the specified name.
Qiang Xue committed
168
	 * This method is required by the SPL interface `ArrayAccess`.
169 170 171
	 * It is implicitly called when you use something like `isset($collection[$name])`.
	 * @param string $name the cookie name
	 * @return boolean whether the named cookie exists
Qiang Xue committed
172
	 */
173
	public function offsetExists($name)
Qiang Xue committed
174
	{
175
		return isset($this->_cookies[$name]);
Qiang Xue committed
176 177 178
	}

	/**
179
	 * Returns the cookie with the specified name.
Qiang Xue committed
180
	 * This method is required by the SPL interface `ArrayAccess`.
181 182 183 184
	 * It is implicitly called when you use something like `$cookie = $collection[$name];`.
	 * This is equivalent to [[get()]].
	 * @param string $name the cookie name
	 * @return Cookie the cookie with the specified name, null if the named cookie does not exist.
Qiang Xue committed
185
	 */
186
	public function offsetGet($name)
Qiang Xue committed
187
	{
188
		return $this->get($name);
Qiang Xue committed
189 190 191
	}

	/**
192
	 * Adds the cookie to the collection.
Qiang Xue committed
193
	 * This method is required by the SPL interface `ArrayAccess`.
194 195 196 197
	 * It is implicitly called when you use something like `$collection[$name] = $cookie;`.
	 * This is equivalent to [[add()]].
	 * @param string $name the cookie name
	 * @param Cookie $cookie the cookie to be added
Qiang Xue committed
198
	 */
199
	public function offsetSet($name, $cookie)
Qiang Xue committed
200
	{
201
		$this->add($cookie);
Qiang Xue committed
202 203 204
	}

	/**
205
	 * Removes the named cookie.
Qiang Xue committed
206
	 * This method is required by the SPL interface `ArrayAccess`.
207 208 209
	 * It is implicitly called when you use something like `unset($collection[$name])`.
	 * This is equivalent to [[remove()]].
	 * @param string $name the cookie name
Qiang Xue committed
210
	 */
211
	public function offsetUnset($name)
Qiang Xue committed
212
	{
213
		$this->remove($name);
Qiang Xue committed
214
	}
Qiang Xue committed
215 216 217 218 219 220 221 222 223

	/**
	 * Returns the current cookies in terms of [[Cookie]] objects.
	 * @return Cookie[] list of current cookies
	 */
	protected function loadCookies()
	{
		$cookies = array();
		if ($this->enableValidation) {
Qiang Xue committed
224 225 226 227 228
			if ($this->validationKey === null) {
				$key = SecurityHelper::getSecretKey(__CLASS__ . '/' . Yii::$app->id);
			} else {
				$key = $this->validationKey;
			}
Qiang Xue committed
229
			foreach ($_COOKIE as $name => $value) {
Qiang Xue committed
230
				if (is_string($value) && ($value = SecurityHelper::validateData($value, $key)) !== false) {
Qiang Xue committed
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
					$cookies[$name] = new Cookie(array(
						'name' => $name,
						'value' => @unserialize($value),
					));
				}
			}
		} else {
			foreach ($_COOKIE as $name => $value) {
				$cookies[$name] = new Cookie(array(
					'name' => $name,
					'value' => $value,
				));
			}
		}
		return $cookies;
	}
Qiang Xue committed
247
}