CacheStorage

Abstract cache storage handler

since

1.7.0

note

As of 4.0 this class will be abstract

package

Joomla CMS

Methods

__construct

Constructor

__construct(mixed||string|int options = []) : 
since

1.7.0

Arguments

options

array<string|int, mixed>Optional parameters

Response

mixed

_getCacheId

Get a cache ID string from an ID/group pair

_getCacheId( id,  group) : 
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 = '') : mixed||string|int
static
since

1.7.0

Arguments

path

array<string|int, mixed>|stringA path to search.

Response

array<string|int, mixed>An array with directory elements

clean

Clean cache for a group given a mode.

clean( group,  mode = null) : 

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( id,  group) : 
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() : 
since

3.6.3

Response

bool

gc

Garbage collect expired cache data

gc() : 
since

1.7.0

Response

bool

get

Get cached data by ID and group

get( id,  group,  checkTime = true) : 
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() : 
since

1.7.0

Response

mixedBoolean false on failure or a cached data object

getInstance

Returns a cache storage handler object.

getInstance( handler = null, mixed||string|int options = []) : \Joomla\CMS\Cache\CacheStorage
static
since

1.7.0

throws

UnexpectedValueException

UnsupportedCacheException

Arguments

handler

stringThe cache storage handler to instantiate

options

array<string|int, mixed>Array of handler options

Response

CacheStorage

isSupported

Test to see if the storage handler is available.

isSupported() : 
static
since

3.0.0

Response

bool

lock

Lock cached item

lock( id,  group,  locktime) : 
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( id,  group) : 
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( id,  group,  data) : 
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( id,  group = null) : 
since

1.7.0

Arguments

id

stringThe cache data ID

group

stringThe cache data group

Response

bool

Properties

rawname

The raw object name

since

1.7.0

Type(s)

string

_now

Time that the cache storage handler was instantiated

since

1.7.0

Type(s)

int

_lifetime

Cache lifetime

since

1.7.0

Type(s)

int

_locking

Flag if locking is enabled

since

1.7.0

Type(s)

bool

_language

Language code

since

1.7.0

Type(s)

string

_application

Application name

since

1.7.0

Type(s)

string

_hash

Object hash

since

1.7.0

Type(s)

string

_threshold

The threshold

since

4.3.0

Type(s)

int