alcaeus / mongo-php-adapter

lib/Mongo/MongoDB.php

Doc Comments +1 added lines, -2 removed lines

@@ -292,7 +292,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 = [])
@@ -433,7 +432,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()
     {

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

Doc Comments +6 added lines, -6 removed lines

@@ -41,7 +41,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() {}
 
@@ -91,7 +91,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) {}
     /**
@@ -101,7 +101,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 = "") {}
 
@@ -112,7 +112,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 = "") {}
 
@@ -121,7 +121,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() {}
 
@@ -153,7 +153,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() {}
 }