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 +2 added lines, -2 removed lines

@@ -216,7 +216,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;
         }
@@ -357,7 +357,7 @@ 
             }
 
             $iterationInfo += [
-                'id' => (string)$this->cursor->getId(),
+                'id' => (string) $this->cursor->getId(),
                 'at' => null, // @todo Complete info for cursor that is iterating
                 'numReturned' => null, // @todo Complete info for cursor that is iterating
                 'server' => null, // @todo Complete info for cursor that is iterating

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 +6 added lines, -7 removed lines

@@ -100,7 +100,6 @@ 
      * @link http://www.php.net/manual/en/mongocollection.aggregate.php
      * @param array $pipeline
      * @param array $op
-     * @param array $pipelineOperators
      * @return array
      */
     public function aggregate(array $pipeline, array $op = [] /* , array $pipelineOperators, ... */)
@@ -170,7 +169,7 @@ 
 
     /**
      * @link http://www.php.net/manual/en/mongocollection.getslaveokay.php
-     * @return bool
+     * @return boolean|null
      */
     public function getSlaveOkay()
     {
@@ -180,7 +179,7 @@ 
     /**
      * @link http://www.php.net/manual/en/mongocollection.setslaveokay.php
      * @param bool $ok
-     * @return bool
+     * @return boolean|null
      */
     public function setSlaveOkay($ok = true)
     {
@@ -199,7 +198,7 @@ 
     /**
      * @param string $read_preference
      * @param array $tags
-     * @return bool
+     * @return boolean|null
      */
     public function setReadPreference($read_preference, array $tags)
     {
@@ -235,7 +234,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())
     {
@@ -248,7 +247,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())
     {
@@ -413,7 +412,7 @@ 
      * @link http://www.php.net/manual/en/mongocollection.ensureindex.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 boolean always true
+     * @return boolean|null always true
      */
     public function ensureIndex(array $keys, array $options = array()) {}
 

Spacing +4 added lines, -4 removed lines

@@ -105,14 +105,14 @@ 
      */
     public function aggregate(array $pipeline, array $op = [] /* , array $pipelineOperators, ... */)
     {
-        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;
                 }
@@ -148,7 +148,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;
         }
@@ -284,7 +284,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;