Lightweight PHP cURL wrapper
PHP
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

PHP cURL

Build Status Version CodeClimate

Requirements

  • PHP >= 5.4
  • cURL library enabled

Install

Composer

{
    "require": {
        "sylouuu/php-curl": "0.8.*"
    }
}
require_once './vendor/autoload.php';

Usage

// Namespace shortcut
use sylouuu\Curl\Method as Curl;

// Template
$request = new Curl\<METHOD_NAME>( string $url [, array $options ] );

Methods are:

  • Get()
  • Head()
  • Options()
  • Post()
  • Put()
  • Patch()
  • Delete()

Constructor $options

[
    'data' => [             // Data to send, available for `Post`, `Put` and `Patch`
        'foo' => 'bar'
    ],
    'headers' => [          // Additional headers (optional)
        'Authorization: foobar'
    ],
    'ssl' => '/cacert.pem', // Use it for SSL (optional)
    'is_payload' => true,   // `true` for sending a payload (JSON-encoded data, optional)
    'autoclose' => true     // Is the request must be automatically closed (optional)
]

Public methods

// Send a request
$request->send();

// HTTP status code
$request->getStatus();

// HTTP header
$request->getHeader();

// HTTP body response
$request->getResponse();

// Used cURL options
$request->getCurlOptions();

// Set a cURL option
$request->setCurlOption(CURLOPT_SOMETHING, $value);

// Manually close the handle (necessary when `autoclose => false` is used)
$request->close();

Examples

Basic:

// Namespace shortcut
use sylouuu\Curl\Method as Curl;

// Standard GET request
$request = new Curl\Get('http://domain.com');

// Send this request
$request->send();

echo $request->getResponse(); // body response
echo $request->getStatus(); // HTTP status code

Send a payload:

// Namespace shortcut
use sylouuu\Curl\Method as Curl;

// JSON-encoded POST request
$request = new Curl\Post($this->endpoint, [
    'data' => [
        'name' => 'foo',
        'email' => 'foo@domain.com'
    ],
    // With 'is_payload' => true
    // You don't have to json_encode() your array of data
    // Moreover, the appropriate headers will be set for you
    'is_payload' => true
]);

// Send this request
$request->send();

echo $request->getResponse(); // body response
echo $request->getStatus(); // HTTP status code

Manual closing:

// Namespace shortcut
use sylouuu\Curl\Method as Curl;

// Set `autoclose` option to `false`
$request = new Curl\Get('http://domain.com', [
    'autoclose' => false
]);

// Send this request
$request->send();

// Now you can retrieve a cURL info as the handle is still open
$request->getCurlInfo(CURLINFO_SOMETHING);

echo $request->getResponse();

// Manually close the handle
$request->close();

Tests

On project directory:

  • composer install to retrieve phpunit
  • phpunit to run tests

Changelog

2015-08-25 - 0.8.1

  • fixed invalid content-length in case of no data provided

2015-07-03 - 0.8.0

  • added is_payload option to perform a request with JSON-encoded data
  • fixed ssl option

2014-10-23 - 0.7.1

  • fixed Post() which didn't send data in some cases

2014-08-01 - 0.7.0 (BC break)

  • moved from psr-0 autoload to psr-4
  • added Method directory, then methods are now in \sylouuu\Curl\Method\

2014-05-30 - 0.6.1

  • removed exception when data option is not specified for Post Put and Patch

2014-05-22 - 0.6.0 (BC break)

  • moved url option to the first constructor parameter

2014-05-20 - 0.5.0 (BC break)

  • renamed repository from php-rest-client to php-curl
  • refactored all code
  • added autoclose option
  • added the way to get/set cURL options
  • added the way to get cURL info
  • sources are now psr-2 compliant

2014-05-13 - 0.4.0 (BC break)

  • renamed RESTClient.class.php to RESTClient.php
  • moved RESTClient.php to /src
  • moved RESTClientTest.php to /tests
  • added HEAD, OPTIONS and PATCH support
  • added getHeader method
  • renamed getJSON to getResponse
  • removed JSON validation
  • added sylouuu namespace
  • removed gulp

2014-05-09 - 0.3.0

  • added ssl option

2014-04-06 - 0.2.1

  • added exception if invalid JSON format returned

2014-04-04 - 0.2.0

  • new way to retrieve result
  • added HTTP status code

2014-04-01 - 0.1.0

  • refactored class
  • removed constructor parameter
  • added unit tests

2014-03-24 - 0.0.2

  • added $api_url as a constructor parameter

2014-02-05 - 0.0.1

  • Initial release