juliangut/spiral

A PSR7 aware cURL client

, _(*1)

, _(*2)

, _(*3)

PSR7 aware cURL client

PSR7 compatible cURL client., _(*4)

Use PSR7 Request and Response objects to perform HTTP Requests with cURL., _(*5)

Installation

Best way to install is using Composer:, _(*6)

composer require juliangut/spiral

Then require_once the autoload file:, _(*7)

require_once './vendor/autoload.php';

Usage

use Jgut\Spiral\Client;

// Create Spiral cURL client
$spiralClient = new Client;

// Create \Psr\Http\Message\RequestInterface request and configure it
$request = new PSR7RequestImplementation();

// Perform the request providing an empty \Psr\Http\Message\ResponseInterface response object to be populated
$response = $spiralClient->request($request, new PSR7ResponseImplementation());

// Use response
$headers = $response->getHeaders();
$content = (string) $response->getBody();

Transport

You can create an empty cURL transport object and set options on it later, _(*8)

$transport = new Curl;

$spiralClient = new Client($transport);

Or you can create the transport object from sane defaults, _(*9)

$transport = Curl::createFromDefaults();

$spiralClient = new Client($transport);

If no transport object is provided to Jgut\Spiral\Client constructor method one will be created by Jgut\Spiral\Transport\Curl::createFromDefaults, _(*10)

Options

Transport object accepts cURL options, _(*11)

use Jgut\Spiral\Transport\Curl;
use Jgut\Spiral\Option\ConnectTimeout;

// Create Spiral cURL client
$transport = new Curl;

// Set option explicitly
$transport->setOption(new ConnectTimeout(10));

// Set by cURL constant
$transport->setOption(CURLOPT_CONNECTTIMEOUT, 10);

// Set using an alias
$transport->setOption('connect_timeout', 10);

Reserved options

Some options are reserved and cannot be added to transport object using setOption method. Some of them are set by extracting the relevant data from request oobject., _(*12)

The following is a list of options automatically handled by the transport object, _(*13)

• CURLOPT_NOBODY
• CURLOPT_HTTPGET
• CURLOPT_POST
• CURLOPT_CUSTOMREQUEST
• CURLOPT_URL
• CURLOPT_POSTFIELDS
• CURLOPT_HTTPHEADER

Available options

Review Jgut\Spiral\Option\OptionFactory for a full list of available aliases, _(*14)

Contributing

Found a bug or have a feature request? Please open a new issue. Have a look at existing issues before, _(*15)

See file CONTRIBUTING.md, _(*16)

License

Release under BSD-3-Clause License.

See file LICENSE included with the source code for a copy of the license terms, _(*17)