Page MenuHomeClusterLabs Projects
Diviner Tech Docs PhabricatorKeyValueSerializingCacheProxy

final class PhabricatorKeyValueSerializingCacheProxy
Phorge Technical Documentation (Cache)

Proxies another cache and serializes values.

This allows more complex data to be stored in a cache which can only store strings.

Tasks

Key-Value Cache Implementation

  • public function isAvailable()
  • final public function getKey($key, $default) — Get a single key from cache. See @{method:getKeys} to get multiple keys at once.
  • final public function setKey($key, $value, $ttl) — Set a single key in cache. See @{method:setKeys} to set multiple keys at once.
  • final public function deleteKey($key) — Delete a key from the cache. See @{method:deleteKeys} to delete multiple keys at once.
  • public function getKeys($keys)
  • public function setKeys($keys, $ttl)
  • public function deleteKeys($keys)
  • public function destroyCache()

Other Methods

Methods

public function isAvailable()
Inherited

PhutilKeyValueCache

Determine if the cache is available. For example, the APC cache tests if APC is installed. If this method returns false, the cache is not operational and can not be used.

Return
boolTrue if the cache can be used.

final public function getKey($key, $default)
Inherited

PhutilKeyValueCache

Get a single key from cache. See getKeys() to get multiple keys at once.

Parameters
string$keyKey to retrieve.
wild$defaultOptional value to return if the key is not found. By default, returns null.
Return
wildCache value (on cache hit) or default value (on cache miss).

final public function setKey($key, $value, $ttl)
Inherited

PhutilKeyValueCache

Set a single key in cache. See setKeys() to set multiple keys at once.

See setKeys() for a description of TTLs.

Parameters
string$keyKey to set.
wild$valueValue to set.
int|null$ttlOptional TTL.
Return
this

final public function deleteKey($key)
Inherited

PhutilKeyValueCache

Delete a key from the cache. See deleteKeys() to delete multiple keys at once.

Parameters
string$keyKey to delete.
Return
this

public function getKeys($keys)

PhutilKeyValueCache

Get data from the cache.

PhabricatorKeyValueSerializingCacheProxy
This method is not documented.
Parameters
list<string>$keysList of cache keys to retrieve.
Return
dict<string, wild>Dictionary of keys that were found in the cache. Keys not present in the cache are omitted, so you can detect a cache miss.

public function setKeys($keys, $ttl)

PhutilKeyValueCache

Put data into the key-value cache.

With a TTL ("time to live"), the cache will automatically delete the key after a specified number of seconds. By default, there is no expiration policy and data will persist in cache indefinitely.

PhabricatorKeyValueSerializingCacheProxy
This method is not documented.
Parameters
dict<string,$keyswild> Map of cache keys to values.
int|null$ttlTTL for cache keys, in seconds.
Return
this

public function deleteKeys($keys)
Inherited

PhutilKeyValueCache

Delete a list of keys from the cache.

Parameters
list<string>$keysList of keys to delete.
Return
this

public function destroyCache()
Inherited

PhutilKeyValueCache

Completely destroy all data in the cache.

Return
this

final public function __construct($proxy)
Inherited

This method is not documented.
Parameters
PhutilKeyValueCache$proxy
Return
this//Implicit.//

final protected function getProxy()
Inherited

This method is not documented.
Return
wild

public function __call($method, $arguments)
Inherited

This method is not documented.
Parameters
$method
array$arguments
Return
wild
Defined
src/applications/cache/PhabricatorKeyValueSerializingCacheProxy.php:9
Extends
PhutilKeyValueCachePhutilKeyValueCacheProxy