Session
概述
ThinkPHP采用think\Session類提供Session功能支持。
| 版本 | 新增功能 |
|---|---|
| 5.0.5 |
增加安全選項參數secure和httponly |
| 5.0.2 |
增加flash方法和flush方法 |
Session初始化
在ThinkPHP5.0中使用\think\Session類(lei)進行Session相關操作,Session會在第一次(ci)調用(yong)(yong)Session類(lei)的時候(hou)按照配(pei)置的參數自動(dong)初(chu)始化,例如,我們在應用(yong)(yong)配(pei)置中添加如下(xia)配(pei)置:
'session' => [
'prefix' => 'think',
'type' => '',
'auto_start' => true,
],
如(ru)果我們使用上述的session配置參數的話,無需(xu)任何(he)操作就可以直(zhi)接調(diao)用Session類的相(xiang)關方法,例如(ru):
Session::set('name','thinkphp');
Session::get('name');
如(ru)果你(ni)應用(yong)下面(mian)的不同(tong)模塊需(xu)要不同(tong)的session參數,那么可以在(zai)模塊配置文件中重新(xin)設置:
'session' => [
'prefix' => 'module',
'type' => '',
'auto_start' => true,
],
或(huo)者調(diao)用init方法進行初始化:
Session::init([
'prefix' => 'module',
'type' => '',
'auto_start' => true,
]);
如果你沒有使用Session類進行Session操作的話,例如直接操作
$_SESSION,必須使用上面的方式手動初始化或者直接調用session_start()方法進行session初始化。
設置參數
默認支持的session設置參數包括:
| 參數 | 描述 |
|---|---|
| type | session類型 |
| expire | session過期時間 |
| prefix | session前綴 |
| auto_start | 是否自動開啟 |
| use_trans_sid | 是否使用use_trans_sid |
| var_session_id | 請求session_id變量名 |
| id | session_id |
| name | session_name |
| path | session保存路徑 |
| domain | session cookie_domain |
| use_cookies | 是否使用cookie |
| cache_limiter | session_cache_limiter |
| cache_expire | session_cache_expire |
如果做了session驅動(dong)擴展,可能有(you)些參數不一(yi)定有(you)效。
基礎用法
賦值
// 賦值(當前作用域)
Session::set('name','thinkphp');
// 賦值(zhi)think作用(yong)域(yu)
Session::set('name','thinkphp','think');
判斷是否存在
// 判斷(duan)(當前(qian)作(zuo)用域)是否(fou)賦值
Session::has('name');
// 判斷think作用域(yu)下面是(shi)否賦值(zhi)
Session::has('name','think');
取值
// 取值(當前作用域)
Session::get('name');
// 取(qu)值think作用域
Session::get('name','think');
如果name的值不存在,返回null。
刪除
// 刪(shan)除(當(dang)前(qian)作用域)
Session::delete('name');
// 刪(shan)除think作用域(yu)下面的值
Session::delete('name','think');
指定作用域
// 指定當前(qian)作用域
Session::prefix('think');
取值并刪除
// 取值并(bing)刪除
Session::pull('name');
如果name的值不存在,返回Null。
清空
// 清除session(當前作用(yong)域)
Session::clear();
// 清除think作用域
Session::clear('think');
閃存數據,下次請求之前有效(v5.0.2+)
// 設置session 并(bing)且在下一次請求之前(qian)有(you)效
Session::flash('name','value');
提前清除當前請求有效的數據(v5.0.2+)
// 清除當前(qian)請求有(you)效的session
Session::flush();
二級數組
支持session的二維數(shu)組(zu)操作,例如:
// 賦值(zhi)(當前作用域(yu))
Session::set('name.item','thinkphp');
// 判(pan)斷(duan)(當前作用(yong)域)是否(fou)賦值
Session::has('name.item');
// 取值(zhi)(當前作用域)
Session::get('name.item');
// 刪除(chu)(當前作用域(yu))
Session::delete('name.item');
助手函數
系統也提(ti)供了助手(shou)函數session完成相同的功能,例如:
// 初始化session
session([
'prefix' => 'module',
'type' => '',
'auto_start' => true,
]);
// 賦值(當(dang)前作用(yong)域)
session('name', 'thinkphp');
// 賦值think作用域(yu)
session('name', 'thinkphp', 'think');
// 判斷(當(dang)前作用域)是否賦值
session('?name');
// 取值(當(dang)前作(zuo)用域)
session('name');
// 取值think作用域
session('name', '', 'think');
// 刪除(當(dang)前作(zuo)用域)
session('name', null);
// 清除session(當前作(zuo)用域(yu))
session(null);
// 清(qing)除think作用域
session(null, 'think');
Session驅動
支(zhi)持指定 Session 驅(qu)動,配置文件如下:
'session' => [
'prefix' => 'module',
'type' => 'redis',
'auto_start' => true,
// redis主機(ji)
'host' => '127.0.0.1',
// redis端口
'port' => 6379,
// 密碼(ma)
'password' => '',
]
表示使用redis作為session類型。
