alcaeus / mongo-php-adapter

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

Spacing +1 added lines, -1 removed lines

@@ -220,7 +220,7 @@
             \MongoClient::RP_SECONDARY_PREFERRED,
             \MongoClient::RP_NEAREST
         ];
-        if (! in_array($readPreference, $availableReadPreferences)) {
+        if (!in_array($readPreference, $availableReadPreferences)) {
             trigger_error("The value '$readPreference' is not valid as read preference type", E_WARNING);
             return $this;
         }

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

Spacing +1 added lines, -1 removed lines

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

lib/Mongo/MongoCollection.php

Doc Comments +4 added lines, -5 removed lines

@@ -311,7 +311,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())
     {
@@ -324,7 +324,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())
     {
@@ -502,7 +502,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())
     {
@@ -595,7 +595,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())
@@ -719,7 +719,6 @@ 
      * @link http://php.net/manual/en/mongodb.setwriteconcern.php
      * Set the write concern for this database
      * @param mixed $w <p>The write concern. This may be an integer denoting the number of servers required to acknowledge the write, or a string mode (e.g. "majority").</p>
-     * @param int $wtimeout[optional] <p>The maximum number of milliseconds to wait for the server to satisfy the write concern.</p>
      * @return boolean Returns <b>TRUE</b> on success, or <b>FALSE</b> otherwise.
      */
     public function setWriteConcern($w, $wtimeout = null)

Spacing +11 added lines, -11 removed lines

@@ -131,14 +131,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;
                 }
@@ -174,7 +174,7 @@ 
         ];
 
         // 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;
         }
@@ -360,7 +360,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;
@@ -601,9 +601,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'];
@@ -665,20 +665,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;
         }
@@ -687,14 +687,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']);
         }

lib/Mongo/MongoClient.php

Doc Comments +1 added lines, -2 removed lines

@@ -244,7 +244,7 @@ 
      * Lists all of the databases available
      *
      * @link http://php.net/manual/en/mongoclient.listdbs.php
-     * @return array Returns an associative array containing three fields. The first field is databases, which in turn contains an array. Each element of the array is an associative array corresponding to a database, giving the database's name, size, and if it's empty. The other two fields are totalSize (in bytes) and ok, which is 1 if this method ran successfully.
+     * @return MongoDB\Model\DatabaseInfoLegacyIterator Returns an associative array containing three fields. The first field is databases, which in turn contains an array. Each element of the array is an associative array corresponding to a database, giving the database's name, size, and if it's empty. The other two fields are totalSize (in bytes) and ok, which is 1 if this method ran successfully.
      */
     public function listDBs()
     {
@@ -303,7 +303,6 @@ 
      * @link http://php.net/manual/en/mongoclient.setwriteconcern.php
      * Set the write concern for this database
      * @param mixed $w <p>The write concern. This may be an integer denoting the number of servers required to acknowledge the write, or a string mode (e.g. "majority").</p>
-     * @param int $wtimeout[optional] <p>The maximum number of milliseconds to wait for the server to satisfy the write concern.</p>
      * @return boolean Returns <b>TRUE</b> on success, or <b>FALSE</b> otherwise.
      */
     public function setWriteConcern($w, $wtimeout = null)

Spacing +9 added lines, -9 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
@@ -195,7 +195,7 @@ 
             $results[$key] = [
                 'host'     => $server->getHost(),
                 'port'     => $server->getPort(),
-                'health'   => (int)$info['ok'], // Not totally sure about this
+                'health'   => (int) $info['ok'], // Not totally sure about this
                 'state'    => $server->getType(),
                 'ping'     => $server->getLatency(),
                 'lastPing' => null,
@@ -235,7 +235,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)
     {
         throw new \Exception('Not implemented');
     }