PHP Интерфейс MatthiasMullie\Scrapbook\KeyValueStore

Автор: Matthias Mullie ([email protected])
Показать файл Открыть проект Примеры использования интерфейса

Открытые методы

Метод Описание
add ( string $key, mixed $value, integer $expire ) : boolean Adds an item under new key.
cas ( mixed $token, string $key, mixed $value, integer $expire ) : boolean Replaces an item in 1 atomic operation, to ensure it didn't change since it was originally read, when the CAS token was issued.
decrement ( string $key, integer $offset = 1, integer $initial, integer $expire ) : integer | boolean Decrements a counter value, or sets an initial value if it does not yet exist.
delete ( string $key ) : boolean Deletes an item from the cache.
deleteMulti ( array $keys ) : bool[] Deletes multiple items at once (reduced network traffic compared to individual operations).
flush ( ) : boolean Clears the entire cache.
get ( string $key, mixed &$token = null ) : mixed | boolean Retrieves an item from the cache.
getMulti ( array $keys, array &$tokens = null ) : mixed[] Retrieves multiple items at once.
increment ( string $key, integer $offset = 1, integer $initial, integer $expire ) : integer | boolean Increments a counter value, or sets an initial value if it does not yet exist.
replace ( string $key, mixed $value, integer $expire ) : boolean Replaces an item.
set ( string $key, mixed $value, integer $expire ) : boolean Stores a value, regardless of whether or not the key already exists (in which case it will overwrite the existing value for that key).
setMulti ( array $items, integer $expire ) : bool[] Store multiple values at once.
touch ( string $key, integer $expire ) : boolean Updates an item's expiration time without altering the stored value.

Описание методов

add() публичный Метод

This operation fails (returns false) if the key already exists in cache. If the operation succeeds, true will be returned.
public add ( string $key, mixed $value, integer $expire ) : boolean
$key string
$value mixed
$expire integer Time when item falls out of the cache: 0 = permanent (doesn't expires); under 2592000 (30 days) = relative time, in seconds from now; over 2592000 = absolute time, unix timestamp
Результат boolean

cas() публичный Метод

This operation fails (returns false) if the CAS token didn't match with what's currently in cache, when a new value has been written to cache after we've fetched it. If the operation succeeds, true will be returned.
public cas ( mixed $token, string $key, mixed $value, integer $expire ) : boolean
$token mixed Token received from get() or getMulti()
$key string
$value mixed
$expire integer Time when item falls out of the cache: 0 = permanent (doesn't expires); under 2592000 (30 days) = relative time, in seconds from now; over 2592000 = absolute time, unix timestamp
Результат boolean

decrement() публичный Метод

The new counter value will be returned if this operation succeeds, or false for failure (e.g. when the value currently in cache is not a number, in which case it can't be decremented)
public decrement ( string $key, integer $offset = 1, integer $initial, integer $expire ) : integer | boolean
$key string
$offset integer Value to decrement with
$initial integer Initial value (if item doesn't yet exist)
$expire integer Time when item falls out of the cache: 0 = permanent (doesn't expires); under 2592000 (30 days) = relative time, in seconds from now; over 2592000 = absolute time, unix timestamp
Результат integer | boolean New value or false on failure

delete() публичный Метод

Returns true if item existed & was successfully deleted, false otherwise. Return value is a boolean true when the operation succeeds, or false on failure.
public delete ( string $key ) : boolean
$key string
Результат boolean

deleteMulti() публичный Метод

Return value will be an associative array in [key => status] form, where status is a boolean true for success, or false for failure.
public deleteMulti ( array $keys ) : bool[]
$keys array
Результат bool[]

flush() публичный Метод

Return value is a boolean true when the operation succeeds, or false on failure.
public flush ( ) : boolean
Результат boolean

get() публичный Метод

Optionally, an 2nd variable can be passed to this function. It will be filled with a value that can be used for cas()
public get ( string $key, mixed &$token = null ) : mixed | boolean
$key string
$token mixed Will be filled with the CAS token
Результат mixed | boolean Value, or false on failure

getMulti() публичный Метод

Return value will be an associative array in [key => value] format. Keys missing in cache will be omitted from the array. Optionally, an 2nd variable can be passed to this function. It will be filled with values that can be used for cas(), in an associative array in [key => token] format. Keys missing in cache will be omitted from the array. getMulti is preferred over multiple individual get operations as you'll get them all in 1 request.
public getMulti ( array $keys, array &$tokens = null ) : mixed[]
$keys array
$tokens array Will be filled with the CAS tokens, in [key => token] format
Результат mixed[] [key => value]

increment() публичный Метод

The new counter value will be returned if this operation succeeds, or false for failure (e.g. when the value currently in cache is not a number, in which case it can't be incremented)
public increment ( string $key, integer $offset = 1, integer $initial, integer $expire ) : integer | boolean
$key string
$offset integer Value to increment with
$initial integer Initial value (if item doesn't yet exist)
$expire integer Time when item falls out of the cache: 0 = permanent (doesn't expires); under 2592000 (30 days) = relative time, in seconds from now; over 2592000 = absolute time, unix timestamp
Результат integer | boolean New value or false on failure

replace() публичный Метод

This operation fails (returns false) if the key does not yet exist in cache. If the operation succeeds, true will be returned.
public replace ( string $key, mixed $value, integer $expire ) : boolean
$key string
$value mixed
$expire integer Time when item falls out of the cache: 0 = permanent (doesn't expires); under 2592000 (30 days) = relative time, in seconds from now; over 2592000 = absolute time, unix timestamp
Результат boolean

set() публичный Метод

Return value is a boolean true when the operation succeeds, or false on failure.
public set ( string $key, mixed $value, integer $expire ) : boolean
$key string
$value mixed
$expire integer Time when item falls out of the cache: 0 = permanent (doesn't expires); under 2592000 (30 days) = relative time, in seconds from now; over 2592000 = absolute time, unix timestamp
Результат boolean

setMulti() публичный Метод

Return value will be an associative array in [key => status] form, where status is a boolean true for success, or false for failure. setMulti is preferred over multiple individual set operations as you'll set them all in 1 request.
public setMulti ( array $items, integer $expire ) : bool[]
$items array [key => value]
$expire integer Time when item falls out of the cache: 0 = permanent (doesn't expires); under 2592000 (30 days) = relative time, in seconds from now; over 2592000 = absolute time, unix timestamp
Результат bool[]

touch() публичный Метод

Return value is a boolean true when the operation succeeds, or false on failure.
public touch ( string $key, integer $expire ) : boolean
$key string
$expire integer Time when item falls out of the cache: 0 = permanent (doesn't expires); under 2592000 (30 days) = relative time, in seconds from now; over 2592000 = absolute time, unix timestamp
Результат boolean