wilkques/http-client

http-client

v5.0.1 2025-03-21 09:28 UTC

Requires

• php: >=8.2
• ext-curl: *
• ext-json: *
• wilkques/php-helper: ^5.0.0

MIT

README

How to start

composer require wilkques/http-client

How to use

use Wilkques\Http\Http;

Methods

1. setCurlOption PHP CURL Setting

   $response = Http::setCurlOption(<CURL OPTION>, <Value>);
   
       // Ex
   
   $response = Http::setCurlOption(CURLOPT_TIMEOUT, 100);

2. withHeaders

   $response = Http::withHeaders([ ... ]); // add header
   
   // Ex
   
   $response = Http::withHeaders([
       'Accept' => 'application/json; charset=utf-8'
   ]);

3. setHeader

   $response = Http::setHeader('<header>', '<value>'); // add header
   
   // Ex
   
   $response = Http::setHeader('Accept', 'application/json; charset=utf-8');

4. asForm

   $response = Http::asForm(); // add header application/x-www-form-urlencoded

5. asJson

   $response = Http::asJson(); // add header application/json

6. asMultipart

   $response = Http::asMultipart(); // add header multipart/form-data

7. attach

   $response = Http::attach('<post key name>', '<file path>', '<file type>', '<file name>'); // add file

8. get

   $response = Http::get('<url>', [ ... ]); // Http method get

9. post

   $response = Http::post('<url>', [ ... ]) // Http method post

10. put

    $response = Http::put('<url>', [ ... ]) // Http method put

11. patch

    $response = Http::patch('<url>', [ ... ]) // Http method patch

12. delete

    $response = Http::delete('<url>', [ ... ]) // Http method delete

13. status

    $response->status(); // get http status code

14. body

    $response->body(); // get body

15. json

    $response->json(); // get json_decode body

16. headers

    $response->headers(); //get headers

17. header

    $response->header('<key>'); // get header

18. ok

    $response->ok(); // bool

19. redirect

    $response->redirect(); // bool

20. successful

    $response->successful(); // bool

21. failed

    $response->failed(); // bool

22. clientError

    $response->clientError(); // bool

23. serverError

    $response->serverError(); // bool

24. throw

    $response->throw(); // throw exception
    
    // or
    
    $response->throw(new \Exception('<message>', '<code>'));
    
    // or
    
    $response->throw(function ($response, $exception) {
        // code
        // return exception
    });

25. pool

    $response = \Wilkques\Http\Http::Pool(function (\Wilkques\Http\Pool $pool) {
        return [
            $pool->get('http://example.com/get', ['abc' => 123]),
            $pool->post('http://example.com/post', ['def' => 456]),
            $pool->as('get')->get('http://example.com/get', ['ghi' => 789]),
            $pool->as('post')->post('http://example.com/post', ['jkl' => 012]),
        ];
    }, [
        'response'  => [
            'sort'  => true, // response sort, default true
        ],
        'timeout'   => 100, // timeout microseconds suggest < 1 sec, default 100
        // success
        'fulfilled' => function (\Wilkques\Http\Response $response, $index) {
            var_dump($index); // array index
            var_dump($response); // \Wilkques\Http\Response
    
            return $response;
        },
        // fail
        'rejected' => function (\Wilkques\Http\Exceptions\CurlExecutionException $exception, $index) {
            var_dump($index); // array index
            var_dump($exception); // \Wilkques\Http\Exceptions\CurlExecutionException
    
            return $response;
        },
        'options'   => [
            // curl_multi_setopt option & value ...
        ]
    ]);
    
    // output
    // array(
    //    '0'       => Wilkques\Http\Response...,
    //    '1'       => Wilkques\Http\Response...,
    //    'get'     => Wilkques\Http\Response...,
    //    'post'    => Wilkques\Http\Response...,
    // )
    var_dump($response);
    
    $response[0]->failed();
    
    $response[1]->successful();
    
    // etc ...