alcaeus / mongo-php-adapter

lib/Mongo/MongoCursor.php

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/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/Alcaeus/MongoDbAdapter/Helper/WriteConcern.php

Spacing +1 added lines, -1 removed lines

@@ -55,7 +55,7 @@
      */
     protected function setWriteConcernFromParameters($wstring, $wtimeout = 0)
     {
-        if (! is_string($wstring) && ! is_int($wstring)) {
+        if (!is_string($wstring) && !is_int($wstring)) {
             trigger_error("w for WriteConcern must be a string or integer", E_WARNING);
             return false;
         }

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

Spacing +13 added lines, -13 removed lines

@@ -121,14 +121,14 @@ 
      */
     public function aggregate(array $pipeline, array $op = [])
     {
-        if (! TypeConverter::isNumericArray($pipeline)) {
+        if (!TypeConverter::isNumericArray($pipeline)) {
             $pipeline = [];
             $options = [];
 
             $i = 0;
             foreach (func_get_args() as $operator) {
                 $i++;
-                if (! is_array($operator)) {
+                if (!is_array($operator)) {
                     trigger_error("Argument $i is not an array", E_WARNING);
                     return;
                 }
@@ -164,14 +164,14 @@ 
         ];
 
         // Convert cursor option
-        if (! isset($options['cursor']) || $options['cursor'] === true || $options['cursor'] === []) {
+        if (!isset($options['cursor']) || $options['cursor'] === true || $options['cursor'] === []) {
             // Cursor option needs to be an object convert bools and empty arrays since those won't be handled by TypeConverter
             $options['cursor'] = new \stdClass;
         }
 
         $command += $options;
 
-        $cursor = new MongoCommandCursor($this->db->getConnection(), (string)$this, $command);
+        $cursor = new MongoCommandCursor($this->db->getConnection(), (string) $this, $command);
         $cursor->setReadPreference($this->getReadPreference());
 
         return $cursor;
@@ -321,7 +321,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;
@@ -389,7 +389,7 @@ 
      */
     public function find(array $query = array(), array $fields = array())
     {
-        $cursor = new MongoCursor($this->db->getConnection(), (string)$this, $query, $fields);
+        $cursor = new MongoCursor($this->db->getConnection(), (string) $this, $query, $fields);
         $cursor->setReadPreference($this->getReadPreference());
 
         return $cursor;
@@ -565,9 +565,9 @@ 
     public function save($a, array $options = array())
     {
         if (is_object($a)) {
-            $a = (array)$a;
+            $a = (array) $a;
         }
-        if ( ! array_key_exists('_id', $a)) {
+        if (!array_key_exists('_id', $a)) {
             $id = new \MongoId();
         } else {
             $id = $a['_id'];
@@ -629,20 +629,20 @@ 
         if (is_string($reduce)) {
             $reduce = new MongoCode($reduce);
         }
-        if ( ! $reduce instanceof MongoCode) {
+        if (!$reduce instanceof MongoCode) {
             throw new \InvalidArgumentExcption('reduce parameter should be a string or MongoCode instance.');
         }
         $command = [
             'group' => [
                 'ns'      => $this->name,
-                '$reduce' => (string)$reduce,
+                '$reduce' => (string) $reduce,
                 'initial' => $initial,
                 'cond'    => $condition,
             ],
         ];
 
         if ($keys instanceof MongoCode) {
-            $command['group']['$keyf'] = (string)$keys;
+            $command['group']['$keyf'] = (string) $keys;
         } else {
             $command['group']['key'] = $keys;
         }
@@ -651,14 +651,14 @@ 
         }
         if (array_key_exists('finalize', $condition)) {
             if ($condition['finalize'] instanceof MongoCode) {
-                $condition['finalize'] = (string)$condition['finalize'];
+                $condition['finalize'] = (string) $condition['finalize'];
             }
             $command['group']['finalize'] = $condition['finalize'];
         }
 
         $result = $this->db->command($command, [], $hash);
         unset($result['waitedMS']);
-        $result['ok'] = (int)$result['ok'];
+        $result['ok'] = (int) $result['ok'];
         if (count($result['retval'])) {
             $result['retval'] = current($result['retval']);
         }