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);

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);

Spacing +18 added lines, -18 removed lines

@@ -67,29 +67,29 @@ 
  */
 class UUID {
   /* UUID versions */
-  const UUID_TIME	 = 1;	/* Time based UUID */
-  const UUID_NAME_MD5	 = 3;	/* Name based (MD5) UUID */
-  const UUID_RANDOM	 = 4;	/* Random UUID */
-  const UUID_NAME_SHA1	 = 5;	/* Name based (SHA1) UUID */
+  const UUID_TIME = 1; /* Time based UUID */
+  const UUID_NAME_MD5 = 3; /* Name based (MD5) UUID */
+  const UUID_RANDOM = 4; /* Random UUID */
+  const UUID_NAME_SHA1 = 5; /* Name based (SHA1) UUID */
 
   /* UUID formats */
   const FMT_FIELD	 = 100;
   const FMT_STRING	 = 101;
   const FMT_BINARY	 = 102;
-  const FMT_QWORD	 = 1;	/* Quad-word, 128-bit (not impl.) */
-  const FMT_DWORD	 = 2;	/* Double-word, 64-bit (not impl.) */
-  const FMT_WORD		 = 4;	/* Word, 32-bit (not impl.) */
-  const FMT_SHORT		= 8;	/* Short (not impl.) */
-  const FMT_BYTE		= 16;	/* Byte */
-  const FMT_DEFAULT	 = 16;
+  const FMT_QWORD	 = 1; /* Quad-word, 128-bit (not impl.) */
+  const FMT_DWORD	 = 2; /* Double-word, 64-bit (not impl.) */
+  const FMT_WORD		 = 4; /* Word, 32-bit (not impl.) */
+  const FMT_SHORT		= 8; /* Short (not impl.) */
+  const FMT_BYTE = 16; /* Byte */
+  const FMT_DEFAULT = 16;
 
   /* Field UUID representation */
   static private $m_uuid_field = array(
-    'time_low' => 0,		/* 32-bit */
-    'time_mid' => 0,		/* 16-bit */
-    'time_hi' => 0,			/* 16-bit */
-    'clock_seq_hi' => 0,		/*  8-bit */
-    'clock_seq_low' => 0,		/*  8-bit */
+    'time_low' => 0, /* 32-bit */
+    'time_mid' => 0, /* 16-bit */
+    'time_hi' => 0, /* 16-bit */
+    'clock_seq_hi' => 0, /*  8-bit */
+    'clock_seq_low' => 0, /*  8-bit */
     'node' => array()		/* 48-bit */
   );
 
@@ -284,7 +284,7 @@ 
     $uuid[9] = $src['clock_seq_low'];
 
     for ($i = 0; $i < 6; $i++)
-      $uuid[10+$i] = $src['node'][$i];
+      $uuid[10 + $i] = $src['node'][$i];
 
     return ($uuid);
   }
@@ -314,7 +314,7 @@ 
     $field['clock_seq_low'] = $uuid[9];
 
     for ($i = 0; $i < 6; $i++)
-      $field['node'][$i] = $uuid[10+$i];
+      $field['node'][$i] = $uuid[10 + $i];
     return ($field);
   }
 
@@ -339,7 +339,7 @@ 
     $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];
+      $field['node'][$i] = $parts[4 + $i];
 
     return ($field);
   }

src/EoC/Helper/ArrayHelper.php

Doc Comments +1 added lines

@@ -54,6 +54,7 @@
    * @brief Converts the given JSON into an array.
    * @param[in] string $json A JSON object.
    * @param[in] bool $assoc When `true`, returned objects will be converted into associative arrays.
+   * @param boolean $assoc
    * @retval array
    */
   public static function fromJson($json, $assoc) {

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"));

Spacing +4 added lines, -4 removed lines

@@ -189,9 +189,9 @@ 
    */
   const X_FORWARDED_FOR_HF = "X-Forwarded-For";
 
-  const DESTINATION_HF = "Destination";  //!< This header field is not supported by HTTP 1.1. It's a special header field used by CouchDB.
-  const X_COUCHDB_WWW_AUTHENTICATE_HF = "X-CouchDB-WWW-Authenticate";  //!< This header field is not supported by HTTP 1.1. It's a special method header field by CouchDB.
-  const X_COUCHDB_FULL_COMMIT_HF = "X-Couch-Full-Commit";  //!< This header field is not supported by HTTP 1.1. It's a special header field used by CouchDB.
+  const DESTINATION_HF = "Destination"; //!< This header field is not supported by HTTP 1.1. It's a special header field used by CouchDB.
+  const X_COUCHDB_WWW_AUTHENTICATE_HF = "X-CouchDB-WWW-Authenticate"; //!< This header field is not supported by HTTP 1.1. It's a special method header field by CouchDB.
+  const X_COUCHDB_FULL_COMMIT_HF = "X-Couch-Full-Commit"; //!< This header field is not supported by HTTP 1.1. It's a special header field used by CouchDB.
 
   //!@}
 
@@ -408,7 +408,7 @@ 
       $params = explode('&', $query);
 
       foreach ($params as $param) {
-        @list($name, $value)  = explode('=', $param, 2);
+        @list($name, $value) = explode('=', $param, 2);
         $this->setQueryParam($name, $value);
       }
     }

src/EoC/Info/DbInfo.php

Spacing +2 added lines, -2 removed lines

@@ -100,8 +100,8 @@
       $buffer .= "File Opened Since: ".sprintf($since, $time['days'], $time['hours'], $time['minutes'], $time['seconds']).PHP_EOL;
     }
 
-    $buffer .= "Disk Size: ".round($this->diskSize/(1024*1024*1024), 3)." GB".PHP_EOL;
-    $buffer .= "Data Size: ".round($this->dataSize/(1024*1024*1024), 3)." GB".PHP_EOL;
+    $buffer .= "Disk Size: ".round($this->diskSize / (1024 * 1024 * 1024), 3)." GB".PHP_EOL;
+    $buffer .= "Data Size: ".round($this->dataSize / (1024 * 1024 * 1024), 3)." GB".PHP_EOL;
     $buffer .= "Disk Format Version: ".$this->diskFormatVersion.PHP_EOL;
 
     $compactRunning = ($this->compactRunning) ? 'active' : 'inactive';

src/EoC/Couch.php

Spacing +3 added lines, -3 removed lines

@@ -35,8 +35,8 @@ 
   //!@{
 
   const STD_DOC_PATH = ""; //!< Path for standard documents.
-  const LOCAL_DOC_PATH = "_local/";  //!< Path for local documents.
-  const DESIGN_DOC_PATH = "_design/";  //!< Path for design documents.
+  const LOCAL_DOC_PATH = "_local/"; //!< Path for local documents.
+  const DESIGN_DOC_PATH = "_design/"; //!< Path for design documents.
 
   //!@}
 
@@ -783,7 +783,7 @@ 
   public function cleanupViews() {
     $this->checkForDb();
 
-    $request =  new Request(Request::POST_METHOD, "/".$this->dbName."/_view_cleanup");
+    $request = new Request(Request::POST_METHOD, "/".$this->dbName."/_view_cleanup");
 
     // A POST method requires Content-Type header.
     $request->setHeaderField(Request::CONTENT_TYPE_HF, "application/json");

src/EoC/Result/QueryResult.php

Spacing +2 added lines, -2 removed lines

@@ -54,7 +54,7 @@ 
    * arrays.
    * @retval array An array of rows.
    */
-  public function asArray()  {
+  public function asArray() {
     return $this->result['rows'];
   }
 
@@ -105,7 +105,7 @@ 
    * @param[in] integer $offset The offset to retrieve.
    * @retval mixed Can return all value types.
    */
-  public function offsetGet($offset)  {
+  public function offsetGet($offset) {
     return $this->result['rows'][$offset];
   }