Merge pull request #4 from pkg6/docs

Docs

Author: chihqiang

.gitignore

@@ -1,7 +1,6 @@
 *.DS_Store
 .scannerwork
 /vendor
-/*.php
 /.idea
 /*.log
 /*.pid
@@ -10,3 +9,4 @@
 /composer.lock
 .php_cs.cache
 .phpunit.result.cache
+.php-cs-fixer.cache

.php-cs-fixer.php

@@ -0,0 +1,46 @@
+<?php
+
+$header = <<<EOF
+This file is part of the pkg6/cloud-print.
+
+(c) pkg6 <https://github.com/pkg6>
+
+This source file is subject to the MIT license that is bundled.
+EOF;
+
+$finder = PhpCsFixer\Finder::create()
+    ->in([__DIR__ . '/src',__DIR__ . '/tests']);
+
+return (new PhpCsFixer\Config())
+    ->setRules([
+        '@PSR2' => true,
+        'header_comment' => array('header' => $header),
+        'array_syntax' => ['syntax' => 'short'],
+        'binary_operator_spaces' => true,
+        'single_line_after_imports' => true,
+        'blank_line_before_statement' => ['statements' => ['return']],
+        'cast_spaces' => true,
+        'concat_space' => ['spacing' => 'one'],
+        'no_singleline_whitespace_before_semicolons' => true,
+        'not_operator_with_space' => true,
+        'no_unused_imports' => true,
+        'phpdoc_align' => false,
+        'phpdoc_indent' => true,
+        'phpdoc_no_access' => true,
+        'phpdoc_no_alias_tag' => true,
+        'phpdoc_no_package' => true,
+        'phpdoc_scalar' => true,
+        'phpdoc_separation' => true,
+        'phpdoc_summary' => true,
+        'phpdoc_to_comment' => true,
+        'phpdoc_trim' => true,
+        'single_blank_line_at_eof' => true,
+        'ternary_operator_spaces' => true,
+        'ordered_imports' => [
+            'sort_algorithm' => 'alpha',
+            'imports_order' => ['const', 'class', 'function'],
+        ],
+        'no_extra_blank_lines' => true,
+        'no_whitespace_in_blank_line' => true,
+    ])
+    ->setFinder($finder);

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 open-package
+Copyright (c) 2023 pkg6
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

composer.json

@@ -36,7 +36,8 @@
   },
   "require-dev": {
     "phpunit/phpunit": "^6|^7|^8|^9",
-    "mockery/mockery": "^1.2.3"
+    "mockery/mockery": "^1.2.3",
+    "friendsofphp/php-cs-fixer": "^3.9"
   },
   "autoload": {
     "psr-4": {
@@ -47,5 +48,16 @@
     "psr-4": {
       "Pkg6\\cloudPrint\\Tests\\": "tests/"
     }
+  },
+  "scripts": {
+    "fresh": [
+      "rm -rf vendor composer.lock",
+      "composer install"
+    ],
+    "tests": [
+      "php ./vendor/bin/phpunit"
+    ],
+    "fixer": "vendor/bin/php-cs-fixer fix",
+    "try-fixer": "vendor/bin/php-cs-fixer fix --diff --dry-run"
   }
 }

doc/printcenter.md renamed to docs/365智能云打印.md

@@ -0,0 +1,12 @@
+## 支持厂商
+
+- [飞鹅云](http://help.feieyun.com/document.php) 
+- [芯烨云](https://www.xpyun.net/open/index.html)
+- [易联云](https://www.yilianyun.net/)
+- [快递100](https://api.kuaidi100.com/document/5f0ff6a32977d50a94e10235)
+- [映美云](http://open.jolimark.com/)
+- [佳博云](https://dev.poscom.cn/)
+- [365智能云打印](http://printcenter.cn/)
+- [中午云](http://www.zhongwu.co/)
+- [优声云](https://www.ushengyun.com/)
+

docs/Home.md

@@ -1,5 +1,13 @@
 <?php
 
+/*
+ * This file is part of the pkg6/cloud-print.
+ *
+ * (c) pkg6 <https://github.com/pkg6>
+ *
+ * This source file is subject to the MIT license that is bundled.
+ */
+
 namespace Pkg6\cloudPrint;
 
 use InvalidArgumentException;
@@ -32,12 +40,12 @@ class Factory
      */
     protected static function make($name, array $config)
     {
-        $app = __NAMESPACE__.'\\'.$name.'\\AppContainer';
-        if (!class_exists($app)) {
-            throw new InvalidArgumentException('class not exists:'.$app);
+        $app = __NAMESPACE__ . '\\' . $name . '\\AppContainer';
+        if ( ! class_exists($app)) {
+            throw new InvalidArgumentException('class not exists:' . $app);
         }
-        $instance = crc32($name.serialize($config));
-        if (!isset(self::$instances[$instance])) {
+        $instance = crc32($name . serialize($config));
+        if ( ! isset(self::$instances[$instance])) {
             self::$instances[$instance] = new $app($config);
         }
 
@@ -52,7 +60,7 @@ protected static function make($name, array $config)
      */
     public static function __callStatic($name, $arguments)
     {
-//        $config = (array_key_exists(0, $arguments) && is_array($arguments) ? $arguments[0] : []);
+        //        $config = (array_key_exists(0, $arguments) && is_array($arguments) ? $arguments[0] : []);
         return self::make($name, ...$arguments);
     }
 }

doc/zhongwu.md renamed to docs/中午云.md

@@ -1,10 +1,17 @@
 <?php
 
+/*
+ * This file is part of the pkg6/cloud-print.
+ *
+ * (c) pkg6 <https://github.com/pkg6>
+ *
+ * This source file is subject to the MIT license that is bundled.
+ */
+
 namespace Pkg6\cloudPrint\Feieyun;
 
 use Pkg6\cloudPrint\Kernel\ServiceContainer;
 
-
 class AppContainer extends ServiceContainer
 {
     /**

doc/ushengyun.md renamed to docs/优声云.md

@@ -1,5 +1,13 @@
 <?php
 
+/*
+ * This file is part of the pkg6/cloud-print.
+ *
+ * (c) pkg6 <https://github.com/pkg6>
+ *
+ * This source file is subject to the MIT license that is bundled.
+ */
+
 namespace Pkg6\cloudPrint\Feieyun;
 
 use Exception;
@@ -22,32 +30,33 @@ class FeieyunClient extends BaseClient
      * @param array $private_params
      *
      * @return string
-     * @throws Exception
      *
+     * @throws Exception
      * @throws GuzzleException
      */
     public function request($action, array $private_params = [])
     {
-        $timestamp     = Timer::timeStamp();
+        $timestamp = Timer::timeStamp();
         $public_params = [
-            'user'    => $this->config['user'],
-            'stime'   => $timestamp,
-            'sig'     => $this->getSig($timestamp),
+            'user' => $this->config['user'],
+            'stime' => $timestamp,
+            'sig' => $this->getSig($timestamp),
             'apiname' => $action,
         ];
-        $url           = $this->config['host'] ?? $this->host;
-        $params        = array_filter(array_merge($public_params, $private_params));
-        $resp          = $this->httpPost($url, $params);
+        $url = $this->config['host'] ?? $this->host;
+        $params = array_filter(array_merge($public_params, $private_params));
+        $resp = $this->httpPost($url, $params);
         $this->requestLog('POST:' . $url, $params, $resp);
+
         return $resp;
     }
 
     /**
      * @param $timestamp
      *
      * @return string
-     * @throws Exception
      *
+     * @throws Exception
      */
     protected function getSig($timestamp)
     {

doc/poscom.md renamed to docs/佳博云.md

@@ -1,5 +1,13 @@
 <?php
 
+/*
+ * This file is part of the pkg6/cloud-print.
+ *
+ * (c) pkg6 <https://github.com/pkg6>
+ *
+ * This source file is subject to the MIT license that is bundled.
+ */
+
 namespace Pkg6\cloudPrint\Feieyun;
 
 use GuzzleHttp\Exception\GuzzleException;

doc/kuaidi100.md renamed to docs/快递100.md

@@ -1,5 +1,13 @@
 <?php
 
+/*
+ * This file is part of the pkg6/cloud-print.
+ *
+ * (c) pkg6 <https://github.com/pkg6>
+ *
+ * This source file is subject to the MIT license that is bundled.
+ */
+
 namespace Pkg6\cloudPrint\Feieyun;
 
 use Pimple\Container;

doc/yilianyun.md renamed to docs/易联云.md

@@ -1,5 +1,13 @@
 <?php
 
+/*
+ * This file is part of the pkg6/cloud-print.
+ *
+ * (c) pkg6 <https://github.com/pkg6>
+ *
+ * This source file is subject to the MIT license that is bundled.
+ */
+
 namespace Pkg6\cloudPrint\Jolimark;
 
 use Pkg6\cloudPrint\Kernel\ServiceContainer;

doc/jolimark.md renamed to docs/映美云.md

@@ -1,5 +1,13 @@
 <?php
 
+/*
+ * This file is part of the pkg6/cloud-print.
+ *
+ * (c) pkg6 <https://github.com/pkg6>
+ *
+ * This source file is subject to the MIT license that is bundled.
+ */
+
 namespace Pkg6\cloudPrint\Jolimark;
 
 use Exception;
@@ -27,13 +35,13 @@ class JolimarkClient extends BaseClient
      * @param $private_params
      *
      * @return string
-     * @throws Exception
      *
+     * @throws Exception
      * @throws GuzzleException
      */
     public function request($method, $action, $private_params)
     {
-        $url           = $this->config['host'] ?? $this->host . $action;
+        $url = $this->config['host'] ?? $this->host . $action;
         $public_params = [
             'app_id' => $this->config['app_id'],
         ];
@@ -46,13 +54,14 @@ public function request($method, $action, $private_params)
             'form_params' => $params,
         ]);
         $this->requestLog($method . ':' . $url, $params, $resp);
+
         return $resp;
     }
 
     /**
      * @return string
-     * @throws Exception
      *
+     * @throws Exception
      * @throws GuzzleException
      */
     protected function accessToken()
@@ -62,14 +71,14 @@ protected function accessToken()
         if ($this->app->cache->hasCache($key)) {
             return $this->app->cache->getCache($key);
         }
-        $time   = Timer::timeStamp();
+        $time = Timer::timeStamp();
         $params = [
             'time_stamp' => $time,
-            'sign'       => $this->sign($time),
-            'sign_type'  => 'MD5',
+            'sign' => $this->sign($time),
+            'sign_type' => 'MD5',
         ];
-        $resp   = $this->request('GET', 'mcp/v2/sys/GetAccessToken', $params);
-        $data   = json_decode($resp, true);
+        $resp = $this->request('GET', 'mcp/v2/sys/GetAccessToken', $params);
+        $data = json_decode($resp, true);
         if (empty($data['return_data']['access_token'])) {
             return $resp;
         }
@@ -86,10 +95,10 @@ protected function accessToken()
     protected function sign($timestamp)
     {
         $str = http_build_query([
-            'app_id'     => $this->config['app_id'],
-            'sign_type'  => $this->signType,
+            'app_id' => $this->config['app_id'],
+            'sign_type' => $this->signType,
             'time_stamp' => $timestamp,
-            'key'        => $this->config['app_key'],
+            'key' => $this->config['app_key'],
         ]);
 
         return strtoupper(md5($str));