docs: Update README and add annotation

alphasnow · alphasnow · commit b712ac8cad68 · 2021-11-09T15:37:02.000+08:00
diff --git a/.php-cs-fixer.php b/.php-cs-fixer.php
@@ -34,7 +34,6 @@
         'unary_operator_spaces' => true,
         'visibility_required' => [
             'elements' => [
-//                'const',
                 'method',
                 'property',
             ],
diff --git a/.travis.yml b/.travis.yml
diff --git a/README-CN.md b/README-CN.md
@@ -4,11 +4,11 @@
 Laravel 的阿里云对象存储 Storage 扩展
 
 [![Latest Stable Version](https://poser.pugx.org/alphasnow/aliyun-oss-laravel/v/stable)](https://packagist.org/packages/alphasnow/aliyun-oss-laravel)
-[![Code Coverage](https://scrutinizer-ci.com/g/alphasnow/aliyun-oss-laravel/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/alphasnow/aliyun-oss-laravel/?branch=master)
+[![Total Downloads](https://poser.pugx.org/alphasnow/aliyun-oss-laravel/downloads)](https://packagist.org/packages/alphasnow/aliyun-oss-laravel)
 [![Build Status](https://github.com/alphasnow/aliyun-oss-laravel/workflows/CI/badge.svg)](https://github.com/alphasnow/aliyun-oss-laravel/actions)
-[![Build Status](https://travis-ci.com/alphasnow/aliyun-oss-laravel.svg?branch=master)](https://travis-ci.com/alphasnow/aliyun-oss-laravel)
-[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Falphasnow%2Faliyun-oss-laravel.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Falphasnow%2Faliyun-oss-laravel?ref=badge_shield)
+[![Code Coverage](https://scrutinizer-ci.com/g/alphasnow/aliyun-oss-laravel/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/alphasnow/aliyun-oss-laravel/?branch=master)
 [![License](https://poser.pugx.org/alphasnow/aliyun-oss-laravel/license)](https://packagist.org/packages/alphasnow/aliyun-oss-laravel)
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Falphasnow%2Faliyun-oss-laravel.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Falphasnow%2Faliyun-oss-laravel?ref=badge_shield)
 
 这个包是封装 [aliyun-oss-flysystem](https://github.com/alphasnow/aliyun-oss-flysystem) 到 Laravel 来作为 Storage 使用.
 
diff --git a/README.md b/README.md
@@ -4,11 +4,11 @@ English | [简体中文](README-CN.md)
 Alibaba Cloud Object Storage Service For Laravel
 
 [![Latest Stable Version](https://poser.pugx.org/alphasnow/aliyun-oss-laravel/v/stable)](https://packagist.org/packages/alphasnow/aliyun-oss-laravel)
-[![Code Coverage](https://scrutinizer-ci.com/g/alphasnow/aliyun-oss-laravel/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/alphasnow/aliyun-oss-laravel/?branch=master)
+[![Total Downloads](https://poser.pugx.org/alphasnow/aliyun-oss-laravel/downloads)](https://packagist.org/packages/alphasnow/aliyun-oss-laravel)
 [![Build Status](https://github.com/alphasnow/aliyun-oss-laravel/workflows/CI/badge.svg)](https://github.com/alphasnow/aliyun-oss-laravel/actions)
-[![Build Status](https://travis-ci.com/alphasnow/aliyun-oss-laravel.svg?branch=master)](https://travis-ci.com/alphasnow/aliyun-oss-laravel)
-[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Falphasnow%2Faliyun-oss-laravel.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Falphasnow%2Faliyun-oss-laravel?ref=badge_shield)
+[![Code Coverage](https://scrutinizer-ci.com/g/alphasnow/aliyun-oss-laravel/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/alphasnow/aliyun-oss-laravel/?branch=master)
 [![License](https://poser.pugx.org/alphasnow/aliyun-oss-laravel/license)](https://packagist.org/packages/alphasnow/aliyun-oss-laravel)
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Falphasnow%2Faliyun-oss-laravel.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Falphasnow%2Faliyun-oss-laravel?ref=badge_shield)
 
 This package is a wrapper bridging [aliyun-oss-flysystem](https://github.com/alphasnow/aliyun-oss-flysystem) into Laravel as an available storage disk.
 
diff --git a/phpstan.neon b/phpstan.neon
@@ -1,9 +1,9 @@
 parameters:
-    level: 3
-
-    inferPrivatePropertyTypeFromConstructor: true
+    level: 6
 
     paths:
-        - %currentWorkingDirectory%/src
+        - src
 
     ignoreErrors:
+
+    checkMissingIterableValueType: false
diff --git a/src/Adapter.php b/src/Adapter.php
@@ -6,6 +6,9 @@
 use League\Flysystem\Config as FlysystemConfig;
 use OSS\OssClient;
 
+/**
+ * Class Adapter
+ */
 class Adapter extends BaseAdapter
 {
     /**
diff --git a/src/Config.php b/src/Config.php
@@ -4,6 +4,9 @@
 
 use Illuminate\Support\Collection;
 
+/**
+ * Class Config
+ */
 class Config extends Collection
 {
     /**
@@ -76,6 +79,10 @@ public function getOssClientParameters()
         ];
     }
 
+    /**
+     * @param string $url
+     * @return string
+     */
     public function correctUrl($url)
     {
         // correct internal domain
diff --git a/src/ServiceProvider.php b/src/ServiceProvider.php
@@ -10,10 +10,13 @@
 
 /**
  * Class ServiceProvider
- * @package AlphaSnow\AliyunOss
  */
 class ServiceProvider extends BaseServiceProvider
 {
+    /**
+     * @throws \Illuminate\Contracts\Container\BindingResolutionException
+     * @return void
+     */
     public function boot()
     {
         $this->mergeConfigFrom(
@@ -27,6 +30,9 @@ public function boot()
             });
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function register()
     {
         $this->app->bind('aliyun-oss.oss-client', function ($app, array $config) {

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,9 @@`
`6`	`6`	`use League\Flysystem\Config as FlysystemConfig;`
`7`	`7`	`use OSS\OssClient;`
`8`	`8`
	`9`	`+/**`
	`10`	`+ * Class Adapter`
	`11`	`+ */`
`9`	`12`	`class Adapter extends BaseAdapter`
`10`	`13`	`{`
`11`	`14`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,9 @@`
`4`	`4`
`5`	`5`	`use Illuminate\Support\Collection;`
`6`	`6`
	`7`	`+/**`
	`8`	`+ * Class Config`
	`9`	`+ */`
`7`	`10`	`class Config extends Collection`
`8`	`11`	`{`
`9`	`12`	`/**`
`@@ -76,6 +79,10 @@ public function getOssClientParameters()`
`76`	`79`	`];`
`77`	`80`	`}`
`78`	`81`
	`82`	`+ /**`
	`83`	`+ * @param string $url`
	`84`	`+ * @return string`
	`85`	`+ */`
`79`	`86`	`public function correctUrl($url)`
`80`	`87`	`{`
`81`	`88`	`// correct internal domain`
Original file line number	Diff line number	Diff line change
`@@ -10,10 +10,13 @@`
`10`	`10`
`11`	`11`	`/**`
`12`	`12`	`* Class ServiceProvider`
`13`		`- * @package AlphaSnow\AliyunOss`
`14`	`13`	`*/`
`15`	`14`	`class ServiceProvider extends BaseServiceProvider`
`16`	`15`	`{`
	`16`	`+ /**`
	`17`	`+ * @throws \Illuminate\Contracts\Container\BindingResolutionException`
	`18`	`+ * @return void`
	`19`	`+ */`
`17`	`20`	`public function boot()`
`18`	`21`	`{`
`19`	`22`	`$this->mergeConfigFrom(`
`@@ -27,6 +30,9 @@ public function boot()`
`27`	`30`	`});`
`28`	`31`	`}`
`29`	`32`
	`33`	`+ /**`
	`34`	`+ * {@inheritdoc}`
	`35`	`+ */`
`30`	`36`	`public function register()`
`31`	`37`	`{`
`32`	`38`	`$this->app->bind('aliyun-oss.oss-client', function ($app, array $config) {`