alcaeus / mongo-php-adapter

lib/Mongo/MongoCollection.php

Doc Comments +3 added lines

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

Spacing +19 added lines, -19 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;
                 }
@@ -176,7 +176,7 @@ 
         ];
 
         // Convert cursor option
-        if (! isset($options['cursor'])) {
+        if ( ! isset($options['cursor'])) {
             $options['cursor'] = true;
         }
 
@@ -262,7 +262,7 @@ 
      */
     public function insert($a, array $options = [])
     {
-        if (! count((array)$a)) {
+        if ( ! count((array) $a)) {
             throw new \MongoException('document must be an array or object');
         }
 
@@ -276,7 +276,7 @@ 
         }
 
 
-        if (! $result->isAcknowledged()) {
+        if ( ! $result->isAcknowledged()) {
             return true;
         }
 
@@ -308,7 +308,7 @@ 
             ExceptionConverter::toLegacy($e);
         }
 
-        if (! $result->isAcknowledged()) {
+        if ( ! $result->isAcknowledged()) {
             return true;
         }
 
@@ -332,7 +332,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';
@@ -349,7 +349,7 @@ 
             ExceptionConverter::toLegacy($e);
         }
 
-        if (! $result->isAcknowledged()) {
+        if ( ! $result->isAcknowledged()) {
             return true;
         }
 
@@ -376,7 +376,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 {
@@ -389,7 +389,7 @@ 
             ExceptionConverter::toLegacy($e);
         }
 
-        if (! $result->isAcknowledged()) {
+        if ( ! $result->isAcknowledged()) {
             return true;
         }
 
@@ -518,7 +518,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');
         }
 
@@ -656,7 +656,7 @@ 
         }
         $options['upsert'] = true;
 
-        if (! count($a)) {
+        if ( ! count($a)) {
             throw new MongoException('document can not be empty');
         }
 
@@ -675,13 +675,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;
             }
 
@@ -724,14 +724,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;
         }
@@ -740,7 +740,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'];
         }
@@ -794,11 +794,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'],

lib/Mongo/MongoDB.php

Doc Comments +3 added lines

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

lib/Mongo/MongoGridFS.php

Doc Comments +6 added lines, -7 removed lines

@@ -80,7 +80,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
+     * @param MongoId $id _id of the file to remove
      * @return boolean Returns true if the remove was successfully sent to the database.
      */
     public function delete($id)
@@ -106,7 +106,6 @@ 
      * @link http://php.net/manual/en/mongogridfs.find.php
      * @param array $query The query
      * @param array $fields Fields to return
-     * @param array $options Options for the find command
      * @return MongoGridFSCursor A MongoGridFSCursor
      */
     public function find(array $query = [], array $fields = [])
@@ -155,7 +154,7 @@ 
      * @param string $filename The name of the file
      * @param array $extra Other metadata to add to the file saved
      * @param array $options An array of options for the insert operations executed against the chunks and files collections.
-     * @return mixed Returns the _id of the saved object
+     * @return MongoId Returns the _id of the saved object
      */
     public function put($filename, array $extra = [], array $options = [])
     {
@@ -190,7 +189,7 @@ 
      * @param string $bytes A string of bytes to store
      * @param array $extra Other metadata to add to the file saved
      * @param array $options Options for the store. "safe": Check that this store succeeded
-     * @return mixed The _id of the object saved
+     * @return MongoId The _id of the object saved
      */
     public function storeBytes($bytes, array $extra = [], array $options = [])
     {
@@ -224,7 +223,7 @@ 
      * @param string $filename The name of the file
      * @param array $extra Other metadata to add to the file saved
      * @param array $options Options for the store. "safe": Check that this store succeeded
-     * @return mixed Returns the _id of the saved object
+     * @return MongoId Returns the _id of the saved object
      * @throws MongoGridFSException
      * @throws Exception
      */
@@ -299,7 +298,7 @@ 
      * @link http://www.php.net/manual/en/mongogridfs.storeupload.php
      * @param string $name The name attribute of the uploaded file, from <input type="file" name="something"/>.
      * @param array $metadata An array of extra fields for the uploaded file.
-     * @return mixed Returns the _id of the uploaded file.
+     * @return null|MongoId Returns the _id of the uploaded file.
      * @throws MongoGridFSException
      */
     public function storeUpload($name, array $metadata = [])
@@ -436,7 +435,7 @@ 
     /**
      * Returns the MD5 string for a file previously stored to the database
      *
-     * @param $id
+     * @param MongoId $id
      * @return string
      */
     private function getMd5ForFile($id)

Spacing +10 added lines, -10 removed lines

@@ -241,10 +241,10 @@ 
             ];
 
             $handle = fopen($filename, 'r');
-            if (! $handle) {
+            if ( ! $handle) {
                 throw new MongoGridFSException('could not open file: ' . $filename);
             }
-        } elseif (! is_resource($filename)) {
+        } elseif ( ! is_resource($filename)) {
             throw new \Exception('first argument must be a string or stream resource');
         } else {
             $handle = $filename;
@@ -266,10 +266,10 @@ 
 
         // Add length and MD5 if they were not present before
         $update = [];
-        if (! isset($record['length'])) {
+        if ( ! isset($record['length'])) {
             $update['length'] = $length;
         }
-        if (! isset($record['md5'])) {
+        if ( ! isset($record['md5'])) {
             try {
                 $update['md5'] = $this->getMd5ForFile($file['_id']);
             } catch (MongoException $e) {
@@ -280,7 +280,7 @@ 
         if (count($update)) {
             try {
                 $result = $this->update(['_id' => $file['_id']], ['$set' => $update]);
-                if (! $this->isOKResult($result)) {
+                if ( ! $this->isOKResult($result)) {
                     throw new MongoGridFSException('Error updating file record');
                 }
             } catch (MongoException $e) {
@@ -304,10 +304,10 @@ 
      */
     public function storeUpload($name, array $metadata = [])
     {
-        if (! isset($_FILES[$name]) || $_FILES[$name]['error'] !== UPLOAD_ERR_OK) {
+        if ( ! isset($_FILES[$name]) || $_FILES[$name]['error'] !== UPLOAD_ERR_OK) {
             throw new MongoGridFSException("Could not find uploaded file $name");
         }
-        if (! isset($_FILES[$name]['tmp_name'])) {
+        if ( ! isset($_FILES[$name]['tmp_name'])) {
             throw new MongoGridFSException("Couldn't find tmp_name in the \$_FILES array. Are you sure the upload worked?");
         }
 
@@ -357,7 +357,7 @@ 
 
         $result = $this->chunks->insert($chunk);
 
-        if (! $this->isOKResult($result)) {
+        if ( ! $this->isOKResult($result)) {
             throw new \MongoException('error inserting chunk');
         }
 
@@ -399,7 +399,7 @@ 
         $chunkSize = $record['chunkSize'];
 
         rewind($handle);
-        while (! feof($handle)) {
+        while ( ! feof($handle)) {
             $data = stream_get_contents($handle, $chunkSize);
             $this->insertChunk($fileId, $data, $i++);
             $written += strlen($data);
@@ -426,7 +426,7 @@ 
 
         $result = $this->insert($record, $options);
 
-        if (! $this->isOKResult($result)) {
+        if ( ! $this->isOKResult($result)) {
             throw new \MongoException('error inserting file');
         }
 

lib/Mongo/MongoGridFSCursor.php

Spacing +1 added lines, -1 removed lines

@@ -65,6 +65,6 @@
     public function key()
     {
         $file = $this->current();
-        return ($file !== null) ? (string)$file->file['_id'] : null;
+        return ($file !== null) ? (string) $file->file['_id'] : null;
     }
 }