Source for file SessionNamespace.php

Documentation is available at SessionNamespace.php

1: <?php
2:
3: /**
4: * Nette Framework
5: *
6: * Copyright (c) 2004, 2009 David Grudl (http://davidgrudl.com)
7: *
8: * This source file is subject to the "Nette license" that is bundled
9: * with this package in the file license.txt.
10: *
11: * For more information please see https://nette.org
12: *
13: * @copyright Copyright (c) 2004, 2009 David Grudl
14: * @license https://nette.org/license Nette license
15: * @link https://nette.org
16: * @category Nette
17: * @package Nette\Web
18: * @version $Id$
19: */
20:
21:
22:
23: require_once dirname(__FILE__) . '/../Object.php';
24:
25:
26:
27: /**
28: * Session namespace for Session.
29: *
30: * @author David Grudl
31: * @copyright Copyright (c) 2004, 2009 David Grudl
32: * @package Nette\Web
33: */
34: final class SessionNamespace extends Object implements IteratorAggregate, ArrayAccess
35: {
36: /** @var array session data storage */
37: private $data;
38:
39: /** @var array session metadata storage */
40: private $meta;
41:
42: /** @var bool */
43: public $warnOnUndefined = FALSE;
44:
45:
46:
47: /**
48: * Do not call directly. Use Session::getNamespace().
49: */
50: public function __construct(& $data, & $meta)
51: {
52: $this->data = & $data;
53: $this->meta = & $meta;
54: }
55:
56:
57:
58: /**
59: * Returns an iterator over all namespace variables.
60: * @return ArrayIterator
61: */
62: public function getIterator()
63: {
64: if (isset($this->data)) {
65: return new ArrayIterator($this->data);
66: } else {
67: return new ArrayIterator;
68: }
69: }
70:
71:
72:
73: /**
74: * Sets a variable in this session namespace.
75: *
76: * @param string name
77: * @param mixed value
78: * @return void
79: */
80: public function __set($name, $value)
81: {
82: $this->data[$name] = $value;
83: }
84:
85:
86:
87: /**
88: * Gets a variable from this session namespace.
89: *
90: * @param string name
91: * @return mixed
92: */
93: public function &__get($name)
94: {
95: if ($this->warnOnUndefined && !array_key_exists($name, $this->data)) {
96: trigger_error("The variable '$name' does not exist in session namespace", E_USER_WARNING);
97: }
98:
99: return $this->data[$name];
100: }
101:
102:
103:
104: /**
105: * Determines whether a variable in this session namespace is set.
106: *
107: * @param string name
108: * @return bool
109: */
110: public function __isset($name)
111: {
112: return isset($this->data[$name]);
113: }
114:
115:
116:
117: /**
118: * Unsets a variable in this session namespace.
119: *
120: * @param string name
121: * @return void
122: */
123: public function __unset($name)
124: {
125: unset($this->data[$name], $this->meta['EXP'][$name]);
126: }
127:
128:
129:
130: /**
131: * Sets a variable in this session namespace.
132: *
133: * @param string name
134: * @param mixed value
135: * @return void
136: */
137: public function offsetSet($name, $value)
138: {
139: $this->__set($name, $value);
140: }
141:
142:
143:
144: /**
145: * Gets a variable from this session namespace.
146: *
147: * @param string name
148: * @return mixed
149: */
150: public function offsetGet($name)
151: {
152: return $this->__get($name);
153: }
154:
155:
156:
157: /**
158: * Determines whether a variable in this session namespace is set.
159: *
160: * @param string name
161: * @return bool
162: */
163: public function offsetExists($name)
164: {
165: return $this->__isset($name);
166: }
167:
168:
169:
170: /**
171: * Unsets a variable in this session namespace.
172: *
173: * @param string name
174: * @return void
175: */
176: public function offsetUnset($name)
177: {
178: $this->__unset($name);
179: }
180:
181:
182:
183: /**
184: * Sets the expiration of the namespace or specific variables.
185: * @param int time in seconds, value 0 means "until the browser is closed"
186: * @param mixed optional list of variables / single variable to expire
187: * @return void
188: */
189: public function setExpiration($seconds, $variables = NULL)
190: {
191: if ($seconds <= 0) {
192: $seconds = 0;
193:
194: } elseif ($seconds <= Tools::YEAR) {
195: $seconds += time();
196: }
197:
198: if ($variables === NULL) {
199: // to entire namespace
200: $this->meta['EXP'][''] = $seconds;
201:
202: } elseif (is_array($variables)) {
203: // to variables
204: foreach ($variables as $variable) {
205: $this->meta['EXP'][$variable] = $seconds;
206: }
207:
208: } else {
209: $this->meta['EXP'][$variables] = $seconds;
210: }
211: }
212:
213:
214:
215: /**
216: * Removes the expiration from the namespace or specific variables.
217: * @param mixed optional list of variables / single variable to expire
218: * @return void
219: */
220: public function removeExpiration($variables = NULL)
221: {
222: if ($variables === NULL) {
223: // from entire namespace
224: unset($this->meta['EXP']['']);
225:
226: } elseif (is_array($variables)) {
227: // from variables
228: foreach ($variables as $variable) {
229: unset($this->meta['EXP'][$variable]);
230: }
231: } else {
232: unset($this->meta['EXP'][$variables]);
233: }
234: }
235:
236:
237:
238: /**
239: * Cancels the current session namespace.
240: * @return void
241: */
242: public function remove()
243: {
244: $this->data = NULL;
245: $this->meta = NULL;
246: }
247:
248: }

Source for file SessionNamespace.php

Namespaces