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 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
<?php
/**
* Persistent Session Data Management.
*
* @package Silla.IO
* @subpackage Core\Modules\Session
* @author Plamen Nikolov <plamen@athlonsofia.com>
* @copyright Copyright (c) 2015, Silla.io
* @license http://opensource.org/licenses/GPL-3.0 GNU General Public License, version 3.0 (GPLv3)
*/
namespace Core\Modules\Session;
use Core;
/**
* Session Class definition.
*/
final class Session
{
/**
* Reference to the current instance of the Session object.
*
* @var Session
* @access private
* @static
*/
private static $instance = null;
/**
* Reference to the current adapter of the Session object.
*
* @var Core\Modules\Session\Interfaces\Adapter
* @access private
*/
private $adapter = null;
/**
* Session constructor.
*
* @param string $adapter Session Adapter.
*
* @throws \DomainException Not supported Session adapter.
* @throws \InvalidArgumentException Not compatible Session adapter.
* @access private
*/
private function __construct($adapter)
{
if (!class_exists($adapter)) {
throw new \DomainException('Not supported Session adapter type: ' . $adapter);
}
if (!is_subclass_of($adapter, 'Core\Modules\Session\Interfaces\Adapter')) {
throw new \InvalidArgumentException('Not compatible Session adapter type: ' . $adapter);
}
$this->adapter = new $adapter;
}
/**
* Setter method. Set a variable.
*
* @param string $name Variable name.
* @param mixed $value Variable value.
*
* @throws \InvalidArgumentException Session varialbe name should be string.
*
* @return void
*/
public function set($name, $value)
{
if (!is_string($name)) {
throw new \InvalidArgumentException('Session variable name should be string.');
}
$this->adapter->set($name, $value);
}
/**
* Getter method. Get a variable.
*
* @param string $name Variable name.
*
* @throws \InvalidArgumentException Session varialbe name should be string.
*
* @return mixed
*/
public function get($name)
{
if (!is_string($name)) {
throw new \InvalidArgumentException('Session variable name should be string.');
}
return $this->adapter->get($name);
}
/**
* Delete variable.
*
* @param string $name Variable name.
*
* @throws \InvalidArgumentException Session varialbe name should be string.
*
* @return boolean
*/
public function remove($name)
{
if (!is_string($name)) {
throw new \InvalidArgumentException('Session variable name should be string.');
}
return $this->adapter->remove($name);
}
/**
* Generator of session key method.
*
* @return string
*/
public function getKey()
{
return $this->adapter->getKey();
}
/**
* Regeneration of session keys method.
*
* @return void
*/
public function regenerateKey()
{
$this->adapter->regenerateKey();
}
/**
* Destroys the whole session.
*
* @return boolean
*/
public function destroy()
{
return $this->adapter->destroy();
}
/**
* Generic setter method.
*
* Provides an easier way of setting session variables.
*
* @param string $name Variable name.
* @param mixed $value Variable value.
*
* @return void
*/
public function __set($name, $value)
{
$this->set($name, $value);
}
/**
* Generic getter method.
*
* Provides an easier way of retrieving session variables.
*
* @param string $name Variable name.
*
* @return mixed
*/
public function __get($name)
{
return $this->get($name);
}
/**
* Generic isset method.
*
* @param string $name Variable name.
*
* @return boolean
*/
public function __isset($name)
{
return !!$this->get($name);
}
/**
* Generic unset method.
*
* @param string $name Variable name.
*
* @return void
*/
public function __unset($name)
{
$this->remove($name);
}
/**
* Cloning of Session is disallowed.
*
* @access public
*
* @return void
*/
public function __clone()
{
trigger_error(__CLASS__ . ' cannot be cloned! It is singleton.', E_USER_ERROR);
}
/**
* Returns an instance of the Session object.
*
* @param string $adapter Adapter name.
*
* @access public
* @static
* @final
* @uses Core\Registry()
*
* @return Session
*/
final public static function getInstance($adapter)
{
if (null === self::$instance) {
$adapter = 'Core\Modules\Session\Adapters\\' . $adapter;
self::$instance = new Session($adapter);
Core\Registry()->set('session', self::$instance);
}
return self::$instance;
}
}