Documentation

Bucket
in package

Application

Bucket provides a public API for interacting with the GridFS files and chunks collections.

Constants

DEFAULT_BUCKET_NAME = 'fs'
DEFAULT_CHUNK_SIZE_BYTES = 261120
DEFAULT_TYPE_MAP = ['array' => \MongoDB\Model\BSONArray::class, 'document' => \MongoDB\Model\BSONDocument::class, 'root' => \MongoDB\Model\BSONDocument::class]
STREAM_WRAPPER_PROTOCOL = 'gridfs'

Properties

$bucketName : string
$chunkSizeBytes : int
$codec : DocumentCodec|null
$collectionWrapper : CollectionWrapper
$databaseName : string
$manager : Manager
$readConcern : ReadConcern
$readPreference : ReadPreference
$typeMap : array<string|int, mixed>
$writeConcern : WriteConcern

Methods

__construct() : mixed: Constructs a GridFS bucket.
__debugInfo() : array<string|int, mixed>: Return internal properties for debugging purposes.
delete() : void: Delete a file from the GridFS bucket.
deleteByName() : void: Delete all the revisions of a file name from the GridFS bucket.
downloadToStream() : void: Writes the contents of a GridFS file to a writable stream.
downloadToStreamByName() : void: Writes the contents of a GridFS file, which is selected by name and revision, to a writable stream.
drop() : void: Drops the files and chunks collections associated with this GridFS bucket.
find() : CursorInterface: Finds documents from the GridFS bucket's files collection matching the query.
findOne() : array<string|int, mixed>|object|null: Finds a single document from the GridFS bucket's files collection matching the query.
getBucketName() : string: Return the bucket name.
getChunksCollection() : Collection: Return the chunks collection.
getChunkSizeBytes() : int: Return the chunk size in bytes.
getDatabaseName() : string: Return the database name.
getFileDocumentForStream() : array<string|int, mixed>|object: Gets the file document of the GridFS file associated with a stream.
getFileIdForStream() : mixed: Gets the file document's ID of the GridFS file associated with a stream.
getFilesCollection() : Collection: Return the files collection.
getReadConcern() : ReadConcern: Return the read concern for this GridFS bucket.
getReadPreference() : ReadPreference: Return the read preference for this GridFS bucket.
getTypeMap() : array<string|int, mixed>: Return the type map for this GridFS bucket.
getWriteConcern() : WriteConcern: Return the write concern for this GridFS bucket.
openDownloadStream() : resource: Opens a readable stream for reading a GridFS file.
openDownloadStreamByName() : resource: Opens a readable stream to read a GridFS file, which is selected by name and revision.
openUploadStream() : resource: Opens a writable stream for writing a GridFS file.
registerGlobalStreamWrapperAlias() : void: Register an alias to enable basic filename access for this bucket.
rename() : void: Renames the GridFS file with the specified ID.
renameByName() : void: Renames all the revisions of a file name in the GridFS bucket.
uploadFromStream() : mixed: Writes the contents of a readable stream to a GridFS file.
createPathForFile() : string: Creates a path for an existing GridFS file.
createPathForUpload() : string: Creates a path for a new GridFS file, which does not yet have an ID.
getFilesNamespace() : string: Returns the names of the files collection.
getRawFileDocumentForStream() : object: Gets the file document of the GridFS file associated with a stream.
openDownloadStreamByFile() : resource: Opens a readable stream for the GridFS file.
registerStreamWrapper() : void: Registers the GridFS stream wrapper if it is not already registered.
resolveStreamContext() : CollectionWrapper, file: object}|CollectionWrapper, filename: string, options: array}: Create a stream context from the path and mode provided to fopen().

DEFAULT_BUCKET_NAME


    private
        mixed
    DEFAULT_BUCKET_NAME
    = 'fs'

DEFAULT_CHUNK_SIZE_BYTES


    private
        mixed
    DEFAULT_CHUNK_SIZE_BYTES
    = 261120

DEFAULT_TYPE_MAP


    private
        mixed
    DEFAULT_TYPE_MAP
    = ['array' => \MongoDB\Model\BSONArray::class, 'document' => \MongoDB\Model\BSONDocument::class, 'root' => \MongoDB\Model\BSONDocument::class]

STREAM_WRAPPER_PROTOCOL


    private
        mixed
    STREAM_WRAPPER_PROTOCOL
    = 'gridfs'

$bucketName


        private
            string
    $bucketName

$chunkSizeBytes


        private
            int
    $chunkSizeBytes

$codec


        private
            DocumentCodec|null
    $codec
     = null

$collectionWrapper


        private
            CollectionWrapper
    $collectionWrapper

$databaseName


        private
            string
    $databaseName

$manager


        private
            Manager
    $manager

$readConcern


        private
            ReadConcern
    $readConcern

$readPreference


        private
            ReadPreference
    $readPreference

$typeMap


        private
            array<string|int, mixed>
    $typeMap

$writeConcern


        private
            WriteConcern
    $writeConcern

__construct()

Constructs a GridFS bucket.


    public
                    __construct(Manager $manager, string $databaseName[, array<string|int, mixed> $options = [] ]) : mixed

Supported options:

bucketName (string): The bucket name, which will be used as a prefix for the files and chunks collections. Defaults to "fs".
chunkSizeBytes (integer): The chunk size in bytes. Defaults to 261120 (i.e. 255 KiB).
readConcern (MongoDB\Driver\ReadConcern): Read concern.
readPreference (MongoDB\Driver\ReadPreference): Read preference.
typeMap (array): Default type map for cursors and BSON documents.
writeConcern (MongoDB\Driver\WriteConcern): Write concern.

Parameters

$manager : Manager: Manager instance from the driver
$databaseName : string: Database name
$options : array<string|int, mixed> = []: Bucket options

__debugInfo()

Return internal properties for debugging purposes.


    public
                    __debugInfo() : array<string|int, mixed>

Return values

array<string|int, mixed>

delete()

Delete a file from the GridFS bucket.


    public
                    delete(mixed $id) : void

If the files collection document is not found, this method will still attempt to delete orphaned chunks.

Parameters

$id : mixed: File ID

deleteByName()

Delete all the revisions of a file name from the GridFS bucket.


    public
                    deleteByName(string $filename) : void

Parameters

$filename : string: Filename

downloadToStream()

Writes the contents of a GridFS file to a writable stream.


    public
                    downloadToStream(mixed $id, resource $destination) : void

Parameters

$id : mixed: File ID
$destination : resource: Writable Stream

downloadToStreamByName()

Writes the contents of a GridFS file, which is selected by name and revision, to a writable stream.


    public
                    downloadToStreamByName(string $filename, resource $destination[, array<string|int, mixed> $options = [] ]) : void

Supported options:

revision (integer): Which revision (i.e. documents with the same filename and different uploadDate) of the file to retrieve. Defaults to -1 (i.e. the most recent revision).

Revision numbers are defined as follows:

0 = the original stored file
1 = the first revision
2 = the second revision
etc…
-2 = the second most recent revision
-1 = the most recent revision

Parameters

$filename : string: Filename
$destination : resource: Writable Stream
$options : array<string|int, mixed> = []: Download options

drop()

Drops the files and chunks collections associated with this GridFS bucket.


    public
                    drop() : void

find()

Finds documents from the GridFS bucket's files collection matching the query.


    public
                    find([array<string|int, mixed>|object $filter = [] ][, array<string|int, mixed> $options = [] ]) : CursorInterface

Parameters

$filter : array<string|int, mixed>|object = []: Query by which to filter documents
$options : array<string|int, mixed> = []: Additional options

Return values

CursorInterface

findOne()

Finds a single document from the GridFS bucket's files collection matching the query.


    public
                    findOne([array<string|int, mixed>|object $filter = [] ][, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>|object|null

Parameters

$filter : array<string|int, mixed>|object = []: Query by which to filter documents
$options : array<string|int, mixed> = []: Additional options

Return values

array<string|int, mixed>|object|null

getBucketName()

Return the bucket name.


    public
                    getBucketName() : string

Return values

string

getChunksCollection()

Return the chunks collection.


    public
                    getChunksCollection() : Collection

Return values

Collection

getChunkSizeBytes()

Return the chunk size in bytes.


    public
                    getChunkSizeBytes() : int

Return values

int

getDatabaseName()

Return the database name.


    public
                    getDatabaseName() : string

Return values

string

getFileDocumentForStream()

Gets the file document of the GridFS file associated with a stream.


    public
                    getFileDocumentForStream(resource $stream) : array<string|int, mixed>|object

Parameters

$stream : resource: GridFS stream

Return values

array<string|int, mixed>|object

getFileIdForStream()

Gets the file document's ID of the GridFS file associated with a stream.


    public
                    getFileIdForStream(resource $stream) : mixed

Parameters

$stream : resource: GridFS stream

getFilesCollection()

Return the files collection.


    public
                    getFilesCollection() : Collection

Return values

Collection

getReadConcern()

Return the read concern for this GridFS bucket.


    public
                    getReadConcern() : ReadConcern

Return values

ReadConcern

getReadPreference()

Return the read preference for this GridFS bucket.


    public
                    getReadPreference() : ReadPreference

Return values

ReadPreference

getTypeMap()

Return the type map for this GridFS bucket.


    public
                    getTypeMap() : array<string|int, mixed>

Return values

array<string|int, mixed>

getWriteConcern()

Return the write concern for this GridFS bucket.


    public
                    getWriteConcern() : WriteConcern

Return values

WriteConcern

openDownloadStream()

Opens a readable stream for reading a GridFS file.


    public
                    openDownloadStream(mixed $id) : resource

Parameters

$id : mixed: File ID

Return values

resource

openDownloadStreamByName()

Opens a readable stream to read a GridFS file, which is selected by name and revision.


    public
                    openDownloadStreamByName(string $filename[, array<string|int, mixed> $options = [] ]) : resource

Supported options:

revision (integer): Which revision (i.e. documents with the same filename and different uploadDate) of the file to retrieve. Defaults to -1 (i.e. the most recent revision).

Revision numbers are defined as follows:

0 = the original stored file
1 = the first revision
2 = the second revision
etc…
-2 = the second most recent revision
-1 = the most recent revision

Parameters

$filename : string: Filename
$options : array<string|int, mixed> = []: Download options

Return values

resource

openUploadStream()

Opens a writable stream for writing a GridFS file.


    public
                    openUploadStream(string $filename[, array<string|int, mixed> $options = [] ]) : resource

Supported options:

_id (mixed): File document identifier. Defaults to a new ObjectId.
chunkSizeBytes (integer): The chunk size in bytes. Defaults to the bucket's chunk size.
metadata (document): User data for the "metadata" field of the files collection document.

Parameters

$filename : string: Filename
$options : array<string|int, mixed> = []: Upload options

Return values

resource

registerGlobalStreamWrapperAlias()


    public
                    registerGlobalStreamWrapperAlias(string $alias) : void

For applications that need to interact with GridFS using only a filename string, a bucket can be registered with an alias. Files can then be accessed using the following pattern:

gridfs://<bucket-alias>/<filename>

Read operations will always target the most recent revision of a file.

Parameters

$alias : string

rename()

Renames the GridFS file with the specified ID.


    public
                    rename(mixed $id, string $newFilename) : void

Parameters

$id : mixed: File ID
$newFilename : string: New filename

renameByName()

Renames all the revisions of a file name in the GridFS bucket.


    public
                    renameByName(string $filename, string $newFilename) : void

Parameters

$filename : string: Filename
$newFilename : string: New filename

uploadFromStream()

Writes the contents of a readable stream to a GridFS file.


    public
                    uploadFromStream(string $filename, resource $source[, array<string|int, mixed> $options = [] ]) : mixed

Supported options:

_id (mixed): File document identifier. Defaults to a new ObjectId.
chunkSizeBytes (integer): The chunk size in bytes. Defaults to the bucket's chunk size.
metadata (document): User data for the "metadata" field of the files collection document.

Parameters

$filename : string: Filename
$source : resource: Readable stream
$options : array<string|int, mixed> = []: Stream options

Return values

mixed —

ID of the newly created GridFS file

createPathForFile()

Creates a path for an existing GridFS file.


    private
                    createPathForFile(object $file) : string

Parameters

$file : object: GridFS file document

Return values

string

createPathForUpload()

Creates a path for a new GridFS file, which does not yet have an ID.


    private
                    createPathForUpload() : string

Return values

string

getFilesNamespace()

Returns the names of the files collection.


    private
                    getFilesNamespace() : string

Return values

string

getRawFileDocumentForStream()

Gets the file document of the GridFS file associated with a stream.


    private
                    getRawFileDocumentForStream(resource $stream) : object

This returns the raw document from the StreamWrapper, which does not respect the Bucket's type map.

Parameters

$stream : resource: GridFS stream

Return values

object

openDownloadStreamByFile()

Opens a readable stream for the GridFS file.


    private
                    openDownloadStreamByFile(object $file) : resource

Parameters

$file : object: GridFS file document

Return values

resource

registerStreamWrapper()

Registers the GridFS stream wrapper if it is not already registered.


    private
                    registerStreamWrapper() : void

resolveStreamContext()

Create a stream context from the path and mode provided to fopen().


    private
                    resolveStreamContext(string $path, string $mode, array{revision?: int, chunkSizeBytes?: int} $context) : CollectionWrapper, file: object}|CollectionWrapper, filename: string, options: array}

Parameters

$path : string: The full url provided to fopen(). It contains the filename. gridfs://database_name/collection_name.files/file_name
$mode : string
$context : array{revision?: int, chunkSizeBytes?: int}: The options provided to fopen()

Return values

CollectionWrapper, file: object}|CollectionWrapper, filename: string, options: array}

Bucket in package Application

Table of Contents

Constants

Properties

Methods

Constants

DEFAULT_BUCKET_NAME

DEFAULT_CHUNK_SIZE_BYTES

DEFAULT_TYPE_MAP

STREAM_WRAPPER_PROTOCOL

Properties

$bucketName

$chunkSizeBytes

$codec

$collectionWrapper

$databaseName

$manager

$readConcern

$readPreference

$typeMap

$writeConcern

Methods

__construct()

Parameters

Tags

__debugInfo()

Tags

Return values

delete()

Parameters

Tags

deleteByName()

Parameters

Tags

downloadToStream()

Parameters

Tags

downloadToStreamByName()

Parameters

Tags

drop()

Tags

find()

Parameters

Tags

Return values

findOne()

Parameters

Tags

Return values

getBucketName()

Return values

getChunksCollection()

Return values

getChunkSizeBytes()

Return values

getDatabaseName()

Return values

getFileDocumentForStream()

Parameters

Tags

Return values

getFileIdForStream()

Parameters

Tags

getFilesCollection()

Return values

getReadConcern()

Tags

Return values

getReadPreference()

Return values

getTypeMap()

Return values

getWriteConcern()

Tags

Return values

openDownloadStream()

Parameters

Tags

Bucket
in package

Application