PHPLIB-215: Accessor method for GridFS stream file document

This adds Bucket::getFileDocumentForStream() and Bucket::getFileIdForStream() methods, the latter of which was renamed from getIdFromStream().

Additionally, this replaces the getId() method in both internal stream classes with a getFile() method. The debug output for ReadableStream has also been simplified to include the entire file document instead of ID, chunkSize, and length.

Author: jmikola

src/GridFS/Bucket.php

@@ -218,20 +218,44 @@ public function getDatabaseName()
     }
 
     /**
-     * Gets the ID of the GridFS file associated with a stream.
+     * Gets the file document of the GridFS file associated with a stream.
      *
      * @param resource $stream GridFS stream
-     * @return mixed
+     * @return stdClass
+     * @throws InvalidArgumentException
      */
-    public function getIdFromStream($stream)
+    public function getFileDocumentForStream($stream)
     {
+        if ( ! is_resource($stream) || get_resource_type($stream) != "stream") {
+            throw InvalidArgumentException::invalidType('$stream', $stream, 'resource');
+        }
+
         $metadata = stream_get_meta_data($stream);
 
-        if ($metadata['wrapper_data'] instanceof StreamWrapper) {
-            return $metadata['wrapper_data']->getId();
+        if (!$metadata['wrapper_data'] instanceof StreamWrapper) {
+            throw InvalidArgumentException::invalidType('$stream wrapper data', $metadata['wrapper_data'], 'MongoDB\Driver\GridFS\StreamWrapper');
+        }
+
+        return $metadata['wrapper_data']->getFile();
+    }
+
+    /**
+     * Gets the file document's ID of the GridFS file associated with a stream.
+     *
+     * @param resource $stream GridFS stream
+     * @return stdClass
+     * @throws CorruptFileException
+     * @throws InvalidArgumentException
+     */
+    public function getFileIdForStream($stream)
+    {
+        $file = $this->getFileDocumentForStream($stream);
+
+        if ( ! isset($file->_id) && ! property_exists($file, '_id')) {
+            throw new CorruptFileException('file._id does not exist');
         }
 
-        // TODO: Throw if we cannot access the ID
+        return $file->_id;
     }
 
     /**
@@ -379,7 +403,7 @@ public function uploadFromStream($filename, $source, array $options = [])
         $destination = $this->openUploadStream($filename, $options);
         stream_copy_to_stream($source, $destination);
 
-        return $this->getIdFromStream($destination);
+        return $this->getFileIdForStream($destination);
     }
 
     /**

src/GridFS/ReadableStream.php

@@ -21,8 +21,8 @@ class ReadableStream
     private $chunkOffset = 0;
     private $chunksIterator;
     private $collectionWrapper;
+    private $file;
     private $firstCheck = true;
-    private $id;
     private $iteratorEmpty = false;
     private $length;
     private $numChunks;
@@ -44,15 +44,15 @@ public function __construct(CollectionWrapper $collectionWrapper, stdClass $file
             throw new CorruptFileException('file.length is not an integer > 0');
         }
 
-        if ( ! isset($file->_id) && ! array_key_exists('_id', (array) $file)) {
+        if ( ! isset($file->_id) && ! property_exists($file, '_id')) {
             throw new CorruptFileException('file._id does not exist');
         }
 
-        $this->id = $file->_id;
+        $this->file = $file;
         $this->chunkSize = $file->chunkSize;
         $this->length = $file->length;
 
-        $this->chunksIterator = $collectionWrapper->getChunksIteratorByFilesId($this->id);
+        $this->chunksIterator = $collectionWrapper->getChunksIteratorByFilesId($file->_id);
         $this->collectionWrapper = $collectionWrapper;
         $this->numChunks = ceil($this->length / $this->chunkSize);
         $this->initEmptyBuffer();
@@ -69,9 +69,7 @@ public function __debugInfo()
         return [
             'bucketName' => $this->collectionWrapper->getBucketName(),
             'databaseName' => $this->collectionWrapper->getDatabaseName(),
-            'id' => $this->id,
-            'chunkSize' => $this->chunkSize,
-            'length' => $this->length,
+            'file' => $this->file,
         ];
     }
 
@@ -130,13 +128,13 @@ public function downloadNumBytes($numBytes)
     }
 
     /**
-     * Return the stream's ID (i.e. file document identifier).
+     * Return the stream's file document.
      *
-     * @return integer
+     * @return stdClass
      */
-    public function getId()
+    public function getFile()
     {
-        return $this->id;
+        return $this->file;
     }
 
     /**

src/GridFS/StreamWrapper.php

@@ -22,9 +22,14 @@ class StreamWrapper
     private $protocol;
     private $stream;
 
-    public function getId()
+    /**
+     * Return the stream's file document.
+     *
+     * @return stdClass
+     */
+    public function getFile()
     {
-        return $this->stream->getId();
+        return $this->stream->getFile();
     }
 
     /**

src/GridFS/WritableStream.php

@@ -127,13 +127,13 @@ public function close()
     }
 
     /**
-     * Return the stream's ID (i.e. file document identifier).
+     * Return the stream's file document.
      *
-     * @return integer
+     * @return stdClass
      */
-    public function getId()
+    public function getFile()
     {
-        return $this->file['_id'];
+        return (object) $this->file;
     }
 
     /**

tests/GridFS/BucketFunctionalTest.php

@@ -323,12 +323,63 @@ public function testGetDatabaseName()
         $this->assertEquals($this->getDatabaseName(), $this->bucket->getDatabaseName());
     }
 
-    public function testGetIdFromStream()
+    public function testGetFileDocumentForStreamWithReadableStream()
+    {
+        $metadata = ['foo' => 'bar'];
+        $id = $this->bucket->uploadFromStream('filename', $this->createStream('foobar'), ['metadata' => $metadata]);
+        $stream = $this->bucket->openDownloadStream($id);
+
+        $fileDocument = $this->bucket->getFileDocumentForStream($stream);
+
+        $this->assertEquals($id, $fileDocument->_id);
+        $this->assertSame('filename', $fileDocument->filename);
+        $this->assertSame(6, $fileDocument->length);
+        $this->assertSameDocument($metadata, $fileDocument->metadata);
+    }
+
+    public function testGetFileDocumentForStreamWithWritableStream()
+    {
+        $metadata = ['foo' => 'bar'];
+        $stream = $this->bucket->openUploadStream('filename', ['_id' => 1, 'metadata' => $metadata]);
+
+        $fileDocument = $this->bucket->getFileDocumentForStream($stream);
+
+        $this->assertEquals(1, $fileDocument->_id);
+        $this->assertSame('filename', $fileDocument->filename);
+        $this->assertSameDocument($metadata, $fileDocument->metadata);
+    }
+
+    /**
+     * @expectedException MongoDB\Exception\InvalidArgumentException
+     * @dataProvider provideInvalidStreamValues
+     */
+    public function testGetFileDocumentForStreamShouldRequireStreamResource($stream)
+    {
+        $this->bucket->getFileDocumentForStream($stream);
+    }
+
+    public function testGetFileIdForStreamWithReadableStream()
     {
         $id = $this->bucket->uploadFromStream('filename', $this->createStream('foobar'));
         $stream = $this->bucket->openDownloadStream($id);
 
-        $this->assertEquals($id, $this->bucket->getIdFromStream($stream));
+        $this->assertEquals($id, $this->bucket->getFileIdForStream($stream));
+    }
+
+    public function testGetFileIdForStreamWithWritableStream()
+    {
+        $stream = $this->bucket->openUploadStream('filename', ['_id' => 1]);
+
+        $this->assertEquals(1, $this->bucket->getFileIdForStream($stream));
+    }
+
+    /**
+     * @expectedException MongoDB\Exception\InvalidArgumentException
+     * @dataProvider provideInvalidStreamValues
+     */
+    public function testGetFileIdForStreamShouldRequireStreamResource($stream)
+    {
+        $this->bucket->getFileIdForStream($stream);
     }
 
     /**

tests/GridFS/WritableStreamFunctionalTest.php

@@ -62,7 +62,7 @@ public function testInsertChunksCalculatesMD5($input, $expectedMD5)
         $stream->close();
 
         $fileDocument = $this->filesCollection->findOne(
-            ['_id' => $stream->getId()],
+            ['_id' => $stream->getFile()->_id],
             ['projection' => ['md5' => 1, '_id' => 0]]
         );