format codes. update action script

Author: inhere

.github/workflows/php.yml

@@ -29,7 +29,7 @@ jobs:
         with:
           php-version: ${{ matrix.php}}
           tools: pecl, php-cs-fixer, phpunit:8.5.8
-          extensions: mbstring, dom, fileinfo, mysql, openssl, igbinary, redis # , swoole-4.4.19 #optional, setup extensions
+          extensions: mbstring, dom, fileinfo, mysql, openssl, igbinary, redis, swoole-4.5.11 # , swoole-4.4.19 #optional, setup extensions
           ini-values: post_max_size=56M, short_open_tag=On #optional, setup php.ini configuration
           coverage: none #optional, setup coverage driver: xdebug, none
 

README.md

@@ -1,8 +1,10 @@
 # HTTP Client 
 
 [![License](https://img.shields.io/packagist/l/php-comp/http-client.svg?style=flat-square)](LICENSE)
-[![Php Version](https://img.shields.io/badge/php-%3E=7.0-brightgreen.svg?maxAge=2592000)](https://packagist.org/packages/php-comp/http-client)
+[![Php Version](https://img.shields.io/badge/php-%3E=7.1-brightgreen.svg?maxAge=2592000)](https://packagist.org/packages/php-comp/http-client)
 [![Latest Stable Version](http://img.shields.io/packagist/v/php-comp/http-client.svg)](https://packagist.org/packages/php-comp/http-client)
+[![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/ulue/phpgit)](https://github.com/ulue/phpgit)
+[![Github Actions Status](https://github.com/ulue/phpgit/workflows/Unit-tests/badge.svg)](https://github.com/ulue/phpgit/actions)
 
 PHP http client library.
 
@@ -22,6 +24,8 @@ composer require php-comp/http-client
 ### 创建客户端实例
 
 ```php
+use PhpComp\Http\Client\Client;
+
 // use factory
 $client = Client::factory([
     'driver' => 'curl', // stream, fsock, fopen, file, co, co2
@@ -44,6 +48,10 @@ $client = CoClient::create($options);
 ### 基本使用
 
 ```php
+use PhpComp\Http\Client\Client;
+
+$client = Client::factory([]);
+
 $client->get('/users/1');
 
 $post = ['name' => 'john'];
@@ -53,6 +61,8 @@ $client->post('/users/1', $post);
 $client->byAjax()->post('/users/1', $post);
 
 // add json content type
+$client->json('/users/1', json_encode($post));
+// or
 $client->byJson()->post('/users/1', json_encode($post));
 
 $statusCode = $client->getStatusCode();

example/refer.php

@@ -1,6 +1,7 @@
 <?php declare(strict_types=1);
 /**
  * # example 1 获取一个页面并发送 POST 数据
+ *
  * @link https://secure.php.net/manual/zh/context.http.php#refsect1-context.http-examples
  */
 
@@ -11,37 +12,40 @@
     ]
 );
 
-$opts = ['http' =>
-    [
-        'method' => 'POST',
-        'header' => 'Content-type: application/x-www-form-urlencoded',
-        'content' => $postdata
-    ]
+$opts = [
+    'http' =>
+        [
+            'method'  => 'POST',
+            'header'  => 'Content-type: application/x-www-form-urlencoded',
+            'content' => $postdata
+        ]
 ];
 
 $context = stream_context_create($opts);
-$result = file_get_contents('http://example.com/submit.php', false, $context);
+$result  = file_get_contents('http://example.com/submit.php', false, $context);
 
 ?>
 
 <?php
 /**
  * # example 2 忽略重定向并获取 header 和内容
+ *
  * @link https://secure.php.net/manual/zh/context.http.php#refsect1-context.http-examples
  */
 
 $url = 'http://www.example.org/header.php';
 
-$opts = ['http' =>
-    [
-        'method' => 'GET',
-        'max_redirects' => '0',
-        'ignore_errors' => '1'
-    ]
+$opts = [
+    'http' =>
+        [
+            'method'        => 'GET',
+            'max_redirects' => '0',
+            'ignore_errors' => '1'
+        ]
 ];
 
 $context = stream_context_create($opts);
-$stream = fopen($url, 'r', false, $context);
+$stream  = fopen($url, 'r', false, $context);
 
 // header information as well as meta data
 // about the stream
@@ -61,7 +65,7 @@
 $data = file_get_contents('http://www.example.com/', null, stream_context_create([
     'http' => [
         'protocol_version' => 1.1,
-        'header' => [
+        'header'           => [
             'Connection: close',
         ],
     ],
@@ -73,12 +77,15 @@
  * @link https://secure.php.net/manual/zh/context.http.php#110449
  */
 
-$stream = stream_context_create(['http' => ['method' => 'GET',
-    'timeout' => 20,
-    'header' => 'User-agent: Myagent',
-    'proxy' => 'tcp://my-proxy.localnet:3128',
-    'request_fulluri' => true /* without this option we get an HTTP error! */
-]]);
+$stream = stream_context_create([
+    'http' => [
+        'method'          => 'GET',
+        'timeout'         => 20,
+        'header'          => 'User-agent: Myagent',
+        'proxy'           => 'tcp://my-proxy.localnet:3128',
+        'request_fulluri' => true /* without this option we get an HTTP error! */
+    ]
+]);
 
 if ($fp = fopen('http://example.com', 'r', false, $stream)) {
     print 'well done';

src/AbstractClient.php

@@ -10,7 +10,6 @@
 namespace PhpComp\Http\Client;
 
 use Closure;
-use Exception;
 use InvalidArgumentException;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
@@ -208,7 +207,7 @@ public function __destruct()
     /**
      * @return array
      */
-    public static function getSupportedMethods()
+    public static function getSupportedMethods(): array
     {
         return self::$supportedMethods;
     }
@@ -308,8 +307,6 @@ public function trace(string $url, $params = null, array $headers = [], array $o
      * @param RequestInterface $request
      *
      * @return ResponseInterface
-     *
-     * @throws \Psr\Http\Client\ClientExceptionInterface If an error happens while processing the request.
      */
     public function sendRequest(RequestInterface $request): ResponseInterface
     {
@@ -323,6 +320,23 @@ public function sendRequest(RequestInterface $request): ResponseInterface
         return $this->getPsr7Response();
     }
 
+    /**
+     * @param string $url
+     * @param mixed   $data
+     * @param array  $headers
+     * @param array  $options
+     *
+     * @return ClientInterface
+     */
+    public function json(string $url, $data = null, array $headers = [], array $options = []): ClientInterface
+    {
+        if (!isset($options['method'])) {
+            $options['method'] = 'POST';
+        }
+
+        return $this->byJson()->request($url, $data, $options['method'], $headers, $options);
+    }
+
     /**
      * File download and save
      *
@@ -363,7 +377,7 @@ public function getTimeout(): int
      *
      * @return $this
      */
-    public function setTimeout(int $seconds)
+    public function setTimeout(int $seconds): self
     {
         $this->options['timeout'] = $seconds;
         return $this;
@@ -374,7 +388,7 @@ public function setTimeout(int $seconds)
      *
      * @return $this
      */
-    public function SSLVerify(bool $enable)
+    public function SSLVerify(bool $enable): self
     {
         $this->options['sslVerify'] = $enable;
         return $this;
@@ -435,7 +449,7 @@ public function acceptGzip()
     /**
      * @return $this
      */
-    public function byJson()
+    public function byJson(): self
     {
         $this->setHeader('Content-Type', 'application/json; charset=utf-8');
         return $this;
@@ -444,15 +458,15 @@ public function byJson()
     /**
      * @return $this
      */
-    public function byXhr()
+    public function byXhr(): self
     {
         return $this->byAjax();
     }
 
     /**
      * @return $this
      */
-    public function byAjax()
+    public function byAjax(): self
     {
         $this->setHeader('X-Requested-With', 'XMLHttpRequest');
         return $this;
@@ -478,7 +492,7 @@ public function setUserAgent(string $userAgent): ClientInterface
      *
      * @return $this
      */
-    public function setUserAuth(string $user, string $pwd = '', int $authType = self::AUTH_BASIC)
+    public function setUserAuth(string $user, string $pwd = '', int $authType = self::AUTH_BASIC): AbstractClient
     {
         if ($authType === self::AUTH_BASIC) {
             $sign = 'Basic ' . base64_encode("$user:$pwd");
@@ -613,7 +627,7 @@ public function delHeader($names): ClientInterface
      *
      * @return string
      */
-    protected function buildFullUrl(string $url, $data = null)
+    protected function buildFullUrl(string $url, $data = null): string
     {
         $url = trim($url);
 
@@ -775,7 +789,7 @@ public function getBaseUrl(): string
 
     /**
      * @param int|string $name
-     * @param bool       $default
+     * @param null       $default
      *
      * @return mixed
      */

src/CType.php

@@ -0,0 +1,17 @@
+<?php declare(strict_types=1);
+
+namespace PhpComp\Http\Client;
+
+/**
+ * Class CType
+ *
+ * @package PhpComp\Http\Client
+ */
+class CType
+{
+    public const HTML = 'text/html';
+    public const JSON = 'application/json';
+    public const XML  = 'application/xml';
+
+    public const MULTIPART = 'multipart/form-data';
+}

src/Client.php

@@ -32,7 +32,7 @@
 class Client
 {
     /**
-     * supported drivers
+     * The supported drivers
      *
      * @var ClientInterface[]
      */

src/ClientInterface.php

@@ -162,9 +162,9 @@ public function trace(string $url, array $params = [], array $headers = [], arra
      * @param array|string|null $data
      * @param string            $method
      * @param array             $headers
-     * @param array             $options
+     * @param array             $options All options please {@see AbstractClient::$defaultOptions}
      *
-     * @return self
+     * @return ClientInterface
      */
     public function request(
         string $url,

src/ClientUtil.php

@@ -103,8 +103,8 @@ public static function parseUrl(string $url): array
     }
 
     /**
-     * @param string       $url
-     * @param array|object $data
+     * @param string $url
+     * @param null   $data
      *
      * @return string
      */

src/Curl/CurlClient.php

@@ -236,12 +236,7 @@ public function upload(string $url, string $field, string $filePath, string $mim
         }
 
         // create file
-        if (function_exists('curl_file_create')) {
-            $file = curl_file_create($filePath, $mimeType); // , $postFilename
-        } else {
-            $this->setCurlOption(CURLOPT_SAFE_UPLOAD, true);
-            $file = "@{$filePath};type={$mimeType}"; // ;filename={$postFilename}
-        }
+        $file = curl_file_create($filePath, $mimeType); // , $postFilename
 
         $headers = [
             'Content-Type' => 'multipart/form-data'
@@ -259,7 +254,7 @@ public function upload(string $url, string $field, string $filePath, string $mim
      *
      * @return string
      */
-    public function downloadImage(string $imgUrl, string $saveDir, string $rename = '')
+    public function downloadImage(string $imgUrl, string $saveDir, string $rename = ''): string
     {
         // e.g. http://static.oschina.net/uploads/user/277/554046_50.jpg?t=34512323
         if (strpos($imgUrl, '?')) {
@@ -536,7 +531,7 @@ public function setReferrer(string $referrer): self
      *
      * @return $this
      */
-    public function setUserAuth(string $user, string $pwd = '', int $authType = CURLAUTH_BASIC): ClientInterface
+    public function setUserAuth(string $user, string $pwd = '', int $authType = CURLAUTH_BASIC): AbstractClient
     {
         $this->_curlOptions[CURLOPT_HTTPAUTH] = $authType;
         $this->_curlOptions[CURLOPT_USERPWD]  = "$user:$pwd";
@@ -552,7 +547,7 @@ public function setUserAuth(string $user, string $pwd = '', int $authType = CURL
      *
      * @return $this
      */
-    public function setSSLAuth(string $pwd, string $file, string $authType = self::SSL_TYPE_CERT): ClientInterface
+    public function setSSLAuth(string $pwd, string $file, string $authType = self::SSL_TYPE_CERT): AbstractClient
     {
         if ($authType !== self::SSL_TYPE_CERT && $authType !== self::SSL_TYPE_KEY) {
             throw new InvalidArgumentException('The SSL auth type only allow: cert|key');
@@ -653,7 +648,7 @@ public function getCurlOptions(): array
 
     /**
      * @param int|string $name
-     * @param bool       $default
+     * @param null       $default
      *
      * @return mixed
      */

src/Curl/CurlMulti.php

@@ -152,7 +152,7 @@ public function build(array $data): self
      *
      * @return $this
      */
-    public function append(string $url, $data = null, array $headers = [], array $options = [])
+    public function append(string $url, $data = null, array $headers = [], array $options = []): self
     {
         $options       = array_merge($this->options, $options);
         $this->chMap[] = $ch = $this->createResource($url, $data, $headers, $options);