Joomla! API

Download
Launch

Cache

Joomla! Cache base object

since

1.7.0
package

Joomla CMS

Methods

__construct

Constructor

__construct(array options) : mixed
since

1.7.0

Arguments

options

arrayCache options

Response

mixed

_getStorage

Get the cache storage handler

_getStorage() : \Joomla\CMS\Cache\CacheStorage
since

1.7.0

Response

\Joomla\CMS\Cache\CacheStorage

addIncludePath

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

addIncludePath(array|string path = '') : array
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 = null, string mode = 'group') : bool

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

boolTrue on success, false otherwise

contains

Check if the cache contains data stored by ID and group

contains(string id, string group = null) : bool
since

3.7.0

Arguments

id

stringThe cache data ID

group

stringThe cache data group

Response

bool

gc

Garbage collect expired cache data

gc() : bool
since

1.7.0

Response

bool

get

Get cached data by ID and group

get(string id, string group = null) : mixed
since

1.7.0

Arguments

id

stringThe cache data ID

group

stringThe cache data group

Response

mixedBoolean false on failure or a cached data object

getAll

Get a list of all cached data

getAll() : mixed
since

1.7.0

Response

mixedBoolean false on failure or an object with a list of cache groups and data

getCaching

Get caching state

getCaching() : bool
since

1.7.0

Response

bool

getInstance

Returns a reference to a cache adapter object, always creating it

getInstance(string type = 'output', array options = array()) : \Joomla\CMS\Cache\CacheController
static
since

1.7.0

Arguments

type

stringThe cache object type to instantiate

options

arrayThe array of options

Response

\Joomla\CMS\Cache\CacheController

getPlatformPrefix

Set a prefix cache key if device calls for separate caching

getPlatformPrefix() : string
static
since

3.5

Response

string

getStores

Get the storage handlers

getStores() : array
static
since

1.7.0

Response

array

getWorkarounds

Perform workarounds on retrieved cached data

getWorkarounds(string data, array options = array()) : string
static
since

1.7.0

Arguments

data

stringCached data

options

arrayArray of options

Response

stringBody of cached data

lock

Set lock flag on cached item

lock(string id, string group = null, string locktime = null) : \stdClass
since

1.7.0

Arguments

id

stringThe cache data ID

group

stringThe cache data group

locktime

stringThe default locktime for locking the cache.

Response

\stdClassObject with properties of lock and locklooped

makeId

Create a safe ID for cached data from URL parameters

makeId() : string
static
since

1.7.0

Response

stringMD5 encoded cache ID

remove

Remove a cached data entry by ID and group

remove(string id, string group = null) : bool
since

1.7.0

Arguments

id

stringThe cache data ID

group

stringThe cache data group

Response

bool

setCaching

Set caching enabled state

setCaching(bool enabled) : void
since

1.7.0

Arguments

enabled

boolTrue to enable caching

setLifeTime

Set cache lifetime

setLifeTime(int lt) : void
since

1.7.0

Arguments

lt

intCache lifetime

setWorkarounds

Create workarounds for data to be cached

setWorkarounds(string data, array options = array()) : string
static
since

1.7.0

Arguments

data

stringCached data

options

arrayArray of options

Response

stringData to be cached

store

Store the cached data by ID and group

store(mixed data, string id, string group = null) : bool
since

1.7.0

Arguments

data

mixedThe data to store

id

stringThe cache data ID

group

stringThe cache data group

Response

bool

unlock

Unset lock flag on cached item

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

1.7.0

Arguments

id

stringThe cache data ID

group

stringThe cache data group

Response

bool

Properties

_handler

Storage handler

static
since

1.7.0

Type(s)

\Joomla\CMS\Cache\CacheStorage[]

_options

Cache options

since

1.7.0

Type(s)

array
  • \ Joomla
  • \ CMS
  • \ Cache
  • \ Cache