Diviner Tech Docs PhutilKeyValueCacheProxy

abstract class PhutilKeyValueCacheProxy
Phorge Technical Documentation ()

This class is not documented.

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

final protected function getProxy()
public function __call($method, $arguments)

Methods

public function isAvailable()

PhutilKeyValueCache

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

PhutilKeyValueCacheProxy

This method is not documented.

Return

bool	True 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	$key	Key to retrieve.
mixed	$default	(optional) Value to return if the key is not found. By default, returns null.

Return

mixed

Cache 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	$key	Key to set.
mixed	$value	Value to set.
int\|null	$ttl	(optional) 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

$key

Key to delete.

Return

$this

public function getKeys($keys)

PhutilKeyValueCache

Get data from the cache.

PhutilKeyValueCacheProxy

This method is not documented.

Parameters

list<string>

$keys

List of cache keys to retrieve.

Return

array<string, mixed>

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.

PhutilKeyValueCacheProxy

This method is not documented.

Parameters

array<string,	$keys	mixed> $keys Map of cache keys to values.
int\|null	$ttl	(optional) TTL for cache keys, in seconds.

Return

$this

public function deleteKeys($keys)

PhutilKeyValueCache

Delete a list of keys from the cache.

PhutilKeyValueCacheProxy

This method is not documented.

Parameters

list<string>

$keys

List of keys to delete.

Return

$this

public function destroyCache()

PhutilKeyValueCache

Completely destroy all data in the cache.

PhutilKeyValueCacheProxy

This method is not documented.

Return

$this

final protected function getProxy()

This method is not documented.

Return

wild

public function __call($method, $arguments)

This method is not documented.

Parameters

	$method
array	$arguments

Return

wild

Defined: src/infrastructure/cache/PhutilKeyValueCacheProxy.php:3
Extends: PhutilKeyValueCache

abstract class PhutilKeyValueCacheProxyPhorge Technical Documentation ()

Tasks

Key-Value Cache Implementation

Other Methods

Methods

public function isAvailable()

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

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

final public function deleteKey($key)Inherited

public function getKeys($keys)

public function setKeys($keys, $ttl)

public function deleteKeys($keys)

public function destroyCache()

final protected function getProxy()

public function __call($method, $arguments)

abstract class PhutilKeyValueCacheProxy
Phorge Technical Documentation ()

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

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

final public function deleteKey($key)
Inherited