dlzer/http-utils

Utility classes and constants for use with PSR-7

dev-master 2021-10-01 19:36 UTC

This package is auto-updated.

Last update: 2024-04-29 04:34:30 UTC


README

GitHub GitHub release (latest by date)

Utility classes and constants to provide quick reference usage for request methods and responses.

Installation

compose require dlzer/http-utils

Usage

When used in conjunction with PHP-FIG Status Code Interface.

// Custom responder method
public function withJson(
    ResponseInterface $response,
    $statusCode, 
    $message, 
    $data = null, 
    int $options = 0
    ): ResponseInterface
{
    return $response->write(json_encode([
        "status" => $statusCode,
        "message" => $message,
        "data" => $data
    ], $options);
    );
}

// Usage
$data = ["connection" => true];
return $this->responder->withJson(
    $response, // The response interface
    StatusCodeInterface::STATUS_OK // The status code interface
    StatusCodeMessage::STATUS_OK // The status message interface: "OK"
    $data // The response data
);

Output:

{
    "status": 200,
    "message": "OK",
    "data": {
        "connection": true
    }
}