ApcuStorage

Extends CacheStorage

APCu cache storage handler

link
since

3.5

package

Application

Methods

__construct

Constructor

__construct(array options = array()) : mixed
inherited
since

1.7.0

Arguments

options

arrayOptional parameters

Response

mixed

_getCacheId

Get a cache ID string from an ID/group pair

_getCacheId(string id, string group) : string
inherited
since

1.7.0

Arguments

id

stringThe cache data ID

group

stringThe cache data group

Response

string

addIncludePath

Add a directory where CacheStorage should search for handlers. You may either pass a string or an array of directories.

addIncludePath(array|string path = '') : array
inherited static
since

1.7.0

Arguments

path

array|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) : bool
inherited

group mode : cleans all cache in the group notgroup mode : cleans all cache not in the group

since

1.7.0

Arguments

group

stringThe cache data group

mode

stringThe mode for cleaning cache [group|notgroup]

Response

bool

contains

Check if the cache contains data stored by ID and group

contains(string id, string group) : bool
inherited
since

3.7.0

Arguments

id

stringThe cache data ID

group

stringThe cache data group

Response

bool

flush

Flush all existing items in storage.

flush() : bool
inherited
since

3.6.3

Response

bool

gc

Garbage collect expired cache data

gc() : bool
inherited
since

1.7.0

Response

bool

get

Get cached data by ID and group

get(string id, string group, bool checkTime = true) : mixed
inherited
since

1.7.0

Arguments

id

stringThe cache data ID

group

stringThe cache data group

checkTime

boolTrue to verify cache time expiration threshold

Response

mixedBoolean false on failure or a cached data object

getAll

Get all cached data

getAll() : mixed
inherited
since

1.7.0

Response

mixedBoolean false on failure or a cached data object

getInstance

Returns a cache storage handler object.

getInstance(string handler = null, array options = array()) : \Joomla\CMS\Cache\CacheStorage
inherited static
since

1.7.0

throws

\UnexpectedValueException

\Joomla\CMS\Cache\Exception\UnsupportedCacheException

Arguments

handler

stringThe cache storage handler to instantiate

options

arrayArray of handler options

Response

\Joomla\CMS\Cache\CacheStorage

isSupported

Test to see if the storage handler is available.

isSupported() : bool
inherited static
since

3.0.0

Response

bool

lock

Lock cached item

lock(string id, string group, int locktime) : mixed
inherited
since

1.7.0

Arguments

id

stringThe cache data ID

group

stringThe cache data group

locktime

intCached item max lock time

Response

mixedBoolean false if locking failed or an object containing properties lock and locklooped

remove

Remove a cached data entry by ID and group

remove(string id, string group) : bool
inherited
since

1.7.0

Arguments

id

stringThe cache data ID

group

stringThe cache data group

Response

bool

store

Store the data to cache by ID and group

store(string id, string group, string data) : bool
inherited
since

1.7.0

Arguments

id

stringThe cache data ID

group

stringThe cache data group

data

stringThe data to store in cache

Response

bool

unlock

Unlock cached item

unlock(string id, string group = null) : bool
inherited
since

1.7.0

Arguments

id

stringThe cache data ID

group

stringThe cache data group

Response

bool

Properties

rawname

The raw object name

inherited
since

1.7.0

Type(s)

string

_now

Time that the cache storage handler was instantiated

inherited
since

1.7.0

Type(s)

int

_lifetime

Cache lifetime

inherited
since

1.7.0

Type(s)

int

_locking

Flag if locking is enabled

inherited
since

1.7.0

Type(s)

bool

_language

Language code

inherited
since

1.7.0

Type(s)

string

_application

Application name

inherited
since

1.7.0

Type(s)

string

_hash

Object hash

inherited
since

1.7.0

Type(s)

string