alisaleem/curl

An easy to use OOP wrapper for cURL

cURL

An easy to use OOP wrapper for cURL, _(*1)

Set Up

• Add package to your project using composer, _(*2)

  composer require alisalemm/curl:dev-master, _(*3)

• Include autoloader in your PHP file, _(*4)

  require 'vendor/autoload.php';, _(*5)

• Select correct namespace for the classes in your PHP file, _(*6)

use \AliSaleem\Curl\Request;
use \AliSaleem\Curl\Response;

Examples

GET Request

$request = new Request('https://requestb.in/xxxxxxxx');
$response = $request->get();

echo $response->getBody();

GET Request with Parameters

$response = $request
    ->setParameters([
        'paramA' => 'valueA',    
        'paramB' => 'valueB',    
    ])
    ->addParameter('paramC', 'valueC')
    ->get();

POST Request

$response = $request
    ->setBody('body content')
    ->post();

The body content can be of the following types, _(*7)

• String
• Array
• Any object that implements JsonSerializable

Other Request Methods

$response = $request->put();
$response = $request->delete();
$response = $request->options();
$response = $request->head();

Custom Request Method

$response = $request->request('CUSTOM_METHOD');

Add Headers

$response = $request
    ->setHeaders([
        'headerA' => 'valueA',    
        'headerB' => 'valueB',    
    ])
    ->addHeader('headerC', 'valueC')
    ->get();

Customising Wrapper Options

$response = $request
    ->setOptions([
        'optionA' => 'valueA',    
        'optionB' => 'valueB',    
    ])
    ->setOption('optionC', 'valueC')
    ->get();

The following options can be set, _(*8)

Adding a validation method for responses

Retries are attempted if the validation fails, _(*9)

use \AliSaleem\Curl\Request;
use \AliSaleem\Curl\Response;

class MyClass {

    public function myValidationMethod(Response $response)
    {
        // $response->getHttpCode();
        // $response->getHeaders();
        // $response->getHeader('headerName');
        // $response->getBody();
        // $response->getInfo();
        // $response->getError();
        // $response->getErrorNo();

        // return true | false;
    }

    public function makeCurlRequest()
    {
        $request = new Request('https://requestb.in/xxxxxxxx');

        $response = $request
            ->setOption('tries', 3)
            ->setValidationMethod($this, 'myValidationMethod')
            ->get();

        echo $response->getBody();
    }
}