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

Spacing +1 added lines, -1 removed lines

@@ -92,7 +92,7 @@
      * </p>
      * @return bool returns the former value of slaveOkay for this instance.
      */
-    public function setSlaveOkay ($ok) {}
+    public function setSlaveOkay($ok) {}
     /**
      * @deprecated Relying on this feature is highly discouraged. Please use MongoPool::setSize() instead.
      *(PECL mongo &gt;= 1.2.0)<br/>

lib/Mongo/MongoClient.php

Doc Comments +1 added lines, -1 removed lines

@@ -207,7 +207,7 @@
      * Lists all of the databases available
      *
      * @link http://php.net/manual/en/mongoclient.listdbs.php
-     * @return array Returns an associative array containing three fields. The first field is databases, which in turn contains an array. Each element of the array is an associative array corresponding to a database, giving the database's name, size, and if it's empty. The other two fields are totalSize (in bytes) and ok, which is 1 if this method ran successfully.
+     * @return MongoDB\Model\DatabaseInfoLegacyIterator Returns an associative array containing three fields. The first field is databases, which in turn contains an array. Each element of the array is an associative array corresponding to a database, giving the database's name, size, and if it's empty. The other two fields are totalSize (in bytes) and ok, which is 1 if this method ran successfully.
      */
     public function listDBs()
     {

Spacing +8 added lines, -8 removed lines

@@ -23,13 +23,13 @@ 
 class MongoClient
 {
     const VERSION = '1.6.12';
-    const DEFAULT_HOST = "localhost" ;
-    const DEFAULT_PORT = 27017 ;
-    const RP_PRIMARY = "primary" ;
-    const RP_PRIMARY_PREFERRED = "primaryPreferred" ;
-    const RP_SECONDARY = "secondary" ;
-    const RP_SECONDARY_PREFERRED = "secondaryPreferred" ;
-    const RP_NEAREST = "nearest" ;
+    const DEFAULT_HOST = "localhost";
+    const DEFAULT_PORT = 27017;
+    const RP_PRIMARY = "primary";
+    const RP_PRIMARY_PREFERRED = "primaryPreferred";
+    const RP_SECONDARY = "secondary";
+    const RP_SECONDARY_PREFERRED = "secondaryPreferred";
+    const RP_NEAREST = "nearest";
 
     /**
      * @var bool
@@ -198,7 +198,7 @@ 
      * {@link http://www.php.net/manual/en/class.mongoint64.php MongoInt64} class. The latter is necessary on 32
      * bit platforms (and Windows).
      */
-    public function killCursor($server_hash , $id)
+    public function killCursor($server_hash, $id)
     {
 
     }

lib/Mongo/MongoCollection.php

Doc Comments +6 added lines, -6 removed lines

@@ -163,7 +163,7 @@ 
      * information on distributing reads to secondaries.
      * </p>
      * @link http://www.php.net/manual/en/mongocollection.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()
     {
@@ -181,7 +181,7 @@ 
      * If reads should be sent to secondary members of a replica set for all
      * possible queries using this {@link http://www.php.net/manual/en/class.mongocollection.php MongoCollection}
      * instance.
-     * @return bool Returns the former value of slaveOkay for this instance.
+     * @return boolean|null Returns the former value of slaveOkay for this instance.
      * </p>
      */
     public function setSlaveOkay($ok = true)
@@ -204,7 +204,7 @@ 
      * (PECL mongo &gt;= 1.3.0)<br/>
      * @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 bool 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)
     {
@@ -252,7 +252,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.
      * Otherwise, returns TRUE if the inserted array is not empty (a MongoException will be thrown if the inserted array is empty).
      * If an array is returned, the following keys may be present:
      * <dl>
@@ -289,7 +289,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())
     {
@@ -437,7 +437,7 @@ 
      * @link http://www.php.net/manual/en/mongocollection.ensureindex.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 boolean always true
+     * @return boolean|null always true
      */
     public function ensureIndex(array $keys, array $options = array()) {}
 

Spacing +3 added lines, -3 removed lines

@@ -325,7 +325,7 @@ 
      * @throws MongoCursorException
      * @return boolean
      */
-    public function update(array $criteria , array $newobj, array $options = array())
+    public function update(array $criteria, array $newobj, array $options = array())
     {
         $multiple = ($options['multiple']) ? $options['multiple'] : false;
 //        $multiple = $options['multiple'] ?? false;
@@ -400,7 +400,7 @@ 
      * @param array $query An optional query parameters
      * @return array|bool Returns an array of distinct values, or <b>FALSE</b> on failure
      */
-    public function distinct ($key, array $query = NULL) {}
+    public function distinct($key, array $query = NULL) {}
 
     /**
      * Update a document and return it
@@ -411,7 +411,7 @@ 
      * @param array $options An array of options to apply, such as remove the match document from the DB and return it.
      * @return array Returns the original document, or the modified document when new is set.
      */
-    public function findAndModify (array $query, array $update = NULL, array $fields = NULL, array $options = NULL) {}
+    public function findAndModify(array $query, array $update = NULL, array $fields = NULL, array $options = NULL) {}
 
     /**
      * Querys this collection, returning a single element

lib/Mongo/MongoCommandCursor.php

Doc Comments +1 added lines, -1 removed lines

@@ -41,7 +41,7 @@
     /**
      * Checks if current position is valid
      * @link http://php.net/manual/en/iterator.valid.php
-     * @return boolean The return value will be casted to boolean and then evaluated.
+     * @return boolean|null The return value will be casted to boolean and then evaluated.
      * Returns true on success or false on failure.
      * @since 5.0.0
      */

Spacing +5 added lines, -5 removed lines

@@ -20,7 +20,7 @@ 
      * @return mixed Can return any type.
      * @since 5.0.0
      */
-    public function current(){}
+    public function current() {}
 
     /**
      * Move forward to next element
@@ -28,7 +28,7 @@ 
      * @return void Any returned value is ignored.
      * @since 5.0.0
      */
-    public function next(){}
+    public function next() {}
 
     /**
      * Return the key of the current element
@@ -36,7 +36,7 @@ 
      * @return mixed scalar on success, or null on failure.
      * @since 5.0.0
      */
-    public function key(){}
+    public function key() {}
 
     /**
      * Checks if current position is valid
@@ -45,7 +45,7 @@ 
      * Returns true on success or false on failure.
      * @since 5.0.0
      */
-    public function valid(){}
+    public function valid() {}
 
     /**
      * Rewind the Iterator to the first element
@@ -53,7 +53,7 @@ 
      * @return void Any returned value is ignored.
      * @since 5.0.0
      */
-    public function rewind(){}
+    public function rewind() {}
 
     function batchSize(int $batchSize):MongoCursorInterface{}
 

lib/Mongo/MongoCursor.php

Doc Comments +3 added lines, -3 removed lines

@@ -59,7 +59,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() {}
 
@@ -168,7 +168,7 @@ 
     /**
      * Checks if there are documents that have not been sent yet from the database for this cursor
      * @link http://www.php.net/manual/en/mongocursor.dead.php
-     * @return boolean Returns if there are more results that have not been sent to the client, yet.
+     * @return boolean|null Returns if there are more results that have not been sent to the client, yet.
      */
     public function dead() {}
 
@@ -251,7 +251,7 @@ 
     /**
      * Checks if the cursor is reading a valid result.
      * @link http://www.php.net/manual/en/mongocursor.valid.php
-     * @return boolean If the current result is not null.
+     * @return boolean|null If the current result is not null.
      */
     public function valid() {}
 

Spacing +8 added lines, -8 removed lines

@@ -53,7 +53,7 @@ 
      * @param bool $wait [optional] <p>If the cursor should wait for more data to become available.</p>
      * @return MongoCursor Returns this cursor.
      */
-    public function awaitData ($wait = true) {}
+    public function awaitData($wait = true) {}
     /**
      * Checks if there are any more elements in this cursor
      * @link http://www.php.net/manual/en/mongocursor.hasnext.php
@@ -78,7 +78,7 @@ 
      * @return array This function returns an array describing the read preference. The array contains the values <em>type</em> for the string
      * read preference mode (corresponding to the {@link http://www.php.net/manual/en/class.mongoclient.php MongoClient} constants), and <em>tagsets</em> containing a list of all tag set criteria. If no tag sets were specified, <em>tagsets</em> will not be present in the array.
      */
-    public function getReadPreference () { }
+    public function getReadPreference() { }
 
     /**
      * Limits the number of results returned
@@ -95,7 +95,7 @@ 
      * @param bool $okay [optional] <p>If receiving partial results is okay.</p>
      * @return MongoCursor Returns this cursor.
      */
-    public function partial ($okay = true) {}
+    public function partial($okay = true) {}
 
     /**
      * (PECL mongo &gt;= 1.2.1)<br/>
@@ -109,7 +109,7 @@ 
      * @param bool $set [optional] <p>Whether the flag should be set (<b>TRUE</b>) or unset (<b>FALSE</b>).</p>
      * @return MongoCursor
      */
-    public function setFlag ($flag, $set = true ) {}
+    public function setFlag($flag, $set = true) {}
 
     /**
      * (PECL mongo &gt;= 1.3.3)<br/>
@@ -118,7 +118,7 @@ 
      * @param array $tags [optional] <p>The read preference mode: MongoClient::RP_PRIMARY, MongoClient::RP_PRIMARY_PREFERRED, MongoClient::RP_SECONDARY, MongoClient::RP_SECONDARY_PREFERRED, or MongoClient::RP_NEAREST.</p>
      * @return MongoCursor Returns this cursor.
      */
-    public function setReadPreference ($read_preference, array $tags) {}
+    public function setReadPreference($read_preference, array $tags) {}
 
     /**
      * Skips a number of results
@@ -284,14 +284,14 @@ 
      * @throws MongoCursorException
      * @return MongoCursor
      */
-    public function fields(array $f){}
+    public function fields(array $f) {}
 
     /**
      * Gets the query, fields, limit, and skip for this cursor
      * @link http://www.php.net/manual/en/mongocursor.info.php
      * @return array The query, fields, limit, and skip for this cursor as an associative array.
      */
-    public function info(){}
+    public function info() {}
 
     /**
      * PECL mongo >=1.0.11
@@ -321,6 +321,6 @@ 
      * @return MongoCursor Returns this cursor.
      * @link http://docs.php.net/manual/en/mongocursor.batchsize.php
      */
-    public function batchSize($batchSize){}
+    public function batchSize($batchSize) {}
 }
 

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

Spacing +3 added lines, -3 removed lines

@@ -103,7 +103,7 @@ 
 
         $collections = $this->db->listCollections($options);
 
-        $getCollectionName = function (CollectionInfo $collectionInfo) {
+        $getCollectionName = function(CollectionInfo $collectionInfo) {
             return $collectionInfo->getName();
         };
 
@@ -204,7 +204,7 @@ 
      * </p>
      * @return bool Returns the former value of slaveOkay for this instance.
      */
-    public function setSlaveOkay ($ok = true)
+    public function setSlaveOkay($ok = true)
     {
         return false;
     }
@@ -296,7 +296,7 @@ 
             $id = isset($document_or_id->_id) ? $document_or_id->_id : null;
 //            $id = $document_or_id->_id ?? null;
         } elseif (is_array($document_or_id)) {
-            if (! isset($document_or_id['_id'])) {
+            if (!isset($document_or_id['_id'])) {
                 return null;
             }
 

lib/Mongo/MongoDBRef.php

Doc Comments +1 added lines, -1 removed lines

@@ -45,7 +45,7 @@
      * @link http://php.net/manual/en/mongodbref.isref.php
      * @static
      * @param mixed $ref Array or object to check
-     * @return boolean Returns true if $ref is a reference
+     * @return boolean|null Returns true if $ref is a reference
      */
     public static function isRef($ref) {}
 

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)