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/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()
     {

Unused Use Statements -1 removed lines

@@ -15,7 +15,6 @@
 
 use Alcaeus\MongoDbAdapter\AbstractCursor;
 use MongoDB\Driver\Cursor;
-use MongoDB\Driver\ReadPreference;
 use MongoDB\Operation\Find;
 
 /**

lib/Mongo/MongoCollection.php

Doc Comments +4 added lines, -4 removed lines

@@ -272,7 +272,7 @@ 
      * @throws MongoException if the inserted document is empty or if it contains zero-length keys. Attempting to insert an object with protected and private properties will cause a zero-length key error.
      * @throws MongoCursorException if the "w" option is set and the write fails.
      * @throws MongoCursorTimeoutException if the "w" option is set to a value greater than one and the operation takes longer than MongoCursor::$timeout milliseconds to complete. This does not kill the operation on the server, it is a client-side timeout. The operation in MongoCollection::$wtimeout is milliseconds.
-     * @return bool|array Returns an array containing the status of the insertion if the "w" option is set.
+     * @return MongoDB\InsertOneResult Returns an array containing the status of the insertion if the "w" option is set.
      */
     public function insert($a, array $options = array())
     {
@@ -285,7 +285,7 @@ 
      * @param array $a An array of arrays.
      * @param array $options Options for the inserts.
      * @throws MongoCursorException
-     * @return mixed f "safe" is set, returns an associative array with the status of the inserts ("ok") and any error that may have occured ("err"). Otherwise, returns TRUE if the batch insert was successfully sent, FALSE otherwise.
+     * @return MongoDB\InsertManyResult f "safe" is set, returns an associative array with the status of the inserts ("ok") and any error that may have occured ("err"). Otherwise, returns TRUE if the batch insert was successfully sent, FALSE otherwise.
      */
     public function batchInsert(array $a, array $options = array())
     {
@@ -466,7 +466,7 @@ 
      * @link http://www.php.net/manual/en/mongocollection.createindex.php
      * @param array $keys Field or fields to use as index.
      * @param array $options [optional] This parameter is an associative array of the form array("optionname" => <boolean>, ...).
-     * @return array Returns the database response.
+     * @return string|false Returns the database response.
      */
     public function createIndex(array $keys, array $options = array())
     {
@@ -559,7 +559,7 @@ 
      * @throws MongoException if the inserted document is empty or if it contains zero-length keys. Attempting to insert an object with protected and private properties will cause a zero-length key error.
      * @throws MongoCursorException if the "w" option is set and the write fails.
      * @throws MongoCursorTimeoutException if the "w" option is set to a value greater than one and the operation takes longer than MongoCursor::$timeout milliseconds to complete. This does not kill the operation on the server, it is a client-side timeout. The operation in MongoCollection::$wtimeout is milliseconds.
-     * @return array|boolean If w was set, returns an array containing the status of the save.
+     * @return MongoDB\UpdateResult If w was set, returns an array containing the status of the save.
      * Otherwise, returns a boolean representing if the array was not empty (an empty array will not be inserted).
      */
     public function save($a, array $options = array())

lib/Mongo/MongoGridFS.php

Doc Comments +14 added lines, -1 removed lines

@@ -51,7 +51,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(MongoDB $db, $prefix = "fs", $chunks = null)
@@ -128,6 +128,9 @@ 
         return $fileDocument['_id'];
     }
 
+    /**
+     * @param resource $file
+     */
     private function insertChunksFromFile($file, $fileInfo)
     {
         $length = $fileInfo['length'];
@@ -143,6 +146,9 @@ 
         }
     }
 
+    /**
+     * @param resource $file
+     */
     private function calculateMD5($file, $length)
     {
         // XXX: this could be really a bad idea with big files...
@@ -180,6 +186,9 @@ 
         return $metadata;
     }
 
+    /**
+     * @param string $bytes
+     */
     private function insertChunksFromBytes($bytes, $fileInfo)
     {
         $length = $fileInfo['length'];
@@ -195,6 +204,10 @@ 
         }
     }
 
+    /**
+     * @param string $data
+     * @param integer $chunkNumber
+     */
     private function insertChunk($id, $data, $chunkNumber)
     {
         $chunk = [

lib/Mongo/MongoGridFSFile.php

Doc Comments +3 added lines

@@ -126,6 +126,9 @@
         );
     }
 
+    /**
+     * @param resource $handle
+     */
     private function writeFromRessource($handle)
     {
 

Unused Use Statements -2 removed lines

@@ -13,8 +13,6 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-use Alcaeus\MongoDbAdapter\TypeConverter;
-
 class MongoGridFSFile {
     /**
      * @link http://php.net/manual/en/class.mongogridfsfile.php#mongogridfsfile.props.file