Session.php 9.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345
  1. <?php
  2. // +----------------------------------------------------------------------
  3. // | ThinkPHP [ WE CAN DO IT JUST THINK ]
  4. // +----------------------------------------------------------------------
  5. // | Copyright (c) 2006~2017 http://thinkphp.cn All rights reserved.
  6. // +----------------------------------------------------------------------
  7. // | Licensed ( http://www.apache.org/licenses/LICENSE-2.0 )
  8. // +----------------------------------------------------------------------
  9. // | Author: liu21st <liu21st@gmail.com>
  10. // +----------------------------------------------------------------------
  11. namespace daswork;
  12. // use think\exception\ClassNotFoundException;
  13. class Session
  14. {
  15. protected static $prefix = '';
  16. protected static $init = null;
  17. /**
  18. * 设置或者获取session作用域(前缀)
  19. * @param string $prefix
  20. * @return string|void
  21. */
  22. public static function prefix($prefix = '')
  23. {
  24. if (empty($prefix) && null !== $prefix) {
  25. return self::$prefix;
  26. } else {
  27. self::$prefix = $prefix;
  28. }
  29. }
  30. /**
  31. * session初始化
  32. * @param array $config
  33. * @return void
  34. * @throws \think\Exception
  35. */
  36. public static function init(array $config = [])
  37. {
  38. if (empty($config)) {
  39. $config = Config::get('session');
  40. }
  41. $isDoStart = false;
  42. // 启动session
  43. if (!empty($config['auto_start']) && PHP_SESSION_ACTIVE != session_status()) {
  44. ini_set('session.auto_start', 0);
  45. $isDoStart = true;
  46. }
  47. if (isset($config['var_session_id']) && isset($_REQUEST[$config['var_session_id']])) {
  48. session_id($_REQUEST[$config['var_session_id']]);
  49. } elseif (isset($config['id']) && !empty($config['id'])) {
  50. session_id($config['id']);
  51. }
  52. if (isset($config['path'])) {
  53. session_save_path($config['path']);
  54. }
  55. if (isset($config['domain'])) {
  56. ini_set('session.cookie_domain', $config['domain']);
  57. }
  58. if (isset($config['expire'])) {
  59. ini_set('session.gc_maxlifetime', $config['expire']);
  60. ini_set('session.cookie_lifetime', $config['expire']);
  61. }
  62. if (isset($config['secure'])) {
  63. ini_set('session.cookie_secure', $config['secure']);
  64. }
  65. if (isset($config['httponly'])) {
  66. ini_set('session.cookie_httponly', $config['httponly']);
  67. }
  68. if (isset($config['use_cookies'])) {
  69. ini_set('session.use_cookies', $config['use_cookies'] ? 1 : 0);
  70. }
  71. if (isset($config['cache_limiter'])) {
  72. session_cache_limiter($config['cache_limiter']);
  73. }
  74. if (isset($config['cache_expire'])) {
  75. session_cache_expire($config['cache_expire']);
  76. }
  77. if ($isDoStart) {
  78. session_start();
  79. self::$init = true;
  80. } else {
  81. self::$init = false;
  82. }
  83. }
  84. /**
  85. * session自动启动或者初始化
  86. * @return void
  87. */
  88. public static function boot()
  89. {
  90. if (is_null(self::$init)) {
  91. self::init();
  92. } elseif (false === self::$init) {
  93. if (PHP_SESSION_ACTIVE != session_status()) {
  94. session_start();
  95. }
  96. self::$init = true;
  97. }
  98. }
  99. /**
  100. * session设置
  101. * @param string $name session名称
  102. * @param mixed $value session值
  103. * @param string|null $prefix 作用域(前缀)
  104. * @return void
  105. */
  106. public static function set($name, $value = '', $prefix = null)
  107. {
  108. empty(self::$init) && self::boot();
  109. $prefix = !is_null($prefix) ? $prefix : self::$prefix;
  110. if (strpos($name, '.')) {
  111. // 二维数组赋值
  112. list($name1, $name2) = explode('.', $name);
  113. if ($prefix) {
  114. $_SESSION[$prefix][$name1][$name2] = $value;
  115. } else {
  116. $_SESSION[$name1][$name2] = $value;
  117. }
  118. } elseif ($prefix) {
  119. $_SESSION[$prefix][$name] = $value;
  120. } else {
  121. $_SESSION[$name] = $value;
  122. }
  123. }
  124. /**
  125. * session获取
  126. * @param string $name session名称
  127. * @param string|null $prefix 作用域(前缀)
  128. * @return mixed
  129. */
  130. public static function get($name = '', $prefix = null)
  131. {
  132. empty(self::$init) && self::boot();
  133. $prefix = !is_null($prefix) ? $prefix : self::$prefix;
  134. if ('' == $name) {
  135. // 获取全部的session
  136. $value = $prefix ? (!empty($_SESSION[$prefix]) ? $_SESSION[$prefix] : []) : $_SESSION;
  137. } elseif ($prefix) {
  138. // 获取session
  139. if (strpos($name, '.')) {
  140. list($name1, $name2) = explode('.', $name);
  141. $value = isset($_SESSION[$prefix][$name1][$name2]) ? $_SESSION[$prefix][$name1][$name2] : null;
  142. } else {
  143. $value = isset($_SESSION[$prefix][$name]) ? $_SESSION[$prefix][$name] : null;
  144. }
  145. } else {
  146. if (strpos($name, '.')) {
  147. list($name1, $name2) = explode('.', $name);
  148. $value = isset($_SESSION[$name1][$name2]) ? $_SESSION[$name1][$name2] : null;
  149. } else {
  150. $value = isset($_SESSION[$name]) ? $_SESSION[$name] : null;
  151. }
  152. }
  153. return $value;
  154. }
  155. /**
  156. * session获取并删除
  157. * @param string $name session名称
  158. * @param string|null $prefix 作用域(前缀)
  159. * @return mixed
  160. */
  161. public static function pull($name, $prefix = null)
  162. {
  163. $result = self::get($name, $prefix);
  164. if ($result) {
  165. self::delete($name, $prefix);
  166. return $result;
  167. } else {
  168. return;
  169. }
  170. }
  171. /**
  172. * session设置 下一次请求有效
  173. * @param string $name session名称
  174. * @param mixed $value session值
  175. * @param string|null $prefix 作用域(前缀)
  176. * @return void
  177. */
  178. public static function flash($name, $value)
  179. {
  180. self::set($name, $value);
  181. if (!self::has('__flash__.__time__')) {
  182. self::set('__flash__.__time__', $_SERVER['REQUEST_TIME_FLOAT']);
  183. }
  184. self::push('__flash__', $name);
  185. }
  186. /**
  187. * 清空当前请求的session数据
  188. * @return void
  189. */
  190. public static function flush()
  191. {
  192. if (self::$init) {
  193. $item = self::get('__flash__');
  194. if (!empty($item)) {
  195. $time = $item['__time__'];
  196. if ($_SERVER['REQUEST_TIME_FLOAT'] > $time) {
  197. unset($item['__time__']);
  198. self::delete($item);
  199. self::set('__flash__', []);
  200. }
  201. }
  202. }
  203. }
  204. /**
  205. * 删除session数据
  206. * @param string|array $name session名称
  207. * @param string|null $prefix 作用域(前缀)
  208. * @return void
  209. */
  210. public static function delete($name, $prefix = null)
  211. {
  212. empty(self::$init) && self::boot();
  213. $prefix = !is_null($prefix) ? $prefix : self::$prefix;
  214. if (is_array($name)) {
  215. foreach ($name as $key) {
  216. self::delete($key, $prefix);
  217. }
  218. } elseif (strpos($name, '.')) {
  219. list($name1, $name2) = explode('.', $name);
  220. if ($prefix) {
  221. unset($_SESSION[$prefix][$name1][$name2]);
  222. } else {
  223. unset($_SESSION[$name1][$name2]);
  224. }
  225. } else {
  226. if ($prefix) {
  227. unset($_SESSION[$prefix][$name]);
  228. } else {
  229. unset($_SESSION[$name]);
  230. }
  231. }
  232. }
  233. /**
  234. * 清空session数据
  235. * @param string|null $prefix 作用域(前缀)
  236. * @return void
  237. */
  238. public static function clear($prefix = null)
  239. {
  240. empty(self::$init) && self::boot();
  241. $prefix = !is_null($prefix) ? $prefix : self::$prefix;
  242. if ($prefix) {
  243. unset($_SESSION[$prefix]);
  244. } else {
  245. $_SESSION = [];
  246. }
  247. }
  248. /**
  249. * 判断session数据
  250. * @param string $name session名称
  251. * @param string|null $prefix
  252. * @return bool
  253. */
  254. public static function has($name, $prefix = null)
  255. {
  256. empty(self::$init) && self::boot();
  257. $prefix = !is_null($prefix) ? $prefix : self::$prefix;
  258. if (strpos($name, '.')) {
  259. // 支持数组
  260. list($name1, $name2) = explode('.', $name);
  261. return $prefix ? isset($_SESSION[$prefix][$name1][$name2]) : isset($_SESSION[$name1][$name2]);
  262. } else {
  263. return $prefix ? isset($_SESSION[$prefix][$name]) : isset($_SESSION[$name]);
  264. }
  265. }
  266. /**
  267. * 添加数据到一个session数组
  268. * @param string $key
  269. * @param mixed $value
  270. * @return void
  271. */
  272. public static function push($key, $value)
  273. {
  274. $array = self::get($key);
  275. if (is_null($array)) {
  276. $array = [];
  277. }
  278. $array[] = $value;
  279. self::set($key, $array);
  280. }
  281. /**
  282. * 启动session
  283. * @return void
  284. */
  285. public static function start()
  286. {
  287. session_start();
  288. self::$init = true;
  289. }
  290. /**
  291. * 销毁session
  292. * @return void
  293. */
  294. public static function destroy()
  295. {
  296. if (!empty($_SESSION)) {
  297. $_SESSION = [];
  298. }
  299. session_unset();
  300. session_destroy();
  301. self::$init = null;
  302. }
  303. /**
  304. * 重新生成session_id
  305. * @param bool $delete 是否删除关联会话文件
  306. * @return void
  307. */
  308. private static function regenerate($delete = false)
  309. {
  310. session_regenerate_id($delete);
  311. }
  312. /**
  313. * 暂停session
  314. * @return void
  315. */
  316. public static function pause()
  317. {
  318. // 暂停session
  319. session_write_close();
  320. self::$init = false;
  321. }
  322. }