README

Versión en español

API Requests using the HTTP protocol through the Curl library.

This was a very basic option for using cURL. The use of Guzzle is recommended.

Requirements
Installation
Available Methods
Quick Start
Usage
Tests
Sponsor
License

Requirements

This library is supported by PHP versions 5.6 or higher and is compatible with HHVM versions 3.0 or higher.

Installation

The preferred way to install this extension is through Composer.

To install PHP Curl library, simply:

composer require Josantonius/Curl

The previous command will only install the necessary files, if you prefer to download the entire source code you can use:

composer require Josantonius/Curl --prefer-source

You can also clone the complete repository with Git:

git clone https://github.com/Josantonius/PHP-Curl.git

Or install it manually:

Download Curl.php:

wget https://raw.githubusercontent.com/Josantonius/PHP-Curl/master/src/Curl.php

Available Methods

Available methods in this library:

- Make request and get response website

Curl::request($url, $params, $result);

Attribute	Description	Type	Required	Default
$url	Url when get content.	string	Yes

Attribute	Key	Description	Type	Required	Default
$params		Parameters.	array	No	array()
	'referer'	The referrer URL.	string	No
	'timeout'	Timeout.	int	No
	'agent'	Useragent.	string	No
	'headers'	HTTP headers.	array	No
	'data'	Parameters to send.	array	No
	'type'	Type of request.	string	No

Attribute	Description	Type	Required	Default
$result	Returns result as array or object.	string	No	'array'

# Return (array|object) → response

Quick Start

To use this class with Composer:

require __DIR__ . '/vendor/autoload.php';

use Josantonius\Curl\Curl;

Or If you installed it manually, use it:

require_once __DIR__ . '/Curl.php';

use Josantonius\Curl\Curl;

Usage

Example of use for this library:

- Send GET request and obtain response as array

Curl::request('https://graph.facebook.com/zuck');

- Send GET request and obtain response as object

Curl::request('https://graph.facebook.com/zuck', false, 'object');

- Send GET request with params and obtain response as array

$data = [
    'timeout' => 10,
    'referer' => 'http://site.com',
];
        
Curl::request('https://graph.facebook.com/zuck', $data);

- Send GET request with params and obtain response as object

$data = [
    'timeout' => 10,
    'referer' => 'http://site.com',
];
        
Curl::request('https://graph.facebook.com/zuck', $data, 'object');

- Send POST request and obtain response as array

$data = [
    'type'    => 'post',
    'data'    => array('user' => '123456', 'password' => 'xxxxx'),
    'timeout' => 10,
    'referer' => 'http://' . $_SERVER['HTTP_HOST'],
    'headers' => [
        'Content-Type:application/json',
        'Authorization:0kdm3hzmb4h3cf',
    ],
];
        
Curl::request('https://graph.facebook.com/zuck', $data);

- Send POST request and obtain response as object

$data = [
    'type'    => 'post',
    'data'    => array('user' => '123456', 'password' => 'xxxxx'),
    'timeout' => 10,
    'referer' => 'http://' . $_SERVER['HTTP_HOST'],
    'headers' => [
        'Content-Type:application/json',
        'Authorization:0kdm3hzmb4h3cf',
    ],
];
        
Curl::request('https://graph.facebook.com/zuck', $data, 'object');

- Send PUT request and obtain response as array

$data = [
    'type'    => 'put',
    'data'    => array('email' => 'new@email.com'),
    'timeout' => 30,
    'referer' => 'http://' . $_SERVER['HTTP_HOST'],
    'headers' => [
        'Content-Type:application/json',
        'Authorization:0kdm3hzmb4h3cf',
    ],
];
        
Curl::request('https://graph.facebook.com/zuck', $data);

- Send PUT request and obtain response as object

$data = [
    'type'    => 'put',
    'data'    => array('email' => 'new@email.com'),
    'timeout' => 30,
    'referer' => 'http://' . $_SERVER['HTTP_HOST'],
    'headers' => [
        'Content-Type:application/json',
        'Authorization:0kdm3hzmb4h3cf',
    ],
];
        
Curl::request('https://graph.facebook.com/zuck', $data, 'object');

- Send DELETE request and obtain response as array

$data = [

    'type'    => 'delete',
    'data'    => ['userId' => 10],
    'timeout' => 30,
    'referer' => 'http://' . $_SERVER['HTTP_HOST'],
    'headers' => [
        'Content-Type:application/json',
        'Authorization:0kdm3hzmb4h3cf',
    ],
];
        
Curl::request('https://graph.facebook.com/zuck', $data);

- Send DELETE request and obtain response as object

$data = [
    'type'    => 'delete',
    'data'    => ['userId' => 10],
    'timeout' => 30,
    'referer' => 'http://' . $_SERVER['HTTP_HOST'],
    'headers' => [
        'Content-Type:application/json',
        'Authorization:0kdm3hzmb4h3cf',
    ],
];
        
Curl::request('https://graph.facebook.com/zuck', $data, 'object');

Tests

To run tests you just need composer and to execute the following:

git clone https://github.com/Josantonius/PHP-Curl.git

cd PHP-Curl

composer install

Run unit tests with PHPUnit:

composer phpunit

Run PSR2 code standard tests with PHPCS:

composer phpcs

Run PHP Mess Detector tests to detect inconsistencies in code style:

composer phpmd

Run all previous tests:

composer tests

Sponsor

If this project helps you to reduce your development time, you can sponsor me to support my open source work 😊

License

This repository is licensed under the MIT License.

josantonius / curl

Maintainers

Details