dedalozzo / eoc-client

src/EoC/Doc/DesignDoc.php

Doc Comments +3 added lines

@@ -189,6 +189,9 @@
   }
 
 
+  /**
+   * @param string $value
+   */
   public function setLanguage($value) {
     if (!empty($value))
       $this->meta['language'] = strtolower((string)$value);

Braces +55 added lines, -46 removed lines

@@ -63,8 +63,9 @@ 
    * @brief Removes `_design/` from he document identifier.
    */
   protected function fixDocId() {
-    if (isset($this->meta['_id']))
-      $this->meta['_id'] = preg_replace('%\A_design/%m', "", $this->meta['_id']);
+    if (isset($this->meta['_id'])) {
+          $this->meta['_id'] = preg_replace('%\A_design/%m', "", $this->meta['_id']);
+    }
   }
 
 
@@ -94,8 +95,9 @@ 
    */
   public function resetHandlers() {
     foreach ($this->sections as $name => $value) {
-      if (array_key_exists($name, $this->meta))
-        unset($this->meta[$name]);
+      if (array_key_exists($name, $this->meta)) {
+              unset($this->meta[$name]);
+      }
     }
   }
 
@@ -108,16 +110,17 @@ 
    */
   public function getHandlerAttributes($section, $name = "") {
     if (empty($name)) { // The handler doesn't have a name.
-      if (array_key_exists($section, $this->meta))
-        return $this->meta[$section];
-      else
-        throw new \Exception(sprintf("Can't find '%s' handler in the design document.", $section));
-    }
-    else { // The handler has a name.
-      if (@array_key_exists($name, $this->meta[$section]))
-        return $this->meta[$section][$name];
-      else
-        throw new \Exception(sprintf("Can't find '%s' handler in the design document '%s' section.", $name, $section));
+      if (array_key_exists($section, $this->meta)) {
+              return $this->meta[$section];
+      } else {
+              throw new \Exception(sprintf("Can't find '%s' handler in the design document.", $section));
+      }
+    } else { // The handler has a name.
+      if (@array_key_exists($name, $this->meta[$section])) {
+              return $this->meta[$section][$name];
+      } else {
+              throw new \Exception(sprintf("Can't find '%s' handler in the design document '%s' section.", $name, $section));
+      }
     }
   }
 
@@ -133,22 +136,25 @@ 
     $section = $handler->getSection();
 
     if (property_exists($handler, "name")) {
-      if (!$handler->isConsistent())
-        throw new \Exception(sprintf("The '%s' handler '%s' is not consistent.", $section, $handler->name));
-
-      if (@array_key_exists($handler->name, $this->meta[$section]))
-        throw new \Exception(sprintf("The '%s' handler '%s' already exists.", $section, $handler->name));
-      else
-        $this->meta[$section][$handler->name] = $handler->asArray();
-    }
-    else {
-      if (!$handler->isConsistent())
-        throw new \Exception(sprintf("The '%s' handler is not consistent.", $section));
-
-      if (array_key_exists($section, $this->meta))
-        throw new \Exception(sprintf("The '%s' handler already exists.", $section));
-      else
-        $this->meta[$section] = $handler;
+      if (!$handler->isConsistent()) {
+              throw new \Exception(sprintf("The '%s' handler '%s' is not consistent.", $section, $handler->name));
+      }
+
+      if (@array_key_exists($handler->name, $this->meta[$section])) {
+              throw new \Exception(sprintf("The '%s' handler '%s' already exists.", $section, $handler->name));
+      } else {
+              $this->meta[$section][$handler->name] = $handler->asArray();
+      }
+    } else {
+      if (!$handler->isConsistent()) {
+              throw new \Exception(sprintf("The '%s' handler is not consistent.", $section));
+      }
+
+      if (array_key_exists($section, $this->meta)) {
+              throw new \Exception(sprintf("The '%s' handler already exists.", $section));
+      } else {
+              $this->meta[$section] = $handler;
+      }
     }
   }
 
@@ -163,16 +169,17 @@ 
    */
   public function removeHandler($section, $name = "") {
     if (empty($name)) { // The handler doesn't have a name.
-      if (array_key_exists($section, $this->meta))
-        unset($this->meta[$section]);
-      else
-        throw new \Exception(sprintf("Can't find the '%s' handler.", $section));
-    }
-    else { // The handler has a name.
-      if (@array_key_exists($name, $this->meta[$section]))
-        unset($this->meta[$section][$name]);
-      else
-        throw new \Exception(sprintf("Can't find the '%s' handler '%s'", $section, $name));
+      if (array_key_exists($section, $this->meta)) {
+              unset($this->meta[$section]);
+      } else {
+              throw new \Exception(sprintf("Can't find the '%s' handler.", $section));
+      }
+    } else { // The handler has a name.
+      if (@array_key_exists($name, $this->meta[$section])) {
+              unset($this->meta[$section][$name]);
+      } else {
+              throw new \Exception(sprintf("Can't find the '%s' handler '%s'", $section, $name));
+      }
     }
   }
 
@@ -190,16 +197,18 @@ 
 
 
   public function setLanguage($value) {
-    if (!empty($value))
-      $this->meta['language'] = strtolower((string)$value);
-    else
-      throw new \InvalidArgumentException("\$language must be a non-empty string.");
+    if (!empty($value)) {
+          $this->meta['language'] = strtolower((string)$value);
+    } else {
+          throw new \InvalidArgumentException("\$language must be a non-empty string.");
+    }
   }
 
 
   public function unsetLanguage() {
-    if ($this->isMetadataPresent('language'))
-      unset($this->meta['language']);
+    if ($this->isMetadataPresent('language')) {
+          unset($this->meta['language']);
+    }
   }
 
   //! @endcond

src/EoC/Generator/UUID.php

Doc Comments +10 added lines

@@ -162,6 +162,11 @@ 
   /*
    * Public API, convert a UUID from one format to another
    */
+
+  /**
+   * @param integer $from
+   * @param integer $to
+   */
   static public function convert($uuid, $from, $to) {
     $conv = self::$m_convert[$from][$to];
     if (!isset($conv))
@@ -189,6 +194,11 @@ 
   /*
    * Generate UUID version 3 and 5 (name based)
    */
+
+  /**
+   * @param string $hash
+   * @param integer $version
+   */
   static private function generateName($ns, $node, $hash, $version) {
     $ns_fmt = self::detectFormat($ns);
     $field = self::convert($ns, $ns_fmt, self::FMT_FIELD);

Braces +34 added lines, -25 removed lines

@@ -131,17 +131,18 @@ 
 
   /* Auto-detect UUID format */
   static private function detectFormat($src) {
-    if (is_string($src))
-      return self::FMT_STRING;
-    else if (is_array($src)) {
+    if (is_string($src)) {
+          return self::FMT_STRING;
+    } else if (is_array($src)) {
       $len = count($src);
-      if ($len == 1 || ($len % 2) == 0)
-        return $len;
-      else
-        return (-1);
+      if ($len == 1 || ($len % 2) == 0) {
+              return $len;
+      } else {
+              return (-1);
+      }
+    } else {
+          return self::FMT_BINARY;
     }
-    else
-      return self::FMT_BINARY;
   }
 
   /*
@@ -151,8 +152,9 @@ 
   static public function generate($type, $fmt = self::FMT_BYTE,
                                   $node = "", $ns = "") {
     $func = self::$m_generate[$type];
-    if (!isset($func))
-      return null;
+    if (!isset($func)) {
+          return null;
+    }
     $conv = self::$m_convert[self::FMT_FIELD][$fmt];
 
     $uuid = self::$func($ns, $node);
@@ -164,8 +166,9 @@ 
    */
   static public function convert($uuid, $from, $to) {
     $conv = self::$m_convert[$from][$to];
-    if (!isset($conv))
-      return ($uuid);
+    if (!isset($conv)) {
+          return ($uuid);
+    }
 
     return (self::$conv($uuid));
   }
@@ -181,8 +184,9 @@ 
     $uuid['time_low'] = mt_rand(0, 0xffff) + (mt_rand(0, 0xffff) << 16);
     $uuid['time_mid'] = mt_rand(0, 0xffff);
     $uuid['clock_seq_low'] = mt_rand(0, 255);
-    for ($i = 0; $i < 6; $i++)
-      $uuid['node'][$i] = mt_rand(0, 255);
+    for ($i = 0; $i < 6; $i++) {
+          $uuid['node'][$i] = mt_rand(0, 255);
+    }
     return ($uuid);
   }
 
@@ -205,8 +209,9 @@ 
     /* Hash the namespace and node and convert to a byte array */
     $val = $hash($raw, true);
     $tmp = unpack('C16', $val);
-    foreach (array_keys($tmp) as $key)
-      $byte[$key - 1] = $tmp[$key];
+    foreach (array_keys($tmp) as $key) {
+          $byte[$key - 1] = $tmp[$key];
+    }
 
     /* Convert byte array to a field array */
     $field = self::conv_byte2field($byte);
@@ -264,8 +269,9 @@ 
       * Node should be set to the 48-bit IEEE node identifier, but
       * we leave it for the user to supply the node.
       */
-    for ($i = 0; $i < 6; $i++)
-      $uuid['node'][$i] = ord(substr($node, $i, 1));
+    for ($i = 0; $i < 6; $i++) {
+          $uuid['node'][$i] = ord(substr($node, $i, 1));
+    }
 
     return ($uuid);
   }
@@ -283,8 +289,9 @@ 
     $uuid[8] = $src['clock_seq_hi'];
     $uuid[9] = $src['clock_seq_low'];
 
-    for ($i = 0; $i < 6; $i++)
-      $uuid[10+$i] = $src['node'][$i];
+    for ($i = 0; $i < 6; $i++) {
+          $uuid[10+$i] = $src['node'][$i];
+    }
 
     return ($uuid);
   }
@@ -313,8 +320,9 @@ 
     $field['clock_seq_hi'] = $uuid[8];
     $field['clock_seq_low'] = $uuid[9];
 
-    for ($i = 0; $i < 6; $i++)
-      $field['node'][$i] = $uuid[10+$i];
+    for ($i = 0; $i < 6; $i++) {
+          $field['node'][$i] = $uuid[10+$i];
+    }
     return ($field);
   }
 
@@ -338,8 +346,9 @@ 
     $field['time_hi'] = ($parts[2]);
     $field['clock_seq_hi'] = ($parts[3] & 0xff00) >> 8;
     $field['clock_seq_low'] = $parts[3] & 0x00ff;
-    for ($i = 0; $i < 6; $i++)
-      $field['node'][$i] = $parts[4+$i];
+    for ($i = 0; $i < 6; $i++) {
+          $field['node'][$i] = $parts[4+$i];
+    }
 
     return ($field);
   }

src/EoC/Message/Request.php

Doc Comments +3 added lines

@@ -266,6 +266,7 @@ 
    * @param[in] string $path The absolute path of the request.
    * @param[in] string $queryParams (optional) Associative array of query parameters.
    * @param[in] string $headerFields (optional) Associative array of header fields.
+   * @param string $path
    */
   public function __construct($method, $path, array $queryParams = NULL, array $headerFields = NULL) {
     parent::__construct();
@@ -419,6 +420,8 @@ 
    * @brief This helper forces request to use the Authorization Basic mode.
    * @param[in] string $userName User name.
    * @param[in] string $password Password.
+   * @param string $userName
+   * @param string $password
    */
   public function setBasicAuth($userName, $password) {
     $this->setHeaderField(self::AUTHORIZATION_HF, "Basic ".base64_encode("$userName:$password"));

Braces +36 added lines, -28 removed lines

@@ -281,11 +281,13 @@ 
     $this->setMethod($method);
     $this->setPath($path);
 
-    if (isset($queryParams))
-      $this->setMultipleQueryParamsAtOnce($queryParams);
+    if (isset($queryParams)) {
+          $this->setMultipleQueryParamsAtOnce($queryParams);
+    }
 
-    if (isset($headerFields))
-      $this->setMultipleHeaderFieldsAtOnce($headerFields);
+    if (isset($headerFields)) {
+          $this->setMultipleHeaderFieldsAtOnce($headerFields);
+    }
   }
 
 
@@ -318,10 +320,11 @@ 
    * @param[in] string $method The HTTP method for the request. You should use one of the public constants, like GET_METHOD.
    */
   public function setMethod($method) {
-    if (array_key_exists($method, self::$supportedMethods))
-      $this->method = $method;
-    else
-      throw new \UnexpectedValueException("$method method not supported. Use addCustomMethod() to add an unsupported method.");
+    if (array_key_exists($method, self::$supportedMethods)) {
+          $this->method = $method;
+    } else {
+          throw new \UnexpectedValueException("$method method not supported. Use addCustomMethod() to add an unsupported method.");
+    }
   }
 
 
@@ -330,10 +333,11 @@ 
    * @param[in] string $method The HTTP custom method.
    */
   public static function addCustomMethod($method) {
-    if (array_key_exists($method, self::$supportedMethods))
-      throw new \UnexpectedValueException("$method method is supported and already exists.");
-    else
-      self::$supportedMethods[] = $method;
+    if (array_key_exists($method, self::$supportedMethods)) {
+          throw new \UnexpectedValueException("$method method is supported and already exists.");
+    } else {
+          self::$supportedMethods[] = $method;
+    }
   }
 
 
@@ -351,10 +355,11 @@ 
    * @param[in] string $path The absolute path of the request.
    */
   public function setPath($path) {
-    if (is_string($path))
-      $this->path = addslashes($path);
-    else
-      throw new \InvalidArgumentException("\$path must be a string.");
+    if (is_string($path)) {
+          $this->path = addslashes($path);
+    } else {
+          throw new \InvalidArgumentException("\$path must be a string.");
+    }
   }
 
 
@@ -364,11 +369,12 @@ 
    * @param[in] string $value Parameter value.
    */
   public function setQueryParam($name, $value) {
-    if (preg_match('/[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*/', $name))
-      $this->queryParams[$name] = $value;
-    else
-      throw new \InvalidArgumentException("\$name must start with a letter or underscore, followed by any number of
+    if (preg_match('/[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*/', $name)) {
+          $this->queryParams[$name] = $value;
+    } else {
+          throw new \InvalidArgumentException("\$name must start with a letter or underscore, followed by any number of
           letters, numbers, or underscores.");
+    }
   }
 
 
@@ -377,11 +383,12 @@ 
    * @param[in] array $params An associative array of parameters.
    */
   public function setMultipleQueryParamsAtOnce(array $params) {
-    if (Helper\ArrayHelper::isAssociative($params))
-      foreach ($params as $name => $value)
+    if (Helper\ArrayHelper::isAssociative($params)) {
+          foreach ($params as $name => $value)
         $this->setQueryParam($name, $value);
-    else
-      throw new \InvalidArgumentException("\$params must be an associative array.");
+    } else {
+          throw new \InvalidArgumentException("\$params must be an associative array.");
+    }
   }
 
 
@@ -390,11 +397,12 @@ 
    * @retval string
    */
   public function getQueryString() {
-    if (empty($this->queryParams))
-      return "";
-    else
-      // Encoding is based on RFC 3986.
+    if (empty($this->queryParams)) {
+          return "";
+    } else {
+          // Encoding is based on RFC 3986.
       return "?".http_build_query($this->queryParams, NULL, "&", PHP_QUERY_RFC3986);
+    }
   }
 
 

src/EoC/Info/AttachmentInfo.php

Braces +5 added lines, -4 removed lines

@@ -45,10 +45,11 @@
    * @retval string|bool The codec name or `false` if the attachment is not compressed.
    */
   public function getContentEncoding() {
-    if ($this->response->hasHeaderField(Response::CONTENT_ENCODING_HF))
-      return $this->response->getHeaderFieldValue(Response::CONTENT_ENCODING_HF);
-    else
-      return FALSE;
+    if ($this->response->hasHeaderField(Response::CONTENT_ENCODING_HF)) {
+          return $this->response->getHeaderFieldValue(Response::CONTENT_ENCODING_HF);
+    } else {
+          return FALSE;
+    }
   }
 
 

src/EoC/Info/DbInfo.php

Braces +2 added lines, -2 removed lines

@@ -82,9 +82,9 @@
       $this->purgeSeq = $info['purge_seq'];
       $this->compactRunning = $info['compact_running'];
       $this->committedUpdateSeq = $info['committed_update_seq'];
+    } else {
+          throw new \Exception("\$info must be an associative array.");
     }
-    else
-      throw new \Exception("\$info must be an associative array.");
   }
 
 

src/EoC/Doc/LocalDoc.php

Braces +3 added lines, -2 removed lines

@@ -25,8 +25,9 @@
    * @brief Removes `_local/` from he document identifier.
    */
   protected function fixDocId() {
-    if (isset($this->meta['_id']))
-      $this->meta['_id'] = preg_replace('%\A_local/%m', "", $this->meta['_id']);
+    if (isset($this->meta['_id'])) {
+          $this->meta['_id'] = preg_replace('%\A_local/%m', "", $this->meta['_id']);
+    }
   }
 
 

src/EoC/Doc/DocRef.php

Braces +5 added lines, -4 removed lines

@@ -59,10 +59,11 @@
 
 
   public function setId($value) {
-    if (!empty($value))
-      $this->id = (string)$value;
-    else
-      throw new \Exception("\$id must be a non-empty string.");
+    if (!empty($value)) {
+          $this->id = (string)$value;
+    } else {
+          throw new \Exception("\$id must be a non-empty string.");
+    }
   }
 
 

src/EoC/Doc/Attachment/Attachment.php

Braces +15 added lines, -12 removed lines

@@ -41,8 +41,9 @@ 
     $instance = new self();
 
     if (file_exists($fileName)) {
-      if (is_dir($fileName))
-        throw new \Exception("The file $fileName is a directory.");
+      if (is_dir($fileName)) {
+              throw new \Exception("The file $fileName is a directory.");
+      }
 
       $instance->name = basename($fileName);
 
@@ -58,14 +59,15 @@ 
         finfo_close($finfo);
         fclose($fd);
 
-        if ($instance->data === FALSE)
-          throw new \Exception("Error reading the file $fileName.");
+        if ($instance->data === FALSE) {
+                  throw new \Exception("Error reading the file $fileName.");
+        }
+      } else {
+              throw new \Exception("Cannot open the file $fileName.");
       }
-      else
-        throw new \Exception("Cannot open the file $fileName.");
+    } else {
+          throw new \Exception("The file $fileName doesn't exist.");
     }
-    else
-      throw new \Exception("The file $fileName doesn't exist.");
 
     return $instance;
   }
@@ -101,11 +103,12 @@ 
       $bytes = fwrite($fd, $this->data);
       fclose($fd);
 
-      if ($bytes === FALSE)
-        throw new \Exception("Error writing the file `$this->name`.");
+      if ($bytes === FALSE) {
+              throw new \Exception("Error writing the file `$this->name`.");
+      }
+    } else {
+          throw new \Exception("Cannot create the file `$this->name`.");
     }
-    else
-      throw new \Exception("Cannot create the file `$this->name`.");
   }
 
 

src/EoC/Doc/Doc.php

Braces +11 added lines, -8 removed lines

@@ -54,8 +54,9 @@ 
   public function getAttachments() {
     $attachments = [];
 
-    foreach ($this->meta[self::ATTACHMENTS] as $attachment)
-      $attachments[] = Attachment::fromArray($attachment);
+    foreach ($this->meta[self::ATTACHMENTS] as $attachment) {
+          $attachments[] = Attachment::fromArray($attachment);
+    }
 
     return $attachments;
   }
@@ -75,13 +76,15 @@ 
    * @todo To be documented.
    */
   public function removeAttachment($name) {
-    if ($this->isMetadataPresent(self::ATTACHMENTS))
-      if (array_key_exists($name, $this->meta[self::ATTACHMENTS]))
+    if ($this->isMetadataPresent(self::ATTACHMENTS)) {
+          if (array_key_exists($name, $this->meta[self::ATTACHMENTS]))
         unset($this->meta[self::ATTACHMENTS][$name]);
-      else
-        throw new \Exception("Can't find `$name` attachment in the document.");
-    else
-      throw new \Exception("The document doesn't have any attachment.");
+    } else {
+              throw new \Exception("Can't find `$name` attachment in the document.");
+      }
+    else {
+          throw new \Exception("The document doesn't have any attachment.");
+    }
   }