API 文档 - ginkgo


ginkgo\session\Driver

会话驱动抽象类,无法直接实例化


类摘要

namespace ginkgo\session;

abstract class Driver {
  // 属性
  public $config = array();

  protected static $instance;

  private $configThis = array(
    'life_time' => 1200,
  );

  // 方法
  public static instance( [ array $config ] ) : object
  public config( array $config )
  public open( string $save_path, string $session_name ) : bool
  public close() : bool
  public read( string $session_id ) : mixed
  public write( string $session_id, mixed $session_data ) : bool
  public destroy( string $session_id ) : bool
  public gc( int $ssin_max_lifetime ) : bool

  protected __construct( [ array $config ] ) : object
  protected __clone()
}

成员目录

- 权限 类型 描述
属性 - - -
$config public array 配置
$instance protected object static 本类的实例
$configThis private array 默认配置
方法 - - -
instance() public static 实例化方法
config() public 配置
open() public 开启会话
close() public 关闭会话
read() public 读取会话
write() public 写入会话
destroy() public 销毁会话
gc() public 清理会话
__construct() protected instance()
__clone() protected 克隆,无实际功能,仅供限制为单例模式使用

$config 配置,$configThis 默认配置

public $config;
private $configThis;

结构

名称 类型 默认 描述
life_time int 24小时 有效期
prefix string ginkgo 前缀

instance() 实例化

public static function instance( [ array $config ] ) : object

参数

返回

  • 本类实例

config() 配置

0.2.0 新增

public function config( array $config )

参数

返回


open() 开启会话

public function open( string $save_path, string $session_name ) : bool

参数

  • save_path 会话保存路径
  • session_name 会话名称

返回

  • 布尔值

close() 关闭会话

public function close() : bool

参数

返回

  • 布尔值

read() 读取会话

public function read( string $session_id ) : mixed

参数

  • session_id 会话 ID

返回

  • 会话数据

write() 写入会话

public function write( string $session_id, mixed $session_data ) : bool

参数

  • session_id 会话 ID
  • session_data 会话数据

返回

  • 布尔值

destroy() 销毁会话

public function destroy( string $session_id ) : bool

参数

  • session_id 会话 ID

返回

  • 布尔值

gc() 清理会话

public function gc( int $ssin_max_lifetime ) : bool

参数

  • ssin_max_lifetime 会话最长生命周期

返回

  • 布尔值

更新时间 10-15 12:54
Top