PHPackages                             cvweiss/guzzler - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [HTTP & Networking](/categories/http)
4. /
5. cvweiss/guzzler

AbandonedArchivedLibrary[HTTP & Networking](/categories/http)

cvweiss/guzzler
===============

A utility that allows multiples sequences of calls with execution of code between each sequence.

v0.0.9(7y ago)1261MITPHP

Since Mar 5Pushed 7y ago1 watchersCompare

[ Source](https://github.com/cvweiss/guzzler)[ Packagist](https://packagist.org/packages/cvweiss/guzzler)[ RSS](/packages/cvweiss-guzzler/feed)WikiDiscussions master Synced 2mo ago

READMEChangelog (9)Dependencies (1)Versions (10)Used By (0)

[![Scrutinizer Code Quality](https://camo.githubusercontent.com/fad979ff04d7e9896c6624fa346b7754d38478a64ae75effb8aa4123b867724e/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f637677656973732f67757a7a6c65722f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/cvweiss/guzzler/?branch=master)[![Latest Stable Version](https://camo.githubusercontent.com/d83ac7226b2e1a69925558bc63690860f913cc711a1f986855280cde2e021c2b/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f637677656973732f67757a7a6c65722e737667)](https://packagist.org/packages/cvweiss/guzzler)

Guzzler
=======

[](#guzzler)

Guzzler utilizes Guzzle's many powerful tools and provides a simple wrapper for performing asynchronous requests in PHP. Guzzle uses curl as the backend for making all requests.

Guzzler Basics
==============

[](#guzzler-basics)

To initiate:

```
use cvweiss\Guzzler;
$guzzler = new Guzzler();
```

To perform a call:

```
$params = []; // Parameters to share with the success and fail function. Not required, defaults to []
$headers = []; // Headers to pass, such as Content-Type or If-None-Match. Not required, defaults to []
$requestType = "GET"; // The http request type. Not required, defaults to "GET"
$guzzler->call("https://example.org", "success", "fail", $params, $headers, $requestType);
```

To perform a call you will need two functions: one for successful requests, and another for failed requests. As seen in the example above, you must pass the function names as strings.

```
function success(&$guzzler, &$params, $content)
{
    // Do stuff with the successful return
}

function fail(&$guzzler, &$params, $exception)
{
    // Do stuff with the failed return
}
```

To allow guzzler to iterate and process existing requests:

```
$guzzler->tick();
```

To finish all guzzler calls:

```
$guzzler->finish();
```

Guzzler Advanced
================

[](#guzzler-advanced)

You can modify the number of concurrent requests as well as the maximum time Guzzler will wait between calls. The wait takes into consideration the time it took for a call to come back and be processed.

```
$guzzler = new Guzzler($concurrentRequests, $utimeSleep);
```

Guzzler lets you define the user agent once as well. The default is `"cvweiss/guzzler"`

```
$userAgent= "MyAppName Example";
$guzzler = new Guzzler($concurrentRequests, $utimeSleep, $userAgent);
```

Guzzler also lets you define curl options initially. The default is `[CURLOPT_FRESH_CONNECT => false]`

```
$curlOptions = [CURLOPT_FRESH_CONNECT => true];
$guzzler = new Guzzler($concurrentRequests, $utimeSleep, $userAgent, $curlOptions);
```

Guzzlers also lets you define curl options with every call, just embed it within the headers with the `curl` key.

```
$headers['User-Agent'] = "MyAppName Example";
$headers['curl'] = [CURLOPT_FRESH_CONNECT => true];
$guzzler->call("https://example.org", "success", "fail", $params, $headers);
```

Guzzler also makes it easier to pass parameters to the functions that are called on fail or success.

```
$params = ['data' = ['id' = 123, 'foo' = 'bar']];
$guzzler->call("https://example.org", "success", "fail", $params);

function success(&$guzzler, &$params, $content)
{
    $data = $params['data'];

    // Do stuff with $content
}
```

Guzzler also allows you to make additional guzzler calls within the functions.

```
$guzzler->call("https://example.org", "success", "fail");

function success(&$guzzler, &$params, $content)
{
    // Do stuff with $content

    $guzzler->call("https://example.org/example.html", "success", "fail");
}
```

Guzzler makes it easy to POST with a body included:

```
$body = "[123, 456, 789]";
$guzzler->call("https://example.org", "success", "fail", $params, $headers, "POST", $body);
```

Guzzler makes it easy to retrieve the headers from the response. Keep in mind, all header's keys are lowercased.

```
function success(&$guzzler, &$params, $content)
{
    $headers = $guzzler->getLastHeaders(); // Retrieves headers for this request
    $etag = $headers['etag'][0]; // Each header is an array (thanks curl). Use [0] to get the value of the header in most cases.
}
```

Guzzler makes it very easy to add headers to the request.

```
$headers = [];
$headers['User-Agent'] = "My Application";
$headers['If-None-Match'] = '"09f8b2541e00231360e70eb9d4d6e6504a298f9c8336277c704509a8"'; // ETag example
$guzzler->call("https://example.org", "success", "fail", $params, $headers);
```

Guzzler will verify that the functions specified to be called actually exist, so if you typo you'll get an immediate notification before the request is actually made.

```
$guzzler->call("https://example.org", "scucess", "fail"); // IllegalArgumentException returned since you have not defined the function 'scucess'

function success(&$guzzler, &$params, $content)
{

}
```

Guzzler makes it easy to implement etags. Pass $redis, which can be anything really as long as it implements get and setex properly.

```
$headers = [];
$headers['etag'] = $redis;
$guzzler->call("https://example.org", "success", "fail", $params, $headers);

function success(&$guzzler, &$params, $content)
{
    // $content will equal "" on a successful etag return
}
```

Guzzler Example
===============

[](#guzzler-example)

Now that you have fully read the manual, here is a complete example:

```