spop #
Removes and returns one or more elements at random from a set of unique values.
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 #
<?php
use \Kuzzle\Kuzzle;
$kuzzle = new Kuzzle('localhost');
try {
$elements = $kuzzle->memoryStorage()->spop('key');
}
catch (ErrorException $e) {
}
Callback response:
["removed element"]
Edit this page on Github(opens new window)