| 1 |
<?php |
| 2 |
|
| 3 |
declare(strict_types=1); |
| 4 |
|
| 5 |
namespace Http\Client\Common; |
| 6 |
|
| 7 |
use Http\Client\Common\Exception\BatchException; |
| 8 |
use Psr\Http\Message\RequestInterface; |
| 9 |
|
| 10 |
/** |
| 11 |
* BatchClient allow to sends multiple request and retrieve a Batch Result. |
| 12 |
* |
| 13 |
* This implementation simply loops over the requests and uses sendRequest with each of them. |
| 14 |
* |
| 15 |
* @author Joel Wurtz <jwurtz@jolicode.com> |
| 16 |
*/ |
| 17 |
interface BatchClientInterface |
| 18 |
{ |
| 19 |
/** |
| 20 |
* Send several requests. |
| 21 |
* |
| 22 |
* You may not assume that the requests are executed in a particular order. If the order matters |
| 23 |
* for your application, use sendRequest sequentially. |
| 24 |
* |
| 25 |
* @param RequestInterface[] $requests The requests to send |
| 26 |
* |
| 27 |
* @return BatchResult Containing one result per request |
| 28 |
* |
| 29 |
* @throws BatchException If one or more requests fails. The exception gives access to the |
| 30 |
* BatchResult with a map of request to result for success, request to |
| 31 |
* exception for failures |
| 32 |
*/ |
| 33 |
public function sendRequests(array $requests): BatchResult; |
| 34 |
} |
| 35 |
|
