Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vormkracht10/flysystem-uploadcare
Uploadcare Flysystem adapter
https://github.com/vormkracht10/flysystem-uploadcare
files flysystem flysystem-adapter laravel php uploadcare uploadcare-api uploads
Last synced: about 1 month ago
JSON representation
Uploadcare Flysystem adapter
- Host: GitHub
- URL: https://github.com/vormkracht10/flysystem-uploadcare
- Owner: vormkracht10
- License: mit
- Created: 2023-03-22T14:00:32.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-10T14:38:32.000Z (5 months ago)
- Last Synced: 2024-10-11T16:38:36.184Z (2 months ago)
- Topics: files, flysystem, flysystem-adapter, laravel, php, uploadcare, uploadcare-api, uploads
- Language: PHP
- Homepage:
- Size: 69.3 KB
- Stars: 16
- Watchers: 4
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Flysystem adapter for Uploadcare
[](https://packagist.org/packages/vormkracht10/flysystem-uploadcare)
[](https://github.com/vormkracht10/flysystem-uploadcare/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/vormkracht10/flysystem-uploadcare/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[](https://packagist.org/packages/vormkracht10/flysystem-uploadcare)
Flysystem adapter for Uploadcare with support for Laravel v9+.
## Installation
You can install the package via composer:
```bash
composer require vormkracht10/flysystem-uploadcare
```
Add the following config to the `disk` array in config/filesystems.php
```php
[
'uploadcare' => [
'driver' => 'uploadcare',
'public' => env('UPLOADCARE_PUBLIC_KEY'),
'secret' => env('UPLOADCARE_SECRET_KEY'),
'cdn' => env('UPLOADCARE_CDN') // Default https://ucarecdn.com
]
]
```
Then set the `FILESYSTEM_DISK` to `uploadcare` in your .env
```env
FILESYSTEM_DISK=uploadcare
```
## Examples
**Please note**: Since adding files to uploadcare always returns a unique id that will be used to retrieve files you might wanna use the `*GetUuid()` function(s) for writing files.
```php
$uuid = Storage::disk('uploadcare')->putGetUuid('example.txt', 'My notes.');
$uuid = Storage::disk('uploadcare')->putFileGetUuid('files', new File('/var/www/uploadcare-app/routes/newcontent.txt'));
$uuid = Storage::disk('uploadcare')->putFileAsGetUuid('files', new File('/var/www/uploadcare-app/routes/newcontent.txt'), 'my-awesome-name.txt');
```
**Get the content of a file**
```php
$contents = Storage::disk('uploadcare')->get('');
```
**Deleting a file:**
```php
Storage::disk('uploadcare')->delete('');
```
**Getting the mimetype of a file**
```php
$mimeType = Storage::disk('uploadcare')->mimeType('');
```
**Get the filesize of a file**
```php
$bytes = Storage::disk('uploadcare')->filesize('');
```
**Get the original filename**
```php
$info = Storage::disk('uploadcare')->fileInfo($result[0]);
$filename = $info->extraMetadata()['originalFilename'];
```
**Get a list of files**
Directories in uploadcare are stored with an "~"-sign at the end of a uuid. Getting files from a directory could be retreived
as follow:
```php
$files = Storage::disk('uploadcare')->files('0123a456-a0bc-0a1b-0ab1-0a1234a5b6c7~');
foreach ($files as $uuid) {
echo 'https://ucarecdn.com/' . $uuid .'
';
}
```
**Working with images?**
See [github.com/vormkracht10/php-uploadcare-transformations](https://github.com/vormkracht10/php-uploadcare-transformations)
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Vormkracht10](https://github.com/vormkracht10)
- [Mathieu](https://github.com/casmo)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.