JCacheStorageApc
Extends \JCacheStorageAPC cache storage handler
| package |
Joomla.Platform |
|---|---|
| subpackage |
Cache |
| see | |
| since |
11.1 |
Methods
__construct
Constructor
__construct(array $options = array())
| since |
11.1 |
|---|
Arguments
- $options
arrayOptional parameters
_getCacheId
Get a cache_id string from an id/group pair
_getCacheId(string $id, string $group) : string
| since |
11.1 |
|---|
Arguments
- $id
stringThe cache data id- $group
stringThe cache data group
Response
stringThe cache_id string
addIncludePath
Add a directory where JCacheStorage should search for handlers. You may either pass a string or an array of directories.
addIncludePath(string $path = '') : array
| since |
11.1 |
|---|
Arguments
- $path
stringA path to search.
Response
arrayAn array with directory elements
clean
Clean cache for a group given a mode.
clean(string $group, string $mode = null) : boolean
| since |
11.1 |
|---|
Arguments
- $group
stringThe cache data group- $mode
stringThe mode for cleaning cache [group|notgroup] group mode : cleans all cache in the group notgroup mode : cleans all cache not in the group
Response
booleanTrue on success, false otherwise
gc
Garbage collect expired cache data
gc() : boolean
| since |
11.1 |
|---|
Response
booleanTrue on success, false otherwise.
get
Get cached data by id and group
get(string $id, string $group, boolean $checkTime = true) : mixed
| since |
11.1 |
|---|
Arguments
- $id
stringThe cache data id- $group
stringThe cache data group- $checkTime
booleanTrue to verify cache time expiration threshold
Response
mixedBoolean false on failure or a cached data object
getAll
Get all cached data
getAll() : mixed
| since |
11.1 |
|---|
Response
mixedBoolean false on failure or a cached data object
getInstance
Returns a cache storage handler object, only creating it if it doesn't already exist.
getInstance(string $handler = null, array $options = array()) : \JCacheStorageHandler
| since |
11.1 |
|---|
Arguments
- $handler
stringThe cache storage handler to instantiate- $options
arrayArray of handler options
Response
\JCacheStorageHandlerA JCacheStorageHandler object
lock
Lock cached item
lock(string $id, string $group, integer $locktime) : boolean
| since |
11.1 |
|---|
Arguments
- $id
stringThe cache data id- $group
stringThe cache data group- $locktime
integerCached item max lock time
Response
booleanTrue on success, false otherwise.
remove
Remove a cached data entry by id and group
remove(string $id, string $group) : boolean
| since |
11.1 |
|---|
Arguments
- $id
stringThe cache data id- $group
stringThe cache data group
Response
booleanTrue on success, false otherwise
store
Store the data to cache by id and group
store(string $id, string $group, string $data) : boolean
| since |
11.1 |
|---|
Arguments
- $id
stringThe cache data id- $group
stringThe cache data group- $data
stringThe data to store in cache
Response
booleanTrue on success, false otherwise
test
Test to see if the storage handler is available.
test() : boolean
| since |
11.1. |
|---|
Response
booleanTrue on success, false otherwise
unlock
Unlock cached item
unlock(string $id, string $group = null) : boolean
| since |
11.1 |
|---|
Arguments
- $id
stringThe cache data id- $group
stringThe cache data group
Response
booleanTrue on success, false otherwise.
Properties
rawname
Rawname
| since |
11.1 |
|---|
Type(s)
string
_now
Now
| since |
11.1 |
|---|
Type(s)
\datetime
_lifetime
Cache lifetime
| since |
11.1 |
|---|
Type(s)
integer
_locking
Locking
| since |
11.1 |
|---|
Type(s)
boolean
_language
Language
| since |
11.1 |
|---|
Type(s)
string
_application
Application name.
| since |
11.1 |
|---|
Type(s)
string
_hash
Hash
| since |
11.1 |
|---|
Type(s)
string