sndsgd/http

Improved HTTP for PHP

v1.0.0 2019-07-30 09:59 UTC

Requires

• php: >=7.1.0
• sndsgd/error: ~0.0.4
• sndsgd/form: >=0.1.3
• sndsgd/fs: >=0.4.0
• sndsgd/util: >=1.1.0

Requires (Dev)

• guzzlehttp/psr7: ^1.3
• mikey179/vfsstream: 1.6.4
• php-mock/php-mock-phpunit: ^2.2.0
• phpunit/phpunit: ^7.5.14
• satooshi/php-coveralls: ~1.0

MIT

• Russell B

README

Improved HTTP for PHP.

Requirements

You need PHP >= 7.1 to use this library, however, the latest stable version of PHP is recommended.

Install

Install sndsgd/http using Composer.

Usage

This library aims to improve how PHP handles HTTP requests, mainly by streamlining the the process of working with request parameters.

Improved Request Parameter Decoders

To experiment with the decoders, you can use PHP's built in webserver with the script located in bin/request-demo.php.

php -S localhost:8000 bin/request-demo.php

Now you will be able to make requests to http://localhost:8000 using any HTTP client. In the examples below, we'll be using httpie. To dump information about the request that is being made, simply append -v to any of the commands below.

Query String Decoder

In many query parameter implementations, you do not need to use brackets to indicate multiple values, but with PHP you do. For compatibility with the built in PHP decoder, you can continue to use brackets.

http http://localhost:8000/query a==1 a==2 a[]==💩

Result:

    "$_GET": {
        "a": [
            "💩"
        ]
    },
    "sndsgd": {
        "a": [
            "1",
            "2",
            "💩"
        ]
    }
}

Request Body Decoder

The built in body decoder for PHP only handles multipart/form-data and application/x-www-form-urlencoded content types for POST requests. This library acts as a polyfill to add application/json to that list, and to allow for decoding the request body for any request method. By default, POST requests will be processed by the built in PHP decoder, however, you can disable that functionality by setting enable_post_data_reading = Off in your php.ini.

The built in decoder will not decode the body of this urlencoded PATCH request

http --form PATCH http://localhost:8000/body a=1 b=2 c[d]=3a

Result:

{
    "$_POST": [],
    "$_FILES": [],
    "sndsgd": {
        "a": "1",
        "b": "2",
        "c": {
            "d": "3"
        }
    }
}

Uploaded Files

Instead of using $_FILES, with sndsgd/http uploaded files are included with the other parameters of the request body as objects.

http --form POST http://localhost:8000/body a=1 [e-mail]

Result:

{
    "$_POST": {
        "a": "1"
    },
    "$_FILES": {
        "file": {
            "name": "README.md",
            "type": "",
            "tmp_name": "/private/var/folders/2b/mtmy5wk56jx13vjgqpydc3nr0000gn/T/php9DTXiq",
            "error": 0,
            "size": 2766
        }
    },
    "sndsgd": {
        "a": "1",
        "file": {
            "filename": "README.md",
            "contentType": "text/x-markdown",
            "realContentType": "text/plain",
            "size": 2766,
            "tempfile": "/private/var/folders/2b/mtmy5wk56jx13vjgqpydc3nr0000gn/T/php9DTXiq"
        }
    }
}