phppkg/http-client

simple http client library of the php

v3.0.2 2023-01-11 05:25 UTC

This package is auto-updated.

Last update: 2024-12-02 03:54:33 UTC


README

License Php Version Latest Stable Version GitHub tag (latest SemVer) Github Actions Status

An easy-to-use HTTP client library for PHP. Support CURL, file, fsockopen, stream drivers.

  • Simple and easy to use HTTP client
  • Support drivers: curl swoole fsockopen stream fopen
  • Support all HTTP method. eg: GET,POST,PATCH,PUT,HEAD,DELETE
  • Support setting proxy, customizing headers, auth, content-type etc.
  • Implement interface PSR 18

安装

composer require phppkg/http-client

使用

创建客户端实例

自动选择驱动类:

use PhpPkg\Http\Client\Client;

// use factory
$client = Client::factory([
    'driver' => 'curl', // stream, fsock, fopen, file, co, co2
    
    // ... 更多选项
    'baseUrl' =>  'http://my-site.com'
]);

直接使用指定的类:

$options = [
  'baseUrl' =>  'http://my-site.com'
  // ...
];
$client = CurlClient::create($options);
$client = FileClient::create($options);
$client = FSockClient::create($options);
$client = FOpenClient::create($options);
$client = CoClient::create($options);

基本使用

use PhpPkg\Http\Client\Client;

$client = Client::factory([]);

$client->get('/users/1');

$post = ['name' => 'john'];
$client->post('/users/1', $post);

// add ajax header
$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();
$headers = $client->getResponseHeaders();

// get body data
$data = $client->getResponseBody();
$array = $client->getArrayData();

解析响应Body:

$data = $client->getDataObject();
$data->getInt('createTime', 0);

$user = new User();
$client->bindBodyTo($user);
vdump($user->name);

文件上传下载

  • public function upload(string $url, string $field, string $filePath, string $mimeType = '')
  • public function download(string $url, string $saveAs)
  • public function downloadImage(string $imgUrl, string $saveDir, string $rename = '')
$client = CurlClient::create([
  // ...
]);

$client->upload(...);

常用方法

  • getJsonArray/getArrayData(): array
  • getJsonObject(): stdClass
  • getDataObject(): DataObject
  • bindBodyTo(object $obj): void

LICENSE

MIT