Giter VIP home page Giter VIP logo

php_component_curl's Introduction

Simple Curl Wrapper Component for PHP

This project aims to deliver an easy to use and free as in freedom object oriented php curl command component.

The build status of the current master branch is tracked by Travis CI: Build Status Latest stable

The scrutinizer status is: code quality

The versioneye status is: Dependency Status

Take a look on openhub.net.

The current change log can be found here.

This component is not developed to replace guzzle.

Example

By Using The Builder

//it is always good to ship the component with a factory to easy up usage
use Net\Bazzline\Component\Curl\BuilderFactory;
use Net\Bazzline\Component\Curl\Option\Timeout;

$factory    = new BuilderFactory();
$builder    = $factory->create();
$url        = 'http://www.foo.bar';
$timeout    = new Timeout(10);  //set the timeout to 10 seconds

/**
 * you can also use:
 *  //assuming that $dispatcher is an instance of DispatcherInterface
 *  //assuming that $requestFactory is an instance of RequestFactory
 *  $builder->overwriteDispatcher($dispatcher);
 *  $builder->overwriteRequestFactory($requestFactory);
 */

$response = $builder->usePost()
    ->onTheUrl($url)
    ->withTheData($data)
    ->withTheParameters(array('descendingOrderBy' => 'id'))
    ->withTheOption($timeout)
    ->andFetchTheResponse();

/** 
 * you can also use:
 *  $builder->withTheHeaderLine($headLine)    //add the headline you want
 *  $builder->withResponseModifier($modifier) //add the response modifier you want
 */

echo 'content: ' . $response->content() . PHP_EOL;
echo 'content type: ' . $response->contentType() . PHP_EOL;
echo 'error:' . $response->error() . PHP_EOL;
echo 'error code:' . $response->errorCode() . PHP_EOL;
echo 'head lines: ' . var_export($response->headerLines(), true) . PHP_EOL;
echo 'status code: ' . $response->statusCode() . PHP_EOL;

By Using The Request

//it is always good to ship the component with a factory to easy up usage
$factory    = new Net\Bazzline\Component\Curl\RequestFactory();
$request    = $factory->create();
$url        = 'http://www.foo.bar';

$response = $request->get($url);

echo 'content: ' . $response->content() . PHP_EOL;
echo 'content type: ' . $response->contentType() . PHP_EOL;
echo 'error:' . $response->error() . PHP_EOL;
echo 'error code:' . $response->errorCode() . PHP_EOL;
echo 'head lines: ' . var_export($response->headerLines(), true) . PHP_EOL;
echo 'status code: ' . $response->statusCode() . PHP_EOL;

Executable Examples

More Examples

Post Request With Basic Authentication

//begin of runtime environments
$factory        = new BuilderFactory();
$builder        = $factory->create();
$data           = array(
    'there'     => 'is',
    'no'        => 'foo',
    'without'   => 'a bar'
);
$password       = '<super secret password>';
$username       = '[email protected]';
$url            = 'https://foo.bar.ru/api/my/rest/endpoint/v1';
//end of runtime environments

//begin building the request
$builder->asJson();
$builder->onTheUrl($url);
$builder->withTheData($data);
$builder->withTheOption(new SetBasicAuthentication());
$builder->withTheOption(new SetUsernameAndPassword($username, $password));
$builder->usePost();
//end building the request

$request = $builder->andFetchTheResponse();
echo PHP_EOL . 'dumping the request' . PHP_EOL;
var_dump($request);

Terms

  • Dispatcher
    • doing the curl request
    • if you want to use pure curl, use this class
  • Request
    • object oriented approach reflecting the request
    • HeadLine
      • object oriented http headers (list of available headers), start a pull request if you need more
    • Options
      • object oriented curl options, start a pull request if you need more
    • Parameters
      • all the parameters you want to add to your url - they are urlencoded automatically
    • Url
      • the url of your endpoint
  • Response
    • object oriented approach reflecting the response
    • ResponseBehaviour
      • interface to interact with the response
        • either modify the response (by creating a new one)
        • change the flow by throwing an exception if the response does not fits your needs (as example)
  • Builder
    • provides a fluent interface to easy up using curl
    • it takes care of all :-)

Not Available Curl Options

In general, the php version is limiting the available curl options. Furthermore, some options are not implemented because of their hardcoded usage in the Response or the Dispatcher (you can set it but they would be overwritten).

This options are:

  • used in the Request
    • CURLOPT_CUSTOMREQUEST
    • CURLOPT_HTTPHEADER
    • CURLOPT_POSTFIELDS
  • used in the Dispatcher
    • CURLINFO_HEADER_OUT
    • CURLOPT_HEADERFUNCTION
    • CURLOPT_RETURNTRANSFER

If you want to change this, you either have to extend the existing Request or Dispatcher object.

Install

By Hand

mkdir -p vendor/net_bazzline/php_component_curl
cd vendor/net_bazzline/php_component_curl
git clone https://github.com/bazzline/php_component_curl .
composer require net_bazzline/php_component_curl:dev-master

Links

Other Components Available

Final Words

Star it if you like it :-). Add issues if you need it. Pull patches if you enjoy it. Write a blog entry if you use it. Donate something if you love it :-].

php_component_curl's People

Contributors

stevleibelt avatar tworzenieweb avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

php_component_curl's Issues

Issue with JSON POST requests

Hi Stev,

I've just found that there is an issue with sending post requests with json as content type using this component.

The first problem is the fact that default header

'application/x-www-form-urlencoded; charset=UTF-8'

is always set in

https://github.com/bazzline/php_component_curl/blob/master/source/Request/RequestFactory.php#L80

so even if you use asJson() method in builder it will have two different content type headers.

'application/json'
'application/x-www-form-urlencoded; charset=UTF-8'

And because the default one is the last one then it is overriding json content type.

Lastly if request is of json type then ConvertJsonToArrayBehaviour is called after performing the request.

But there at line https://github.com/bazzline/php_component_curl/blob/master/source/ResponseBehaviour/ConvertJsonToArrayBehaviour.php#L24

json_encode function is triggered instead of json_decode.

As a workaround user can call Builder::reset(true) method after builder create method to just have this headers empty and then use asJson to make the valid content type.

But there is no way to fetch the correct response content since original json content is encoded once again after fetchin instead of json_decodeing.

Regards
Luke

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.