Merge pull request #5 from 007hacky007/get-responses

Added getResponses method

Author: matthi4s

README.md

@@ -41,7 +41,18 @@ $client->put("key", "value");
 $client->get("key");
 $client->delete("key");
 $client->putIf("key", "newValue", "valueToCompareWith");
-$client->deleteIf("key", "3");
+$client->deleteIf("key", "valueToCompareWith");
+
+// complex transaction example
+$leaseId = $client->getLeaseID(10);
+$putOp = $client->getPutOperation('key', 'someValueToPutOnSuccess', $leaseId);
+$getOp = $client->getGetOperation('key');
+// following compare checks for key existence
+$compare = $client->getCompare('key', '0', \Etcdserverpb\Compare\CompareResult::EQUAL, \Etcdserverpb\Compare\CompareTarget::MOD);
+// execute Put operation and return the key we stored, just return the key value if it already exists
+$txnResponse = $client->txnRequest([$putOp, $getOp], [$getOp], [$compare]);
+$result = $client->getResponses($txnResponse, 'response_range', true);
+// $result[0] contains "someValueToPutOnSuccess"
 ```
 
 #### Sharded client

src/Client.php

@@ -29,6 +29,7 @@
 use Etcdserverpb\TxnResponse;
 use Exception;
 use Grpc\ChannelCredentials;
+use Mvccpb\KeyValue;
 
 /**
  * Class Client
@@ -316,6 +317,51 @@ public function txnRequest(array $requestOperations, ?array $failureOperations,
         return $response;
     }
 
+    /**
+     * Transform TxnResponse into more friendly array
+     *
+     * @param TxnResponse $txnResponse return value of txnRequest method
+     * @param string|null $type returns only chosen type if defined,
+     *                          can be one of those: response_range, response_put, response_delete_range, response_txn
+     * @param bool $simpleArray return just simple array containing values,
+     *                          example: ['value1', 'value2']
+     * @return array example: [
+     *                          [
+     *                           'type' => 'response_range',
+     *                           'values' => [
+     *                                        'key' => 'key',
+     *                                        'value' => '2',
+     *                                        'version' => 3
+     *                                        ]
+     *                           ]
+     *                         ]
+     */
+    public function getResponses(TxnResponse $txnResponse, ?string $type = null, bool $simpleArray = false): array
+    {
+        $v = $r = [];
+        /** @var ResponseOp $response */
+        foreach ($txnResponse->getResponses() as $response) {
+            if ($type !== null && $type !== $response->getResponse())
+                continue;
+            $values = [];
+            if ($response->getResponseRange() !== null) {
+                /** @var KeyValue $field */
+                foreach ($response->getResponseRange()->getKvs() as $field) {
+                    $v[] = $field->getValue();
+                    $values[] = [
+                        'key' => $field->getKey(),
+                        'value' => $field->getValue(),
+                        'version' => $field->getVersion()
+                    ];
+                }
+
+            }
+            $r[] = ['type' => $response->getResponse(), 'values' => $values];
+        }
+
+        return ($simpleArray) ? $v : $r;
+    }
+
     /**
      * Creates RequestOp of Get operation for requestIf method
      *

src/ClientInterface.php

@@ -151,4 +151,25 @@ public function revokeLeaseID(int $leaseID);
      * @throws Exception
      */
     public function refreshLease(int $leaseID);
+
+    /**
+     * Transform TxnResponse into more friendly array
+     *
+     * @param TxnResponse $txnResponse return value of txnRequest method
+     * @param string|null $type returns only chosen type if defined,
+     *                          can be one of those: response_range, response_put, response_delete_range, response_txn
+     * @param bool $simpleArray return just simple array containing values,
+     *                          example: ['value1', 'value2']
+     * @return array example: [
+     *                          [
+     *                           'type' => 'response_range',
+     *                           'values' => [
+     *                                        'key' => 'key',
+     *                                        'value' => '2',
+     *                                        'version' => 3
+     *                                        ]
+     *                           ]
+     *                         ]
+     */
+    public function getResponses(TxnResponse $txnResponse, ?string $type = null, bool $simpleArray = false): array;
 }

src/ShardedClient.php

@@ -209,4 +209,28 @@ public function refreshLease(int $leaseID)
     {
         return $this->getRandomClient()->refreshLease($leaseID);
     }
+
+    /**
+     * Transform TxnResponse into more friendly array
+     *
+     * @param TxnResponse $txnResponse return value of txnRequest method
+     * @param string|null $type returns only chosen type if defined,
+     *                          can be one of those: response_range, response_put, response_delete_range, response_txn
+     * @param bool $simpleArray return just simple array containing values,
+     *                          example: ['value1', 'value2']
+     * @return array example: [
+     *                          [
+     *                           'type' => 'response_range',
+     *                           'values' => [
+     *                                        'key' => 'key',
+     *                                        'value' => '2',
+     *                                        'version' => 3
+     *                                        ]
+     *                           ]
+     *                         ]
+     */
+    public function getResponses(TxnResponse $txnResponse, ?string $type = null, bool $simpleArray = false): array
+    {
+        return $this->getRandomClient()->getResponses($txnResponse, $type, $simpleArray);
+    }
 }