grantholle/pear-http-request2

A port of pear/http_request2: Provides an easy way to perform HTTP requests.

4.0.0 2023-02-15 09:51 UTC

Requires

• php: ^8.1
• ext-curl: *
• ext-fileinfo: *
• ext-mbstring: *
• ext-zlib: *
• grantholle/pear-net-url2: ^4.0

Requires (Dev)

• ext-json: *
• phpunit/phpunit: ^8

Suggests

• ext-openssl: Allows handling SSL requests when not using cURL.

BSD-3-Clause

• Alexey Borzov
• Grant Holle

• PEAR
• curl
• http
• request

README

Provides an easy way to perform HTTP requests, uses pluggable adapters

• Socket: pure PHP implementation of HTTP protocol (does not use http stream wrapper), based on older PEAR HTTP_Request package
• Curl: wrapper around PHP's cURL extension
• Mock: used for testing packages depending on HTTP_Request2, returns predefined responses without network interaction

Both Socket and Curl adapters support POST requests with data and file uploads, basic and digest authentication, cookies, managing cookies across requests, HTTP and SOCKS5 proxies, gzip and deflate encodings, redirects, monitoring the request progress with Observers...

This package is PEAR HTTP_Request2 and has been migrated from PEAR SVN

Please report all issues via the GitHub issues.

Pull requests are welcome.

Basic usage

require_once 'src/Request2.php';

$request = new HTTP_Request2('http://pear.php.net/', HTTP_Request2::METHOD_GET);
try {
    $response = $request->send();
    if (200 == $response->getStatus()) {
        echo $response->getBody();
    } else {
        echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
             $response->getReasonPhrase();
    }
} catch (HTTP_Request2_Exception $e) {
    echo 'Error: ' . $e->getMessage();
}

Documentation

...is available on PEAR website

• Numerous configuration options
• How to populate the request object
• Description of available adapters
• Processing of HTTP response
• Monitoring the progress of request with observers
• Possible exceptions

Generated API documentation for the current release is also there.

Testing, Packaging and Installing (Pear)

To test, run either

$ phpunit tests/

or

$ pear run-tests -r

You may need to set up the NetworkConfig.php file if you want to perform tests that interact with a web server. Its template is NetworkConfig.php.dist file, consult it for the details.

To build, simply

$ pear package

To install from scratch

$ pear install package.xml

To upgrade

$ pear upgrade -f package.xml