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/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.
 
   //!@}
 
@@ -662,7 +662,7 @@ 
    * @see http://docs.couchdb.org/en/latest/api/database/compact.html#db-view-cleanup
    */
   public function cleanupViews($dbName) {
-    $request =  new Request(Request::POST_METHOD, "/".rawurlencode($this->prefix.$dbName)."/_view_cleanup");
+    $request = new Request(Request::POST_METHOD, "/".rawurlencode($this->prefix.$dbName)."/_view_cleanup");
 
     // A POST method requires Content-Type header.
     $request->setHeaderField(Request::CONTENT_TYPE_HF, "application/json");

Doc Comments +11 added lines, -11 removed lines

@@ -296,7 +296,7 @@ 
 
   /**
    * @brief Returns a list of all database events in the CouchDB instance.
-   * @param DbUpdatesFeedOpts $opts Additional options.
+   * @param Opt\DbUpdatesFeedOpts $opts Additional options.
    * @return array An associative array.
    * @attention Requires admin privileges.
    * @see http://docs.couchdb.org/en/latest/api/server/common.html#db-updates
@@ -564,7 +564,7 @@ 
   /**
    * @brief Returns information about the selected database.
    * @param string $name The database name.
-   * @return array An associative array.
+   * @return Info\DbInfo An associative array.
    * @see http://docs.couchdb.org/en/latest/api/database/common.html#get--db
    */
   public function getDbInfo($name) {
@@ -576,7 +576,7 @@ 
    * @brief Obtains a list of the changes made to the database. This can be used to monitor for update and modifications
    * to the database for post processing or synchronization.
    * @param string $name The database name.
-   * @param ChangesFeedOpts $opts Additional options.
+   * @param Opt\ChangesFeedOpts $opts Additional options.
    * @return Response
    * @see http://docs.couchdb.org/en/latest/api/database/changes.html
    */
@@ -707,7 +707,7 @@ 
   /**
    * @brief Returns the special security object for the database.
    * @param string $dbName The database name.
-   * @return string A JSON object.
+   * @return Response A JSON object.
    * @see http://docs.couchdb.org/en/latest/api/database/security.html#get--db-_security
    */
   public function getSecurityObj($dbName) {
@@ -761,7 +761,7 @@ 
    * permanent continuous replications that survive a server restart without you having to do anything.
    * @param string|array $filter (optional) Name of a filter function that can choose which revisions get replicated.
    * You can also provide an array of document identifiers; if given, only these documents will be replicated.
-   * @param ViewQueryOpts $opts (optional) Query options to get additional information, grouping results, include
+   * @param Opt\ViewQueryOpts $opts (optional) Query options to get additional information, grouping results, include
    * docs, etc.
    * @return Response
    * @see http://docs.couchdb.org/en/latest/api/server/common.html#post--_replicate
@@ -865,7 +865,7 @@ 
    * @param array $keys (optional) Used to retrieve just the view rows matching that set of keys. Rows are returned
    * in the order of the specified keys. Combining this feature with Opt\ViewQueryOpts.includeDocs() results in the so-called
    * multi-document-fetch feature.
-   * @param ViewQueryOpts $opts (optional) Query options to get additional information, grouping results, include
+   * @param Opt\ViewQueryOpts $opts (optional) Query options to get additional information, grouping results, include
    * docs, etc.
    * @param IChunkHook $chunkHook (optional) A class instance that implements the IChunkHook interface.
    * @return Result\QueryResult The result of the query.
@@ -897,7 +897,7 @@ 
    * @param array $keys (optional) Used to retrieve just the view rows matching that set of keys. Rows are returned
    * in the order of the specified keys. Combining this feature with Opt\ViewQueryOpts.includeDocs() results in the so-called
    * multi-document-fetch feature.
-   * @param ViewQueryOpts $opts (optional) Query options to get additional information, grouping results, include
+   * @param Opt\ViewQueryOpts $opts (optional) Query options to get additional information, grouping results, include
    * docs, etc.
    * @param IChunkHook $chunkHook (optional) A class instance that implements the IChunkHook interface.
    * @return Result\QueryResult The result of the query.
@@ -949,7 +949,7 @@ 
    * @param array $keys (optional) Used to retrieve just the view rows matching that set of keys. Rows are returned
    * in the order of the specified keys. Combining this feature with Opt\ViewQueryOpts.includeDocs() results in the so-called
    * multi-document-fetch feature.
-   * @param ViewQueryOpts $opts (optional) Query options to get additional information, grouping results, include
+   * @param Opt\ViewQueryOpts $opts (optional) Query options to get additional information, grouping results, include
    * docs, etc.
    * @param string $language The language used to implement the map and reduce functions.
    * @param IChunkHook $chunkHook (optional) A class instance that implements the IChunkHook interface.
@@ -1089,7 +1089,7 @@ 
    * @param string $docId The document's identifier.
    * @param string $path The document's path.
    * @param string $rev (optional) The document's revision.
-   * @param DocOpts $opts Query options to get additional document information, like conflicts, attachments, etc.
+   * @param Opt\DocOpts $opts Query options to get additional document information, like conflicts, attachments, etc.
    * @return object|Response An instance of Doc, LocalDoc, DesignDoc or any subclass of Doc.
    * @see http://docs.couchdb.org/en/latest/api/document/common.html#get--db-docid
    */
@@ -1144,7 +1144,7 @@ 
    * using PUT instead we need to specify one. We can still use the function getUuids() to ask CouchDB for some ids.
    * This is an internal detail. You have only to know that CouchDB can generate the document id for you.
    * @param string $dbName The database name.
-   * @param Doc $doc The document you want insert or update.
+   * @param Doc\IDoc $doc The document you want insert or update.
    * @param bool $batchMode (optional) You can write documents to the database at a higher rate by using the batch
    * option. This collects document writes together in memory (on a user-by-user basis) before they are committed to
    * disk. This increases the risk of the documents not being stored in the event of a failure, since the documents are
@@ -1333,7 +1333,7 @@ 
    * @param string $docId The document's identifier.
    * @param string $path The document's path.
    * @param string $rev (optional) The document's revision.
-   * @return string The document's revision.
+   * @return Response The document's revision.
    * @see http://docs.couchdb.org/en/latest/api/document/attachments.html#db-doc-attachment
    */
   public function getAttachmentInfo($dbName, $fileName, $path, $docId, $rev = NULL) {

src/EoC/Result/QueryResult.php

Spacing +2 added lines, -2 removed lines

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