http-response

Installation with Composer

Add repository

Add Repository to "composer.json"

"repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/saeedmou/http-response"
        }
    ],

Require

Require this package with the following composer cli command

composer require http-response

How to use

Add composer autoload at the beginig of the script

require_once("../vendor/autoload.php");

use the namespace

use Saeedmou\HttpResponse\HttpResponse;

create a new Instance of the library

$httpResponse=new HttpResponse();

now send headers

$httpResponse->sendHeaders();

set the output data

$httpResponse->setResponseParameters(true,"Test",["root",array("data1"=>null,"data2"=>"test","data3"=>55)],false);

or

$array=
    array(
        "status"=> true,
        "message"=> "Test",
        "data"=>
            ["root",
            array(
                "data1"=>null,
                "data2"=>"test",
                "data3"=>66
                )
            ]
    );
$httpResponse->setResponseArray($array);

now send the data as json

$httpResponse->sendJson(true);

and output will be like this

{
    "status": true,
    "message": "Test",
    "data": [
        "root",
        {
            "data1": null,
            "data2": "test",
            "data3": 66
        }
    ]
}

and the Http response header

HTTP/1.1 200 OK
Host: localhost:3000
Date: Thu, 04 Mar 2021 14:30:06 GMT
Connection: close
X-Powered-By: PHP/7.3.26
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods:  GET, POST, OPTIONS, HEAD
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
Content-Type: application/json; charset=UTF-8
Expires: on, 01 Jan 1970 00:00:00 GMT
Last-Modified: Thu, 04 Mar 2021 14:30:06 GMT
Cache-Control: no-store, no-cache, must-revalidate, max-age=0
Cache-Control: post-check=0, pre-check=0
Pragma: no-cache

the content also could be transfered as a json file

$httpResponse->sendJsonAsFile("myFile.json");

and output will be downloaded as "myFile.json" with the following content

{"status":true,"message":"Test","data":["root",{"data1":null,"data2":"test","data3":66}]}

general send contents as file

$content = file_get_contents("./files/sample.txt");
$httpResponse->sendContentAsFile($content,"new-text.txt");

the output the "./files/sample.txt" renamed to "new-text.txt". the header is

HTTP/1.1 200 OK
Host: localhost:3000
Date: Fri, 05 Mar 2021 21:07:02 GMT
Connection: close
X-Powered-By: PHP/7.3.26
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods:  GET, POST, OPTIONS, HEAD
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
Expires: on, 01 Jan 1970 00:00:00 GMT
Last-Modified: Fri, 05 Mar 2021 21:07:02 GMT
Cache-Control: no-store, no-cache, must-revalidate, max-age=0
Cache-Control: post-check=0, pre-check=0
Pragma: no-cache
Content-Type: application/octet-stream
Content-Transfer-Encoding: Binary
Content-Length: 22
Content-disposition: attachment; filename="new-text.txt"