alcaeus / mongo-php-adapter

lib/Mongo/MongoGridFS.php

Doc Comments +3 added lines, -3 removed lines

@@ -45,7 +45,7 @@ 
      * @link http://php.net/manual/en/mongogridfs.construct.php
      * @param MongoDB $db Database
      * @param string $prefix [optional] <p>Optional collection name prefix.</p>
-     * @param mixed $chunks  [optional]
+     * @param string $chunks  [optional]
      * @return MongoGridFS
      */
     public function __construct($db, $prefix = "fs", $chunks = "fs") {}
@@ -100,7 +100,7 @@ 
      * @param array $criteria Description of records to remove.
      * @param array $options Options for remove. Valid options are: "safe"- Check that the remove succeeded.
      * @throws MongoCursorException
-     * @return boolean
+     * @return boolean|null
      */
     public function remove(array $criteria = array(), array $options = array()) {}
 
@@ -108,7 +108,7 @@ 
      * Delete a file from the database
      * @link http://php.net/manual/en/mongogridfs.delete.php
      * @param mixed $id _id of the file to remove
-     * @return boolean Returns true if the remove was successfully sent to the database.
+     * @return boolean|null Returns true if the remove was successfully sent to the database.
      */
     public function delete($id) {}
 

Braces +35 added lines, -12 removed lines

@@ -13,7 +13,8 @@ 
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-class MongoGridFS extends MongoCollection {
+class MongoGridFS extends MongoCollection
+{
     const ASCENDING = 1;
     const DESCENDING = -1;
 
@@ -48,14 +49,18 @@ 
      * @param mixed $chunks  [optional]
      * @return MongoGridFS
      */
-    public function __construct($db, $prefix = "fs", $chunks = "fs") {}
+    public function __construct($db, $prefix = "fs", $chunks = "fs")
+    {
+}
 
     /**
      * Drops the files and chunks collections
      * @link http://php.net/manual/en/mongogridfs.drop.php
      * @return array The database response
      */
-    public function drop() {}
+    public function drop()
+    {
+}
 
     /**
      * @link http://php.net/manual/en/mongogridfs.find.php
@@ -63,7 +68,9 @@ 
      * @param array $fields Fields to return
      * @return MongoGridFSCursor A MongoGridFSCursor
      */
-    public function find(array $query = array(), array $fields = array()) {}
+    public function find(array $query = array(), array $fields = array())
+    {
+}
 
     /**
      * Stores a file in the database
@@ -73,7 +80,9 @@ 
      * @param array $options Options for the store. "safe": Check that this store succeeded
      * @return mixed Returns the _id of the saved object
      */
-    public function storeFile($filename, $extra = array(), $options = array()) {}
+    public function storeFile($filename, $extra = array(), $options = array())
+    {
+}
 
     /**
      * Chunkifies and stores bytes in the database
@@ -83,7 +92,9 @@ 
      * @param array $options Options for the store. "safe": Check that this store succeeded
      * @return mixed The _id of the object saved
      */
-    public function storeBytes($bytes, $extra = array(), $options = array()) {}
+    public function storeBytes($bytes, $extra = array(), $options = array())
+    {
+}
 
     /**
      * Returns a single file matching the criteria
@@ -92,7 +103,9 @@ 
      * @param array $fields Fields of the results to return.
      * @return MongoGridFSFile|null
      */
-    public function findOne(array $query = array(), array $fields = array()) {}
+    public function findOne(array $query = array(), array $fields = array())
+    {
+}
 
     /**
      * Removes files from the collections
@@ -102,7 +115,9 @@ 
      * @throws MongoCursorException
      * @return boolean
      */
-    public function remove(array $criteria = array(), array $options = array()) {}
+    public function remove(array $criteria = array(), array $options = array())
+    {
+}
 
     /**
      * Delete a file from the database
@@ -110,7 +125,9 @@ 
      * @param mixed $id _id of the file to remove
      * @return boolean Returns true if the remove was successfully sent to the database.
      */
-    public function delete($id) {}
+    public function delete($id)
+    {
+}
 
     /**
      * Saves an uploaded file directly from a POST to the database
@@ -119,7 +136,9 @@ 
      * @param array $metadata An array of extra fields for the uploaded file.
      * @return mixed Returns the _id of the uploaded file.
      */
-    public function storeUpload($name, array $metadata = array()) {}
+    public function storeUpload($name, array $metadata = array())
+    {
+}
 
 
     /**
@@ -128,7 +147,9 @@ 
      * @param mixed $id _id of the file to find.
      * @return MongoGridFSFile|null Returns the file, if found, or NULL.
      */
-    public function __get($id) {}
+    public function __get($id)
+    {
+}
 
     /**
      * Stores a file in the database
@@ -137,6 +158,8 @@ 
      * @param array $extra Other metadata to add to the file saved
      * @return mixed Returns the _id of the saved object
      */
-    public function put($filename, array $extra = array()) {}
+    public function put($filename, array $extra = array())
+    {
+}
 
 }

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