Kirin 93a3391a21 init 11 months ago
..
docs 93a3391a21 init 11 months ago
src 93a3391a21 init 11 months ago
tests 93a3391a21 init 11 months ago
.editorconfig 93a3391a21 init 11 months ago
.gitignore 93a3391a21 init 11 months ago
.travis.yml 93a3391a21 init 11 months ago
CHANGELOG.md 93a3391a21 init 11 months ago
LICENSE 93a3391a21 init 11 months ago
Makefile 93a3391a21 init 11 months ago
README.rst 93a3391a21 init 11 months ago
composer.json 93a3391a21 init 11 months ago
phpunit.xml.dist 93a3391a21 init 11 months ago

README.rst

=======
RingPHP
=======

Provides a simple API and specification that abstracts away the details of HTTP
into a single PHP function. RingPHP be used to power HTTP clients and servers
through a PHP function that accepts a request hash and returns a response hash
that is fulfilled using a `promise `_,
allowing RingPHP to support both synchronous and asynchronous workflows.

By abstracting the implementation details of different HTTP clients and
servers, RingPHP allows you to utilize pluggable HTTP clients and servers
without tying your application to a specific implementation.

.. code-block:: php

require 'vendor/autoload.php';

use GuzzleHttp\Ring\Client\CurlHandler;

$handler = new CurlHandler();
$response = $handler([
'http_method' => 'GET',
'uri' => '/',
'headers' => [
'host' => ['www.google.com'],
'x-foo' => ['baz']
]
]);

$response->then(function (array $response) {
echo $response['status'];
});

$response->wait();

RingPHP is inspired by Clojure's `Ring `_,
which, in turn, was inspired by Python's WSGI and Ruby's Rack. RingPHP is
utilized as the handler layer in `Guzzle `_ 5.0+ to send
HTTP requests.

Documentation
-------------

See http://ringphp.readthedocs.org/ for the full online documentation.