alcaeus / mongo-php-adapter

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)

lib/Mongo/MongoClient.php

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

Doc Comments +1 added lines, -1 removed lines

@@ -216,7 +216,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)
     {

lib/Mongo/MongoResultException.php

Spacing +1 added lines, -1 removed lines

@@ -25,7 +25,7 @@
      * http://php.net/manual/en/mongoresultexception.getdocument.php
      * @return array <p>The full result document as an array, including partial data if available and additional keys.</p>
      */
-    public function getDocument () {}
+    public function getDocument() {}
 
     public $document;
 

Braces +5 added lines, -2 removed lines

@@ -18,13 +18,16 @@
  * @link http://php.net/manual/en/class.mongoresultexception.php#mongoresultexception.props.document
  *
  */
-class MongoResultException extends MongoException {
+class MongoResultException extends MongoException
+{
     /**
      * Retrieve the full result document
      * http://php.net/manual/en/mongoresultexception.getdocument.php
      * @return array <p>The full result document as an array, including partial data if available and additional keys.</p>
      */
-    public function getDocument () {}
+    public function getDocument ()
+    {
+}
 
     public $document;
 

lib/Mongo/MongoBinData.php

Unused Use Statements -1 removed lines

@@ -15,7 +15,6 @@
 
 use Alcaeus\MongoDbAdapter\TypeInterface;
 use MongoDB\BSON\Binary;
-use MongoDB\BSON\Type;
 
 class MongoBinData implements TypeInterface
 {

lib/Alcaeus/MongoDbAdapter/AbstractCursor.php

Doc Comments +1 added lines, -1 removed lines

@@ -72,7 +72,7 @@
     protected $readPreference = [];
 
     /**
-     * @return Cursor
+     * @return \Traversable
      */
     abstract protected function ensureCursor();
 

lib/Mongo/MongoCursor.php

Doc Comments +1 added lines, -1 removed lines

@@ -201,7 +201,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()
     {

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

Spacing +1 added lines, -1 removed lines

@@ -380,7 +380,7 @@
      */
     protected function convertCursorType()
     {
-        if (! $this->tailable) {
+        if ( ! $this->tailable) {
             return null;
         }
 

lib/Mongo/MongoGridFSFile.php

Doc Comments +3 added lines

@@ -126,6 +126,9 @@
         );
     }
 
+    /**
+     * @param resource $handle
+     */
     private function writeFromRessource($handle)
     {
 

Spacing +1 added lines, -1 removed lines

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

lib/Mongo/Mongo.php

Doc Comments +9 added lines, -9 removed lines

@@ -48,7 +48,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.
      */
@@ -61,7 +61,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()
     {
@@ -73,7 +73,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.
      */
@@ -99,7 +99,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)
     {
@@ -111,7 +111,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)
@@ -126,7 +126,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 = "")
@@ -141,7 +141,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 = "")
@@ -154,7 +154,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()
     {
@@ -201,7 +201,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()

Spacing +1 added lines, -1 removed lines

@@ -101,7 +101,7 @@
      * @param bool $ok
      * @return bool returns the former value of slaveOkay for this instance.
      */
-    public function setSlaveOkay ($ok)
+    public function setSlaveOkay($ok)
     {
         $this->notImplemented();
     }

lib/Mongo/MongoCollection.php

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

@@ -32,7 +32,7 @@ 
     /**
      * @var MongoDB
      */
-    public $db = NULL;
+    public $db = null;
 
     /**
      * @var string
@@ -133,7 +133,7 @@ 
             foreach (func_get_args() as $operator) {
                 $i++;
                 if (! is_array($operator)) {
-                    trigger_error("Argument $i is not an array", E_WARNING);
+                    trigger_error("argument $i is not an array", E_WARNING);
                     return;
                 }
 
@@ -234,7 +234,7 @@ 
      * @param bool $scan_data Only validate indices, not the base collection.
      * @return array Returns the database's evaluation of this object.
      */
-    public function validate($scan_data = FALSE)
+    public function validate($scan_data = false)
     {
         $command = [
             'validate' => $this->name,

Doc Comments +3 added lines

@@ -816,6 +816,9 @@
         return $options;
     }
 
+    /**
+     * @param string $name
+     */
     private function checkCollectionName($name)
     {
         if (empty($name)) {

Spacing +23 added lines, -23 removed lines

@@ -127,14 +127,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;
                 }
@@ -177,7 +177,7 @@ 
         ];
 
         // Convert cursor option
-        if (! isset($options['cursor'])) {
+        if ( ! isset($options['cursor'])) {
             $options['cursor'] = true;
         }
 
@@ -265,12 +265,12 @@ 
     {
         $this->validateDocument($a);
 
-        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_WARNING);
             return;
         }
 
-        if (! count((array)$a)) {
+        if ( ! count((array) $a)) {
             throw new \MongoException('document must be an array or object');
         }
 
@@ -292,7 +292,7 @@ 
             ExceptionConverter::toLegacy($e);
         }
 
-        if (! $result->isAcknowledged()) {
+        if ( ! $result->isAcknowledged()) {
             return true;
         }
 
@@ -329,7 +329,7 @@ 
             ExceptionConverter::toLegacy($e);
         }
 
-        if (! $result->isAcknowledged()) {
+        if ( ! $result->isAcknowledged()) {
             return true;
         }
 
@@ -353,7 +353,7 @@ 
      * @throws MongoCursorException
      * @return boolean
      */
-    public function update(array $criteria , array $newobj, array $options = [])
+    public function update(array $criteria, array $newobj, array $options = [])
     {
         $multiple = isset($options['multiple']) ? $options['multiple'] : false;
         $method = $multiple ? 'updateMany' : 'updateOne';
@@ -381,7 +381,7 @@ 
             ExceptionConverter::toLegacy($e);
         }
 
-        if (! $result->isAcknowledged()) {
+        if ( ! $result->isAcknowledged()) {
             return true;
         }
 
@@ -408,7 +408,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 {
@@ -421,7 +421,7 @@ 
             ExceptionConverter::toLegacy($e);
         }
 
-        if (! $result->isAcknowledged()) {
+        if ( ! $result->isAcknowledged()) {
             return true;
         }
 
@@ -545,7 +545,7 @@ 
      */
     public function createIndex(array $keys, array $options = [])
     {
-        if (! is_array($keys) || ! count($keys)) {
+        if ( ! is_array($keys) || ! count($keys)) {
             throw new MongoException('keys cannot be empty');
         }
 
@@ -555,7 +555,7 @@ 
         $indexes = $this->collection->listIndexes();
         foreach ($indexes as $index) {
 
-            if (! empty($options['name']) && $index->getName() === $options['name']) {
+            if ( ! empty($options['name']) && $index->getName() === $options['name']) {
                 throw new \MongoDuplicateKeyException();
             }
 
@@ -718,13 +718,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;
             }
 
@@ -767,14 +767,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;
         }
@@ -783,7 +783,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'];
         }
@@ -837,11 +837,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'],
@@ -866,13 +866,13 @@ 
     private function ensureDocumentHasMongoId(&$document)
     {
         if (is_array($document)) {
-            if (! isset($document['_id'])) {
+            if ( ! isset($document['_id'])) {
                 $document['_id'] = new \MongoId();
             }
 
             return $document['_id'];
         } elseif (is_object($document)) {
-            if (! isset($document->_id)) {
+            if ( ! isset($document->_id)) {
                 $document->_id = new \MongoId();
             }
 
@@ -884,7 +884,7 @@ 
 
     private function validateDocument(&$document)
     {
-        if (! is_array($document) && ! is_object($document)) {
+        if ( ! is_array($document) && ! is_object($document)) {
             throw new \MongoException('document must be an array or object');
         }
         $array = (array) $document;