[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
- 虚拟主机