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.

spop #

Removes and returns one or more elements at random from a set of unique values.

[Redis documentation]

spop(key, [options], [callback]) #

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

Options #

Option Type Description Default
count int Number of elements to remove 1
queuable boolean Make this request queuable or not true

Return Value #

Returns the MemoryStorage object to allow chaining.

Callback Response #

Returns an array of removed elements.

Usage #

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

Callback response:

Copied to clipboard!
["removed element"]