Page MenuHomeClusterLabs Projects
Diviner Tech Docs PhutilInRequestKeyValueCache

final class PhutilInRequestKeyValueCache
Phorge Technical Documentation ()

Key-value cache implemented in the current request. All storage is local to this request (i.e., the current page) and destroyed after the request exits. This means the first request to this cache for a given key on a page will ALWAYS miss.

This cache exists mostly to support unit tests. In a well-designed applications, you generally should not be fetching the same data over and over again in one request, so this cache should be of limited utility. If using this cache improves application performance, especially if it improves it significantly, it may indicate an architectural problem in your application.

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

  • public function setLimit($limit) — Set a limit on the number of keys this cache may contain.
  • public function getAllKeys()

Methods

public function isAvailable()

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.

PhutilInRequestKeyValueCache
This method is not documented.
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.

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

PhutilInRequestKeyValueCache
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)

PhutilKeyValueCache

Delete a list of keys from the cache.

PhutilInRequestKeyValueCache
This method is not documented.
Parameters
list<string>$keysList of keys to delete.
Return
this

public function destroyCache()

PhutilKeyValueCache

Completely destroy all data in the cache.

PhutilInRequestKeyValueCache
This method is not documented.
Return
this

public function setLimit($limit)

Set a limit on the number of keys this cache may contain.

When too many keys are inserted, the oldest keys are removed from the cache. Setting a limit of 0 disables the cache.

Parameters
int$limitMaximum number of items to store in the cache.
Return
this

public function getAllKeys()

This method is not documented.
Return
wild
Defined
src/infrastructure/cache/PhutilInRequestKeyValueCache.php:16
Extends
PhutilKeyValueCache