siriusphp / upload
Framework agnostic upload library
Installs: 514 391
Dependents: 13
Suggesters: 0
Security: 0
Stars: 224
Watchers: 14
Forks: 25
Open Issues: 0
Requires
- php: >=8.1
- siriusphp/validation: ^4.0
Requires (Dev)
- laminas/laminas-diactoros: ^3.3
- pestphp/pest: ^2.24
- pestphp/pest-plugin-drift: ^2.5
- phpstan/phpstan: ^1.10
- symfony/http-foundation: ^6.3
- symfony/mime: ^6.3
Suggests
- knplabs/gaufrette: Alternative filesystem abstraction library for upload destinations
- league/flysystem: To upload to different destinations, not just to the local file system
README
Framework agnostic upload handler library.
Features
- Validates files against usual rules: extension, file size, image size (wdith, height, ratio). It uses Sirius Validation for this purpose.
- 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.
- Works with PSR7
UploadedFileInterface
objects and with Symfony'sUploadedFile
s (see integrations).
Used by Bolt CMS
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(); }