FileService<`Tk`,`Tv`>

Interface for storing and retrieving uploaded files.

interface FileService<Tk,Tv>

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.
`?Tv`	`read`(`mixed $id`) Gets a stored file.
`Traversable`<`Tv`>	`readAll`(`ConstMap<string,mixed> $criteria`) Finds several files by some arbitrary criteria.
`resource`	`resource`(`mixed $id`) Gets a stream resource for the given ID.
`Tk`	`store`(`UploadedFileInterface $file`, `ConstMap<string,mixed> $metadata`) Stores an uploaded file.
`void`	`stream`(`Tv $file`, `StreamInterface $stream`) Efficiently writes the contents of a file to a Stream.

abstract public function delete(mixed $id)

Deletes a stored file.

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

abstract 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

abstract 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
`?Tv`	The stored file

abstract 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`<`Tv`>	The objects found

abstract public function resource(mixed $id)

Gets a 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 stream

abstract 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
`Tk`	The document ID of the stored file

abstract public function stream(Tv $file, StreamInterface $stream)

Efficiently writes the contents of a file to a Stream.

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