cloudycity/laravel-filesystem-obs

huawei cloud obs filesystem storage for laravel 5+

v3.3.1 2021-07-10 08:10 UTC

Requires

• php: ^7.1|^8.0
• guzzlehttp/guzzle: ^7.0
• laravel/framework: ^5.2|^6.0|^7.0|^8.0
• league/flysystem: ^1.1

MIT

• storage
• laravel
• filesystems
• OBS
• huawei

README

Huawei Cloud OBS storage for Laravel based on cloudycity/laravel-filesystem-obs.

Only compatible with Guzzle v7. If you must use Guzzle v6, check this out dscmall/laravel-filesystem-obs.

Requirement

• PHP >= 7.1.3

Installation

$ composer require "cloudycity/laravel-filesystem-obs:^3.3.1" -vvv

Configuration

1. Add obs config to config\filesystems.php.

 <?php

 return [
    'disks' => [
        //...
        'obs' => [
            'driver' => 'obs',
            'key' => env('OBS_ACCESS_ID'), // <Your Huawei OBS AccessKeyId>
            'secret' => env('OBS_ACCESS_KEY'), // <Your Huawei OBS AccessKeySecret>
            'bucket' => env('OBS_BUCKET'), // <OBS bucket name>
            'endpoint' => env('OBS_ENDPOINT'), // <the endpoint of OBS, E.g: (https:// or http://).obs.cn-east-2.myhuaweicloud.com | custom domain, E.g:img.abc.com> OBS 外网节点或自定义外部域名
            'cdn_domain' => env('OBS_CDN_DOMAIN'), //<CDN domain, cdn域名> 如果isCName为true, getUrl会判断cdnDomain是否设定来决定返回的url，如果cdnDomain未设置，则使用endpoint来生成url，否则使用cdn
            'ssl_verify' => env('OBS_SSL_VERIFY'), // <true|false> true to use 'https://' and false to use 'http://'. default is false,
            'debug' => env('APP_DEBUG'), // <true|false>
        ],
        //...
     ]
 ];

1. (Optional) If you are using laravel which version < 5.5, you need register the Obs\ObsServiceProvider in your config/app.php file:

'providers' => [
    // Other service providers...
    Obs\ObsServiceProvider::class,
],

Usage

$disk = Storage::disk('obs');

// create a file
$disk->put('avatars/filename.jpg', $fileContents);

// check if a file exists
$exists = $disk->has('file.jpg');

// get timestamp
$time = $disk->lastModified('file1.jpg');
$time = $disk->getTimestamp('file1.jpg');

// copy a file
$disk->copy('old/file1.jpg', 'new/file1.jpg');

// move a file
$disk->move('old/file1.jpg', 'new/file1.jpg');

// get file contents
$contents = $disk->read('folder/my_file.txt');

// fetch url content
$file = $disk->fetch('folder/save_as.txt', $fromUrl);

// get file url
$url = $disk->getUrl('folder/my_file.txt');

// get file upload token
$token = $disk->getUploadToken('folder/my_file.txt');
$token = $disk->getUploadToken('folder/my_file.txt', 3600);

// get private url
$url = $disk->privateDownloadUrl('folder/my_file.txt');

Full API documentation.

License

MIT