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 +34 added lines, -34 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,12 +277,12 @@ 
      */
     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;
         }
 
-        if (! count((array)$a)) {
+        if ( ! count((array) $a)) {
             throw new \MongoException('document must be an array or object');
         }
 
@@ -295,7 +295,7 @@ 
             throw ExceptionConverter::toLegacy($e);
         }
 
-        if (! $result->isAcknowledged()) {
+        if ( ! $result->isAcknowledged()) {
             return true;
         }
 
@@ -326,7 +326,7 @@ 
 
         foreach ($a as $key => $item) {
             try {
-                if (! $this->ensureDocumentHasMongoId($a[$key])) {
+                if ( ! $this->ensureDocumentHasMongoId($a[$key])) {
                     if ($continueOnError) {
                         unset($a[$key]);
                     } else {
@@ -335,7 +335,7 @@ 
                     }
                 }
             } catch (MongoException $e) {
-                if (! $continueOnError) {
+                if ( ! $continueOnError) {
                     throw $e;
                 }
             }
@@ -350,7 +350,7 @@ 
             throw ExceptionConverter::toLegacy($e, 'MongoResultException');
         }
 
-        if (! $result->isAcknowledged()) {
+        if ( ! $result->isAcknowledged()) {
             return true;
         }
 
@@ -398,7 +398,7 @@ 
             throw ExceptionConverter::toLegacy($e);
         }
 
-        if (! $result->isAcknowledged()) {
+        if ( ! $result->isAcknowledged()) {
             return true;
         }
 
@@ -425,7 +425,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 {
@@ -438,7 +438,7 @@ 
             throw ExceptionConverter::toLegacy($e);
         }
 
-        if (! $result->isAcknowledged()) {
+        if ( ! $result->isAcknowledged()) {
             return true;
         }
 
@@ -516,7 +516,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);
@@ -547,7 +547,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;
         }
@@ -587,11 +587,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);
         }
 
@@ -626,14 +626,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']);
         }
@@ -666,7 +666,7 @@ 
     {
         if (is_string($keys)) {
             $indexName = $keys;
-            if (! preg_match('#_-?1$#', $indexName)) {
+            if ( ! preg_match('#_-?1$#', $indexName)) {
                 $indexName .= '_1';
             }
         } elseif (is_array($keys)) {
@@ -705,7 +705,7 @@ 
      */
     public function getIndexInfo()
     {
-        $convertIndex = function (\MongoDB\Model\IndexInfo $indexInfo) {
+        $convertIndex = function(\MongoDB\Model\IndexInfo $indexInfo) {
             $infos = [
                 'v' => $indexInfo->getVersion(),
                 'key' => $indexInfo->getKey(),
@@ -729,7 +729,7 @@ 
             ];
 
             foreach ($additionalKeys as $key) {
-                if (! isset($indexInfo[$key])) {
+                if ( ! isset($indexInfo[$key])) {
                     continue;
                 }
 
@@ -754,7 +754,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 = [];
 
@@ -801,7 +801,7 @@ 
                 $this->convertWriteConcernOptions($options)
             );
 
-            if (! $result->isAcknowledged()) {
+            if ( ! $result->isAcknowledged()) {
                 return true;
             }
 
@@ -835,13 +835,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;
             }
 
@@ -884,14 +884,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;
         }
@@ -900,7 +900,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'];
         }
@@ -954,11 +954,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'],
@@ -982,7 +982,7 @@ 
      */
     private function ensureDocumentHasMongoId(&$document)
     {
-        $checkKeys = function ($array) {
+        $checkKeys = function($array) {
             foreach (array_keys($array) as $key) {
                 if (empty($key) && $key !== 0) {
                     throw new \MongoException('zero-length keys are not allowed, did you use $ with double quotes?');
@@ -991,7 +991,7 @@ 
         };
 
         if (is_array($document)) {
-            if (! isset($document['_id'])) {
+            if ( ! isset($document['_id'])) {
                 $document['_id'] = new \MongoId();
             }
 
@@ -1001,12 +1001,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();
             }
 

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

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

Spacing +5 added lines, -5 removed lines

@@ -142,7 +142,7 @@ 
             throw ExceptionConverter::toLegacy($e);
         }
 
-        $getCollectionInfo = function (CollectionInfo $collectionInfo) {
+        $getCollectionInfo = function(CollectionInfo $collectionInfo) {
             return [
                 'name' => $collectionInfo->getName(),
                 'options' => $collectionInfo->getOptions(),
@@ -179,7 +179,7 @@ 
             throw ExceptionConverter::toLegacy($e);
         }
 
-        $getCollectionName = function (CollectionInfo $collectionInfo) {
+        $getCollectionName = function(CollectionInfo $collectionInfo) {
             return $collectionInfo->getName();
         };
 
@@ -348,13 +348,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)) {
                 $id = $document_or_id;
             } else {
                 $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;
             }
 
@@ -542,7 +542,7 @@ 
      */
     private function getSystemCollectionFilterClosure($includeSystemCollections = false)
     {
-        return function (CollectionInfo $collectionInfo) use ($includeSystemCollections) {
+        return function(CollectionInfo $collectionInfo) use ($includeSystemCollections) {
             return $includeSystemCollections || ! preg_match('#^system\.#', $collectionInfo->getName());
         };
     }