MongoFileService

File upload service backed by GridFS.

class MongoFileService implements FileService<ObjectID,stdClass>

use MongoHelper

Requires the mongodb/mongodb composer package to be installed.

Copyright: 2015-2016 Appertly

License: Apache-2.0

Constructors / Destructors

Public
Returns	Signature and Description
`void`	`__construct`(`Bucket $bucket`) Creates a new MongoFileService

Instance Methods

Public
Returns	Signature and Description
`void`	`delete`(`mixed $id`) Deletes a stored file.
`StreamInterface`	`messageStream`(`mixed $id`) Gets the file as a PSR-7 Stream.
`?stdClass`	`read`(`mixed $id`) Gets a stored file.
`Traversable`<`stdClass`>	`readAll`(`ConstMap<string,mixed> $criteria`) Finds several files by some arbitrary criteria.
`resource`	`resource`(`mixed $id`) Gets a readable stream resource for the given ID.
`ObjectID`	`store`(`UploadedFileInterface $file`, `ConstMap<string,mixed> $metadata`) Stores an uploaded file.
`void`	`stream`(`stdClass $file`, `StreamInterface $stream`) Efficiently writes the contents of a file to a Stream.

Protected
Returns	Signature and Description
`Ta`	`doExecute`<`Ta`>(`(function(Bucket):Ta) $cb`) Executes something in the context of the collection.
`Ta`	`ensure`<`Ta`>(`mixed $id`, `?Ta $document`) Makes sure a document isn't null.
`UTCDateTime`	`now`() Gets the current time.
`?UTCDateTime`	`toDate`(`mixed $date`) Tries to parse a date.
`ObjectID`	`toId`(`mixed $id`) Transforms a literal into a MongoDB ObjectId.
`ConstVector`<`ObjectID`>	`toIds`(`ConstVector<mixed> $ids`) Transforms literals into MongoDB ObjectIds.

Method Details

__construct

public function __construct(Bucket $bucket)

Creates a new MongoFileService

Parameters
Name	Type	Description
`$bucket`	`Bucket`	The GridFS Bucket

delete

public function delete(mixed $id)

Deletes a stored file.

Parameters
Name	Type	Description
`$id`	`mixed`	The document identifier, either a string or `ObjectID`

Throws
Type	Conditions
`Unreachable`	If the connection fails
`Unretrievable`	If the document doesn't exist
`Generic`	If any other database problem occurs

doExecute

protected function doExecute<Ta>((function(Bucket):Ta) $cb)

Executes something in the context of the collection.

Exceptions are caught and translated.

Parameters
Name	Type	Description
`$cb`	`(function(Bucket):Ta)`	The closure to execute, takes the Bucket

Returns
Type	Description
`Ta`	Whatever the function returns, this method also returns

Throws
Type	Conditions
`Exception`	If a database problem occurs

ensure

Inherited from MongoHelper

protected function ensure<Ta>(mixed $id, ?Ta $document)

Makes sure a document isn't null.

Parameters
Name	Type	Description
`$id`	`mixed`	The document identifier, either a `\MongoDB\BSON\ObjectID` or string
`$document`	`?Ta`	The document to check

Returns
Type	Description
`Ta`	Returns `$document`

Throws
Type	Conditions
`Unretrievable`	if the document is null

messageStream

public function messageStream(mixed $id)

Gets the file as a PSR-7 Stream.

Parameters
Name	Type	Description
`$id`	`mixed`	The document identifier, either a string or `ObjectID`

Returns
Type	Description
`StreamInterface`	The readable stream

Throws
Type	Conditions
`Unreachable`	If the connection fails
`Unretrievable`	If the document doesn't exist
`Generic`	If any other database problem occurs

now

Inherited from MongoHelper

protected function now()

Gets the current time.

Returns
Type	Description
`UTCDateTime`	The current time

read

public function read(mixed $id)

Gets a stored file.

Parameters
Name	Type	Description
`$id`	`mixed`	The document identifier, either a string or `ObjectID`

Returns
Type	Description
`?stdClass`	The stored file

Throws
Type	Conditions
`Unreachable`	If the connection fails
`Unretrievable`	If the result cannot be retrieved
`Generic`	If any other database problem occurs

readAll

public function readAll(ConstMap<string,mixed> $criteria)

Finds several files by some arbitrary criteria.

Parameters
Name	Type	Description
`$criteria`	`ConstMap`<`string`,`mixed`>	Field to value pairs

Returns
Type	Description
`Traversable`<`stdClass`>	The objects found

Throws
Type	Conditions
`Unreachable`	If the connection fails
`Unretrievable`	If the result cannot be retrieved
`Generic`	If any other database problem occurs

resource

public function resource(mixed $id)

Gets a readable stream resource for the given ID.

Parameters
Name	Type	Description
`$id`	`mixed`	The document identifier, either a string or `ObjectID`

Returns
Type	Description
`resource`	The readable stream

Throws
Type	Conditions
`Unreachable`	If the connection fails
`Unretrievable`	If the document doesn't exist
`Generic`	If any other database problem occurs

store

public function store(UploadedFileInterface $file, ConstMap<string,mixed> $metadata)

Stores an uploaded file.

You should specify contentType in the metadata Map.

Parameters
Name	Type	Description
`$file`	`UploadedFileInterface`	The uploaded file
`$metadata`	`ConstMap`<`string`,`mixed`>	Any additional fields to persist. At the very least, try to supply `contentType`.

Returns
Type	Description
`ObjectID`	The document ID of the stored file

Throws
Type	Conditions
`Unreachable`	If the connection fails
`Violating`	If a constraint is violated
`Generic`	If any other database problem occurs

stream

public function stream(stdClass $file, StreamInterface $stream)

Efficiently writes the contents of a file to a Stream.

Parameters
Name	Type	Description
`$file`	`stdClass`	The file
`$stream`	`StreamInterface`	The stream

Throws
Type	Conditions
`Unreachable`	If the connection fails
`Violating`	If a constraint is violated
`Generic`	If any other database problem occurs

toDate

Inherited from MongoHelper

protected function toDate(mixed $date)

Tries to parse a date.

Parameters
Name	Type	Description
`$date`	`mixed`	The possible string date value, a string, a `\DateTimeInterface`, or a `\MongoDB\BSON\UTCDateTime`

Returns
Type	Description
`?UTCDateTime`	The MongoDB datetime or null

toId

Inherited from MongoHelper

protected function toId(mixed $id)

Transforms a literal into a MongoDB ObjectId.

Parameters
Name	Type	Description
`$id`	`mixed`	If it's an `ObjectID`, returns that, otherwise creates a new `ObjectID`.

Returns
Type	Description
`ObjectID`	The ObjectID

toIds

Inherited from MongoHelper

protected function toIds(ConstVector<mixed> $ids)

Transforms literals into MongoDB ObjectIds.

Parameters
Name	Type	Description
`$ids`	`ConstVector`<`mixed`>	Goes through each entry, converts to `ObjectID`

Returns
Type	Description
`ConstVector`<`ObjectID`>	The ObjectIDs