Create separate methods popOne() and popMany() for the php client

Author: Gab

README.md

@@ -3,6 +3,7 @@
 redis-priority-queue is a simple work queue similar to [Redis lists](https://redis.io/commands#list) with the following added features:
 
  - An item can be added with a priority (between -9007199254740992 and 9007199254740992)
+ - Queues are automatically de-duplicated (duplicate items are voided when pushing them)
  - Multiple items can be popped from the queue at the same time
  - A queue monitoring tool to easily see how many items are in each queue
 
@@ -20,7 +21,7 @@ redis-cli --eval src/redis-priority-queue.lua null null , [push|pop|peek|count]
 redis-cli --eval src/redis-priority-queue.lua null null , push my_super_list my_item
 
 -- Pop an item
-redis-cli --eval src/redis-priority-queue.lua null null , pop my_super_list my_item
+redis-cli --eval src/redis-priority-queue.lua null null , pop my_super_list
 ```
 
 ## `push`: Push an item in a queue

clients/php/README.md

@@ -14,9 +14,9 @@ PHP client for redis-priority-queue.
 use RedisPriorityQueue as RQP;
 
 // Requires
-require_once(__DIR__.'/../lib/Lua.php');
-require_once(__DIR__.'/../lib/Queue.php');
-require_once(__DIR__.'/../lib/Redis.php');
+require_once('lib/Lua.php');
+require_once('lib/Queue.php');
+require_once('lib/Redis.php');
 
 // Create a Redis instance
 $r = new RQP\Redis($host, $port, $auth, $dbnum);
@@ -29,10 +29,12 @@ $q->setQueueName('sample_queue');
 
 // Push an item in the queue
 $res = $q->push('item');
-echo $res;
+echo "* Push an item:\n";
+echo $res."\n";
 
 // Pop an item from the queue
-$res = $q->pop();
+$res = $q->popOne();
+echo "* Pop an item:\n";
 echo json_encode($res)."\n";
 ```
 

clients/php/lib/Queue.php

@@ -76,15 +76,48 @@ public function push(string $item, int $priority = null): int
         return $this->run();
     }
 
+    /**
+     * popOne function.
+     *
+     * @access public
+     * @param string $orderBy (default: 'asc')
+     * @return void
+     */
+    public function popOne(string $orderBy = 'asc')
+    {
+        // Get item
+        $item = $this->popMany($orderBy, 1);
+
+        // Get first (and unique) item from array
+        if(is_array($item) && count($item) > 0) {
+            return $item[0];
+        }
+
+        return null;
+    }
+
     /**
      * pop function.
+     * Alias to popOne();
      *
      * @access public
      * @param string $orderBy (default: 'asc')
-     * @param int $numberOfItems (default: 1)
      * @return misc
      */
-    public function pop(string $orderBy = 'asc', int $numberOfItems = 1)
+    public function pop(string $orderBy = 'asc')
+    {
+        return $this->popOne($orderBy);
+    }
+
+    /**
+     * popMany function.
+     *
+     * @access public
+     * @param string $orderBy (default: 'asc')
+     * @param int $numberOfItems (default: 1)
+     * @return void
+     */
+    public function popMany(string $orderBy = 'asc', int $numberOfItems = 1)
     {
         // Set args
         $this->prepareArgs('pop', [$orderBy, $numberOfItems]);

clients/php/tests/pop.php

@@ -15,15 +15,15 @@
 
 // Run
 echo "* pop (one):\n";
-$res = $q->pop();
-echo json_encode($res)."\n";
+$res = $q->popOne();
+echo $res."\n";
 
 // Run
 echo "* pop (one, descending):\n";
-$res = $q->pop('desc');
-echo json_encode($res)."\n";
+$res = $q->popOne('desc');
+echo $res."\n";
 
 // Run
 echo "* pop (many):\n";
-$res = $q->pop('asc', MULTIPLE_ITEMS_COUNT);
+$res = $q->popMany('asc', MULTIPLE_ITEMS_COUNT);
 echo json_encode($res)."\n";