SDK PHP v3.x

You are currently looking at the documentation of a previous version of Kuzzle. We strongly recommend that you use the latest version. You can also use the version selector in the top menu.

incrbyfloat #

Increments the number stored at key by the provided float value. If the key does not exist, it is set to 0 before performing the operation.

[Redis documentation]

incrbyfloat(key, value, [options], [callback]) #

Arguments Type Description
key string Key identifier
value double Increment value
options JSON Object Optional parameters
callback function Callback

Options #

Option Type Description Default
queuable boolean Make this request queuable or not true

Return Value #

Returns the MemoryStorage object to allow chaining.

Callback Response #

Returns a floating point number that contains the updated key value.

Usage #

Copied to clipboard!
use \Kuzzle\Kuzzle;
$kuzzle = new Kuzzle('localhost');
try {
  $value = $kuzzle->memoryStorage()->incrbyfloat('key', -3.14159);
catch (ErrorException $e) {

Callback response:

Copied to clipboard!