Diviner Tech Docs PhutilDirectoryKeyValueCache

final class PhutilDirectoryKeyValueCache
Phorge Technical Documentation ()

Interface to a directory-based disk cache. Storage persists across requests.

This cache is very very slow, and most suitable for command line scripts which need to build large caches derived from sources like working copies (for example, Diviner). This cache performs better for large amounts of data than PhutilOnDiskKeyValueCache because each key is serialized individually, but this comes at the cost of having even slower reads and writes.

In addition to having slow reads and writes, this entire cache locks for any read or write activity.

Keys for this cache treat the character "/" specially, and encode it as a new directory on disk. This can help keep the cache organized and keep the number of items in any single directory under control, by using keys like "ab/cd/efghijklmn".

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 setCacheDirectory($directory)
private function getCacheDirectory()
private function getKeyFile($key)
private function validateKeys($keys)
private function lockCache($wait)
private function unlockCache()

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

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.

PhutilDirectoryKeyValueCache

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.

PhutilDirectoryKeyValueCache

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.

PhutilDirectoryKeyValueCache

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.

PhutilDirectoryKeyValueCache

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.

PhutilDirectoryKeyValueCache

This method is not documented.

Return

this

public function setCacheDirectory($directory)

This method is not documented.

Parameters

$directory

Return

wild

private function getCacheDirectory()

This method is not documented.

Return

wild

private function getKeyFile($key)

This method is not documented.

Parameters

$key

Return

wild

private function validateKeys($keys)

This method is not documented.

Parameters

array

$keys

Return

wild

private function lockCache($wait)

This method is not documented.

Parameters

$wait

Return

wild

private function unlockCache()

This method is not documented.

Return

wild

Defined: src/infrastructure/cache/PhutilDirectoryKeyValueCache.php:24
Extends: PhobjectPhutilKeyValueCache

final class PhutilDirectoryKeyValueCachePhorge Technical Documentation ()

Tasks

Key-Value Cache Implementation

Cache Storage

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)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 setCacheDirectory($directory)

private function getCacheDirectory()

private function getKeyFile($key)

private function validateKeys($keys)

private function lockCache($wait)

private function unlockCache()

final class PhutilDirectoryKeyValueCache
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

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

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

final public function deleteKey($key)
Inherited