sokil / php-upload
File uploader
Requires
- php: >=5.3
- knplabs/gaufrette: >=0.2.0
Requires (Dev)
- phpunit/phpunit: >=3.7.38 <6.0
- satooshi/php-coveralls: >=0.7.1 <2.0
Suggests
- sokil/file-storage-bundle: Symfony bundle
README
Installation
You can install library through Composer:
{ "require": { "sokil/php-upload": "dev-master" } }
Related packages
- https://github.com/sokil/upload.js - frontend component. Implements uploading wile without reloading page with upload progress
- https://github.com/sokil/php-upload-sandbox - Sandbox to test backend (this library) and frontend (https://github.com/sokil/upload.js). To start testing just clone repo and start server.
- https://github.com/sokil/FileStorageBundle - Symfony bundle
Quick start
First create HTML:
<input type="file" name="attachment" />
Then add PHP code to upload action to upload file to local system:
<?php $uploader = new \Sokil\Upload\Handler([ 'fieldName' => 'attachment', ]); $uploader->moveLocal(__DIR__ . '/uploads/');
Also library supports Gaufrette filesistems. Read about Gaufrette at https://github.com/KnpLabs/Gaufrette. Read abount configuring Gaufrette filesystems in Symfony at https://github.com/KnpLabs/KnpGaufretteBundle.
To upload file into Gaufrette Filesystem:
<?php $filesystem = new \Gaufrette\Filesystem(new \Gaufrette\Adapter\Local( __DIR__ . '/attachments/' )); $uploader = new \Sokil\Upload\Handler([ 'fieldName' => 'attachment', ]); $uploader->move($filesystem);
Upload transports
Stream upload
Nginx upload
Multipart Form Data Transport
Nginx configuration
During standard upload file is moved to php's temp dir, and then moved to target
destination using move_uploaded_file
. If this dirs on different
physical drives, some time will be spend to move file physically between devices.
There is another reason when nginx + php-fpm stack used.
During upload nginx stored file to its own temp dir. After passing control to
php-fpm, nginx moves cached file to php's temp dir, and than php moves file
to destination using move_uploaded_file
. So file copied three times, and
maybe on different physical devices.
This method moves file directly to configured drive, so in php code only rename of file required.
Using upload_module and upload_progress_module (nginx < 1.3.9)
This method is deprecated due to compilation errors of upload_module
on nginx versions 1.3.9+.
Nginx must be compiled with this modules:
- Upload module: https://github.com/vkholodkov/nginx-upload-module
--add-module=/path/to/nginx-upload-module
- Upload progress module: https://github.com/masterzen/nginx-upload-progress-module
--add-module=/path/to/nginx-upload-progress-module
Example of nginx configuration to handle upload and progress:
upload_progress upload 5m;
server
{
location @php
{
fastcgi_pass 127.0.0.1:9000;
fastcgi_param SCRIPT_FILENAME $document_root/app.php;
include /etc/nginx/fastcgi_params;
}
location /upload
{
upload_pass @php;
upload_store %PATH_TO_STORAGE_DIRECTORY%;
upload_pass_args on;
upload_max_file_size 0;
upload_set_form_field $upload_field_name.name "$upload_file_name";
upload_set_form_field $upload_field_name.type "$upload_content_type";
upload_set_form_field $upload_field_name.tmp_name "$upload_tmp_path";
upload_aggregate_form_field $upload_field_name.size "$upload_file_size";
track_uploads upload 5s;
}
location /progress
{
report_uploads upload;
}
}
Using client_body_in_file_only directive
See more info at http://nginx.org/en/docs/http/ngx_http_core_module.html#client_body_in_file_only
Currently not supported