siriusphp/upload

Framework agnostic upload library

Sirius\Upload

, _(*1)

Framework agnostic upload handler library., _(*2)

Features

1. Validates files against usual rules: extension, file size, image size (wdith, height, ratio). It uses Sirius Validation for this purpose.
2. Moves valid uploaded files into containers. Containers are usually local folders but you can implement your own or use other filesystem abstractions like Gaufrette or Flysystem.
3. Works with PSR7 UploadedFileInterface objects and with Symfony's UploadedFiles (see integrations).

Used by Bolt CMS, _(*3)

Elevator pitch

use Sirius\Upload\Handler as UploadHandler;
$uploadHandler = new UploadHandler('/path/to/local_folder');

// validation rules
$uploadHandler->addRule('extension', ['allowed' => ['jpg', 'jpeg', 'png']], '{label} should be a valid image (jpg, jpeg, png)', 'Profile picture');
$uploadHandler->addRule('size', ['max' => '20M'], '{label} should have less than {max}', 'Profile picture');

$result = $uploadHandler->process($_FILES['picture']); // ex: subdirectory/my_headshot.png

if ($result->isValid()) {
    // do something with the image like attaching it to a model etc
    try {
        $profile->picture = $result->name;
        $profile->save();
        $result->confirm(); // this will remove the .lock file
    } catch (\Exception $e) {
        // something wrong happened, we don't need the uploaded files anymore
        $result->clear();
        throw $e;
    }
} else {
    // image was not moved to the container, where are error messages
    $messages = $result->getMessages();
}

Links

• documentation
• changelog