Diviner Tech Docs PhutilKeyValueCache

abstract class PhutilKeyValueCache
Phorge Technical Documentation ()

Interface to a key-value cache like Memcache or APC. This class provides a uniform interface to multiple different key-value caches and integration with PhutilServiceProfiler.

Tasks

Key-Value Cache Implementation

public function isAvailable() — 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.
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.
abstract public function getKeys($keys) — Get data from the cache.
abstract public function setKeys($keys, $ttl) — Put data into the key-value cache.
abstract public function deleteKeys($keys) — Delete a list of keys from the cache.
abstract public function destroyCache() — Completely destroy all data in the cache.

Other Methods

public function __get($name)
public function __set($name, $value)
public function current()
public function key()
public function next()
public function rewind()
public function valid()
private function throwOnAttemptedIteration()
public function getPhobjectClassConstant($key, $byte_limit) — Read the value of a class constant.

Methods

public function __get($name)
Inherited

This method is not documented.

Parameters

$name

Return

wild

public function __set($name, $value)
Inherited

This method is not documented.

Parameters

	$name
	$value

Return

wild

public function current()
Inherited

This method is not documented.

Return

wild

public function key()
Inherited

This method is not documented.

Return

wild

public function next()
Inherited

This method is not documented.

Return

wild

public function rewind()
Inherited

This method is not documented.

Return

wild

public function valid()
Inherited

This method is not documented.

Return

wild

private function throwOnAttemptedIteration()
Inherited

This method is not documented.

Return

wild

public function getPhobjectClassConstant($key, $byte_limit)
Inherited

Phobject

Read the value of a class constant.

This is the same as just typing self::CONSTANTNAME, but throws a more useful message if the constant is not defined and allows the constant to be limited to a maximum length.

Parameters

string	$key	Name of the constant.
int\|null	$byte_limit	Maximum number of bytes permitted in the value.

Return

string

Value of the constant.

public function isAvailable()

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

bool	True if the cache can be used.

final public function getKey($key, $default)

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

Parameters

string	$key	Key to retrieve.
wild	$default	Optional value to return if the key is not found. By default, returns null.

Return

wild	Cache value (on cache hit) or default value (on cache miss).

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

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

See setKeys() for a description of TTLs.

Parameters

string	$key	Key to set.
wild	$value	Value to set.
int\|null	$ttl	Optional TTL.

Return

this

final public function deleteKey($key)

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

Parameters

string

$key

Key to delete.

Return

this

abstract public function getKeys($keys)

Get data from the cache.

Parameters

list<string>

$keys

List 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.

abstract public function setKeys($keys, $ttl)

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.

Parameters

dict<string,	$keys	wild> Map of cache keys to values.
int\|null	$ttl	TTL for cache keys, in seconds.

Return

this

abstract public function deleteKeys($keys)

Delete a list of keys from the cache.

Parameters

list<string>

$keys

List of keys to delete.

Return

this

abstract public function destroyCache()

Completely destroy all data in the cache.

Return

this

Defined: src/infrastructure/cache/PhutilKeyValueCache.php:10
Extends: Phobject

abstract class PhutilKeyValueCachePhorge Technical Documentation ()

Tasks

Key-Value Cache Implementation

Other Methods

Methods

public function __get($name)Inherited

public function __set($name, $value)Inherited

public function current()Inherited

public function key()Inherited

public function next()Inherited

public function rewind()Inherited

public function valid()Inherited

private function throwOnAttemptedIteration()Inherited

public function getPhobjectClassConstant($key, $byte_limit)Inherited

public function isAvailable()

final public function getKey($key, $default)

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

final public function deleteKey($key)

abstract public function getKeys($keys)

abstract public function setKeys($keys, $ttl)

abstract public function deleteKeys($keys)

abstract public function destroyCache()

abstract class PhutilKeyValueCache
Phorge Technical Documentation ()

public function __get($name)
Inherited

public function __set($name, $value)
Inherited

public function current()
Inherited

public function key()
Inherited

public function next()
Inherited

public function rewind()
Inherited

public function valid()
Inherited

private function throwOnAttemptedIteration()
Inherited

public function getPhobjectClassConstant($key, $byte_limit)
Inherited