alcaeus / mongo-php-adapter

lib/Mongo/MongoGridFS.php

Doc Comments +1 added lines, -2 removed lines

@@ -105,7 +105,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 = [])
@@ -446,7 +445,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function __sleep()
     {

Spacing +12 added lines, -12 removed lines

@@ -131,7 +131,7 @@ 
      */
     public function findOne($query = [], array $fields = [], array $options = [])
     {
-        if (! is_array($query)) {
+        if ( ! is_array($query)) {
             $query = ['filename' => (string) $query];
         }
 
@@ -207,7 +207,7 @@ 
         try {
             $file = $this->insertFile($record, $options);
         } catch (MongoException $e) {
-            throw new MongoGridFSException('Could not store file: '. $e->getMessage(), $e->getCode(), $e);
+            throw new MongoGridFSException('Could not store file: ' . $e->getMessage(), $e->getCode(), $e);
         }
 
         try {
@@ -244,10 +244,10 @@ 
             ];
 
             $handle = fopen($filename, 'r');
-            if (! $handle) {
+            if ( ! $handle) {
                 throw new MongoGridFSException('could not open file: ' . $filename);
             }
-        } elseif (! is_resource($filename)) {
+        } elseif ( ! is_resource($filename)) {
             throw new \Exception('first argument must be a string or stream resource');
         } else {
             $handle = $filename;
@@ -270,10 +270,10 @@ 
 
         // Add length and MD5 if they were not present before
         $update = [];
-        if (! isset($record['length'])) {
+        if ( ! isset($record['length'])) {
             $update['length'] = $length;
         }
-        if (! isset($record['md5'])) {
+        if ( ! isset($record['md5'])) {
             try {
                 $update['md5'] = $md5;
             } catch (MongoException $e) {
@@ -284,7 +284,7 @@ 
         if (count($update)) {
             try {
                 $result = $this->update(['_id' => $file['_id']], ['$set' => $update]);
-                if (! $this->isOKResult($result)) {
+                if ( ! $this->isOKResult($result)) {
                     throw new MongoGridFSException('Could not store file');
                 }
             } catch (MongoException $e) {
@@ -307,10 +307,10 @@ 
      */
     public function storeUpload($name, array $metadata = [])
     {
-        if (! isset($_FILES[$name]) || $_FILES[$name]['error'] !== UPLOAD_ERR_OK) {
+        if ( ! isset($_FILES[$name]) || $_FILES[$name]['error'] !== UPLOAD_ERR_OK) {
             throw new MongoGridFSException("Could not find uploaded file $name");
         }
-        if (! isset($_FILES[$name]['tmp_name'])) {
+        if ( ! isset($_FILES[$name]['tmp_name'])) {
             throw new MongoGridFSException("Couldn't find tmp_name in the \$_FILES array. Are you sure the upload worked?");
         }
 
@@ -360,7 +360,7 @@ 
 
         $result = $this->chunks->insert($chunk);
 
-        if (! $this->isOKResult($result)) {
+        if ( ! $this->isOKResult($result)) {
             throw new \MongoException('error inserting chunk');
         }
 
@@ -405,7 +405,7 @@ 
         $hash = hash_init('md5');
 
         rewind($handle);
-        while (! feof($handle)) {
+        while ( ! feof($handle)) {
             $data = stream_get_contents($handle, $chunkSize);
             hash_update($hash, $data);
             $this->insertChunk($fileId, $data, $i++);
@@ -435,7 +435,7 @@ 
 
         $result = $this->insert($record, $options);
 
-        if (! $this->isOKResult($result)) {
+        if ( ! $this->isOKResult($result)) {
             throw new \MongoException('error inserting file');
         }
 

lib/Mongo/MongoCursor.php

Doc Comments +1 added lines, -1 removed lines

@@ -102,7 +102,7 @@
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function __sleep()
     {

Spacing +3 added lines, -3 removed lines

@@ -221,7 +221,7 @@ 
      */
     public function hasNext()
     {
-        if (! $this->startedIterating) {
+        if ( ! $this->startedIterating) {
             $this->ensureIterator();
             $this->startedIterating = true;
             $this->storeIteratorState();
@@ -405,7 +405,7 @@ 
      */
     protected function convertCursorType()
     {
-        if (! $this->tailable) {
+        if ( ! $this->tailable) {
             return null;
         }
 
@@ -446,7 +446,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;

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;
 
 /**

lib/Mongo/MongoWriteBatch.php

Spacing +7 added lines, -7 removed lines

@@ -83,7 +83,7 @@ 
     public function add($item)
     {
         if (is_object($item)) {
-            $item = (array)$item;
+            $item = (array) $item;
         }
 
         $this->validate($item);
@@ -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;

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

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

@@ -139,7 +139,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;
                 }
 

Spacing +33 added lines, -33 removed lines

@@ -130,7 +130,7 @@ 
      */
     public function aggregate(array $pipeline, array $op = [])
     {
-        if (! TypeConverter::isNumericArray($pipeline)) {
+        if ( ! TypeConverter::isNumericArray($pipeline)) {
             $operators = func_get_args();
             $pipeline = [];
             $options = [];
@@ -138,7 +138,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;
                 }
@@ -191,7 +191,7 @@ 
         ];
 
         // Convert cursor option
-        if (! isset($options['cursor'])) {
+        if ( ! isset($options['cursor'])) {
             $options['cursor'] = new \stdClass();
         }
 
@@ -277,7 +277,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;
         }
@@ -293,7 +293,7 @@ 
             throw ExceptionConverter::toLegacy($e);
         }
 
-        if (! $result->isAcknowledged()) {
+        if ( ! $result->isAcknowledged()) {
             return true;
         }
 
@@ -324,7 +324,7 @@ 
 
         foreach ($a as $key => $item) {
             try {
-                if (! $this->ensureDocumentHasMongoId($a[$key])) {
+                if ( ! $this->ensureDocumentHasMongoId($a[$key])) {
                     if ($continueOnError) {
                         unset($a[$key]);
                     } else {
@@ -333,7 +333,7 @@ 
                     }
                 }
             } catch (MongoException $e) {
-                if (! $continueOnError) {
+                if ( ! $continueOnError) {
                     throw $e;
                 }
             }
@@ -348,7 +348,7 @@ 
             throw ExceptionConverter::toLegacy($e, 'MongoResultException');
         }
 
-        if (! $result->isAcknowledged()) {
+        if ( ! $result->isAcknowledged()) {
             return true;
         }
 
@@ -402,7 +402,7 @@ 
             throw ExceptionConverter::toLegacy($e);
         }
 
-        if (! $result->isAcknowledged()) {
+        if ( ! $result->isAcknowledged()) {
             return true;
         }
 
@@ -429,7 +429,7 @@ 
      */
     public function remove(array $criteria = [], array $options = [])
     {
-        $multiple = isset($options['justOne']) ? !$options['justOne'] : true;
+        $multiple = isset($options['justOne']) ? ! $options['justOne'] : true;
         $method = $multiple ? 'deleteMany' : 'deleteOne';
 
         try {
@@ -442,7 +442,7 @@ 
             throw ExceptionConverter::toLegacy($e);
         }
 
-        if (! $result->isAcknowledged()) {
+        if ( ! $result->isAcknowledged()) {
             return true;
         }
 
@@ -520,7 +520,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);
@@ -551,7 +551,7 @@ 
     public function findOne($query = [], array $fields = [], array $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;
         }
@@ -591,11 +591,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);
         }
 
@@ -630,14 +630,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']);
         }
@@ -670,7 +670,7 @@ 
     {
         if (is_string($keys)) {
             $indexName = $keys;
-            if (! preg_match('#_-?1$#', $indexName)) {
+            if ( ! preg_match('#_-?1$#', $indexName)) {
                 $indexName .= '_1';
             }
         } elseif (is_array($keys)) {
@@ -709,7 +709,7 @@ 
      */
     public function getIndexInfo()
     {
-        $convertIndex = function (\MongoDB\Model\IndexInfo $indexInfo) {
+        $convertIndex = function(\MongoDB\Model\IndexInfo $indexInfo) {
             $infos = [
                 'v' => $indexInfo->getVersion(),
                 'key' => $indexInfo->getKey(),
@@ -733,7 +733,7 @@ 
             ];
 
             foreach ($additionalKeys as $key) {
-                if (! isset($indexInfo[$key])) {
+                if ( ! isset($indexInfo[$key])) {
                     continue;
                 }
 
@@ -758,7 +758,7 @@ 
     {
         try {
             // Handle legacy mode - limit and skip as second and third parameters, respectively
-            if (! is_array($options)) {
+            if ( ! is_array($options)) {
                 $limit = $options;
                 $options = [];
 
@@ -805,7 +805,7 @@ 
                 $this->convertWriteConcernOptions($options)
             );
 
-            if (! $result->isAcknowledged()) {
+            if ( ! $result->isAcknowledged()) {
                 return true;
             }
 
@@ -839,13 +839,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;
             }
 
@@ -888,14 +888,14 @@ 
         $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;
         }
@@ -904,7 +904,7 @@ 
         }
         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'];
         }
@@ -958,11 +958,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'],
@@ -1000,7 +1000,7 @@ 
     private function ensureDocumentHasMongoId(&$document)
     {
         if (is_array($document)) {
-            if (! isset($document['_id'])) {
+            if ( ! isset($document['_id'])) {
                 $document['_id'] = new \MongoId();
             }
 
@@ -1010,12 +1010,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();
             }
 
@@ -1046,7 +1046,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');
         }
     }

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

Doc Comments +3 added lines, -3 removed lines

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

Spacing +8 added lines, -8 removed lines

@@ -32,13 +32,13 @@ 
     use Helper\WriteConcern;
 
     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
@@ -90,7 +90,7 @@ 
 
         $this->server = $server;
         if (false === strpos($this->server, 'mongodb://')) {
-            $this->server = 'mongodb://'.$this->server;
+            $this->server = 'mongodb://' . $this->server;
         }
         $this->client = new Client($this->server, $options, $driverOptions);
         $info = $this->client->__debugInfo();

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;
         }