Uploads

MMO\edms\helpers · 1 symbol · generated 5 Oct 2026

class

Uploads

The uploads in progress, in a folder of their own ($folder), which only the server's account reads: the server keeps what an upload is and where its bytes are, a client only knows the upload's id. A chunk is only taken where the previous one stopped, and never past the size the upload started with. An upload that made its file remembers it until it expires, so a client that did not hear the answer to its last chunk gets it again.

class MMO\edms\helpers\Uploads

Namespace: MMO\edms\helpers

$uploads = new Uploads('/tmp/mmo.edms'); $upload = $uploads->start($user, 'report.pdf', 1048576); $uploads->append($upload, 0, $chunk);

Index

	folder readonly
	append($upload, $offset, $bytes)	Append $bytes to the upload, where it stopped
	finish($upload, $fileId)	The upload made the file $fileId: it remembers it, its bytes are the file's now
	get($id)
	getOf($id, $client)
	loopExpired($time)	The uploads nothing was received for since $time: those the garbage collector deletes
	metaFilename($id)
	remove($upload)	Forget the upload, deleting its bytes
	start($owner, $name, $size, $labels, $attachment, $temporary)	Start an upload of $size bytes
	take($upload)	Take the bytes of a complete upload: the upload is forgotten, the file it returns is the caller's to move or delete
	write($filename, $content)	Write $content to $filename, which only the server's account reads
	__construct($folder)

Properties1

folder

readonly

readonly string $folder

Type: string

Methods11

append($upload, $offset, $bytes)

Uploads.php:77

Append $bytes to the upload, where it stopped

function append(MMO\edms\helpers\Upload $upload, int $offset, string $bytes): int

$upload	Upload
$offset	int	where $bytes go: the number of bytes already received
$bytes	string
returns	int	the number of bytes received, $bytes included
throws		(409) if $offset is not where the upload stopped, (413) if $bytes go past its size

finish($upload, $fileId)

Uploads.php:54

The upload made the file $fileId: it remembers it, its bytes are the file's now

function finish(MMO\edms\helpers\Upload $upload, mixed $fileId): MMO\edms\helpers\Upload

$upload	Upload
$fileId	mixed
returns	Upload	the upload, finished

get($id)

Uploads.php:40

function get(string $id): ?MMO\edms\helpers\Upload

$id	string
returns	null \| Upload	the upload $id, null if there is none

getOf($id, $client)

Uploads.php:65

function getOf(string $id, MMO\oauth\interfaces\iClient $client): MMO\edms\helpers\Upload

$id	string
$client	iClient
returns	Upload	the upload $id of $client
throws		(404) if $client has no such upload: another's is not found either

loopExpired($time)

Uploads.php:126

The uploads nothing was received for since $time: those the garbage collector deletes

function loopExpired(int $time): Generator

$time	int
returns	Generator

metaFilename($id)

Uploads.php:133

protected function metaFilename(string $id): string

$id	string
returns	string

remove($upload)

Uploads.php:104

Forget the upload, deleting its bytes

function remove(MMO\edms\helpers\Upload $upload): void

$upload	Upload
returns	void

start($owner, $name, $size, $labels, $attachment, $temporary)

Uploads.php:29

Start an upload of $size bytes

function start( MMO\oauth\interfaces\iClient $owner, string $name, int $size, array $labels = [], ?string $attachment = null, bool $temporary = false ): MMO\edms\helpers\Upload

$owner	iClient
$name	string
$size	int
$labels = []	array	the ids of the labels the file will carry
$attachment = null	null \| string
$temporary = false	bool
returns	Upload

take($upload)

Uploads.php:115

Take the bytes of a complete upload: the upload is forgotten, the file it returns is the caller's to move or delete

function take(MMO\edms\helpers\Upload $upload): string

$upload	Upload
returns	string	the local file
throws		(409) if the upload is not complete

write($filename, $content)

Uploads.php:138

Write $content to $filename, which only the server's account reads

protected function write(string $filename, string $content): void

$filename	string
$content	string
returns	void

__construct($folder)

Uploads.php:22

function __construct(string $folder)

$folder

string

where the uploads are kept (created if needed)