117 lines
2.8 KiB
PHP
117 lines
2.8 KiB
PHP
<?php
|
||
declare(strict_types=1);
|
||
|
||
namespace core\jwt\interfaces;
|
||
|
||
/**
|
||
* Token 存储接口
|
||
*
|
||
* 可实现此接口以支持不同的存储后端（Redis、MySQL、Memcached 等）
|
||
*/
|
||
interface TokenStorageInterface
|
||
{
|
||
/**
|
||
* 保存 Token 信息
|
||
*
|
||
* @param string $jti Token 唯一标识
|
||
* @param array $data Token 数据
|
||
* @param int $ttl 有效期（秒）
|
||
* @return bool
|
||
*/
|
||
public function save(string $jti, array $data, int $ttl): bool;
|
||
|
||
/**
|
||
* 获取 Token 信息
|
||
*
|
||
* @param string $jti
|
||
* @return array|null
|
||
*/
|
||
public function get(string $jti): ?array;
|
||
|
||
/**
|
||
* 删除 Token 信息
|
||
*
|
||
* @param string $jti
|
||
* @return bool
|
||
*/
|
||
public function delete(string $jti): bool;
|
||
|
||
/**
|
||
* 验证 Token 是否存在
|
||
*
|
||
* @param string $jti
|
||
* @return bool
|
||
*/
|
||
public function exists(string $jti): bool;
|
||
|
||
/**
|
||
* 根据用户删除所有 Token
|
||
*
|
||
* @param string $id 用户ID（雪花ID）
|
||
* @param string|null $clientType
|
||
* @param string|null $exceptJti 保留的 JTI
|
||
* @return int 删除数量
|
||
*/
|
||
public function deleteByUser(string $id, ?string $clientType = null, ?string $exceptJti = null): int;
|
||
|
||
/**
|
||
* 删除最早的 Token
|
||
*
|
||
* @param string $id 用户ID（雪花ID）
|
||
* @return bool
|
||
*/
|
||
public function deleteOldest(string $id): bool;
|
||
|
||
/**
|
||
* 获取用户的所有 Token 数量
|
||
*
|
||
* @param string $id 用户ID（雪花ID）
|
||
* @param string|null $clientType
|
||
* @return int
|
||
*/
|
||
public function countByUser(string $id, ?string $clientType = null): int;
|
||
|
||
/**
|
||
* 获取用户的所有 Token
|
||
*
|
||
* @param string $id 用户ID（雪花ID）
|
||
* @return array
|
||
*/
|
||
public function getByUser(string $id): array;
|
||
|
||
/**
|
||
* 获取用户的所有 Token 信息（包含索引信息）
|
||
*
|
||
* @param string $id 用户ID（雪花ID）
|
||
* @param string|null $clientType 客户端类型
|
||
* @return array
|
||
*/
|
||
public function getUserTokens(string $id, ?string $clientType = null): array;
|
||
|
||
/**
|
||
* 获取所有在线 Token 信息
|
||
*
|
||
* @param string|null $clientType 客户端类型
|
||
* @return array
|
||
*/
|
||
public function getAllTokens(?string $clientType = null): array;
|
||
|
||
/**
|
||
* 更新 Token 最后活跃时间
|
||
*
|
||
* @param string $jti Token 唯一标识
|
||
* @param int|null $timestamp 活跃时间戳
|
||
* @return bool
|
||
*/
|
||
public function touch(string $jti, ?int $timestamp = null): bool;
|
||
|
||
/**
|
||
* 标记 Token 会话离线
|
||
*
|
||
* @param string $jti Token 唯一标识
|
||
* @param int|null $timestamp 离线时间戳
|
||
* @return bool
|
||
*/
|
||
public function markOffline(string $jti, ?int $timestamp = null): bool;
|
||
}
|