File: README.md

Recommend this page to a friend!
  Classes of Josantonius  >  PHP Curl  >  README.md  >  Download  
File: README.md
Role: Documentation
Content type: text/markdown
Description: Documentation
Class: PHP Curl
Send HTTP requests to remote servers using Curl
Author: By
Last change:
Date: 2 years ago
Size: 8,711 bytes
 

Contents

Class file image Download

PHP Curl library

Latest Stable Version Latest Unstable Version License Codacy Badge Total Downloads Travis PSR2 PSR4 CodeCov

Versión en español

API Requests using the HTTP protocol through the Curl library.

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

? TODO

  • [ ] Add new feature.
  • [ ] Improve tests.
  • [ ] Improve documentation.
  • [ ] Refactor code for disabled code style rules. See phpmd.xml and .php_cs.dist.

Contribute

If you would like to help, please take a look at the list of issues or the To Do checklist.

Pull requests

  • Fork and clone.
  • Run the command `composer install` to install the dependencies. This will also install the dev dependencies.
  • Run the command `composer fix` to excute code standard fixers.
  • Run the tests.
  • Create a branch, commit, push and send me a pull request.

Repository

The file structure from this repository was created with PHP-Skeleton.

License

This project is licensed under MIT license. See the LICENSE file for more info.

Copyright

2016 - 2018 Josantonius, josantonius.com

If you find it useful, let me know :wink:

You can contact me on Twitter or through my email.


For more information send a message to info at phpclasses dot org.