https://github.com/jacobcyl/Aliyun-oss-storage
阿里云OSS laravel storage Filesystem adapter, 打造Laravel最好的OSS Storage扩展.
https://github.com/jacobcyl/Aliyun-oss-storage
Last synced: about 1 year ago
JSON representation
阿里云OSS laravel storage Filesystem adapter, 打造Laravel最好的OSS Storage扩展.
- Host: GitHub
- URL: https://github.com/jacobcyl/Aliyun-oss-storage
- Owner: jacobcyl
- License: mit
- Created: 2016-05-21T13:45:31.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2021-08-17T02:21:49.000Z (almost 5 years ago)
- Last Synced: 2025-04-23T23:39:15.477Z (about 1 year ago)
- Language: PHP
- Homepage: http://jacobcyl.github.io/Aliyun-oss-storage/
- Size: 59.6 KB
- Stars: 521
- Watchers: 16
- Forks: 160
- Open Issues: 58
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
- awesome-php-cn - jacobcyl/Aliyun-oss-storage - 阿里云OSS laravel扩展 (配置 Configuration / 第三方api Third Party APIs)
- awesome-php - jacobcyl/Aliyun-oss-storage - 阿里云OSS laravel扩展 (第三方API( Third Party APIs ))
README
# Aliyun-oss-storage for Laravel 5+
Aliyun oss filesystem storage adapter for laravel 5. You can use Aliyun OSS just like laravel Storage as usual.
借鉴了一些优秀的代码，综合各方，同时做了更多优化，将会添加更多完善的接口和插件，打造Laravel最好的OSS Storage扩展
## Inspired By
- [thephpleague/flysystem-aws-s3-v2](https://github.com/thephpleague/flysystem-aws-s3-v2)
- [apollopy/flysystem-aliyun-oss](https://github.com/apollopy/flysystem-aliyun-oss)
## Require
- Laravel 5+
- cURL extension
##Installation
In order to install AliOSS-storage, just add
"jacobcyl/ali-oss-storage": "^2.1"
to your composer.json. Then run `composer install` or `composer update`.
Or you can simply run below command to install:
"composer require jacobcyl/ali-oss-storage:^2.1"
Then in your `config/app.php` add this line to providers array:
```php
Jacobcyl\AliOSS\AliOssServiceProvider::class,
```
## Configuration
Add the following in app/filesystems.php:
```php
'disks'=>[
...
'oss' => [
'driver' => 'oss',
'access_id' => '',
'access_key' => '',
'bucket' => '',
'endpoint' => '', // OSS 外网节点或自定义外部域名
//'endpoint_internal' => '', // v2.0.4 新增配置属性，如果为空，则默认使用 endpoint 配置(由于内网上传有点小问题未解决，请大家暂时不要使用内网节点上传，正在与阿里技术沟通中)
'cdnDomain' => '', // 如果isCName为true, getUrl会判断cdnDomain是否设定来决定返回的url，如果cdnDomain未设置，则使用endpoint来生成url，否则使用cdn
'ssl' => // true to use 'https://' and false to use 'http://'. default is false,
'isCName' => // 是否使用自定义域名,true: 则Storage.url()会使用自定义的cdn或域名生成文件url， false: 则使用外部节点生成url
'debug' =>
],
...
]
```
Then set the default driver in app/filesystems.php:
```php
'default' => 'oss',
```
Ok, well! You are finish to configure. Just feel free to use Aliyun OSS like Storage!
## Usage
See [Larave doc for Storage](https://laravel.com/docs/5.2/filesystem#custom-filesystems)
Or you can learn here:
> First you must use Storage facade
```php
use Illuminate\Support\Facades\Storage;
```
> Then You can use all APIs of laravel Storage
```php
Storage::disk('oss'); // if default filesystems driver is oss, you can skip this step
//fetch all files of specified bucket(see upond configuration)
Storage::files($directory);
Storage::allFiles($directory);
Storage::put('path/to/file/file.jpg', $contents); //first parameter is the target file path, second paramter is file content
Storage::putFile('path/to/file/file.jpg', 'local/path/to/local_file.jpg'); // upload file from local path
Storage::get('path/to/file/file.jpg'); // get the file object by path
Storage::exists('path/to/file/file.jpg'); // determine if a given file exists on the storage(OSS)
Storage::size('path/to/file/file.jpg'); // get the file size (Byte)
Storage::lastModified('path/to/file/file.jpg'); // get date of last modification
Storage::directories($directory); // Get all of the directories within a given directory
Storage::allDirectories($directory); // Get all (recursive) of the directories within a given directory
Storage::copy('old/file1.jpg', 'new/file1.jpg');
Storage::move('old/file1.jpg', 'new/file1.jpg');
Storage::rename('path/to/file1.jpg', 'path/to/file2.jpg');
Storage::prepend('file.log', 'Prepended Text'); // Prepend to a file.
Storage::append('file.log', 'Appended Text'); // Append to a file.
Storage::delete('file.jpg');
Storage::delete(['file1.jpg', 'file2.jpg']);
Storage::makeDirectory($directory); // Create a directory.
Storage::deleteDirectory($directory); // Recursively delete a directory.It will delete all files within a given directory, SO Use with caution please.
// upgrade logs
// new plugin for v2.0 version
Storage::putRemoteFile('target/path/to/file/jacob.jpg', 'http://example.com/jacob.jpg'); //upload remote file to storage by remote url
// new function for v2.0.1 version
Storage::url('path/to/img.jpg') // get the file url
```
## Documentation
More development detail see [Aliyun OSS DOC](https://help.aliyun.com/document_detail/32099.html?spm=5176.doc31981.6.335.eqQ9dM)
## License
Source code is release under MIT license. Read LICENSE file for more information.