https://github.com/slince/upload
Process file uploads with multiple and extensible validation rules.
https://github.com/slince/upload
file-upload file-upload-validate file-uploader upload validation
Last synced: 6 months ago
JSON representation
Process file uploads with multiple and extensible validation rules.
- Host: GitHub
- URL: https://github.com/slince/upload
- Owner: slince
- License: mit
- Created: 2014-10-23T08:50:56.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2023-03-23T15:32:06.000Z (over 2 years ago)
- Last Synced: 2025-03-30T00:31:38.173Z (7 months ago)
- Topics: file-upload, file-upload-validate, file-uploader, upload, validation
- Language: PHP
- Homepage:
- Size: 146 KB
- Stars: 4
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FileUpload
[](https://app.travis-ci.com/github/slince/upload)
[](https://codecov.io/github/slince/upload)
[](https://packagist.org/packages/slince/upload)
[](https://scrutinizer-ci.com/g/slince/upload/?branch=master)
Process uploaded files with multiple and extensible validation rules.
## Installation
Install via composer
```bash
$ composer require slince/upload
```
## Quick view
```php
$builder = new Slince\Upload\UploadHandlerBuilder(); //create a builder.
$handler = $builder
->saveTo(__DIR__ . '/dst')
->getHandler();
$files = $handler->handle();
print_r($files);
```
## Usage
Assume files are uploaded with this HTML form:
```html
```
Server:
```php
$builder = new Slince\Upload\UploadHandlerBuilder(); //create a builder.
$handler = $builder
->overwrite(true) // open overwrite mode.
//Custom namer
->naming(function (UploadedFile $file) {
return date('Y/md') . '/' . uniqid() . '.' . $file->getClientOriginalExtension();
})
//add constraints
->sizeBetween('10m', '20m')
->allowExtensions(['jpg', 'txt'])
->allowMimeTypes(['image/*', 'text/plain'])
->saveTo(__DIR__ . '/dst') //save to local
->getHandler();
$files = $handler->handle();
foreach ($files as $file) {
$uploadedFile = $file->getUploadedFile();
if ($file->isUploaded()) {
echo $uploadedFile->getClientOriginalName() . ' upload ok, path:' . $file->getMetadata('spl_file')->getPathname();
} else {
echo $uploadedFile->getClientOriginalName() . ' upload error: ' . $file->getException()->getMessage();
}
echo PHP_EOL;
}
```
File metadata `$file->getMetadata('metadata name')` is provided by storage layer.
if you are using `Local`, the file has a metadata named 'spl_file', it is an instance of `SplFileInfo`.
If you want access attributes of the file saved in the client, you can use like this.
```php
$files['foo']->getUploadedFile()->getClientOriginalName(); // original name
$files['bar']['baz'][0]->getUploadedFile()->getClientOriginalExtension(); // original extension
$files['bar']['baz'][1]->getUploadedFile()->getClientMimeType(); // original mime type
```
### Integration with [flysystem](https://github.com/thephpleague/flysystem)
```php
function createS3Flysystem()
{
$client = new Aws\S3\S3Client([
'credentials' => [
'key' => 'your-key',
'secret' => 'your-secret'
],
'region' => 'your-region',
'version' => 'latest|version',
]);
$adapter = new League\Flysystem\AwsS3v3\AwsS3Adapter($client, 'your-bucket-name');
$flysystem = new League\Flysystem\Filesystem($adapter);
return $flysystem;
}
$builder = new Slince\Upload\UploadHandlerBuilder(); //create a builder.
$handler = $builder->setFilesystem(new Slince\Upload\Filesystem\Flysystem(createS3Flysystem()))
->getHandler();
$files = $handler->handle();
print_r($files);
```
All files will be automatically uploaded to AWS S3.
## License
The MIT license. See [MIT](https://opensource.org/licenses/MIT)