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.

lrem #

Removes the first count occurences of elements equal to value from a list.

[Redis documentation]


lrem(key, count, value, [options], [callback]) #

ArgumentsTypeDescription
keystringKey identifier
countintNumber of occurences of the value to remove
valuestringValue to be removed from the list
optionsJSON ObjectOptional parameters
callbackfunctionCallback

Options #

OptionTypeDescriptionDefault
queuablebooleanMake this request queuable or nottrue

Return Value #

Returns the MemoryStorage object to allow chaining.


Callback Response #

Returns an integer containing the number of removed elements.

Usage #

<?php
use \Kuzzle\Kuzzle;
$kuzzle = new Kuzzle('localhost');
try {
  $count = $kuzzle->memoryStorage()->lrem('key', 1, 'foo');
}
catch (ErrorException $e) {
}

Callback response:

1