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/MongoLog.php

Doc Comments +1 added lines, -1 removed lines

@@ -97,7 +97,7 @@
      *
      * <p>The log message itself.</p></li>
      * <ul>
-     * @return boolean Returns <b>TRUE</b> on success or <b>FALSE</b> on failure.
+     * @return boolean|null Returns <b>TRUE</b> on success or <b>FALSE</b> on failure.
      */
     public static function setCallback ( callable $log_function ) {}
 

Spacing +1 added lines, -1 removed lines

@@ -99,7 +99,7 @@
      * <ul>
      * @return boolean Returns <b>TRUE</b> on success or <b>FALSE</b> on failure.
      */
-    public static function setCallback ( callable $log_function ) {}
+    public static function setCallback(callable $log_function) {}
 
     /**
      * This function can be used to set how verbose logging should be and the types of

Braces +17 added lines, -6 removed lines

@@ -13,7 +13,8 @@ 
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-class MongoLog {
+class MongoLog
+{
     /**
      * @link http://php.net/manual/en/class.mongolog.php#mongolog.constants.none
      */
@@ -99,7 +100,9 @@ 
      * <ul>
      * @return boolean Returns <b>TRUE</b> on success or <b>FALSE</b> on failure.
      */
-    public static function setCallback ( callable $log_function ) {}
+    public static function setCallback ( callable $log_function )
+    {
+}
 
     /**
      * This function can be used to set how verbose logging should be and the types of
@@ -111,7 +114,9 @@ 
      * @param int $level The levels you would like to log
      * @return void
      */
-    public static function setLevel($level) {}
+    public static function setLevel($level)
+    {
+}
 
     /**
      * This can be used to see the log level. Use the constants described in the
@@ -121,7 +126,9 @@ 
      * @static
      * @return int Returns the current level
      */
-    public static function getLevel() {}
+    public static function getLevel()
+    {
+}
 
     /**
      * This function can be used to set which parts of the driver's functionality
@@ -133,7 +140,9 @@ 
      * @param int $module The module(s) you would like to log
      * @return void
      */
-    public static function setModule($module) {}
+    public static function setModule($module)
+    {
+}
 
     /**
      * This function can be used to see which parts of the driver's functionality are
@@ -144,5 +153,7 @@ 
      * @static
      * @return int Returns the modules currently being logged
      */
-    public static function getModule() {}
+    public static function getModule()
+    {
+}
 }

lib/Mongo/MongoPool.php

Doc Comments +1 added lines, -1 removed lines

@@ -50,7 +50,7 @@
      * @param int $size 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
-     * @return boolean Returns the former value of pool size
+     * @return boolean|null Returns the former value of pool size
      */
     public static function setSize($size) {}
 

Braces +11 added lines, -4 removed lines

@@ -13,7 +13,8 @@ 
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-class MongoPool {
+class MongoPool
+{
     /**
      * Returns an array of information about all connection pools.
      *
@@ -40,7 +41,9 @@ 
      *         keeps increasing, you may want to use MongoPool::setSize to add more connections
      *         to your pool
      */
-    public static function info() {}
+    public static function info()
+    {
+}
 
     /**
      * Sets the max number of connections new pools will be able to create.
@@ -52,7 +55,9 @@ 
      *        connections
      * @return boolean Returns the former value of pool size
      */
-    public static function setSize($size) {}
+    public static function setSize($size)
+    {
+}
 
     /**
      * .
@@ -61,5 +66,7 @@ 
      * @static
      * @return int Returns the current pool size
      */
-    public static function getSize() {}
+    public static function getSize()
+    {
+}
 }

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/MongoCollection.php

Doc Comments +4 added lines, -4 removed lines

@@ -272,7 +272,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())
     {
@@ -285,7 +285,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())
     {
@@ -466,7 +466,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())
     {
@@ -559,7 +559,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())

Spacing +11 added lines, -11 removed lines

@@ -125,14 +125,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;
                 }
@@ -170,14 +170,14 @@ 
         ];
 
         // 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;
         }
 
         $command += $options;
 
-        $cursor = new MongoCommandCursor($this->db->getConnection(), (string)$this, $command);
+        $cursor = new MongoCommandCursor($this->db->getConnection(), (string) $this, $command);
         $cursor->setReadPreference($this->getReadPreference());
 
         return $cursor;
@@ -284,7 +284,7 @@ 
      * @throws MongoCursorException
      * @return boolean
      */
-    public function update(array $criteria , array $newobj, array $options = [])
+    public function update(array $criteria, array $newobj, array $options = [])
     {
         $multiple = ($options['multiple']) ? $options['multiple'] : false;
         $method = $multiple ? 'updateMany' : 'updateOne';
@@ -305,7 +305,7 @@ 
      */
     public function remove(array $criteria = [], array $options = [])
     {
-        $multiple = isset($options['justOne']) ? !$options['justOne'] : false;
+        $multiple = isset($options['justOne']) ? ! $options['justOne'] : false;
         $method = $multiple ? 'deleteMany' : 'deleteOne';
 
         return $this->collection->$method($criteria, $options);
@@ -321,7 +321,7 @@ 
      */
     public function find(array $query = [], array $fields = [])
     {
-        $cursor = new MongoCursor($this->db->getConnection(), (string)$this, $query, $fields);
+        $cursor = new MongoCursor($this->db->getConnection(), (string) $this, $query, $fields);
         $cursor->setReadPreference($this->getReadPreference());
 
         return $cursor;
@@ -504,7 +504,7 @@ 
     public function save($a, array $options = [])
     {
         if (is_object($a)) {
-            $a = (array)$a;
+            $a = (array) $a;
         }
         if ( ! array_key_exists('_id', $a)) {
             $id = new \MongoId();
@@ -577,14 +577,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;
         }
@@ -593,7 +593,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'];
         }

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,