Diviner Tech Docs PhutilOnDiskKeyValueCache

final class PhutilOnDiskKeyValueCache
Phorge Technical Documentation ()

Interface to a disk cache. Storage persists across requests.

This cache is very slow compared to caches like APC. It is intended as a specialized alternative to APC when APC is not available.

This is a highly specialized cache and not appropriate for use as a generalized key-value cache for arbitrary application data.

Also note that reading and writing keys from the cache currently involves loading and saving the entire cache, no matter how little data you touch.

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

Cache Storage

public function setCacheFile($file)
private function loadCache($hold_lock)
private function saveCache()
private function getCacheFile()

Other Methods

public function setWait($wait) — Set duration (in seconds) to wait for the file lock.

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.

PhutilOnDiskKeyValueCache

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.
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)
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.
wild	$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.

PhutilOnDiskKeyValueCache

This method is not documented.

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.

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.

PhutilOnDiskKeyValueCache

This method is not documented.

Parameters

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

Return

this

public function deleteKeys($keys)

PhutilKeyValueCache

Delete a list of keys from the cache.

PhutilOnDiskKeyValueCache

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.

PhutilOnDiskKeyValueCache

This method is not documented.

Return

this

public function setWait($wait)

Set duration (in seconds) to wait for the file lock.

Parameters

$wait

Return

wild

public function setCacheFile($file)

This method is not documented.

Parameters

$file

Return

wild

private function loadCache($hold_lock)

This method is not documented.

Parameters

$hold_lock

Return

wild

private function saveCache()

This method is not documented.

Return

wild

private function getCacheFile()

This method is not documented.

Return

wild

Defined: src/infrastructure/cache/PhutilOnDiskKeyValueCache.php:18
Extends: PhutilKeyValueCache

final class PhutilOnDiskKeyValueCachePhorge Technical Documentation ()

Tasks

Key-Value Cache Implementation

Cache Storage

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

public function setWait($wait)

public function setCacheFile($file)

private function loadCache($hold_lock)

private function saveCache()

private function getCacheFile()

final class PhutilOnDiskKeyValueCache
Phorge Technical Documentation ()

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

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

final public function deleteKey($key)
Inherited