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.

hincrbyfloat #

Increments the number stored in a hash field by the provided float value.

[Redis documentation]

hincrbyfloat(key, field, value, [options], [callback]) #

Arguments Type Description
key string Key identifier
field string Hash field to increment
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 the newly incremented value, as a floating point number.

Usage #

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

Callback response:

Copied to clipboard!