Methods

Public

__construct()

Constructor.

__destruct()

Default destructor; does nothing other than provide a safe fallback for calls to parent::__destruct().

add()

Inserts cache entry data, but only if the entry does not already exist.

delete()

Deletes an entry from the cache.

deleteAll()

Removes all entries from the cache.

dump()

Convenience method for getting a dump the whole object, or one of its properties, or an external variable.

entry()

Returns the path and filename for the entry key.

fetch()

Fetches cache entry data.

fetchOrAdd()

Fetches data if it exists; if not, uses a callback to create the data and adds it to the cache in a race-condition-safe way.

fetchOrSave()

Fetches data if it exists; if not, uses a callback to create the data and saves it to the cache.

getLife()

Gets the cache lifetime in seconds.

increment()

Increments a cache entry value by the specified amount.

isActive()

Gets the current activity state of the cache (on or off).

locale()

Looks up class-specific locale strings based on a key.

save()

Inserts/updates cache entry data.

setActive()

Makes the cache active (true) or inactive (false).

Protected

_buildConfig()

Builds and returns the default config for a class, including all configs inherited from its parents.

_deleteAll()

Support method to recursively descend into cache subdirectories and remove their contents.

_exception()

Convenience method for returning exceptions with localized text.

_fetchOrInsert()

Support method for fetchOrSave() and fetchOrAdd().

_isExpired()

Checks if a file has expired (is past its lifetime) or not.

_postConfig()

A hook that activates after _buildConfig() in the constructor.

_postConstruct()

Post-construction tasks to complete object construction.

_preConfig()

Sets the default cache directory location.

Private

None.