alcaeus / mongo-php-adapter

lib/Mongo/MongoCollection.php

Doc Comments +4 added lines, -1 removed lines

@@ -1018,6 +1018,9 @@ 
         return null;
     }
 
+    /**
+     * @param string $name
+     */
     private function checkCollectionName($name)
     {
         if (empty($name)) {
@@ -1028,7 +1031,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function __sleep()
     {

Spacing +37 added lines, -37 removed lines

@@ -142,8 +142,8 @@ 
           'criteria' => 0,
           'options' => 1,
           'operation' => 'aggregate'
-        ], function () use ($pipeline, $op) {
-            if (! TypeConverter::isNumericArray($pipeline)) {
+        ], function() use ($pipeline, $op) {
+            if ( ! TypeConverter::isNumericArray($pipeline)) {
                 $operators = func_get_args();
                 $pipeline = [];
                 $options = [];
@@ -151,7 +151,7 @@ 
                 $i = 0;
                 foreach ($operators as $operator) {
                     $i++;
-                    if (! is_array($operator)) {
+                    if ( ! is_array($operator)) {
                         trigger_error("Argument $i is not an array", E_USER_WARNING);
                         return;
                     }
@@ -205,7 +205,7 @@ 
         ];
 
         // Convert cursor option
-        if (! isset($options['cursor'])) {
+        if ( ! isset($options['cursor'])) {
             $options['cursor'] = new \stdClass();
         }
 
@@ -291,7 +291,7 @@ 
      */
     public function insert(&$a, array $options = [])
     {
-        if (! $this->ensureDocumentHasMongoId($a)) {
+        if ( ! $this->ensureDocumentHasMongoId($a)) {
             trigger_error(sprintf('%s(): expects parameter %d to be an array or object, %s given', __METHOD__, 1, gettype($a)), E_USER_WARNING);
             return;
         }
@@ -307,7 +307,7 @@ 
             throw ExceptionConverter::toLegacy($e);
         }
 
-        if (! $result->isAcknowledged()) {
+        if ( ! $result->isAcknowledged()) {
             return true;
         }
 
@@ -338,7 +338,7 @@ 
 
         foreach ($a as $key => $item) {
             try {
-                if (! $this->ensureDocumentHasMongoId($a[$key])) {
+                if ( ! $this->ensureDocumentHasMongoId($a[$key])) {
                     if ($continueOnError) {
                         unset($a[$key]);
                     } else {
@@ -347,7 +347,7 @@ 
                     }
                 }
             } catch (MongoException $e) {
-                if (! $continueOnError) {
+                if ( ! $continueOnError) {
                     throw $e;
                 }
             }
@@ -362,7 +362,7 @@ 
             throw ExceptionConverter::toLegacy($e, 'MongoResultException');
         }
 
-        if (! $result->isAcknowledged()) {
+        if ( ! $result->isAcknowledged()) {
             return true;
         }
 
@@ -393,7 +393,7 @@ 
           'criteria' => 0,
           'options' => 2,
           'operation' => 'update'
-      ], function () use ($criteria, $newobj, $options) {
+      ], function() use ($criteria, $newobj, $options) {
           $this->mustBeArrayOrObject($criteria);
           $this->mustBeArrayOrObject($newobj);
 
@@ -421,7 +421,7 @@ 
               throw ExceptionConverter::toLegacy($e);
           }
 
-          if (! $result->isAcknowledged()) {
+          if ( ! $result->isAcknowledged()) {
               return true;
           }
 
@@ -453,8 +453,8 @@ 
              'criteria' => 0,
              'options' => 1,
              'operation' => 'remove'
-         ], function () use ($criteria, $options) {
-             $multiple = isset($options['justOne']) ? !$options['justOne'] : true;
+         ], function() use ($criteria, $options) {
+             $multiple = isset($options['justOne']) ? ! $options['justOne'] : true;
              $method = $multiple ? 'deleteMany' : 'deleteOne';
 
              try {
@@ -467,7 +467,7 @@ 
                  throw ExceptionConverter::toLegacy($e);
              }
 
-             if (! $result->isAcknowledged()) {
+             if ( ! $result->isAcknowledged()) {
                  return true;
              }
 
@@ -510,7 +510,7 @@ 
           'criteria' => 1,
           'options' => 0,
           'operation' => 'distinct'
-        ], function () use ($key, $query) {
+        ], function() use ($key, $query) {
             try {
                 return array_map([TypeConverter::class, 'toLegacy'], $this->collection->distinct($key, TypeConverter::fromLegacy($query)));
             } catch (\MongoDB\Driver\Exception\Exception $e) {
@@ -535,7 +535,7 @@ 
           'criteria' => 0,
           'options' => 3,
           'operation' => 'findAndModify'
-      ], function () use ($query, $update, $fields, $options) {
+      ], function() use ($query, $update, $fields, $options) {
           $query = TypeConverter::fromLegacy($query);
           try {
               if (isset($options['remove'])) {
@@ -557,7 +557,7 @@ 
 
                   $options['projection'] = TypeConverter::convertProjection($fields);
 
-                  if (! \MongoDB\is_first_key_operator($update)) {
+                  if ( ! \MongoDB\is_first_key_operator($update)) {
                       $document = $this->collection->findOneAndReplace($query, $update, $options);
                   } else {
                       $document = $this->collection->findOneAndUpdate($query, $update, $options);
@@ -592,9 +592,9 @@ 
           'criteria' => 0,
           'options' => 2,
           'operation' => 'findOne'
-      ], function () use ($query, $fields, $options) {
+      ], function() use ($query, $fields, $options) {
           // Can't typehint for array since MongoGridFS extends and accepts strings
-        if (! is_array($query)) {
+        if ( ! is_array($query)) {
             trigger_error(sprintf('MongoCollection::findOne(): expects parameter 1 to be an array or object, %s given', gettype($query)), E_USER_WARNING);
             return;
         }
@@ -635,11 +635,11 @@ 
             $keys = (array) $keys;
         }
 
-        if (! is_array($keys) || ! count($keys)) {
+        if ( ! is_array($keys) || ! count($keys)) {
             throw new MongoException('index specification has no elements');
         }
 
-        if (! isset($options['name'])) {
+        if ( ! isset($options['name'])) {
             $options['name'] = \MongoDB\generate_index_name($keys);
         }
 
@@ -674,14 +674,14 @@ 
         }
 
         $result = [
-            'createdCollectionAutomatically' => !$collectionExists,
+            'createdCollectionAutomatically' => ! $collectionExists,
             'numIndexesBefore' => $indexCount,
             'numIndexesAfter' => $indexCount,
             'note' => 'all indexes already exist',
             'ok' => 1.0,
         ];
 
-        if (! $indexExists) {
+        if ( ! $indexExists) {
             $result['numIndexesAfter']++;
             unset($result['note']);
         }
@@ -714,7 +714,7 @@ 
     {
         if (is_string($keys)) {
             $indexName = $keys;
-            if (! preg_match('#_-?1$#', $indexName)) {
+            if ( ! preg_match('#_-?1$#', $indexName)) {
                 $indexName .= '_1';
             }
         } elseif (is_array($keys)) {
@@ -753,7 +753,7 @@ 
      */
     public function getIndexInfo()
     {
-        $convertIndex = function (\MongoDB\Model\IndexInfo $indexInfo) {
+        $convertIndex = function(\MongoDB\Model\IndexInfo $indexInfo) {
             $infos = [
                 'v' => $indexInfo->getVersion(),
                 'key' => $indexInfo->getKey(),
@@ -777,7 +777,7 @@ 
             ];
 
             foreach ($additionalKeys as $key) {
-                if (! isset($indexInfo[$key])) {
+                if ( ! isset($indexInfo[$key])) {
                     continue;
                 }
 
@@ -804,10 +804,10 @@ 
           'criteria' => 0,
           'options' => 1,
           'operation' => 'count'
-        ], function () use ($query, $options) {
+        ], function() use ($query, $options) {
             try {
                 // Handle legacy mode - limit and skip as second and third parameters, respectively
-            if (! is_array($options)) {
+            if ( ! is_array($options)) {
                 $limit = $options;
                 $options = [];
 
@@ -855,7 +855,7 @@ 
                 $this->convertWriteConcernOptions($options)
             );
 
-            if (! $result->isAcknowledged()) {
+            if ( ! $result->isAcknowledged()) {
                 return true;
             }
 
@@ -889,13 +889,13 @@ 
         if ($document_or_id instanceof \MongoId) {
             $id = $document_or_id;
         } elseif (is_object($document_or_id)) {
-            if (! isset($document_or_id->_id)) {
+            if ( ! isset($document_or_id->_id)) {
                 return null;
             }
 
             $id = $document_or_id->_id;
         } elseif (is_array($document_or_id)) {
-            if (! isset($document_or_id['_id'])) {
+            if ( ! isset($document_or_id['_id'])) {
                 return null;
             }
 
@@ -1008,11 +1008,11 @@ 
             $options['w'] = ($options['safe']) ? 1 : 0;
         }
 
-        if (isset($options['wtimeout']) && !isset($options['wTimeoutMS'])) {
+        if (isset($options['wtimeout']) && ! isset($options['wTimeoutMS'])) {
             $options['wTimeoutMS'] = $options['wtimeout'];
         }
 
-        if (isset($options['w']) || !isset($options['wTimeoutMS'])) {
+        if (isset($options['w']) || ! isset($options['wTimeoutMS'])) {
             $collectionWriteConcern = $this->getWriteConcern();
             $writeConcern = $this->createWriteConcernFromParameters(
                 isset($options['w']) ? $options['w'] : $collectionWriteConcern['w'],
@@ -1050,7 +1050,7 @@ 
     private function ensureDocumentHasMongoId(&$document)
     {
         if (is_array($document)) {
-            if (! isset($document['_id'])) {
+            if ( ! isset($document['_id'])) {
                 $document['_id'] = new \MongoId();
             }
 
@@ -1060,12 +1060,12 @@ 
         } elseif (is_object($document)) {
             $reflectionObject = new \ReflectionObject($document);
             foreach ($reflectionObject->getProperties() as $property) {
-                if (! $property->isPublic()) {
+                if ( ! $property->isPublic()) {
                     throw new \MongoException('zero-length keys are not allowed, did you use $ with double quotes?');
                 }
             }
 
-            if (! isset($document->_id)) {
+            if ( ! isset($document->_id)) {
                 $document->_id = new \MongoId();
             }
 
@@ -1096,7 +1096,7 @@ 
 
     private function mustBeArrayOrObject($a)
     {
-        if (!is_array($a) && !is_object($a)) {
+        if ( ! is_array($a) && ! is_object($a)) {
             throw new \MongoException('document must be an array or object');
         }
     }

Upper-Lower-Casing +1 added lines, -1 removed lines

@@ -152,7 +152,7 @@
                 foreach ($operators as $operator) {
                     $i++;
                     if (! is_array($operator)) {
-                        trigger_error("Argument $i is not an array", E_USER_WARNING);
+                        trigger_error("argument $i is not an array", E_USER_WARNING);
                         return;
                     }
 

lib/Mongo/MongoCursor.php

Unused Use Statements -1 removed lines

@@ -21,7 +21,6 @@
 use Alcaeus\MongoDbAdapter\TypeConverter;
 use Alcaeus\MongoDbAdapter\ExceptionConverter;
 use MongoDB\Driver\Cursor;
-use MongoDB\Driver\ReadPreference;
 use MongoDB\Operation\Find;
 
 /**

Doc Comments +2 added lines, -2 removed lines

@@ -490,7 +490,7 @@ 
     }
 
     /**
-     * @return Cursor
+     * @return Traversable
      */
     protected function ensureCursor()
     {
@@ -534,7 +534,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function __sleep()
     {

Spacing +5 added lines, -5 removed lines

@@ -143,7 +143,7 @@ 
         'options' => array_merge(['foundOnly'=> $foundOnly], $this->options),
         'operation' => 'count',
         'name' => $this->collection->getCollectionName()
-      ], function () use ($foundOnly) {
+      ], function() use ($foundOnly) {
           $optionNames = ['hint', 'maxTimeMS'];
           if ($foundOnly) {
               $optionNames = array_merge($optionNames, ['limit', 'skip']);
@@ -173,7 +173,7 @@ 
             'options' => $this->options,
             'operation' => 'count',
             'name' => $this->collection->getCollectionName()
-        ], function () {
+        ], function() {
             // MongoDB\Driver\Cursor needs to be wrapped into a \Generator so that a valid \Iterator with working implementations of
             // next, current, valid, key and rewind is returned. These methods don't work if we wrap the Cursor inside an \IteratorIterator
             if ($this->iterator === null) {
@@ -271,7 +271,7 @@ 
      */
     public function hasNext()
     {
-        if (! $this->startedIterating) {
+        if ( ! $this->startedIterating) {
             $this->ensureIterator();
             $this->startedIterating = true;
             $this->storeIteratorState();
@@ -456,7 +456,7 @@ 
      */
     protected function convertCursorType()
     {
-        if (! $this->tailable) {
+        if ( ! $this->tailable) {
             return null;
         }
 
@@ -510,7 +510,7 @@ 
     protected function wrapTraversable(\Traversable $traversable)
     {
         foreach ($traversable as $key => $value) {
-            if (isset($value->_id) && ($value->_id instanceof \MongoDB\BSON\ObjectID || !is_object($value->_id))) {
+            if (isset($value->_id) && ($value->_id instanceof \MongoDB\BSON\ObjectID || ! is_object($value->_id))) {
                 $key = (string) $value->_id;
             }
             yield $key => $value;

lib/Mongo/MongoGridFSFile.php

Doc Comments +3 added lines

@@ -121,6 +121,9 @@
         return $handle;
     }
 
+    /**
+     * @param resource $handle
+     */
     private function copyToResource($handle)
     {
         $written = 0;

Spacing +1 added lines, -1 removed lines

@@ -78,7 +78,7 @@
             $filename = 'file';
         }
 
-        if (! $handle = fopen($filename, 'w')) {
+        if ( ! $handle = fopen($filename, 'w')) {
             trigger_error('Can not open the destination file', E_USER_ERROR);
             return 0;
         }

lib/Alcaeus/MongoDbAdapter/Helper/WriteConcernConverter.php

Spacing +1 added lines, -1 removed lines

@@ -29,7 +29,7 @@
             $wstring = (int) $wstring;
         }
 
-        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_USER_WARNING);
             return false;
         }

lib/Mongo/Mongo.php

Doc Comments +9 added lines, -9 removed lines

@@ -52,7 +52,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.
      */
@@ -65,7 +65,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()
     {
@@ -77,7 +77,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.
      */
@@ -103,7 +103,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)
     {
@@ -115,7 +115,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)
@@ -130,7 +130,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 = "")
@@ -145,7 +145,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 = "")
@@ -158,7 +158,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()
     {
@@ -217,7 +217,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/Alcaeus/MongoDbAdapter/Helper/ReadPreference.php

Spacing +1 added lines, -1 removed lines

@@ -110,7 +110,7 @@
                 return false;
         }
 
-        if ($readPreference == \MongoClient::RP_PRIMARY && !empty($tags)) {
+        if ($readPreference == \MongoClient::RP_PRIMARY && ! empty($tags)) {
             trigger_error("You can't use read preference tags with a read preference of PRIMARY", E_USER_WARNING);
             return false;
         }

lib/Alcaeus/MongoDbAdapter/TypeConverter.php

Spacing +4 added lines, -4 removed lines

@@ -103,16 +103,16 @@
      */
     public static function convertProjection($fields)
     {
-        if (! is_array($fields) || $fields === []) {
+        if ( ! is_array($fields) || $fields === []) {
             return null;
         }
 
-        if (! TypeConverter::isNumericArray($fields)) {
+        if ( ! TypeConverter::isNumericArray($fields)) {
             $projection = TypeConverter::fromLegacy($fields);
         } else {
             $projection = array_fill_keys(
-                array_map(function ($field) {
-                    if (!is_string($field)) {
+                array_map(function($field) {
+                    if ( ! is_string($field)) {
                         throw new \MongoException('field names must be strings', 8);
                     }
 

lib/Mongo/MongoClient.php

Doc Comments +3 added lines, -3 removed lines

@@ -238,7 +238,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)
     {
@@ -350,7 +350,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function __sleep()
     {
@@ -360,7 +360,7 @@ 
     }
 
     /**
-     * @param $server
+     * @param string $server
      * @return array
      */
     private function extractUrlOptions($server)

lib/Mongo/MongoWriteBatch.php

Spacing +6 added lines, -6 removed lines

@@ -102,7 +102,7 @@ 
     final public function execute(array $writeOptions = [])
     {
         $writeOptions += $this->writeOptions;
-        if (! count($this->items)) {
+        if ( ! count($this->items)) {
             return ['ok' => true];
         }
 
@@ -167,7 +167,7 @@ 
                 break;
         }
 
-        if (! $ok) {
+        if ( ! $ok) {
             // Exception code is hardcoded to the value in ext-mongo, see
             // https://github.com/mongodb/mongo-php-driver-legacy/blob/ab4bc0d90e93b3f247f6bcb386d0abc8d2fa7d74/batch/write.c#L428
             throw new \MongoWriteConcernException('Failed write', 911, null, $resultDocument);
@@ -180,19 +180,19 @@ 
     {
         switch ($this->batchType) {
             case self::COMMAND_UPDATE:
-                if (! isset($item['q'])) {
+                if ( ! isset($item['q'])) {
                     throw new Exception("Expected \$item to contain 'q' key");
                 }
-                if (! isset($item['u'])) {
+                if ( ! isset($item['u'])) {
                     throw new Exception("Expected \$item to contain 'u' key");
                 }
                 break;
 
             case self::COMMAND_DELETE:
-                if (! isset($item['q'])) {
+                if ( ! isset($item['q'])) {
                     throw new Exception("Expected \$item to contain 'q' key");
                 }
-                if (! isset($item['limit'])) {
+                if ( ! isset($item['limit'])) {
                     throw new Exception("Expected \$item to contain 'limit' key");
                 }
                 break;