Session.php 21.8 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
 * @license http://www.yiiframework.com/license/
 */

Qiang Xue committed
8 9
namespace yii\web;

Qiang Xue committed
10
use Yii;
11
use yii\base\Arrayable;
Qiang Xue committed
12
use yii\base\Component;
Qiang Xue committed
13
use yii\base\InvalidConfigException;
Qiang Xue committed
14 15
use yii\base\InvalidParamException;

Qiang Xue committed
16
/**
Qiang Xue committed
17
 * Session provides session data management and the related configurations.
Qiang Xue committed
18
 *
Qiang Xue committed
19
 * Session is a Web application component that can be accessed via `Yii::$app->session`.
20
 *
Qiang Xue committed
21 22
 * To start the session, call [[open()]]; To complete and send out session data, call [[close()]];
 * To destroy the session, call [[destroy()]].
Qiang Xue committed
23
 *
Qiang Xue committed
24 25
 * By default, [[autoStart]] is true which means the session will be started automatically
 * when the session component is accessed the first time.
Qiang Xue committed
26
 *
Qiang Xue committed
27
 * Session can be used like an array to set and get session data. For example,
Qiang Xue committed
28
 *
Qiang Xue committed
29 30 31 32 33 34 35 36
 * ~~~
 * $session = new Session;
 * $session->open();
 * $value1 = $session['name1'];  // get session variable 'name1'
 * $value2 = $session['name2'];  // get session variable 'name2'
 * foreach ($session as $name => $value) // traverse all session variables
 * $session['name3'] = $value3;  // set session variable 'name3'
 * ~~~
Qiang Xue committed
37
 *
Qiang Xue committed
38
 * Session can be extended to support customized session storage.
Qiang Xue committed
39 40 41 42
 * To do so, override [[useCustomStorage()]] so that it returns true, and
 * override these methods with the actual logic about using custom storage:
 * [[openSession()]], [[closeSession()]], [[readSession()]], [[writeSession()]],
 * [[destroySession()]] and [[gcSession()]].
Qiang Xue committed
43
 *
Qiang Xue committed
44 45 46 47 48
 * Session also supports a special type of session data, called *flash messages*.
 * A flash message is available only in the current request and the next request.
 * After that, it will be deleted automatically. Flash messages are particularly
 * useful for displaying confirmation messages. To use flash messages, simply
 * call methods such as [[setFlash()]], [[getFlash()]].
Qiang Xue committed
49
 *
50
 * @property array $allFlashes Flash messages (key => message). This property is read-only.
Qiang Xue committed
51
 * @property array $cookieParams The session cookie parameters. This property is read-only.
52 53 54 55 56 57
 * @property integer $count The number of session variables. This property is read-only.
 * @property string $flash The key identifying the flash message. Note that flash messages and normal session
 * variables share the same name space. If you have a normal session variable using the same name, its value will
 * be overwritten by this method. This property is write-only.
 * @property float $gCProbability The probability (percentage) that the GC (garbage collection) process is
 * started on every session initialization, defaults to 1 meaning 1% chance.
58
 * @property string $id The current session ID.
59 60 61
 * @property boolean $isActive Whether the session has started. This property is read-only.
 * @property SessionIterator $iterator An iterator for traversing the session variables. This property is
 * read-only.
62
 * @property string $name The current session name.
63 64 65
 * @property string $savePath The current session save path, defaults to '/tmp'.
 * @property integer $timeout The number of seconds after which data will be seen as 'garbage' and cleaned up.
 * The default value is 1440 seconds (or the value of "session.gc_maxlifetime" set in php.ini).
66 67 68 69 70
 * @property boolean|null $useCookies The value indicating whether cookies should be used to store session
 * IDs.
 * @property boolean $useCustomStorage Whether to use custom storage. This property is read-only.
 * @property boolean $useTransparentSessionID Whether transparent sid support is enabled or not, defaults to
 * false.
71
 *
Qiang Xue committed
72
 * @author Qiang Xue <qiang.xue@gmail.com>
Qiang Xue committed
73
 * @since 2.0
Qiang Xue committed
74
 */
75
class Session extends Component implements \IteratorAggregate, \ArrayAccess, \Countable, Arrayable
Qiang Xue committed
76 77
{
	/**
Qiang Xue committed
78
	 * @var boolean whether the session should be automatically started when the session component is initialized.
Qiang Xue committed
79
	 */
Qiang Xue committed
80
	public $autoStart = true;
Qiang Xue committed
81 82 83 84
	/**
	 * @var string the name of the session variable that stores the flash message data.
	 */
	public $flashVar = '__flash';
85 86 87 88
	/**
	 * @var \SessionHandlerInterface|array an object implementing the SessionHandlerInterface or a configuration array. If set, will be used to provide persistency instead of build-in methods.
	 */
	public $handler;
89
	/**
90
	 * @var array parameter-value pairs to override default session cookie parameters that are used for session_set_cookie_params() function
91
	 * Array may have the following possible keys: 'lifetime', 'path', 'domain', 'secure', 'httpOnly'
92
	 * @see http://www.php.net/manual/en/function.session-set-cookie-params.php
93
	 */
94
	private $_cookieParams = ['httpOnly' => true];
95

Qiang Xue committed
96 97 98 99 100 101 102
	/**
	 * Initializes the application component.
	 * This method is required by IApplicationComponent and is invoked by application.
	 */
	public function init()
	{
		parent::init();
Qiang Xue committed
103
		if ($this->autoStart) {
Qiang Xue committed
104
			$this->open();
Qiang Xue committed
105
		}
Alexander Makarov committed
106
		register_shutdown_function([$this, 'close']);
Qiang Xue committed
107 108 109 110
	}

	/**
	 * Returns a value indicating whether to use custom session storage.
Qiang Xue committed
111 112 113
	 * This method should be overridden to return true by child classes that implement custom session storage.
	 * To implement custom session storage, override these methods: [[openSession()]], [[closeSession()]],
	 * [[readSession()]], [[writeSession()]], [[destroySession()]] and [[gcSession()]].
Qiang Xue committed
114 115 116 117 118 119 120 121
	 * @return boolean whether to use custom storage.
	 */
	public function getUseCustomStorage()
	{
		return false;
	}

	/**
Qiang Xue committed
122
	 * Starts the session.
Qiang Xue committed
123 124 125
	 */
	public function open()
	{
126 127
		if (session_status() == PHP_SESSION_ACTIVE) {
			return;
Qiang Xue committed
128 129
		}

130 131 132 133 134 135 136 137
		if ($this->handler !== null) {
			if (!is_object($this->handler)) {
				$this->handler = Yii::createObject($this->handler);
			}
			if (!$this->handler instanceof \SessionHandlerInterface) {
				throw new InvalidConfigException('"' . get_class($this) . '::handler" must implement the SessionHandlerInterface.');
			}
			@session_set_save_handler($this->handler, false);
138
		} elseif ($this->getUseCustomStorage()) {
139 140 141 142 143 144 145 146 147
			@session_set_save_handler(
				[$this, 'openSession'],
				[$this, 'closeSession'],
				[$this, 'readSession'],
				[$this, 'writeSession'],
				[$this, 'destroySession'],
				[$this, 'gcSession']
			);
		}
Qiang Xue committed
148

149
		$this->setCookieParamsInternal();
150

151
		@session_start();
Qiang Xue committed
152

153 154 155 156 157 158
		if (session_id() == '') {
			$error = error_get_last();
			$message = isset($error['message']) ? $error['message'] : 'Failed to start session.';
			Yii::error($message, __METHOD__);
		} else {
			$this->updateFlashCounters();
Qiang Xue committed
159 160 161 162 163 164 165 166
		}
	}

	/**
	 * Ends the current session and store session data.
	 */
	public function close()
	{
Qiang Xue committed
167
		if (session_id() !== '') {
Qiang Xue committed
168
			@session_write_close();
Qiang Xue committed
169
		}
Qiang Xue committed
170 171 172 173 174 175 176
	}

	/**
	 * Frees all session variables and destroys all data registered to a session.
	 */
	public function destroy()
	{
Qiang Xue committed
177
		if (session_id() !== '') {
Qiang Xue committed
178 179 180 181 182 183 184 185
			@session_unset();
			@session_destroy();
		}
	}

	/**
	 * @return boolean whether the session has started
	 */
Qiang Xue committed
186
	public function getIsActive()
Qiang Xue committed
187
	{
188
		return session_status() == PHP_SESSION_ACTIVE;
Qiang Xue committed
189 190 191 192 193
	}

	/**
	 * @return string the current session ID
	 */
Qiang Xue committed
194
	public function getId()
Qiang Xue committed
195 196 197 198 199 200 201
	{
		return session_id();
	}

	/**
	 * @param string $value the session ID for the current session
	 */
Qiang Xue committed
202
	public function setId($value)
Qiang Xue committed
203 204 205 206 207
	{
		session_id($value);
	}

	/**
Qiang Xue committed
208
	 * Updates the current session ID with a newly generated one .
Carsten Brandt committed
209
	 * Please refer to <http://php.net/session_regenerate_id> for more details.
Qiang Xue committed
210 211
	 * @param boolean $deleteOldSession Whether to delete the old associated session file or not.
	 */
Qiang Xue committed
212
	public function regenerateID($deleteOldSession = false)
Qiang Xue committed
213
	{
214 215 216
		// add @ to inhibit possible warning due to race condition
		// https://github.com/yiisoft/yii2/pull/1812
		@session_regenerate_id($deleteOldSession);
Qiang Xue committed
217 218 219 220 221
	}

	/**
	 * @return string the current session name
	 */
Qiang Xue committed
222
	public function getName()
Qiang Xue committed
223 224 225 226 227
	{
		return session_name();
	}

	/**
Qiang Xue committed
228 229
	 * @param string $value the session name for the current session, must be an alphanumeric string.
	 * It defaults to "PHPSESSID".
Qiang Xue committed
230
	 */
Qiang Xue committed
231
	public function setName($value)
Qiang Xue committed
232 233 234 235 236 237 238 239 240 241 242 243 244
	{
		session_name($value);
	}

	/**
	 * @return string the current session save path, defaults to '/tmp'.
	 */
	public function getSavePath()
	{
		return session_save_path();
	}

	/**
Qiang Xue committed
245 246
	 * @param string $value the current session save path. This can be either a directory name or a path alias.
	 * @throws InvalidParamException if the path is not a valid directory
Qiang Xue committed
247 248 249
	 */
	public function setSavePath($value)
	{
Qiang Xue committed
250
		$path = Yii::getAlias($value);
Qiang Xue committed
251
		if (is_dir($path)) {
Qiang Xue committed
252
			session_save_path($path);
Qiang Xue committed
253
		} else {
Qiang Xue committed
254
			throw new InvalidParamException("Session save path is not a valid directory: $value");
Qiang Xue committed
255
		}
Qiang Xue committed
256 257 258 259 260 261 262 263
	}

	/**
	 * @return array the session cookie parameters.
	 * @see http://us2.php.net/manual/en/function.session-get-cookie-params.php
	 */
	public function getCookieParams()
	{
Qiang Xue committed
264 265 266 267 268
		$params = session_get_cookie_params();
		if (isset($params['httponly'])) {
			$params['httpOnly'] = $params['httponly'];
			unset($params['httponly']);
		}
269
		return array_merge($params, $this->_cookieParams);
Qiang Xue committed
270 271 272 273
	}

	/**
	 * Sets the session cookie parameters.
274 275
	 * The cookie parameters passed to this method will be merged with the result
	 * of `session_get_cookie_params()`.
Qiang Xue committed
276
	 * @param array $value cookie parameters, valid keys include: `lifetime`, `path`, `domain`, `secure` and `httpOnly`.
Qiang Xue committed
277
	 * @throws InvalidParamException if the parameters are incomplete.
Qiang Xue committed
278 279
	 * @see http://us2.php.net/manual/en/function.session-set-cookie-params.php
	 */
280 281 282 283 284 285 286 287 288 289 290 291
	public function setCookieParams(array $value)
	{
		$this->_cookieParams = $value;
	}

	/**
	 * Sets the session cookie parameters.
	 * This method is called by [[open()]] when it is about to open the session.
	 * @throws InvalidParamException if the parameters are incomplete.
	 * @see http://us2.php.net/manual/en/function.session-set-cookie-params.php
	 */
	private function setCookieParamsInternal()
Qiang Xue committed
292
	{
Qiang Xue committed
293
		$data = $this->getCookieParams();
Qiang Xue committed
294
		extract($data);
Qiang Xue committed
295 296
		if (isset($lifetime, $path, $domain, $secure, $httpOnly)) {
			session_set_cookie_params($lifetime, $path, $domain, $secure, $httpOnly);
Qiang Xue committed
297
		} else {
298
			throw new InvalidParamException('Please make sure cookieParams contains these elements: lifetime, path, domain, secure and httpOnly.');
Qiang Xue committed
299
		}
Qiang Xue committed
300 301 302
	}

	/**
Qiang Xue committed
303 304 305
	 * Returns the value indicating whether cookies should be used to store session IDs.
	 * @return boolean|null the value indicating whether cookies should be used to store session IDs.
	 * @see setUseCookies()
Qiang Xue committed
306
	 */
Qiang Xue committed
307
	public function getUseCookies()
Qiang Xue committed
308
	{
Qiang Xue committed
309
		if (ini_get('session.use_cookies') === '0') {
Qiang Xue committed
310 311 312
			return false;
		} elseif (ini_get('session.use_only_cookies') === '1') {
			return true;
Qiang Xue committed
313
		} else {
Qiang Xue committed
314
			return null;
Qiang Xue committed
315
		}
Qiang Xue committed
316 317 318
	}

	/**
Qiang Xue committed
319 320 321 322 323 324 325 326
	 * Sets the value indicating whether cookies should be used to store session IDs.
	 * Three states are possible:
	 *
	 * - true: cookies and only cookies will be used to store session IDs.
	 * - false: cookies will not be used to store session IDs.
	 * - null: if possible, cookies will be used to store session IDs; if not, other mechanisms will be used (e.g. GET parameter)
	 *
	 * @param boolean|null $value the value indicating whether cookies should be used to store session IDs.
Qiang Xue committed
327
	 */
Qiang Xue committed
328
	public function setUseCookies($value)
Qiang Xue committed
329
	{
Qiang Xue committed
330
		if ($value === false) {
Qiang Xue committed
331 332
			ini_set('session.use_cookies', '0');
			ini_set('session.use_only_cookies', '0');
Qiang Xue committed
333 334 335
		} elseif ($value === true) {
			ini_set('session.use_cookies', '1');
			ini_set('session.use_only_cookies', '1');
Qiang Xue committed
336
		} else {
Qiang Xue committed
337 338
			ini_set('session.use_cookies', '1');
			ini_set('session.use_only_cookies', '0');
Qiang Xue committed
339 340 341 342
		}
	}

	/**
Qiang Xue committed
343
	 * @return float the probability (percentage) that the GC (garbage collection) process is started on every session initialization, defaults to 1 meaning 1% chance.
Qiang Xue committed
344 345 346
	 */
	public function getGCProbability()
	{
Qiang Xue committed
347
		return (float)(ini_get('session.gc_probability') / ini_get('session.gc_divisor') * 100);
Qiang Xue committed
348 349 350
	}

	/**
Qiang Xue committed
351 352
	 * @param float $value the probability (percentage) that the GC (garbage collection) process is started on every session initialization.
	 * @throws InvalidParamException if the value is not between 0 and 100.
Qiang Xue committed
353 354 355
	 */
	public function setGCProbability($value)
	{
Qiang Xue committed
356
		if ($value >= 0 && $value <= 100) {
Qiang Xue committed
357 358 359
			// percent * 21474837 / 2147483647 ≈ percent * 0.01
			ini_set('session.gc_probability', floor($value * 21474836.47));
			ini_set('session.gc_divisor', 2147483647);
Qiang Xue committed
360
		} else {
Qiang Xue committed
361
			throw new InvalidParamException('GCProbability must be a value between 0 and 100.');
Qiang Xue committed
362
		}
Qiang Xue committed
363 364 365 366 367 368 369
	}

	/**
	 * @return boolean whether transparent sid support is enabled or not, defaults to false.
	 */
	public function getUseTransparentSessionID()
	{
Qiang Xue committed
370
		return ini_get('session.use_trans_sid') == 1;
Qiang Xue committed
371 372 373 374 375 376 377
	}

	/**
	 * @param boolean $value whether transparent sid support is enabled or not.
	 */
	public function setUseTransparentSessionID($value)
	{
Qiang Xue committed
378
		ini_set('session.use_trans_sid', $value ? '1' : '0');
Qiang Xue committed
379 380 381
	}

	/**
Qiang Xue committed
382 383
	 * @return integer the number of seconds after which data will be seen as 'garbage' and cleaned up.
	 * The default value is 1440 seconds (or the value of "session.gc_maxlifetime" set in php.ini).
Qiang Xue committed
384 385 386 387 388 389 390 391 392 393 394
	 */
	public function getTimeout()
	{
		return (int)ini_get('session.gc_maxlifetime');
	}

	/**
	 * @param integer $value the number of seconds after which data will be seen as 'garbage' and cleaned up
	 */
	public function setTimeout($value)
	{
Qiang Xue committed
395
		ini_set('session.gc_maxlifetime', $value);
Qiang Xue committed
396 397 398 399
	}

	/**
	 * Session open handler.
Qiang Xue committed
400
	 * This method should be overridden if [[useCustomStorage()]] returns true.
Qiang Xue committed
401 402 403 404 405
	 * Do not call this method directly.
	 * @param string $savePath session save path
	 * @param string $sessionName session name
	 * @return boolean whether session is opened successfully
	 */
Qiang Xue committed
406
	public function openSession($savePath, $sessionName)
Qiang Xue committed
407 408 409 410 411 412
	{
		return true;
	}

	/**
	 * Session close handler.
Qiang Xue committed
413
	 * This method should be overridden if [[useCustomStorage()]] returns true.
Qiang Xue committed
414 415 416 417 418 419 420 421 422 423
	 * Do not call this method directly.
	 * @return boolean whether session is closed successfully
	 */
	public function closeSession()
	{
		return true;
	}

	/**
	 * Session read handler.
Qiang Xue committed
424
	 * This method should be overridden if [[useCustomStorage()]] returns true.
Qiang Xue committed
425 426 427 428 429 430 431 432 433 434 435
	 * Do not call this method directly.
	 * @param string $id session ID
	 * @return string the session data
	 */
	public function readSession($id)
	{
		return '';
	}

	/**
	 * Session write handler.
Qiang Xue committed
436
	 * This method should be overridden if [[useCustomStorage()]] returns true.
Qiang Xue committed
437 438 439 440 441
	 * Do not call this method directly.
	 * @param string $id session ID
	 * @param string $data session data
	 * @return boolean whether session write is successful
	 */
Qiang Xue committed
442
	public function writeSession($id, $data)
Qiang Xue committed
443 444 445 446 447 448
	{
		return true;
	}

	/**
	 * Session destroy handler.
Qiang Xue committed
449
	 * This method should be overridden if [[useCustomStorage()]] returns true.
Qiang Xue committed
450 451 452 453 454 455 456 457 458 459 460
	 * Do not call this method directly.
	 * @param string $id session ID
	 * @return boolean whether session is destroyed successfully
	 */
	public function destroySession($id)
	{
		return true;
	}

	/**
	 * Session GC (garbage collection) handler.
Qiang Xue committed
461
	 * This method should be overridden if [[useCustomStorage()]] returns true.
Qiang Xue committed
462 463 464 465 466 467 468 469 470 471 472 473
	 * Do not call this method directly.
	 * @param integer $maxLifetime the number of seconds after which data will be seen as 'garbage' and cleaned up.
	 * @return boolean whether session is GCed successfully
	 */
	public function gcSession($maxLifetime)
	{
		return true;
	}

	/**
	 * Returns an iterator for traversing the session variables.
	 * This method is required by the interface IteratorAggregate.
Qiang Xue committed
474
	 * @return SessionIterator an iterator for traversing the session variables.
Qiang Xue committed
475 476 477
	 */
	public function getIterator()
	{
Qiang Xue committed
478
		return new SessionIterator;
Qiang Xue committed
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501
	}

	/**
	 * Returns the number of items in the session.
	 * @return integer the number of session variables
	 */
	public function getCount()
	{
		return count($_SESSION);
	}

	/**
	 * Returns the number of items in the session.
	 * This method is required by Countable interface.
	 * @return integer number of items in the session.
	 */
	public function count()
	{
		return $this->getCount();
	}

	/**
	 * Returns the session variable value with the session variable name.
Qiang Xue committed
502 503
	 * If the session variable does not exist, the `$defaultValue` will be returned.
	 * @param string $key the session variable name
Qiang Xue committed
504 505 506
	 * @param mixed $defaultValue the default value to be returned when the session variable does not exist.
	 * @return mixed the session variable value, or $defaultValue if the session variable does not exist.
	 */
Qiang Xue committed
507
	public function get($key, $defaultValue = null)
Qiang Xue committed
508 509 510 511 512 513
	{
		return isset($_SESSION[$key]) ? $_SESSION[$key] : $defaultValue;
	}

	/**
	 * Adds a session variable.
Qiang Xue committed
514 515
	 * If the specified name already exists, the old value will be overwritten.
	 * @param string $key session variable name
Qiang Xue committed
516 517
	 * @param mixed $value session variable value
	 */
Qiang Xue committed
518
	public function set($key, $value)
Qiang Xue committed
519
	{
Qiang Xue committed
520
		$_SESSION[$key] = $value;
Qiang Xue committed
521 522 523 524
	}

	/**
	 * Removes a session variable.
Qiang Xue committed
525
	 * @param string $key the name of the session variable to be removed
Qiang Xue committed
526 527 528 529
	 * @return mixed the removed value, null if no such session variable.
	 */
	public function remove($key)
	{
Qiang Xue committed
530 531
		if (isset($_SESSION[$key])) {
			$value = $_SESSION[$key];
Qiang Xue committed
532 533
			unset($_SESSION[$key]);
			return $value;
Qiang Xue committed
534
		} else {
Qiang Xue committed
535
			return null;
Qiang Xue committed
536
		}
Qiang Xue committed
537 538 539 540 541
	}

	/**
	 * Removes all session variables
	 */
Qiang Xue committed
542
	public function removeAll()
Qiang Xue committed
543
	{
Qiang Xue committed
544
		foreach (array_keys($_SESSION) as $key) {
Qiang Xue committed
545
			unset($_SESSION[$key]);
Qiang Xue committed
546
		}
Qiang Xue committed
547 548 549 550 551 552
	}

	/**
	 * @param mixed $key session variable name
	 * @return boolean whether there is the named session variable
	 */
Qiang Xue committed
553
	public function has($key)
Qiang Xue committed
554 555 556 557 558 559 560 561 562 563 564 565
	{
		return isset($_SESSION[$key]);
	}

	/**
	 * @return array the list of all session variables in array
	 */
	public function toArray()
	{
		return $_SESSION;
	}

Qiang Xue committed
566 567 568 569 570 571
	/**
	 * Updates the counters for flash messages and removes outdated flash messages.
	 * This method should only be called once in [[init()]].
	 */
	protected function updateFlashCounters()
	{
Alexander Makarov committed
572
		$counters = $this->get($this->flashVar, []);
Qiang Xue committed
573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592
		if (is_array($counters)) {
			foreach ($counters as $key => $count) {
				if ($count) {
					unset($counters[$key], $_SESSION[$key]);
				} else {
					$counters[$key]++;
				}
			}
			$_SESSION[$this->flashVar] = $counters;
		} else {
			// fix the unexpected problem that flashVar doesn't return an array
			unset($_SESSION[$this->flashVar]);
		}
	}

	/**
	 * Returns a flash message.
	 * A flash message is available only in the current request and the next request.
	 * @param string $key the key identifying the flash message
	 * @param mixed $defaultValue value to be returned if the flash message does not exist.
593 594
	 * @param boolean $delete whether to delete this flash message right after this method is called.
	 * If false, the flash message will be automatically deleted after the next request.
Qiang Xue committed
595 596
	 * @return mixed the flash message
	 */
597
	public function getFlash($key, $defaultValue = null, $delete = false)
Qiang Xue committed
598
	{
Alexander Makarov committed
599
		$counters = $this->get($this->flashVar, []);
600 601 602 603 604 605 606 607 608
		if (isset($counters[$key])) {
			$value = $this->get($key, $defaultValue);
			if ($delete) {
				$this->removeFlash($key);
			}
			return $value;
		} else {
			return $defaultValue;
		}
Qiang Xue committed
609 610 611 612 613 614 615 616
	}

	/**
	 * Returns all flash messages.
	 * @return array flash messages (key => message).
	 */
	public function getAllFlashes()
	{
Alexander Makarov committed
617 618
		$counters = $this->get($this->flashVar, []);
		$flashes = [];
Qiang Xue committed
619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634
		foreach (array_keys($counters) as $key) {
			if (isset($_SESSION[$key])) {
				$flashes[$key] = $_SESSION[$key];
			}
		}
		return $flashes;
	}

	/**
	 * Stores a flash message.
	 * A flash message is available only in the current request and the next request.
	 * @param string $key the key identifying the flash message. Note that flash messages
	 * and normal session variables share the same name space. If you have a normal
	 * session variable using the same name, its value will be overwritten by this method.
	 * @param mixed $value flash message
	 */
Qiang Xue committed
635
	public function setFlash($key, $value = true)
Qiang Xue committed
636
	{
Alexander Makarov committed
637
		$counters = $this->get($this->flashVar, []);
Qiang Xue committed
638 639 640 641 642 643 644 645 646 647 648 649 650 651 652
		$counters[$key] = 0;
		$_SESSION[$key] = $value;
		$_SESSION[$this->flashVar] = $counters;
	}

	/**
	 * Removes a flash message.
	 * Note that flash messages will be automatically removed after the next request.
	 * @param string $key the key identifying the flash message. Note that flash messages
	 * and normal session variables share the same name space.  If you have a normal
	 * session variable using the same name, it will be removed by this method.
	 * @return mixed the removed flash message. Null if the flash message does not exist.
	 */
	public function removeFlash($key)
	{
Alexander Makarov committed
653
		$counters = $this->get($this->flashVar, []);
Qiang Xue committed
654 655 656 657 658 659 660 661 662 663 664 665 666 667
		$value = isset($_SESSION[$key], $counters[$key]) ? $_SESSION[$key] : null;
		unset($counters[$key], $_SESSION[$key]);
		$_SESSION[$this->flashVar] = $counters;
		return $value;
	}

	/**
	 * Removes all flash messages.
	 * Note that flash messages and normal session variables share the same name space.
	 * If you have a normal session variable using the same name, it will be removed
	 * by this method.
	 */
	public function removeAllFlashes()
	{
Alexander Makarov committed
668
		$counters = $this->get($this->flashVar, []);
Qiang Xue committed
669 670 671 672 673 674 675
		foreach (array_keys($counters) as $key) {
			unset($_SESSION[$key]);
		}
		unset($_SESSION[$this->flashVar]);
	}

	/**
Qiang Xue committed
676
	 * Returns a value indicating whether there is a flash message associated with the specified key.
Qiang Xue committed
677 678 679 680 681 682 683 684
	 * @param string $key key identifying the flash message
	 * @return boolean whether the specified flash message exists
	 */
	public function hasFlash($key)
	{
		return $this->getFlash($key) !== null;
	}

Qiang Xue committed
685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709
	/**
	 * This method is required by the interface ArrayAccess.
	 * @param mixed $offset the offset to check on
	 * @return boolean
	 */
	public function offsetExists($offset)
	{
		return isset($_SESSION[$offset]);
	}

	/**
	 * This method is required by the interface ArrayAccess.
	 * @param integer $offset the offset to retrieve element.
	 * @return mixed the element at the offset, null if no element is found at the offset
	 */
	public function offsetGet($offset)
	{
		return isset($_SESSION[$offset]) ? $_SESSION[$offset] : null;
	}

	/**
	 * This method is required by the interface ArrayAccess.
	 * @param integer $offset the offset to set element
	 * @param mixed $item the element value
	 */
Qiang Xue committed
710
	public function offsetSet($offset, $item)
Qiang Xue committed
711
	{
Qiang Xue committed
712
		$_SESSION[$offset] = $item;
Qiang Xue committed
713 714 715 716 717 718 719 720 721 722 723
	}

	/**
	 * This method is required by the interface ArrayAccess.
	 * @param mixed $offset the offset to unset element
	 */
	public function offsetUnset($offset)
	{
		unset($_SESSION[$offset]);
	}
}