understeam/yii2-httpclient

Yii2 http client implementation based on Guzzle library

Yii2 HTTP client

, _(*1)

Installation

Recommended way to install this extenstion is through Composer:, _(*2)

php composer.phar require understeam/yii2-httpclient:~1.0 --prefer-dist

Configuration

Add this lines to your config file:, _(*3)

...
'components' => [
    'httpclient' => [
        'class' =>'understeam\httpclient\Client',
        'detectMimeType' => true, // automatically transform request to data according to response Content-Type header
        'requestOptions' => [
            // see guzzle request options documentation
        ],
        'requestHeaders' => [
            // specify global request headers (can be overrided with $options on making request)
        ],
    ],
],
...

Basic usage

Performing HTTP GET request with mime type detection:, _(*4)

// Result is html text
$text = Yii::$app->httpclient->get('http://httpbin.org/html');

// Result is SimpleXMLElement containing parsed XML
$xml = Yii::$app->httpclient->get('http://httpbin.org/xml');

// Result is parsed JSON array
$json = Yii::$app->httpclient->get('http://httpbin.org/get');

You can disable this behavior by specifying $detectMimeType option to whole component or single call, _(*5)

// Result is Guzzle `Response` object
$text = Yii::$app->httpclient->get('http://httpbin.org/xml', [], false);

Make request with custom options:, _(*6)

$text = Yii::$app->httpclient->get('http://httpbin.org/xml', [
    'proxy' => 'tcp://localhost:8125'
]);

Read more about this options in Guzzle 6 documentation, _(*7)

HTTP methods

You can make request with several ways:, _(*8)

1. Call shortcut method (get(), post(), put(), delete(), etc.)
2. Call request() method

All shortcut methods has the same signature except get():, _(*9)

// Synchronous GET request
Yii::$app->httpclient->get(
    $url, // URL
    [], // Options
    true // Detect Mime Type?
);

// Synchronous POST (and others) request
Yii::$app->httpclient->post(
    $url, // URL
    $body, // Body
    [], // Options
    true // Detect Mime Type?
);

// Asynchronous GET request
Yii::$app->httpclient->getAsync(
    $url, // URL
    [] // Options
);

// Asynchronous POST (and others) request
Yii::$app->httpclient->postAsync(
    $url, // URL
    $body, // Body
    [] // Options
);

NOTE: you still can make a GET request with body via request() function, _(*10)

Asynchronous calls

To make an asynchronous request simly add Async to end of request method:, _(*11)

// PromiseInterface
$promise = Yii::$app->httpclient->postAsync('http://httpbin.org/post');

NOTE: mime type detection is not supported for asynchronous calls, _(*12)

Read more about asynchronous requests in Guzzle 6 documentation, _(*13)

Request body

Types you can pass as a body of request:, _(*14)

1. __Arrayable object__ (ActiveRecord, Model etc.) - will be encoded into JSON object
2. Array - will be sent as form request (x-form-urlencoded)

Any other data passed as body will be sent into Guzzle without any transformations., _(*15)

Read more about request body in Guzzle documentation, _(*16)

Appendix

Feel free to send feature requests and fix bugs with Pull Requests, _(*17)