alcaeus / mongo-php-adapter

lib/Mongo/MongoId.php

Doc Comments +1 added lines, -1 removed lines

@@ -200,7 +200,7 @@
     }
 
     /**
-     * @param $id
+     * @param string|null $id
      * @throws MongoException
      */
     private function createObjectID($id)

lib/Mongo/Mongo.php

Doc Comments +9 added lines, -9 removed lines

@@ -48,7 +48,7 @@ 
      * Returns the address being used by this for slaveOkay reads
      *
      * @link http://php.net/manual/en/mongo.getslave.php
-     * @return bool The address of the secondary this connection is using for
+     * @return boolean|null The address of the secondary this connection is using for
      * reads. This returns NULL if this is not connected to a replica set or not yet
      * initialized.
      */
@@ -61,7 +61,7 @@ 
      * Get slaveOkay setting for this connection
      *
      * @link http://php.net/manual/en/mongo.getslaveokay.php
-     * @return bool Returns the value of slaveOkay for this instance.
+     * @return boolean|null Returns the value of slaveOkay for this instance.
      */
     public function getSlaveOkay()
     {
@@ -73,7 +73,7 @@ 
      *
      * @link http://www.php.net/manual/en/mongo.pairconnect.php
      * @throws MongoConnectionException
-     * @return boolean
+     * @return boolean|null
      *
      * @deprecated Pass a string of the form "mongodb://server1,server2" to the constructor instead of using this method.
      */
@@ -99,7 +99,7 @@ 
      *
      * @link http://php.net/manual/en/mongo.setslaveokay.php
      * @param bool $ok
-     * @return bool returns the former value of slaveOkay for this instance.
+     * @return boolean|null returns the former value of slaveOkay for this instance.
      */
     public function setSlaveOkay ($ok)
     {
@@ -111,7 +111,7 @@ 
      *
      * @link http://php.net/manual/en/mongo.setpoolsize.php
      * @param $size <p>The max number of connections future pools will be able to create. Negative numbers mean that the pool will spawn an infinite number of connections.</p>
-     * @return bool Returns the former value of pool size.
+     * @return boolean|null Returns the former value of pool size.
      * @deprecated Relying on this feature is highly discouraged. Please use MongoPool::setSize() instead.
      */
     public function setPoolSize($size)
@@ -126,7 +126,7 @@ 
      * @param string $username A username used to identify the connection.
      * @param string $password A password used to identify the connection.
      * @throws MongoConnectionException
-     * @return boolean If the connection was successful.
+     * @return boolean|null If the connection was successful.
      * @deprecated Pass array("persist" => $id) to the constructor instead of using this method.
      */
     public function persistConnect($username = "", $password = "")
@@ -141,7 +141,7 @@ 
      * @param string $username A username used to identify the connection.
      * @param string $password A password used to identify the connection.
      * @throws MongoConnectionException
-     * @return boolean If the connection was successful.
+     * @return boolean|null If the connection was successful.
      * @deprecated Pass "mongodb://server1,server2" and array("persist" => $id) to the constructor instead of using this method.
      */
     public function pairPersistConnect($username = "", $password = "")
@@ -154,7 +154,7 @@ 
      *
      * @link http://www.php.net/manual/en/mongo.connectutil.php
      * @throws MongoConnectionException
-     * @return boolean If the connection was successful.
+     * @return boolean|null If the connection was successful.
      */
     protected function connectUtil()
     {
@@ -201,7 +201,7 @@ 
      * Creates a database error on the database.
      *
      * @link http://www.php.net/manual/en/mongo.forceerror.php
-     * @return boolean The database response.
+     * @return boolean|null The database response.
      * @deprecated Use MongoDB::forceError() instead.
      */
     public function forceError()

lib/Mongo/MongoDuplicateKeyException.php

Braces +2 added lines, -1 removed lines

@@ -17,6 +17,7 @@
  * <p>(PECL mongo &gt;= 1.5.0)</p>
  * @link http://php.net/manual/en/class.mongoduplicatekeyexception.php
  */
-class MongoDuplicateKeyException extends MongoWriteConcernException {
+class MongoDuplicateKeyException extends MongoWriteConcernException
+{
 
 }

lib/Mongo/MongoExecutionTimeoutException.php

Braces +3 added lines, -1 removed lines

@@ -17,4 +17,6 @@
  * <p>(PECL mongo &gt;= 1.5.0)</p>
  * @link http://php.net/manual/en/class.mongoexecutiontimeoutexception.php
  */
-class MongoExecutionTimeoutException extends MongoException {}
+class MongoExecutionTimeoutException extends MongoException
+{
+}

lib/Mongo/MongoProtocolException.php

Braces +3 added lines, -1 removed lines

@@ -16,4 +16,6 @@
 /**
  * <p>(PECL mongo &gt;= 1.5.0)</p>
  */
-class MongoProtocolException extends MongoException {}
+class MongoProtocolException extends MongoException
+{
+}

lib/Mongo/MongoResultException.php

Braces +5 added lines, -2 removed lines

@@ -18,13 +18,16 @@
  * @link http://php.net/manual/en/class.mongoresultexception.php#mongoresultexception.props.document
  *
  */
-class MongoResultException extends MongoException {
+class MongoResultException extends MongoException
+{
     /**
      * Retrieve the full result document
      * http://php.net/manual/en/mongoresultexception.getdocument.php
      * @return array <p>The full result document as an array, including partial data if available and additional keys.</p>
      */
-    public function getDocument () {}
+    public function getDocument ()
+    {
+}
 
     public $document;
 

lib/Mongo/MongoPool.php

Doc Comments +1 added lines, -1 removed lines

@@ -35,7 +35,7 @@
      *
      * @link http://php.net/manual/en/mongopool.setsize.php
      * @param int $size
-     * @return boolean Returns the former value of pool size
+     * @return integer Returns the former value of pool size
      */
     public static function setSize($size)
     {

lib/Mongo/MongoDB.php

Braces +2 added lines, -1 removed lines

@@ -540,7 +540,8 @@
      * @param bool $includeSystemCollections
      * @return Closure
      */
-    private function getSystemCollectionFilterClosure($includeSystemCollections = false) {
+    private function getSystemCollectionFilterClosure($includeSystemCollections = false)
+    {
         return function (CollectionInfo $collectionInfo) use ($includeSystemCollections) {
             return $includeSystemCollections || ! preg_match('#^system\.#', $collectionInfo->getName());
         };

Doc Comments +4 added lines, -1 removed lines

@@ -511,6 +511,9 @@ 
         }
     }
 
+    /**
+     * @param string $name
+     */
     private function checkDatabaseName($name)
     {
         if (empty($name)) {
@@ -543,7 +546,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function __sleep()
     {

lib/Alcaeus/MongoDbAdapter/AbstractCursor.php

Doc Comments +2 added lines, -2 removed lines

@@ -80,7 +80,7 @@ 
     ];
 
     /**
-     * @return Cursor
+     * @return \Traversable
      */
     abstract protected function ensureCursor();
 
@@ -377,7 +377,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function __sleep()
     {