dedalozzo / eoc-client

src/EoC/Couch.php

Braces +206 added lines, -154 removed lines

@@ -102,10 +102,13 @@ 
       foreach ($keys as $key) {
         $hash = md5(json_encode($key));
 
-        if (isset($matches[$hash])) // Match found.
+        if (isset($matches[$hash])) {
+          // Match found.
           $allRows[] = $matches[$hash];
-        else // No match found.
+        } else {
+          // No match found.
           $allRows[] = ['id' => NULL, 'key' => $key, 'value' => NULL];
+        }
       }
 
       // Overrides the response, replacing rows.
@@ -176,15 +179,18 @@ 
    * @param[in] bool $excludeLocal Document path.
    */
   public function validateDocPath($path, $excludeLocal = FALSE) {
-    if (empty($path)) // STD_DOC_PATH
+    if (empty($path)) {
+      // STD_DOC_PATH
       return;
+    }
 
-    if ($path == self::DESIGN_DOC_PATH)
-      return;
-    elseif ($path == self::LOCAL_DOC_PATH && $excludeLocal)
-      throw new \InvalidArgumentException("Local document doesn't have attachments.");
-    else
-      throw new \InvalidArgumentException("Invalid document path.");
+    if ($path == self::DESIGN_DOC_PATH) {
+          return;
+    } elseif ($path == self::LOCAL_DOC_PATH && $excludeLocal) {
+          throw new \InvalidArgumentException("Local document doesn't have attachments.");
+    } else {
+          throw new \InvalidArgumentException("Invalid document path.");
+    }
   }
 
 
@@ -206,10 +212,11 @@ 
     #    One of the characters “_$()” «_$()»
     #    A character in the range between “+” and “/” «+-/»
     # Assert position at the very end of the string «\z»
-    if (preg_match('%\A[a-z][a-z\d_$()+-/]++\z%', $name))
-      return $name = rawurlencode($name);
-    else
-      throw new \InvalidArgumentException("Invalid database name.");
+    if (preg_match('%\A[a-z][a-z\d_$()+-/]++\z%', $name)) {
+          return $name = rawurlencode($name);
+    } else {
+          throw new \InvalidArgumentException("Invalid database name.");
+    }
   }
 
 
@@ -220,10 +227,11 @@ 
    * @param string $docId Document id.
    */
   public function validateAndEncodeDocId(&$docId) {
-    if (!empty($docId))
-      $docId = rawurlencode($docId);
-    else
-      throw new \InvalidArgumentException("\$docId must be a non-empty string.");
+    if (!empty($docId)) {
+          $docId = rawurlencode($docId);
+    } else {
+          throw new \InvalidArgumentException("\$docId must be a non-empty string.");
+    }
   }
 
   //!@}
@@ -255,10 +263,10 @@ 
     // before the client has received the entire response. To avoid problems, we trap the exception and we go on.
     try {
       $this->send($request);
-    }
-    catch (\Exception $e) {
-      if ($e->getCode() > 0)
-        throw $e;
+    } catch (\Exception $e) {
+      if ($e->getCode() > 0) {
+              throw $e;
+      }
     }
   }
 
@@ -295,10 +303,11 @@ 
   public function getFavicon() {
     $response = $this->send(new Request(Request::GET_METHOD, "/favicon.ico"));
 
-    if ($response->getHeaderFieldValue(Request::CONTENT_TYPE_HF) == "image/x-icon")
-      return $response->getBody();
-    else
-      throw new \InvalidArgumentException("Content-Type must be image/x-icon.");
+    if ($response->getHeaderFieldValue(Request::CONTENT_TYPE_HF) == "image/x-icon") {
+          return $response->getBody();
+    } else {
+          throw new \InvalidArgumentException("Content-Type must be image/x-icon.");
+    }
   }
 
 
@@ -334,8 +343,9 @@ 
 
     $request = new Request(Request::GET_METHOD, "/_db_updates");
 
-    if (isset($opts))
-      $request->setMultipleQueryParamsAtOnce($opts->asArray());
+    if (isset($opts)) {
+          $request->setMultipleQueryParamsAtOnce($opts->asArray());
+    }
 
     return $this->send($request)->getBodyAsArray();
   }
@@ -364,9 +374,9 @@ 
       $request = new Request(Request::GET_METHOD, "/_log");
       $request->setQueryParam("bytes", $bytes);
       return $this->send($request)->getBody();
+    } else {
+          throw new \InvalidArgumentException("\$bytes must be a positive integer.");
     }
-    else
-      throw new \InvalidArgumentException("\$bytes must be a positive integer.");
   }
 
 
@@ -383,13 +393,15 @@ 
 
       $response = $this->send($request);
 
-      if ($count == 1) // We don't need to use === operator because, just above, we made a type checking.
+      if ($count == 1) {
+        // We don't need to use === operator because, just above, we made a type checking.
         return $response->getBodyAsArray()['uuids'][0];
-      else
-        return $response->getBodyAsArray()['uuids'];
+      } else {
+              return $response->getBodyAsArray()['uuids'];
+      }
+    } else {
+          throw new \InvalidArgumentException("\$count must be a positive integer.");
     }
-    else
-      throw new \InvalidArgumentException("\$count must be a positive integer.");
   }
 
   //!@}
@@ -403,8 +415,9 @@ 
   private function endTransaction() {
     if (is_array($this->transaction)) {
 
-      foreach ($this->transaction as $doc)
-        unset($doc);
+      foreach ($this->transaction as $doc) {
+              unset($doc);
+      }
 
       unset($this->transaction);
     }
@@ -416,10 +429,11 @@ 
    * @brief Starts a new transaction.
    */
   public function begin() {
-    if (is_null($this->transaction))
-      $this->transaction = [];
-    else
-      throw new \RuntimeException("A transaction is already in progress.");
+    if (is_null($this->transaction)) {
+          $this->transaction = [];
+    } else {
+          throw new \RuntimeException("A transaction is already in progress.");
+    }
   }
 
 
@@ -445,8 +459,7 @@ 
     try {
       $this->performBulkOperations($this->transaction, $immediately, TRUE, $newEdits);
       $this->endTransaction();
-    }
-    catch (\Exception $e) {
+    } catch (\Exception $e) {
       $this->rollback();
       throw $e;
     }
@@ -481,8 +494,9 @@ 
     if (!empty($section)) {
       $path .= "/".$section;
 
-      if (!empty($key))
-        $path .= "/".$key;
+      if (!empty($key)) {
+              $path .= "/".$key;
+      }
     }
 
     return $this->send(new Request(Request::GET_METHOD, $path))->getBodyAsArray();
@@ -497,14 +511,17 @@ 
    * @see http://docs.couchdb.org/en/latest/api/server/configuration.html#put--_config-section-key
    */
   public function setConfigKey($section, $key, $value) {
-    if (!is_string($section) or empty($section))
-      throw new \InvalidArgumentException("\$section must be a not empty string.");
+    if (!is_string($section) or empty($section)) {
+          throw new \InvalidArgumentException("\$section must be a not empty string.");
+    }
 
-    if (!is_string($key) or empty($key))
-      throw new \InvalidArgumentException("\$key must be a not empty string.");
+    if (!is_string($key) or empty($key)) {
+          throw new \InvalidArgumentException("\$key must be a not empty string.");
+    }
 
-    if (is_null($value))
-      throw new \InvalidArgumentException("\$value cannot be null.");
+    if (is_null($value)) {
+          throw new \InvalidArgumentException("\$value cannot be null.");
+    }
 
     $request = new Request(Request::PUT_METHOD, "/_config/".$section."/".$key);
     $request->setHeaderField(Request::CONTENT_TYPE_HF, "application/json");
@@ -520,11 +537,13 @@ 
    * @see http://docs.couchdb.org/en/latest/api/configuration.html#delete-config-section-key
    */
   public function deleteConfigKey($section, $key) {
-    if (!is_string($section) or empty($section))
-      throw new \InvalidArgumentException("\$section must be a not empty string.");
+    if (!is_string($section) or empty($section)) {
+          throw new \InvalidArgumentException("\$section must be a not empty string.");
+    }
 
-    if (!is_string($key) or empty($key))
-      throw new \InvalidArgumentException("\$key must be a not empty string.");
+    if (!is_string($key) or empty($key)) {
+          throw new \InvalidArgumentException("\$key must be a not empty string.");
+    }
 
     $this->send(new Request(Request::DELETE_METHOD, "/_config/".$section."/".$key));
   }
@@ -551,11 +570,13 @@ 
    * @see http://docs.couchdb.org/en/latest/api/server/authn.html#post--_session
    */
   public function setSession($userName, $password) {
-    if (!is_string($userName) or empty($userName))
-      throw new \InvalidArgumentException("\$userName must be a not empty string.");
+    if (!is_string($userName) or empty($userName)) {
+          throw new \InvalidArgumentException("\$userName must be a not empty string.");
+    }
 
-    if (!is_string($password) or empty($password))
-      throw new \InvalidArgumentException("\$password must be a not empty string.");
+    if (!is_string($password) or empty($password)) {
+          throw new \InvalidArgumentException("\$password must be a not empty string.");
+    }
 
     $request = new Request(Request::POST_METHOD, "/_session");
 
@@ -650,8 +671,9 @@ 
    * you are making a not supported call to CouchDB.
    */
   public function checkForDb() {
-    if (empty($this->dbName))
-      throw new \RuntimeException("No database selected.");
+    if (empty($this->dbName)) {
+          throw new \RuntimeException("No database selected.");
+    }
   }
 
 
@@ -669,11 +691,12 @@ 
     if ($name != $this->dbName) {
       $this->send(new Request(Request::PUT_METHOD, "/".$name."/"));
 
-      if ($autoSelect)
-        $this->dbName = $name;
+      if ($autoSelect) {
+              $this->dbName = $name;
+      }
+    } else {
+          throw new \UnexpectedValueException("You can't create a database with the same name of the selected database.");
     }
-    else
-      throw new \UnexpectedValueException("You can't create a database with the same name of the selected database.");
   }
 
 
@@ -687,10 +710,11 @@ 
   public function deleteDb($name) {
     $this->validateAndEncodeDbName($name);
 
-    if ($name != $this->dbName)
-      $this->send(new Request(Request::DELETE_METHOD, "/".$name));
-    else
-      throw new \UnexpectedValueException("You can't delete the selected database.");
+    if ($name != $this->dbName) {
+          $this->send(new Request(Request::DELETE_METHOD, "/".$name));
+    } else {
+          throw new \UnexpectedValueException("You can't delete the selected database.");
+    }
   }
 
 
@@ -718,8 +742,9 @@ 
 
     $request = new Request(Request::GET_METHOD, "/".$this->dbName."/_changes");
 
-    if (isset($opts))
-      $request->setMultipleQueryParamsAtOnce($opts->asArray());
+    if (isset($opts)) {
+          $request->setMultipleQueryParamsAtOnce($opts->asArray());
+    }
 
     return $this->send($request);
   }
@@ -914,40 +939,47 @@ 
       is_string($targetDbUrl) && !empty($targetDbUrl)) {
       $body["source"] = $sourceDbUrl;
       $body["target"] = $targetDbUrl;
+    } else {
+          throw new \InvalidArgumentException("\$source_db_url and \$target_db_url must be non-empty strings.");
     }
-    else
-      throw new \InvalidArgumentException("\$source_db_url and \$target_db_url must be non-empty strings.");
 
-    if (!is_bool($continuous))
-      throw new \InvalidArgumentException("\$continuous must be a bool.");
-    elseif ($continuous)
-      $body["continuous"] = $continuous;
+    if (!is_bool($continuous)) {
+          throw new \InvalidArgumentException("\$continuous must be a bool.");
+    } elseif ($continuous) {
+          $body["continuous"] = $continuous;
+    }
 
     // Uses the specified proxy if any set.
-    if (isset($proxy))
-      $body["proxy"] = $this->proxy;
+    if (isset($proxy)) {
+          $body["proxy"] = $this->proxy;
+    }
 
     // create_target option
-    if (!is_bool($createTargetDb))
-      throw new \InvalidArgumentException("\$createTargetDb must be a bool.");
-    elseif ($createTargetDb)
-      $body["create_target"] = $createTargetDb;
+    if (!is_bool($createTargetDb)) {
+          throw new \InvalidArgumentException("\$createTargetDb must be a bool.");
+    } elseif ($createTargetDb) {
+          $body["create_target"] = $createTargetDb;
+    }
 
     if (!empty($filter)) {
-      if (is_string($filter)) // filter option
+      if (is_string($filter)) {
+        // filter option
         $body["filter"] = $filter;
-      elseif (is_array($filter)) // doc_ids option
+      } elseif (is_array($filter)) {
+        // doc_ids option
         $body["doc_ids"] = array_values($filter);
-      else
-        throw new \InvalidArgumentException("\$filter must be a string or an array.");
+      } else {
+              throw new \InvalidArgumentException("\$filter must be a string or an array.");
+      }
     }
 
     // queryParams option
     if (!is_null($opts)) {
-      if ($opts instanceof Opt\ViewQueryOpts)
-        $body["query_params"] = get_object_vars($opts);
-      else
-        throw new \InvalidArgumentException("\$queryParams must be an instance of ViewQueryOpts class.");
+      if ($opts instanceof Opt\ViewQueryOpts) {
+              $body["query_params"] = get_object_vars($opts);
+      } else {
+              throw new \InvalidArgumentException("\$queryParams must be an instance of ViewQueryOpts class.");
+      }
     }
 
     $request = new Request(Request::POST_METHOD, "/_replicate");
@@ -964,8 +996,9 @@ 
    * @see http://docs.couchdb.org/en/latest/api/server/common.html#canceling-continuous-replication
    */
   public function stopReplication($replicationId) {
-    if (is_null($replicationId))
-      throw new \InvalidArgumentException("You must provide a replication id.");
+    if (is_null($replicationId)) {
+          throw new \InvalidArgumentException("You must provide a replication id.");
+    }
 
     $body["replication_id"] = $replicationId;
     $body["cancel"] = TRUE;
@@ -1015,15 +1048,16 @@ 
   public function queryAllDocs(array $keys = NULL, Opt\ViewQueryOpts $opts = NULL, Hook\IChunkHook $chunkHook = NULL) {
     $this->checkForDb();
 
-    if (is_null($keys))
-      $request = new Request(Request::GET_METHOD, "/".$this->dbName."/_all_docs");
-    else {
+    if (is_null($keys)) {
+          $request = new Request(Request::GET_METHOD, "/".$this->dbName."/_all_docs");
+    } else {
       $request = new Request(Request::POST_METHOD, "/".$this->dbName."/_all_docs");
       $request->setBody(json_encode(['keys' => $keys]));
     }
 
-    if (isset($opts))
-      $request->setMultipleQueryParamsAtOnce($opts->asArray());
+    if (isset($opts)) {
+          $request->setMultipleQueryParamsAtOnce($opts->asArray());
+    }
 
     $result = $this->send($request, $chunkHook)->getBodyAsArray();
 
@@ -1052,12 +1086,13 @@ 
     $this->checkForDb();
     $this->validateAndEncodeDocId($designDocName);
 
-    if (empty($viewName))
-      throw new \InvalidArgumentException("You must provide a valid \$viewName.");
+    if (empty($viewName)) {
+          throw new \InvalidArgumentException("You must provide a valid \$viewName.");
+    }
 
-    if (empty($keys))
-      $request = new Request(Request::GET_METHOD, "/".$this->dbName."/_design/".$designDocName."/_view/".$viewName);
-    else {
+    if (empty($keys)) {
+          $request = new Request(Request::GET_METHOD, "/".$this->dbName."/_design/".$designDocName."/_view/".$viewName);
+    } else {
       $request = new Request(Request::POST_METHOD, "/".$this->dbName."/_design/".$designDocName."/_view/".$viewName);
       $request->setBody(json_encode(['keys' => $keys]));
     }
@@ -1065,14 +1100,15 @@ 
     if (isset($opts)) {
       $request->setMultipleQueryParamsAtOnce($opts->asArray());
       $includeMissingKeys = $opts->issetIncludeMissingKeys();
+    } else {
+          $includeMissingKeys = FALSE;
     }
-    else
-      $includeMissingKeys = FALSE;
 
     $result = $this->send($request, $chunkHook)->getBodyAsArray();
 
-    if ($includeMissingKeys)
-      $this->addMissingRows($keys, $result['rows']);
+    if ($includeMissingKeys) {
+          $this->addMissingRows($keys, $result['rows']);
+    }
 
     return new Result\QueryResult($result);
   }
@@ -1100,30 +1136,33 @@ 
     $handler = new Handler\ViewHandler('temp');
     $handler->language = $language;
     $handler->mapFn = $mapFn;
-    if (!empty($reduce))
-      $handler->reduceFn = $reduceFn;
+    if (!empty($reduce)) {
+          $handler->reduceFn = $reduceFn;
+    }
 
     $request = new Request(Request::POST_METHOD, "/".$this->dbName."/_temp_view");
     $request->setHeaderField(Request::CONTENT_TYPE_HF, "application/json");
 
     $array = $handler->asArray();
 
-    if (!empty($keys))
-      $array['keys'] = $keys;
+    if (!empty($keys)) {
+          $array['keys'] = $keys;
+    }
 
     $request->setBody(json_encode($array));
 
     if (isset($opts)) {
       $request->setMultipleQueryParamsAtOnce($opts->asArray());
       $includeMissingKeys = $opts->issetIncludeMissingKeys();
+    } else {
+          $includeMissingKeys = FALSE;
     }
-    else
-      $includeMissingKeys = FALSE;
 
     $result = $this->send($request, $chunkHook)->getBodyAsArray();
 
-    if ($includeMissingKeys)
-      $this->addMissingRows($keys, $result['rows']);
+    if ($includeMissingKeys) {
+          $this->addMissingRows($keys, $result['rows']);
+    }
 
     return new Result\QueryResult($result);
   }
@@ -1186,8 +1225,9 @@ 
   public function setRevsLimit($revsLimit = self::REVS_LIMIT) {
     $this->checkForDb();
 
-    if (!is_int($revsLimit) or ($revsLimit <= 0))
-      throw new \InvalidArgumentException("\$revsLimit must be a positive integer.");
+    if (!is_int($revsLimit) or ($revsLimit <= 0)) {
+          throw new \InvalidArgumentException("\$revsLimit must be a positive integer.");
+    }
 
     $request = new Request(Request::PUT_METHOD, "/".$this->dbName."/_revs_limit");
     $request->setHeaderField(Request::CONTENT_TYPE_HF, "application/json");
@@ -1245,16 +1285,17 @@ 
     $request = new Request(Request::GET_METHOD, $requestPath);
 
     // Retrieves the specific revision of the document.
-    if (!empty($rev))
-      $request->setQueryParam("rev", (string)$rev);
+    if (!empty($rev)) {
+          $request->setQueryParam("rev", (string)$rev);
+    }
 
     // If there are any options, add them to the request.
     if (isset($opts)) {
       $request->setMultipleQueryParamsAtOnce($opts->asArray());
       $ignoreClass = $opts->issetIgnoreClass();
+    } else {
+          $ignoreClass = FALSE;
     }
-    else
-      $ignoreClass = FALSE;
 
     $response = $this->send($request);
     $body = $response->getBodyAsArray();
@@ -1266,18 +1307,18 @@ 
     if (!$ignoreClass && isset($body['class'])) { // Special document class inherited from Doc or LocalDoc.
       $class = "\\".$body['class'];
       $doc = new $class;
+    } elseif ($path == self::DESIGN_DOC_PATH) {
+          $doc = new Doc\DesignDoc;
+    } else {
+          $doc = NULL;
     }
-    elseif ($path == self::DESIGN_DOC_PATH)
-      $doc = new Doc\DesignDoc;
-    else
-      $doc = NULL;
 
     if (is_object($doc)) {
       $doc->assignArray($body);
       return $doc;
+    } else {
+          return $response;
     }
-    else
-      return $response;
   }
 
 
@@ -1304,8 +1345,9 @@ 
 
     // Whether the document has an id we use a different HTTP method. Using POST CouchDB generates an id for the doc
     // using PUT we need to specify one. We can still use the function getUuids() to ask CouchDB for some ids.
-    if (!$doc->issetId())
-      $doc->setId(Generator\UUID::generate(Generator\UUID::UUID_RANDOM, Generator\UUID::FMT_STRING));
+    if (!$doc->issetId()) {
+          $doc->setId(Generator\UUID::generate(Generator\UUID::UUID_RANDOM, Generator\UUID::FMT_STRING));
+    }
 
     $this->setDocInfo($doc);
 
@@ -1319,8 +1361,9 @@ 
     $request->setBody($doc->asJson());
 
     // Enables batch mode.
-    if ($batchMode)
-      $request->setQueryParam("batch", "ok");
+    if ($batchMode) {
+          $request->setQueryParam("batch", "ok");
+    }
 
     $this->send($request);
   }
@@ -1373,10 +1416,11 @@ 
     // This request uses the special method COPY.
     $request = new Request(Request::COPY_METHOD, $path);
 
-    if (empty($rev))
-      $request->setHeaderField(Request::DESTINATION_HF, $targetDocId);
-    else
-      $request->setHeaderField(Request::DESTINATION_HF, $targetDocId."?rev=".(string)$rev);
+    if (empty($rev)) {
+          $request->setHeaderField(Request::DESTINATION_HF, $targetDocId);
+    } else {
+          $request->setHeaderField(Request::DESTINATION_HF, $targetDocId."?rev=".(string)$rev);
+    }
 
     $this->send($request);
   }
@@ -1406,8 +1450,9 @@ 
     $request = new Request(Request::POST_METHOD, $path);
 
     $purge = [];
-    foreach ($refs as $ref)
-      $purge[] = $ref->asArray();
+    foreach ($refs as $ref) {
+          $purge[] = $ref->asArray();
+    }
 
     $request->setBody(json_encode($purge));
 
@@ -1440,26 +1485,30 @@ 
   public function performBulkOperations(array $docs, $fullCommit = FALSE, $allOrNothing = FALSE, $newEdits = TRUE) {
     $this->checkForDb();
 
-    if (count($docs) == 0)
-      throw new \InvalidArgumentException("The \$docs array cannot be empty.");
-    else
-      $operations = [];
+    if (count($docs) == 0) {
+          throw new \InvalidArgumentException("The \$docs array cannot be empty.");
+    } else {
+          $operations = [];
+    }
 
     $path = "/".$this->dbName."/_bulk_docs";
 
     $request = new Request(Request::POST_METHOD, $path);
     $request->setHeaderField(Request::CONTENT_TYPE_HF, "application/json");
 
-    if ($fullCommit)
-      $request->setHeaderField(Request::X_COUCHDB_FULL_COMMIT_HF, "full_commit");
-    else
-      $request->setHeaderField(Request::X_COUCHDB_FULL_COMMIT_HF, "delay_commit");
+    if ($fullCommit) {
+          $request->setHeaderField(Request::X_COUCHDB_FULL_COMMIT_HF, "full_commit");
+    } else {
+          $request->setHeaderField(Request::X_COUCHDB_FULL_COMMIT_HF, "delay_commit");
+    }
 
-    if ($allOrNothing)
-      $operations['all_or_nothing'] = 'true';
+    if ($allOrNothing) {
+          $operations['all_or_nothing'] = 'true';
+    }
 
-    if (!$newEdits)
-      $operations['new_edits'] = 'false';
+    if (!$newEdits) {
+          $operations['new_edits'] = 'false';
+    }
 
     foreach ($docs as $doc) {
       $this->setDocInfo($doc);
@@ -1497,8 +1546,9 @@ 
     $request = new Request(Request::HEAD_METHOD, $path);
 
     // In case we want retrieve a specific document revision.
-    if (!empty($rev))
-      $request->setQueryParam("rev", (string)$rev);
+    if (!empty($rev)) {
+          $request->setQueryParam("rev", (string)$rev);
+    }
 
     return $this->send($request);
   }
@@ -1524,8 +1574,9 @@ 
     $request = new Request(Request::GET_METHOD, $path);
 
     // In case we want retrieve a specific document revision.
-    if (!empty($rev))
-      $request->setQueryParam("rev", (string)$rev);
+    if (!empty($rev)) {
+          $request->setQueryParam("rev", (string)$rev);
+    }
 
     return $this->send($request)->getBody();
   }
@@ -1554,8 +1605,9 @@ 
     $request->setBody(base64_encode($attachment->getData()));
 
     // In case of adding or updating an existence document.
-    if (!empty($rev))
-      $request->setQueryParam("rev", (string)$rev);
+    if (!empty($rev)) {
+          $request->setQueryParam("rev", (string)$rev);
+    }
 
     return $this->send($request);
   }