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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
<?php
/* Icinga Web 2 | (c) 2014 Icinga Development Team | GPLv2+ */
namespace Icinga\Web\Session;
use Exception;
use ArrayIterator;
use Icinga\Exception\IcingaException;
use IteratorAggregate;
use Traversable;
/**
* Container for session values
*/
class SessionNamespace implements IteratorAggregate
{
/**
* The actual values stored in this container
*
* @var array
*/
protected $values = array();
/**
* The names of all values removed from this container
*
* @var array
*/
protected $removed = array();
/**
* Return an iterator for all values in this namespace
*
* @return ArrayIterator
*/
public function getIterator(): Traversable
{
return new ArrayIterator($this->getAll());
}
/**
* Set a session value by property access
*
* @param string $key The value's name
* @param mixed $value The value
*/
public function __set($key, $value)
{
$this->set($key, $value);
}
/**
* Return a session value by property access
*
* @param string $key The value's name
*
* @return mixed The value
* @throws Exception When the given value-name is not found
*/
public function __get($key)
{
if (!array_key_exists($key, $this->values)) {
throw new IcingaException(
'Cannot access non-existent session value "%s"',
$key
);
}
return $this->get($key);
}
/**
* Return whether the given session value is set
*
* @param string $key The value's name
* @return bool
*/
public function __isset($key)
{
return isset($this->values[$key]);
}
/**
* Unset the given session value
*
* @param string $key The value's name
*/
public function __unset($key)
{
$this->delete($key);
}
/**
* Setter for session values
*
* @param string $key Name of value
* @param mixed $value Value to set
*
* @return $this
*/
public function set($key, $value)
{
$this->values[$key] = $value;
if (in_array($key, $this->removed, true)) {
unset($this->removed[array_search($key, $this->removed, true)]);
}
return $this;
}
public function setByRef($key, &$value)
{
$this->values[$key] = & $value;
if (in_array($key, $this->removed, true)) {
unset($this->removed[array_search($key, $this->removed, true)]);
}
return $this;
}
/**
* Getter for session values
*
* @param string $key Name of the value to return
* @param mixed $default Default value to return
*
* @return mixed
*/
public function get($key, $default = null)
{
return isset($this->values[$key]) ? $this->values[$key] : $default;
}
public function & getByRef($key, $default = null)
{
$value = $default;
if (isset($this->values[$key])) {
$value = & $this->values[$key];
}
return $value;
}
/**
* Delete the given value from the session
*
* @param string $key The value's name
*/
public function delete($key)
{
$this->removed[] = $key;
unset($this->values[$key]);
}
/**
* Getter for all session values
*
* @return array
*/
public function getAll()
{
return $this->values;
}
/**
* Put an array into the session
*
* @param array $values Values to set
* @param bool $overwrite Overwrite existing values
*/
public function setAll(array $values, $overwrite = false)
{
foreach ($values as $key => $value) {
if ($this->get($key, $value) !== $value && !$overwrite) {
continue;
}
$this->set($key, $value);
}
}
/**
* Return whether the session namespace has been changed
*
* @return bool
*/
public function hasChanged()
{
return false === empty($this->values) || false === empty($this->removed);
}
/**
* Clear all values from the session namespace
*/
public function clear()
{
$this->values = array();
$this->removed = array();
}
}
|
