SDK
SDK PHP v3.x
1

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]) #

ArgumentsTypeDescription
keystringKey identifier
fieldstringHash field to increment
valuedoubleIncrement value
optionsJSON ObjectOptional parameters
callbackfunctionCallback

Options #

OptionTypeDescriptionDefault
queuablebooleanMake this request queuable or nottrue

Return Value #

Returns the MemoryStorage object to allow chaining.


Callback Response #

Returns the newly incremented value, as a floating point number.

Usage #

<?php
use \Kuzzle\Kuzzle;
$kuzzle = new Kuzzle('localhost');
try {
  $value = $kuzzle->memoryStorage()->hincrbyfloat('key', 'field', 3.14159);
}
catch (ErrorException $e) {
}

Callback response:

48.14159