kodus/tempkit-fs

This package is abandoned and no longer maintained. The author suggests using the kodus/tempkit package instead.

Implements a server-side strategy for collection and recovery of PSR-7 UploadedFile objects

dev-master 2017-09-08 12:26 UTC

Requires

• php: >= 7
• kodus/uuid-v4: ^1.1
• league/flysystem: ^1
• psr/http-message: ^1.0

Requires (Dev)

• codeception/codeception: ^2.2
• league/flysystem-memory: ^1
• zendframework/zend-diactoros: ^1.4

MIT

README

This package implements a server-side strategy for temporary collection and recovery of PSR-7 UploadedFile objects as files stored in a Flysystem file-system.

This is a fork of kodus/tempkit which implements the same thing using the regular file-system API in PHP.

You can use this service to implement controllers that collect uploaded files posted asynchronously by a browser and return the temporary file UUIDs, then, on completion, recover the uploaded files and move them to permanent storage.

The filename and MIME-type (as posted by the client) will be preserved.

Unrecovered files are automatically flushed after a defined expiration period.

Usage

Bootstrap the service using an existing Flysystem FilesystemInterface instance:

$service = new TempFileService($filesystem, __DIR__ . '/temp');

In your asynchronous file post-controller, collect posted files and return UUIDs:

$uuids = [];

foreach ($request->getUploadedFiles() as $file) {
    $uuids[] = $service->collect($file);
}

echo json_encode($uuids);

In your form post-controller, recover the collected files:

foreach ($uuids as $uuid) {
    $file = $service->recover($uuid);

    // get information about recovered file:

    $filename = $file->getClientFilename();
    $media_type = $file->getClientMediaType();

    // move recovered file into permanent storage:

    $file->moveTo(__DIR__ . '/files/' . $file->getClientFilename());
}

Note that, if you don't flush the temporary file, it will of course be garbage-collected after the defined expiration period.

Also, if you manually rename or move the temporary file, the JSON meta-data file will be collected and flushed for you immediately when the TempFile instance is destroyed.

Refer to TempFileService for inline documentation.