alcaeus / mongo-php-adapter

lib/Mongo/Mongo.php

Doc Comments +9 added lines, -9 removed lines

@@ -34,7 +34,7 @@ 
      * (PECL mongo &gt;= 1.1.0)<br/>
      * Returns the address being used by this for slaveOkay reads
      * @link http://php.net/manual/en/mongo.getslave.php
-     * @return bool <p>The address of the secondary this connection is using for reads.
+     * @return boolean|null <p>The address of the secondary this connection is using for reads.
      * </p>
      * <p>
      * This returns <b>NULL</b> if this is not connected to a replica set or not yet
@@ -46,7 +46,7 @@ 
      * (PECL mongo &gt;= 1.1.0)<br/>
      * 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() {}
     /**
@@ -54,7 +54,7 @@ 
      * @deprecated Pass a string of the form "mongodb://server1,server2" to the constructor instead of using this method.
      * @link http://www.php.net/manual/en/mongo.pairconnect.php
      * @throws MongoConnectionException
-     * @return boolean
+     * @return boolean|null
      */
     public function pairConnect() {}
 
@@ -90,7 +90,7 @@ 
      * If reads should be sent to secondary members of a replica set for all
      * possible queries using this {@see MongoClient} instance.
      * </p>
-     * @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) {}
     /**
@@ -99,7 +99,7 @@ 
      * Set the size for future connection pools.
      * @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.
      */
     public function setPoolSize($size) {}
     /**
@@ -109,7 +109,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.
      */
     public function persistConnect($username = "", $password = "") {}
 
@@ -120,7 +120,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.
      */
     public function pairPersistConnect($username = "", $password = "") {}
 
@@ -129,7 +129,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() {}
 
@@ -161,7 +161,7 @@ 
      * Creates a database error on the database.
      * @deprecated Use MongoDB::forceError() instead.
      * @link http://www.php.net/manual/en/mongo.forceerror.php
-     * @return boolean The database response.
+     * @return boolean|null The database response.
      */
     public function forceError() {}
 }

lib/Mongo/MongoDB.php

Doc Comments +3 added lines, -5 removed lines

@@ -266,7 +266,6 @@ 
      * (PECL mongo &gt;= 0.9.0)<br/>
      * Get a list of collections in this database
      * @link http://www.php.net/manual/en/mongodb.listcollections.php
-     * @param bool $includeSystemCollections [optional] <p>Include system collections.</p>
      * @return array Returns a list of MongoCollections.
      */
     public function listCollections(array $options = [])
@@ -410,7 +409,7 @@ 
      * (PECL mongo &gt;= 0.9.5)<br/>
      * Creates a database error
      * @link http://www.php.net/manual/en/mongodb.forceerror.php
-     * @return boolean Returns the database response.
+     * @return boolean|null Returns the database response.
      */
     public function forceError()
     {
@@ -460,7 +459,7 @@ 
      * @link http://www.php.net/manual/en/mongodb.setreadpreference.php
      * @param string $read_preference <p>The read preference mode: <b>MongoClient::RP_PRIMARY</b>, <b>MongoClient::RP_PRIMARY_PREFERRED</b>, <b>MongoClient::RP_SECONDARY</b>, <b>MongoClient::RP_SECONDARY_PREFERRED</b>, or <b>MongoClient::RP_NEAREST</b>.</p>
      * @param array $tags [optional] <p>An array of zero or more tag sets, where each tag set is itself an array of criteria used to match tags on replica set members.</p>
-     * @return boolean Returns <b>TRUE</b> on success, or <b>FALSE</b> otherwise.
+     * @return boolean|null Returns <b>TRUE</b> on success, or <b>FALSE</b> otherwise.
      */
     public function setReadPreference($read_preference, array $tags)
     {
@@ -472,8 +471,7 @@ 
      * @link http://php.net/manual/en/mongodb.setwriteconcern.php
      * Set the write concern for this database
      * @param mixed $w <p>The write concern. This may be an integer denoting the number of servers required to acknowledge the write, or a string mode (e.g. "majority").</p>
-     * @param int $wtimeout[optional] <p>The maximum number of milliseconds to wait for the server to satisfy the write concern.</p>
-     * @return boolean Returns <b>TRUE</b> on success, or <b>FALSE</b> otherwise.
+     * @return boolean|null Returns <b>TRUE</b> on success, or <b>FALSE</b> otherwise.
      */
     public function setWriteConcern($w, $wtimeout)
     {

lib/Mongo/MongoGridFS.php

Doc Comments +3 added lines, -3 removed lines

@@ -45,7 +45,7 @@ 
      * @link http://php.net/manual/en/mongogridfs.construct.php
      * @param MongoDB $db Database
      * @param string $prefix [optional] <p>Optional collection name prefix.</p>
-     * @param mixed $chunks  [optional]
+     * @param string $chunks  [optional]
      * @return MongoGridFS
      */
     public function __construct($db, $prefix = "fs", $chunks = "fs") {}
@@ -100,7 +100,7 @@ 
      * @param array $criteria Description of records to remove.
      * @param array $options Options for remove. Valid options are: "safe"- Check that the remove succeeded.
      * @throws MongoCursorException
-     * @return boolean
+     * @return boolean|null
      */
     public function remove(array $criteria = array(), array $options = array()) {}
 
@@ -108,7 +108,7 @@ 
      * Delete a file from the database
      * @link http://php.net/manual/en/mongogridfs.delete.php
      * @param mixed $id _id of the file to remove
-     * @return boolean Returns true if the remove was successfully sent to the database.
+     * @return boolean|null Returns true if the remove was successfully sent to the database.
      */
     public function delete($id) {}
 

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/MongoLog.php

Doc Comments +1 added lines, -1 removed lines

@@ -97,7 +97,7 @@
      *
      * <p>The log message itself.</p></li>
      * <ul>
-     * @return boolean Returns <b>TRUE</b> on success or <b>FALSE</b> on failure.
+     * @return boolean|null Returns <b>TRUE</b> on success or <b>FALSE</b> on failure.
      */
     public static function setCallback ( callable $log_function ) {}
 

lib/Mongo/MongoPool.php

Doc Comments +1 added lines, -1 removed lines

@@ -50,7 +50,7 @@
      * @param int $size 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
-     * @return boolean Returns the former value of pool size
+     * @return boolean|null Returns the former value of pool size
      */
     public static function setSize($size) {}
 

lib/Mongo/MongoBinData.php

Unused Use Statements -1 removed lines

@@ -15,7 +15,6 @@
 
 use Alcaeus\MongoDbAdapter\TypeInterface;
 use MongoDB\BSON\Binary;
-use MongoDB\BSON\Type;
 
 class MongoBinData implements TypeInterface
 {

lib/Alcaeus/MongoDbAdapter/AbstractCursor.php

Doc Comments +1 added lines, -1 removed lines

@@ -72,7 +72,7 @@
     protected $readPreference = [];
 
     /**
-     * @return Cursor
+     * @return \Traversable
      */
     abstract protected function ensureCursor();
 

lib/Mongo/MongoCursor.php

Doc Comments +1 added lines, -1 removed lines

@@ -201,7 +201,7 @@
      * @link http://www.php.net/manual/en/mongocursor.hasnext.php
      * @throws MongoConnectionException
      * @throws MongoCursorTimeoutException
-     * @return bool Returns true if there is another element
+     * @return boolean|null Returns true if there is another element
      */
     public function hasNext()
     {