README

This is the PHP package for making http request through cURL and getting response.

Installation

$ composer require amsify42/php-curl-http

Table of Contents

1. Initialization
2. Request
3. Response

1. Initialization

For creating cURL http request, we can do like this by passing url to it.

$curlHttp = new Amsify42\CurlHttp\CurlHttp('http://www.sample.com/users');

or with helper method

$curlHttp = get_curl_http('http://www.sample.com/users');

2. Request

If the request method is not of type GET, we can pass this with CurlHtpp instance

$curlHttp = new Amsify42\CurlHttp\CurlHttp('http://www.sample.com/user/create');
$curlHttp->setRequestMethod('POST');
$curlHttp->setRequestData(['name' => 'test', 'salary' => 123]);

or with Amsify42\CurlHtpp\Request instance

$curlRequest = new Amsify42\CurlHtpp\Request();
$curlRequest->setMethod('POST');
/**
 * Set one of the header as Content-Type: application/json if you want to pass bodyData as json
 */
$curlRequest->setHeaders(['Content-Type: application/json']);
$curlRequest->setData(['name' => 'test', 'salary' => 123]);

$curlHttp = new Amsify42\CurlHttp\CurlHttp('http://www.sample.com/user/create', $curlRequest);

With Amsify42\CurlHtpp\Request we can also call these methods.

$curlRequest->setMethod('PUT');
$curlRequest->setHeaders(['Authorization: Bearer sf23rsdf23fds']);
/**
 * Set request ContentType as json if you want to pass bodyData as json
 */
$curlRequest->setContenType('json');
$curlRequest->setData(['name' => 'test', 'salary' => 123]);

You can simply pass json encoded request data also if you don't want to pass header or contentType for json

$curlRequest->setData(json_encode(['name' => 'test', 'salary' => 123]));

For headers, you can also pass array items as key values

$curlRequest->setHeaders(['Authorization' => 'Bearer sf23rsdf23fds']);

3. Response

After executing the cURL through CurlHttp, we will get response of type Amsify42\CurlHttp\Response

$curlHttp = get_curl_http('http://www.sample.com/users');
$response = $curlHttp->execute();

We can call these methods with the response

/* To get the response code */
$response->getCode();
/* To get the response body data */
$response->getBodyData();
/* To get the response headers as array */
$response->getHeaders();
/* To get the json decoded data of response */
$response->json();

For executing different methods like GET, POST, PUT and DELETE, you can also call these methods to get response with a single call.

$response = CurlHttp::get('https://www.somsite.com/users');
$response = CurlHttp::post('https://www.somsite.com/user/create', ['name' => 'dummy'], ['Authorization: Bearer sdf23rsdf23'], 'json');
$response = CurlHttp::put('https://www.somsite.com/user/2', ['name' => 'dummy...edited'], ['Authorization: Bearer sdf23rsdf23'], 'json');
$response = CurlHttp::delete('https://www.somsite.com/user/2', ['Authorization: Basic sdf23rsdf23']);

Methods post(), put() and delete() expects three more optional parameters

data - expects data array or defaults to NULL
headers - expects headers array or defaults to NULL
contentType - expects either string 'json' or defaults to NULL

For json request data, instead of passing contentType parameter as json to these methods you can also pass one of the header as Content-Type: application/json

$response = CurlHttp::post('https://www.somsite.com/user/create', ['name' => 'dummy'], ['Authorization: Bearer sdf23rsdf23', 'Content-Type: application/json']);

or you can simply pass json encoded request data

$response = CurlHttp::post('https://www.somsite.com/user/create', json_encode(['name' => 'dummy']), ['Authorization: Bearer sdf23rsdf23']);