类 DatabaseSession
DatabaseSession 提供了与 Session 一起使用的方法。
命名空间: Cake\Http\Session
属性摘要
-
$_table protected
Cake\ORM\Table对处理会话数据的表的引用
-
$_tableLocator protected
Cake\ORM\Locator\LocatorInterface|null表定位器实例
-
$_timeout protected
int将会话标记为过期的时间（以秒为单位）
-
$defaultTable protected
string|null此对象的默认表别名。
方法摘要
-
__construct() public
构造函数。查看 Session 配置信息并设置会话模型。
-
close() public
在数据库会话关闭时调用的方法。
-
destroy() public
在数据库会话销毁时调用的方法。
-
fetchTable() public
获取表实例的便捷方法。
-
gc() public
数据库会话 gc 时调用的辅助函数。
-
getTableLocator() public
获取表定位器。
-
open() public
在数据库会话打开时调用的方法。
-
read() public
用于从数据库会话读取数据的方法。
-
setTableLocator() public
设置表定位器。
-
setTimeout() public
设置会话的超时值。
-
write() public
数据库会话写入时调用的辅助函数。
方法详情
__construct() ¶ public
__construct(array<string, mixed> $config = [])构造函数。查看 Session 配置信息并设置会话模型。
参数
-
array<string, mixed>$config optional 此引擎的配置。它要求存在 'model' 键，对应于用于管理会话的表。
fetchTable() ¶ public
fetchTable(string|null $alias = null, array<string, mixed> $options = []): Cake\ORM\Table获取表实例的便捷方法。
参数
-
string|null$alias optional 您要获取的别名。应为 CamelCase 格式。如果为 `null`，则使用 $defaultTable 属性的值。
-
array<string, mixed>$options optional 您要构建表的选项。如果表已加载，则注册选项将被忽略。
返回
Cake\ORM\Table抛出
Cake\Core\Exception\CakeException如果 `$alias` 参数和 `$defaultTable` 属性都为 `null`。
另请参阅
\Cake\ORM\TableLocator::get()
gc() ¶ public
gc(int $max_lifetime): int|false数据库会话 gc 时调用的辅助函数。
参数
-
int$max_lifetime 最后 `maxlifetime` 秒内没有更新的会话将被删除。
返回
int|falsegetTableLocator() ¶ public
getTableLocator(): Cake\ORM\Locator\LocatorInterface获取表定位器。
返回
Cake\ORM\Locator\LocatorInterfaceopen() ¶ public
open(string $path, string $name): bool在数据库会话打开时调用的方法。
参数
-
string$path 存储/检索会话的路径。
-
string$name 会话名称。
返回
boolread() ¶ public
read(string $id): string|false用于从数据库会话读取数据的方法。
参数
-
string$id 唯一标识数据库中会话的 ID。
返回
string|falsesetTableLocator() ¶ public
setTableLocator(Cake\ORM\Locator\LocatorInterface $tableLocator): $this设置表定位器。
参数
-
Cake\ORM\Locator\LocatorInterface$tableLocator LocatorInterface 实例。
返回
$thissetTimeout() ¶ public
setTimeout(int $timeout): $this设置会话的超时值。
主要用于测试。
参数
-
int$timeout 超时时间。
返回
$thiswrite() ¶ public
write(string $id, string $data): bool数据库会话写入时调用的辅助函数。
参数
-
string$id 唯一标识数据库中会话的 ID。
-
string$data 要保存的数据。
返回
bool