[TOC]
### 組件說明
> Lying的Session是內置組件,用于簡單的操作session。
> session支持多維數組操作,如`$session->set('user.name', 'lying');`。
### 配置選項
| 配置名 | 參數類型 | 可選 | 默認值 | 說明 |
| --- | --- | --- | --- | --- |
| class | string | 是 | lying\service\Session | 不可更改 |
### 示例配置
Session組件暫時不需要配置,可直接使用
### 調用方式
~~~php
\Lying::$maker->get('session');
\Lying::$maker->session();
\Lying::$maker->session;
~~~
### 方法列表
~~~php
/**
* 判斷SESSION是否啟用
* @return bool 返回SESSION是否已經啟用
*/
public function isActive();
~~~
* * * * *
~~~php
/**
* 啟用SESSION
* @return bool 返回SESSION是否成功啟用
*/
public function open();
~~~
* * * * *
~~~php
/**
* 寫入SESSION并關閉SESSION
* 此操作并不會清空$_SESSION數組,也不會重置會話cookie,如果需要再次使用會話變量,必須重新調用open函數
* @return bool 返回會話是否成功關閉
*/
public function close();
~~~
* * * * *
~~~php
/**
* 銷毀會話,不會重置會話cookie,但會清空$_SESSION數組并且關閉會話,如果需要再次使用會話變量,必須重新調用open函數
* @return bool 返回會話是否成功關閉,如果會話未啟用則返回false
*/
public function destroy();
~~~
* * * * *
~~~php
/**
* 獲取SESSION的值
* @param string $key 鍵名
* @param mixed $default 默認值,默認為null
* @return mixed 返回SESSION的值
*/
public function get($key, $default = null);
~~~
* * * * *
~~~
/**
* 設置SESSION的值
* @param string $key 鍵名
* @param mixed $value 值
*/
public function set($key, $value);
~~~
* * * * *
~~~php
/**
* SESSION是否存在
* @param string $key 鍵名
* @return bool 返回SESSION是否存在
*/
public function exists($key);
~~~
* * * * *
~~~php
/**
* 移除SESSION
* @param string $key 要移除的鍵名,如果key為null,則清空整個$_SESSION數組
* @return bool 返回SESSION是否成功移除
*/
public function remove($key = null);
~~~
* * * * *
~~~php
/**
* 獲取/設置新的會話ID
* @param string $newId 新的會話ID
* @return bool|string 返回當前會話ID,如果設置會話ID失敗,則返回false
*/
public function id($newId = null);
~~~
* * * * *
~~~php
/**
* 獲取/設置新的會話名稱
* @param string $newName 新的會話名稱
* @return bool|string 返回當前會話名稱,如果設置會話名稱失敗,則返回false
*/
public function name($newName = null);
~~~
* * * * *
~~~php
/**
* 獲取/設置當前會話的保存路徑
* @param string $newPath 指定會話數據保存的路徑
* @return bool|string 返回前會話的保存路徑,如果設置會話路徑失敗,則返回false
*/
public function savePath($newPath = null);
~~~
* * * * *
~~~php
/**
* 獲取/設置會話cookie參數
* @param array $params 會話cookie參數
* @return array|bool 成功返回會話cookie參數,失敗返回false
*/
public function cookieParams(array $params = null);
~~~
- 序言
- 更新日志
- 安裝
- 規范
- 常量
- 配置
- 自動加載
- MVC
- 模塊
- 控制器
- 模型
- 視圖
- php原生模板
- 模板引擎
- 變量輸出
- 模板注釋
- 模板繼承
- 模板引用
- 流程控制
- 原樣輸出
- 服務組件
- Hook組件
- Request組件
- Router組件
- Cookie組件
- Encrypter組件
- Dispatch組件
- Response組件
- View組件
- Session組件
- Helper組件
- 數據分頁
- 數據驗證
- Logger組件
- Cache組件
- Redis組件
- Connection組件
- 執行sql語句
- 查詢生成器
- 查詢方法詳解
- Schema
- Captcha組件
- CLI
- CLI工具
- 事件
- 類事件
- 實例事件
- 全局事件
- 助手函數
- 擴展
- 異常
- 部署
- Apache
- Nginx
- IIS
- 虛擬主機