itinysun/laravel-cos

Flysystem sdk for Tencent Cos

v0.0.3 2025-04-22 13:38 UTC

Requires

• php: ^8.4
• illuminate/contracts: ^10.0||^11.0||^12.0
• league/flysystem: ^3.0
• qcloud/cos-sdk-v5: ^2.6
• spatie/laravel-data: ^4.15
• spatie/laravel-package-tools: ^1.16

Requires (Dev)

• laravel/pint: ^1.14
• nunomaduro/collision: ^8.1.1||^7.10.0
• orchestra/testbench: ^10.0.0||^9.0.0||^8.22.0
• pestphp/pest: ^3.8
• pestphp/pest-plugin-arch: ^3.0
• pestphp/pest-plugin-laravel: ^3.0
• roave/security-advisories: dev-latest

MIT

• Itinysun

• laravel
• laravel-cos
• Itinysun

README

一个使用腾讯云原生SDK实现的laravel文件存储扩展包,支持切片上传和下载

Installation 安装

使用composer 安装 You can install the package via composer:

composer require itinysun/laravel-cos

发布配置文件 You can publish the config file with:

php artisan vendor:publish --tag="cos-config"

This is the contents of the published config file:

return [
    'default' => [
        'app_id' => env('COS_APP_ID'),
        'secret_id' => env('COS_SECRET_ID'),
        'secret_key' => env('COS_SECRET_KEY'),
        'bucket' => env('COS_BUCKET'),  // 不带数字 app_id 后缀

        'region' => 'ap-beijing',

        // 可选，如果 bucket 为私有访问请打开此项
        'signed_url' => true,

        // 可选，是否使用 https，默认 false
        'use_https' => true,

        // 可选，自定义域名
        'domain' => '',

        // 可选，使用 CDN 域名时指定生成的 URL host
        'cdn' => '',

        'prefix' => '', // 全局路径前缀
    ],
];

Usage

//直接使用cos客户端
$laravelCos = new Itinysun\LaravelCos\Lib\LaravelCos('default');

// 上传文件
$laravelCos->uploadFile('test.txt', 'local/test.txt');

//使用facade
use Itinysun\LaravelCos\Facades\LaravelCos;
LaravelCos::uploadFile('test.txt', 'local/test.txt');

//使用laravel的storage
//首先在config/filesystems.php 中添加一个 disk,config_name 是上面配置文件中的key
        'cos_disk' => [
            'driver' => 'cos',
            'config_name' => 'cos_source',
        ],

//然后就可以使用laravel的storage了

Testing

扩展包使用TestBench进行测试,不需要安装laravel

### 发布测试文件
composer build

填写一个cos配置到 test_config.php , 切记这个文件不要提交到版本控制,已经在.gitignore中忽略了

```bash
### 运行测试
composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Credits

• Itinysun
• All Contributors

License

The MIT License (MIT). Please see License File for more information.