201 lines
4.4 KiB
PHP
201 lines
4.4 KiB
PHP
<?php
|
|
/* Icinga Web 2 | (c) 2014 Icinga Development Team | GPLv2+ */
|
|
|
|
namespace Icinga\Web\Session;
|
|
|
|
use Exception;
|
|
use ArrayIterator;
|
|
use Icinga\Exception\IcingaException;
|
|
use IteratorAggregate;
|
|
|
|
/**
|
|
* 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()
|
|
{
|
|
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();
|
|
}
|
|
}
|