Add stream debug methods, update docs, and remove unused methods

Classes using CollectionWrapper should rely on its public API rather than work with its files and chunks collections directly.

Author: jmikola

src/GridFS/CollectionWrapper.php

@@ -17,7 +17,9 @@
  */
 class CollectionWrapper
 {
+    private $bucketName;
     private $chunksCollection;
+    private $databaseName;
     private $checkedIndexes = false;
     private $filesCollection;
 
@@ -33,6 +35,9 @@ class CollectionWrapper
      */
     public function __construct(Manager $manager, $databaseName, $bucketName, array $collectionOptions = [])
     {
+        $this->databaseName = (string) $databaseName;
+        $this->bucketName = (string) $bucketName;
+
         $this->filesCollection = new Collection($manager, $databaseName, sprintf('%s.files', $bucketName), $collectionOptions);
         $this->chunksCollection = new Collection($manager, $databaseName, sprintf('%s.chunks', $bucketName), $collectionOptions);
     }
@@ -135,10 +140,14 @@ public function findFiles($filter, array $options = [])
         return $this->filesCollection->find($filter, $options);
     }
 
-    // TODO: Remove this
-    public function getChunksCollection()
+    /**
+     * Return the bucket name.
+     *
+     * @return string
+     */
+    public function getBucketName()
     {
-        return $this->chunksCollection;
+        return $this->bucketName;
     }
 
     /**
@@ -160,10 +169,14 @@ public function getChunksIteratorByFilesId($id)
         return new IteratorIterator($cursor);
     }
 
-    // TODO: Remove this
-    public function getFilesCollection()
+    /**
+     * Return the database name.
+     *
+     * @return string
+     */
+    public function getDatabaseName()
     {
-        return $this->filesCollection;
+        return $this->databaseName;
     }
 
     /**

src/GridFS/ReadableStream.php

@@ -20,6 +20,7 @@ class ReadableStream
     private $chunkSize;
     private $chunkOffset = 0;
     private $chunksIterator;
+    private $collectionWrapper;
     private $firstCheck = true;
     private $id;
     private $iteratorEmpty = false;
@@ -52,10 +53,28 @@ public function __construct(CollectionWrapper $collectionWrapper, stdClass $file
         $this->length = $file->length;
 
         $this->chunksIterator = $collectionWrapper->getChunksIteratorByFilesId($this->id);
+        $this->collectionWrapper = $collectionWrapper;
         $this->numChunks = ceil($this->length / $this->chunkSize);
         $this->initEmptyBuffer();
     }
 
+    /**
+     * 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->collectionWrapper->getBucketName(),
+            'databaseName' => $this->collectionWrapper->getDatabaseName(),
+            'id' => $this->id,
+            'chunkSize' => $this->chunkSize,
+            'length' => $this->length,
+        ];
+    }
+
     public function close()
     {
         fclose($this->buffer);
@@ -129,7 +148,7 @@ public function downloadToStream($destination)
     }
 
     /**
-     * Return the ID of the GridFS file document for this stream.
+     * Return the stream's ID (i.e. file document identifier).
      *
      * @return integer
      */
@@ -139,7 +158,7 @@ public function getId()
     }
 
     /**
-     * Return the stream size in bytes.
+     * Return the stream's size in bytes.
      *
      * @return integer
      */

src/GridFS/WritableStream.php

@@ -89,6 +89,21 @@ public function __construct(CollectionWrapper $collectionWrapper, $filename, arr
         ] + array_intersect_key($options, ['aliases' => 1, 'contentType' => 1, 'metadata' => 1]);
     }
 
+    /**
+     * 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->collectionWrapper->getBucketName(),
+            'databaseName' => $this->collectionWrapper->getDatabaseName(),
+            'file' => $this->file,
+        ];
+    }
+
     /**
      * Closes an active stream and flushes all buffered data to GridFS.
      */
@@ -111,26 +126,23 @@ public function close()
         $this->isClosed = true;
     }
 
-    public function getChunkSize()
-    {
-        return $this->chunkSize;
-    }
-
-    public function getFile()
-    {
-        return $this->file;
-    }
-
+    /**
+     * Return the stream's ID (i.e. file document identifier).
+     *
+     * @return integer
+     */
     public function getId()
     {
         return $this->file['_id'];
     }
 
-    public function getLength()
-    {
-        return $this->length;
-    }
-
+    /**
+     * Return the stream's size in bytes.
+     *
+     * Note: this value will increase as more data is written to the stream.
+     *
+     * @return integer
+     */
     public function getSize()
     {
         return $this->length;