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

lib/Mongo/MongoGridFSFile.php

Doc Comments +3 added lines

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

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

Doc Comments +1 added lines, -1 removed lines

@@ -216,7 +216,7 @@
      * @link http://www.php.net/manual/en/mongoclient.killcursor.php
      * @param string $server_hash The server hash that has the cursor.
      * @param int|MongoInt64 $id The ID of the cursor to kill.
-     * @return bool
+     * @return boolean|null
      */
     public function killCursor($server_hash , $id)
     {

lib/Mongo/MongoCollection.php

Doc Comments +1 added lines, -1 removed lines

@@ -468,7 +468,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.
      *
      * @todo This method does not yet return the correct result
      */

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

Doc Comments +5 added lines, -6 removed lines

@@ -106,7 +106,6 @@ 
      * @link http://php.net/manual/en/mongogridfs.find.php
      * @param array $query The query
      * @param array $fields Fields to return
-     * @param array $options Options for the find command
      * @return MongoGridFSCursor A MongoGridFSCursor
      */
     public function find(array $query = [], array $fields = [])
@@ -155,7 +154,7 @@ 
      * @param string $filename The name of the file
      * @param array $extra Other metadata to add to the file saved
      * @param array $options An array of options for the insert operations executed against the chunks and files collections.
-     * @return mixed Returns the _id of the saved object
+     * @return MongoId Returns the _id of the saved object
      */
     public function put($filename, array $extra = [], array $options = [])
     {
@@ -190,7 +189,7 @@ 
      * @param string $bytes A string of bytes to store
      * @param array $extra Other metadata to add to the file saved
      * @param array $options Options for the store. "safe": Check that this store succeeded
-     * @return mixed The _id of the object saved
+     * @return MongoId The _id of the object saved
      */
     public function storeBytes($bytes, array $extra = [], array $options = [])
     {
@@ -214,7 +213,7 @@ 
      * @param string $filename The name of the file
      * @param array $extra Other metadata to add to the file saved
      * @param array $options Options for the store. "safe": Check that this store succeeded
-     * @return mixed Returns the _id of the saved object
+     * @return MongoId Returns the _id of the saved object
      * @throws MongoGridFSException
      * @throws Exception
      */
@@ -265,7 +264,7 @@ 
      * @link http://www.php.net/manual/en/mongogridfs.storeupload.php
      * @param string $name The name attribute of the uploaded file, from <input type="file" name="something"/>.
      * @param array $metadata An array of extra fields for the uploaded file.
-     * @return mixed Returns the _id of the uploaded file.
+     * @return null|MongoId Returns the _id of the uploaded file.
      * @throws MongoGridFSException
      */
     public function storeUpload($name, array $metadata = [])
@@ -388,7 +387,7 @@ 
     /**
      * Returns the MD5 string for a file previously stored to the database
      *
-     * @param $id
+     * @param MongoId $id
      * @return string
      */
     private function getMd5ForFile($id)