kemist/http

PSR-7 Compliant HTTP library

v1.0.1 2015-03-24 09:04 UTC

This package is auto-updated.

Last update: 2024-12-05 20:38:27 UTC


README

Build Status Scrutinizer Code Quality Coverage Status Latest Stable Version License

HTTP library compliant with proposed PSR-7 message implementation, basically inspired by phly/http

Installation

Via composer:

{
    "require": {
        "kemist/http": "1.0.*"
    }
}

HTTP Client

This package contains a cURL- and a socket-based HTTP client class. Basic GET example:

<?php
$request=new Kemist\Http\Request('http://httpbin.org/get?sd=43','GET',array('accept'=>'text/html','connection'=>'close'));

// cURL client
$client=new Kemist\Http\Client\CurlClient();
// OR Socket-based client
$client=new Kemist\Http\Client\SocketClient();

$response=$client->send($request);

var_dump($response->getHeaders());
var_dump($response->getBody()->getContents());

Basic POST example:

<?php
$request=(new Kemist\Http\Request())
        ->withUri(new Kemist\Http\Uri('http://httpbin.org/post'))
        ->withMethod('POST')
        ->withHeader('accept','text/html')
        ->withHeader('connection','close')
        ->withBody(new Kemist\Http\Stream\StringStream('param1=value1&param2=value2'))
;

// cURL client
$client=new Kemist\Http\Client\CurlClient();
// OR Socket-based client
$client=new Kemist\Http\Client\SocketClient();

$response=$client->send($request);

var_dump($response->getHeaders());
var_dump(json_decode($response->getBody()));

Both client types have the following options:

<?php

// Client options and their default values
$options=array(
        'follow_redirections' => true,
        'max_redirections' => 10,
        'use_cookies' => true,
        'dechunk_content' => true,
        'decode_content' => true,
        'connection_timeout' => 30,
        'timeout' => 60,
    );
// Options are set through the client constructor
$client=new Kemist\Http\Client\SocketClient($options);

HTTP Server

When using the HTTP server component, you can handle incoming request to the server through middleware objects or closures.

<?php
$server = new Kemist\Http\Server\Server();
// Appends a closure middleware
$server->appendMiddleware(function($request, $response, $server) {    
    $response->getBody()->write('world!');    
    return $response;
});
// Prepends a closure middleware
$server->prependMiddleware(function($request, $response, $server) {    
    $response->getBody()->write('Hello ');    
    return $response;
});

$response=$server->handle();
echo $response;

You can break the middleware chain by stopping propagation to the next middleware:

<?php

$server->appendMiddleware(function($request, $response, $server) {    
    $response->getBody()->write('This string never appears!');    
    return $response;
});

$server->prependMiddleware(function($request, $response, $server) {    
    $response->getBody()->write('Hello world!');    
    $server->stopPropagation();
    return $response;
});

You can also use middlewares extending AbstractMiddleware class. This package ships with one example middleware: IsNotModifiedMiddleware. It decides if content is not modified comparing some special request and response headers (ETag and Last-Modified) then sets the proper response status code and stops propagation.

<?php
$server->appendMiddleware(new Kemist\Http\Server\IsNotModifiedMiddleware());