Cache
Joomla! 缓存基础对象
自 |
1.7.0 |
---|---|
包 |
Joomla CMS |
方法
__construct
构造函数
__construct(mixed||string|int options) :
自 |
1.7.0 |
---|
参数
- options
array<string|int, mixed>
缓存选项
响应
mixed
addIncludePath
添加 Cache 应在其中搜索处理程序的目录。您可以传递字符串或目录数组。
addIncludePath(array|string path = '') : mixed||string|int
自 |
1.7.0 |
---|
参数
- path
array<string|int, mixed>|string
要搜索的路径。
响应
array<string|int, mixed>
包含目录元素的数组
clean
清理给定模式的组的缓存。
clean( group = null, mode = 'group') :
group 模式:清理组中所有缓存 notgroup 模式:清理组外所有缓存
自 |
1.7.0 |
---|
参数
- group
string
缓存数据组- mode
string
用于清理缓存的模式 [group|notgroup]
响应
bool
成功时为 True,否则为 False
contains
检查缓存是否包含通过 ID 和组存储的数据
contains( id, group = null) :
自 |
3.7.0 |
---|
参数
- id
string
缓存数据 ID- group
string
缓存数据组
响应
bool
gc
垃圾回收过期的缓存数据
gc() :
自 |
1.7.0 |
---|
响应
bool
get
通过 ID 和组获取缓存数据
get( id, group = null) :
自 |
1.7.0 |
---|
参数
- id
string
缓存数据 ID- group
string
缓存数据组
响应
mixed
失败时为布尔值 false 或缓存数据对象
getAll
获取所有缓存数据的列表
getAll() :
自 |
1.7.0 |
---|
响应
mixed
失败时为布尔值 false 或包含缓存组和数据列表的对象
getCaching
获取缓存状态
getCaching() :
自 |
1.7.0 |
---|
响应
bool
getInstance
返回对缓存适配器对象的引用,始终创建它
getInstance( type = 'output', mixed||string|int options = []) : \Joomla\CMS\Cache\CacheController
自 |
1.7.0 |
---|---|
已弃用 |
4.2 将在 6.0 中删除 使用缓存控制器工厂代替 示例:Factory::getContainer()->get(CacheControllerFactoryInterface::class)->createCacheController($type, $options); |
参数
- type
string
要实例化的缓存对象类型- options
array<string|int, mixed>
选项数组
响应
getPlatformPrefix
如果设备需要单独缓存,则设置前缀缓存键
getPlatformPrefix() :
自 |
3.5 |
---|
响应
string
getStores
获取存储处理程序
getStores() : mixed||string|int
自 |
1.7.0 |
---|
响应
array<string|int, mixed>
getWorkarounds
对检索到的缓存数据执行变通方案
getWorkarounds(mixed||string|int data, mixed||string|int options = []) :
自 |
1.7.0 |
---|
参数
- data
array<string|int, mixed>
缓存数据- options
array<string|int, mixed>
选项数组
响应
string
缓存数据的正文
lock
设置缓存项上的锁定标志
lock( id, group = null, locktime = null) : \stdClass
自 |
1.7.0 |
---|
参数
- id
string
缓存数据 ID- group
string
缓存数据组- locktime
string
锁定缓存的默认锁定时间。
响应
stdClass
包含锁定和锁定循环属性的对象
makeId
从 URL 参数创建缓存数据的安全 ID
makeId() :
自 |
1.7.0 |
---|
响应
string
MD5 编码的缓存 ID
remove
通过 ID 和组删除缓存数据条目
remove( id, group = null) :
自 |
1.7.0 |
---|
参数
- id
string
缓存数据 ID- group
string
缓存数据组
响应
bool
setCaching
设置缓存启用状态
setCaching( enabled) :
自 |
1.7.0 |
---|
参数
- enabled
bool
启用缓存时为 True
响应
void
setLifeTime
设置缓存生命周期
setLifeTime( lt) :
自 |
1.7.0 |
---|
参数
- lt
int
缓存生命周期(以分钟为单位)
响应
void
setWorkarounds
为要缓存的数据创建变通方案
setWorkarounds( data, mixed||string|int options = []) : mixed||string|int
自 |
1.7.0 |
---|
参数
- data
string
缓存数据- options
array<string|int, mixed>
选项数组
响应
array<string|int, mixed>
要缓存的数据
store
通过 ID 和组存储缓存数据
store( data, id, group = null) :
自 |
1.7.0 |
---|
参数
- data
mixed
要存储的数据- id
string
缓存数据 ID- group
string
缓存数据组
响应
bool
unlock
取消设置缓存项上的锁定标志
unlock( id, group = null) :
自 |
1.7.0 |
---|
参数
- id
string
缓存数据 ID- group
string
缓存数据组
响应
bool
属性
_options
缓存选项
自 |
1.7.0 |
---|
类型
array<string|int, mixed>