feat:yii版腾讯云cos-filesystem

Author: vartruexuan

.gitignore

@@ -8,4 +8,5 @@ composer.lock
 .subsplit
 .php_cs.cache
 cghooks.lock
+.phpunit.result.cache
 

README.md

@@ -1,28 +1,63 @@
-# PHP Package Template
+<div style="text-align: center"> <h1>yii-filesystem-cos</h1> </div>  
 
-A template repository for PHP package.
+<a href="https://packagist.org/packages/vartruexuan/yii-filesystem-cos" rel="nofollow"><img src="https://badgen.net/github/tag/vartruexuan/yii-filesystem-cos" alt="Latest Version" data-canonical-src="https://badgen.net/github/tag/vartruexuan/yii-filesystem-cos" style="max-width: 100%;"></a>
+<a href="https://www.php.net" rel="nofollow"><img src="https://img.shields.io/badge/php-%3E=7.4-brightgreen.svg?maxAge=2592000" alt="Php Version" data-canonical-src="https://img.shields.io/badge/php-%3E=7.4-brightgreen.svg?maxAge=2592000" style="max-width: 100%;"></a>
 
-## Installing
+# 概述
+[creocoder/yii2-flysystem](https://github.com/creocoder/yii2-flysystem)
+
+# 安装
 
 ```shell
-$ composer require vendor/package -vvv
+composer require vartruexuan/yii-filesystem-cos
 ```
 
-## Usage
-
-TODO
-
-
-## Contributing
-
-You can contribute in one of three ways:
-
-1. File bug reports using the [issue tracker](https://github.com/vendor/package/issues).
-2. Answer questions or fix bugs on the [issue tracker](https://github.com/vendor/package/issues).
-3. Contribute new features or update the wiki.
-
-_The code contribution process is not very formal. You just need to make sure that you follow the PSR-0, PSR-1, and PSR-2 coding guidelines. Any new code contributions must be accompanied by unit tests where applicable._
-
-## License
-
-MIT
+# 使用
+
+## 配置组件
+
+```php
+// 加入配置组件
+'components' => [
+    'cos' => [
+        'class' => 'Vartruexuan\Yii2\Filesystem\Cos\Filesystem',
+        // 配置
+        'region' => 'gz',
+        'appId' => '1272757004',
+        'secretId' => 'AKIDd5HCSPDanlU1ILnzwc2sSmpcIqTY',
+        'secretKey' => '58kxufPxEiiSWIbeuUqxsYzDB3gAPVLwI',
+        'token' => null,
+        'timeout' => 60,
+        'connect_timeout' => 60,
+        'bucket' => 'bucket-1272757004',
+        'cdn' => 'https://bucket-1272757004.file.myqcloud.com',
+        'scheme' => 'https',
+        'read_from_cdn' => false,
+        'cdn_key' => '',
+        'encrypt' => false,
+    ],
+],
+```
+## 使用
+```php   
+bool Yii::$app->cos->->write('file.md', 'contents');
+bool Yii::$app->cos->->writeStream('file.md', fopen('path/to/your/local/file.jpg', 'r'));
+bool Yii::$app->cos->->update('file.md', 'new contents');
+bool Yii::$app->cos->->updateStram('file.md', fopen('path/to/your/local/file.jpg', 'r'));
+bool Yii::$app->cos->->rename('foo.md', 'bar.md');
+bool Yii::$app->cos->->copy('foo.md', 'foo2.md');
+bool Yii::$app->cos->->delete('file.md');
+bool Yii::$app->cos->->has('file.md');
+string|false Yii::$app->cos->->read('file.md');
+array Yii::$app->cos->->listContents();
+array Yii::$app->cos->->getMetadata('file.md');
+int Yii::$app->cos->->getSize('file.md');
+string Yii::$app->cos->->getUrl('file.md'); 
+string Yii::$app->cos->->getTemporaryUrl('file.md', date_create('2018-12-31 18:12:31')); 
+string Yii::$app->cos->->getMimetype('file.md');
+int Yii::$app->cos->->getTimestamp('file.md');
+string Yii::$app->cos->->getVisibility('file.md');
+bool Yii::$app->cos->->setVisibility('file.md', 'public'); //or 'private', 'default'
+// ...
+``` 
+[详细文档](https://flysystem.thephpleague.com/api/)

composer.json

@@ -1,15 +1,23 @@
 {
-    "name": "vartruexuan/php-package",
-    "description": "A PHP package template repository.",
+    "name": "vartruexuan/yii-filesystem-cos",
+    "description": "yii2 filesystem 腾讯云cos",
     "license": "MIT",
     "authors": [
         {
             "name": "vendor",
             "email": "name@domain.com"
         }
     ],
+    "keywords": [
+        "yii2",
+        "filesystem",
+        "files",
+        "cos"
+    ],
     "require": {
-        "php": ">=7.4"
+        "php": ">=7.4",
+        "creocoder/yii2-flysystem": "^1.1",
+        "freyo/flysystem-qcloud-cos-v5": "^2.2"
     },
     "require-dev": {
         "brainmaestro/composer-git-hooks": "^2.8",
@@ -21,18 +29,16 @@
     },
     "autoload": {
         "psr-4": {
-            "Vendor\\Package\\": "src"
+            "Vartruexuan\\Yii\\Filesystem\\Cos\\": "src"
         }
     },
     "extra": {
         "hooks": {
             "pre-commit": [
-                "composer check-style",
-                "composer test"
+
             ],
             "pre-push": [
-                "composer test",
-                "composer check-style"
+
             ]
         }
     },

src/.gitkeep

@@ -0,0 +1,73 @@
+<?php
+
+namespace Vartruexuan\Yii\Filesystem\Cos;
+
+use Freyo\Flysystem\QcloudCOSv5\Adapter;
+use Qcloud\Cos\Client;
+
+class Filesystem extends \creocoder\flysystem\Filesystem
+{
+    public $region;
+    public $appId;
+    public $secretId;
+    public $secretKey;
+    public $token;
+    public $timeout = 60;
+    public $connect_timeout = 60;
+    public $scheme = 'https';
+    public $bucket;
+    public $encrypt = false;
+    public $cdn = '';
+    public $cdn_key = '';
+    public $read_from_cdn = '';
+
+    public function init()
+    {
+        parent::init();
+    }
+
+
+    /**
+     * 设置适配器
+     *
+     * @return \League\Flysystem\AdapterInterface|void
+     *
+     * @date 2023/3/9
+     * @author vartruexuan
+     */
+    protected function prepareAdapter()
+    {
+        $client = new Client($this->getConfig());
+        return new Adapter($client, $this->getConfig());
+    }
+
+    /**
+     * 配置信息
+     *
+     * @return array
+     *
+     * @date 2023/3/9
+     * @author vartruexuan
+     */
+    protected function getConfig()
+    {
+        return [
+            'region' => $this->region,
+            'credentials' => [
+                'appId' => $this->appId,
+                'secretId' => $this->secretId,
+                'secretKey' => $this->secretKey,
+                'token' => $this->token,
+            ],
+            'timeout' => $this->timeout,
+            'connect_timeout' => $this->connect_timeout,
+            'bucket' => $this->bucket,
+            'cdn' => $this->cdn,
+            'scheme' => $this->scheme,
+            'read_from_cdn' => $this->read_from_cdn,
+            'cdn_key' => $this->cdn_key,
+            'encrypt' => $this->encrypt,
+        ];
+    }
+
+}