Rename function added to bucket

Author: Will Banfield

src/GridFS/Bucket.php

@@ -163,7 +163,11 @@ public function find($filter, array $options =[])
     {
         return $this->collectionsWrapper->getFilesCollection()->find($filter, $options);
     }
-
+    /**
+    * Gets the id of the GridFs file associated with $stream
+    *
+    * @param resource     $stream  wrapped gridFsStream
+    */
     public function getIdFromStream($stream)
     {
         $metadata = stream_get_meta_data($stream);
@@ -172,7 +176,23 @@ public function getIdFromStream($stream)
         }
         return null;
     }
-
+    /**
+    * Gets the id of the GridFs file associated with $stream
+    *
+    * @param \MongoDB\BSON\ObjectId     $id             id of the file to rename
+    * @param string                     $newFilename    new name for the file
+    * @throws \MongoDB\Exception\GridFSFileNotFoundException
+    */
+    public function rename(\MongoDB\BSON\ObjectId $id, $newFilename)
+    {
+        $filesCollection = $this->collectionsWrapper->getFilesCollection();
+        $file = $filesCollection->findOne(["_id" => $id]);
+        if (is_null($file)) {
+            throw new \MongoDB\Exception\GridFSFileNotFoundException($id, $this->collectionsWrapper->getFilesCollection()->getNameSpace());
+        }
+        $file->filename = $newFilename;
+        $filesCollection->replaceOne(["_id"=> $id], $file);
+    }
     public function getCollectionsWrapper()
     {
         return $this->collectionsWrapper;

tests/GridFS/BucketFunctionalTest.php

@@ -220,6 +220,24 @@ public function testGetIdFromStream()
         fclose($download);
         $this->assertTrue($id instanceof \MongoDB\BSON\ObjectId);
     }
+    public function testRename()
+    {
+        $id = $this->bucket->uploadFromStream("first_name", $this->generateStream("testing"));
+        $this->assertEquals("testing", stream_get_contents($this->bucket->openDownloadStream($id)));
+
+        $this->bucket->rename($id, "second_name");
+
+        $error = null;
+        try{
+            $this->bucket->openDownloadStreamByName("first_name");
+        } catch(\MongoDB\Exception\Exception $e) {
+            $error = $e;
+        }
+        $fileNotFound = '\MongoDB\Exception\GridFSFileNotFoundException';
+        $this->assertTrue($error instanceof $fileNotFound);
+
+        $this->assertEquals("testing", stream_get_contents($this->bucket->openDownloadStreamByName("second_name")));
+    }
     /**
      *@dataProvider provideInsertChunks
      */