Implement Bucket::getBucketName() and debug handler

Author: jmikola

src/GridFS/Bucket.php

@@ -26,7 +26,8 @@ class Bucket
 
     private $collectionWrapper;
     private $databaseName;
-    private $options;
+    private $bucketName;
+    private $chunkSizeBytes;
 
     /**
      * Constructs a GridFS bucket.
@@ -78,14 +79,30 @@ public function __construct(Manager $manager, $databaseName, array $options = []
         }
 
         $this->databaseName = (string) $databaseName;
-        $this->options = $options;
+        $this->bucketName = $options['bucketName'];
+        $this->chunkSizeBytes = $options['chunkSizeBytes'];
 
         $collectionOptions = array_intersect_key($options, ['readConcern' => 1, 'readPreference' => 1, 'writeConcern' => 1]);
 
         $this->collectionWrapper = new CollectionWrapper($manager, $databaseName, $options['bucketName'], $collectionOptions);
         $this->registerStreamWrapper();
     }
 
+    /**
+     * Return internal properties for debugging purposes.
+     *
+     * @see http://php.net/manual/en/language.oop5.magic.php#language.oop5.magic.debuginfo
+     * @return array
+     */
+    public function __debugInfo()
+    {
+        return [
+            'bucketName' => $this->bucketName,
+            'databaseName' => $this->databaseName,
+            'chunkSizeBytes' => $this->chunkSizeBytes,
+        ];
+    }
+
     /**
      * Delete a file from the GridFS bucket.
      *
@@ -179,6 +196,21 @@ public function find($filter, array $options = [])
         return $this->collectionWrapper->findFiles($filter, $options);
     }
 
+    /**
+     * Return the bucket name.
+     *
+     * @return string
+     */
+    public function getBucketName()
+    {
+        return $this->bucketName;
+    }
+
+    /**
+     * Return the database name.
+     *
+     * @return string
+     */
     public function getDatabaseName()
     {
         return $this->databaseName;
@@ -275,7 +307,7 @@ public function openDownloadStreamByName($filename, array $options = [])
      */
     public function openUploadStream($filename, array $options = [])
     {
-        $options += ['chunkSizeBytes' => $this->options['chunkSizeBytes']];
+        $options += ['chunkSizeBytes' => $this->chunkSizeBytes];
 
         $path = $this->createPathForUpload();
         $context = stream_context_create([
@@ -367,7 +399,7 @@ private function createPathForFile(stdClass $file)
             '%s://%s/%s.files/%s',
             self::$streamWrapperProtocol,
             urlencode($this->databaseName),
-            urlencode($this->options['bucketName']),
+            urlencode($this->bucketName),
             urlencode($id)
         );
     }
@@ -383,7 +415,7 @@ private function createPathForUpload()
             '%s://%s/%s.files',
             self::$streamWrapperProtocol,
             urlencode($this->databaseName),
-            urlencode($this->options['bucketName'])
+            urlencode($this->bucketName)
         );
     }
 
@@ -394,7 +426,7 @@ private function createPathForUpload()
      */
     private function getFilesNamespace()
     {
-        return sprintf('%s.%s.files', $this->databaseName, $this->options['bucketName']);
+        return sprintf('%s.%s.files', $this->databaseName, $this->bucketName);
     }
 
     /**

tests/GridFS/BucketFunctionalTest.php

@@ -306,6 +306,18 @@ public function testFind()
         $this->assertSameDocuments($expected, $cursor);
     }
 
+    public function testGetBucketNameWithCustomValue()
+    {
+        $bucket = new Bucket($this->manager, $this->getDatabaseName(), ['bucketName' => 'custom_fs']);
+
+        $this->assertEquals('custom_fs', $bucket->getBucketName());
+    }
+
+    public function testGetBucketNameWithDefaultValue()
+    {
+        $this->assertEquals('fs', $this->bucket->getBucketName());
+    }
+
     public function testGetDatabaseName()
     {
         $this->assertEquals($this->getDatabaseName(), $this->bucket->getDatabaseName());