Merge pull request #1 from ABGEO07/develope

Develope

Author: ABGEO

CHANGELOG.md

@@ -1 +1,10 @@
-# Cherry-response Changelog
+# Cherry-response Changelog
+
+## [v1.0.0](https://github.com/ABGEO07/cherry-response/releases/tag/v1.0.0 "v1.0.0") (2019-03-25)
+#### The first stable version
+
+- Package available on: `composer require cherry-project/response`
+
+- Class features
+	- Set status code
+	- Set additional headers

README.md

@@ -1,4 +1,54 @@
 # Cherry-Response
 The Cherry-project Response wrapper
 
+[![GitHub license](https://img.shields.io/github/license/abgeo07/cherry-response.svg)](https://github.com/ABGEO07/cherry-response/blob/master/LICENSE)
+
+[![GitHub release](https://img.shields.io/github/release/abgeo07/cherry-response.svg)](https://github.com/ABGEO07/cherry-response/releases)
+
+[![Packagist Version](https://img.shields.io/packagist/v/cherry-project/response.svg "Packagist Version")](https://packagist.org/packages/cherry-project/response "Packagist Version")
+
+------------
+
+## Including
+**Install from composer** `composer require cherry-project/response`
+
+**Include Autoloader in your main file** (Ex.: index.php)
+```php
+require_once __DIR__ . '/vendor/autoload.php';
+```
+
+## Class Request
+Import class
+```php
+use Cherry\Response;
+```
+Crete class new object
+```php
+$response = new Response();
+```
+
+Prepare data for transmission (Ex.: Array)
+```php
+$arr = [
+    'test' => 'vTest',
+    'test2' => [
+        'test2.1' => '2.1',
+        'test2.2' => [
+            'test2.2.1' => '2.2.1'
+        ]
+    ]
+];
+```
+
+For sending response use **sendResponse()** method
+
+The method takes 3 arguments:
+- Content (**Required**; Mixed) - The data for returning;
+- Status Code (**Optional**; 200 by default; Integer) - The HTTP Status Code;
+- HTTP Headers (**Optional**; empty by default; Key `=>` Value Array) - The HTTP Headers;
+
+```php
+echo $response->sendResponse(json_encode($arr), 200, ['Content-Type' => 'application/json']);
+```
+
 **2019 © Cherry-project**

examples/test.php

@@ -5,4 +5,17 @@
 
 use Cherry\Response;
 
-$request = new Response();
+//Send Response
+$response = new Response();
+
+$arr = [
+    'test' => 'vTest',
+    'test2' => [
+        'test2.1' => '2.1',
+        'test2.2' => [
+            'test2.2.1' => '2.2.1'
+        ]
+    ]
+];
+
+echo $response->sendResponse(json_encode($arr), 200, ['Content-Type' => 'application/json']);

src/Response.php

@@ -10,4 +10,125 @@
  */
 class Response
 {
+    /**
+     * Get http status code full text
+     *
+     * @param $statusCode
+     * @return string
+     */
+    private function getStatusCodeMsg($statusCode)
+    {
+        $msg = array(
+            100 => 'Continue',
+            101 => 'Switching Protocols',
+            102 => 'Processing',
+            200 => 'OK',
+            201 => 'Created',
+            202 => 'Accepted',
+            203 => 'Non-Authoritative Information',
+            204 => 'No Content',
+            205 => 'Reset Content',
+            206 => 'Partial Content',
+            207 => 'Multi-Status',
+            208 => 'Already Reported',
+            226 => 'IM Used',
+            300 => 'Multiple Choices',
+            301 => 'Moved Permanently',
+            302 => 'Found',
+            303 => 'See Other',
+            304 => 'Not Modified',
+            305 => 'Use Proxy',
+            306 => 'Switch Proxy',
+            307 => 'Temporary Redirect',
+            308 => 'Permanent Redirect',
+            400 => 'Bad Request',
+            401 => 'Unauthorized',
+            402 => 'Payment Required',
+            403 => 'Forbidden',
+            404 => 'Not Found',
+            405 => 'Method Not Allowed',
+            406 => 'Not Acceptable',
+            407 => 'Proxy Authentication Required',
+            408 => 'Request Timeout',
+            409 => 'Conflict',
+            410 => 'Gone',
+            411 => 'Length Required',
+            412 => 'Precondition Failed',
+            413 => 'Request Entity Too Large',
+            414 => 'Request-URI Too Long',
+            415 => 'Unsupported Media Type',
+            416 => 'Requested Range Not Satisfiable',
+            417 => 'Expectation Failed',
+            418 => 'I\'m a teapot',
+            419 => 'Authentication Timeout',
+            420 => 'Enhance Your Calm',
+            422 => 'Unprocessable Entity',
+            423 => 'Locked',
+            424 => 'Failed Dependency',
+            425 => 'Unordered Collection',
+            426 => 'Upgrade Required',
+            428 => 'Precondition Required',
+            429 => 'Too Many Requests',
+            431 => 'Request Header Fields Too Large',
+            444 => 'No Response',
+            449 => 'Retry With',
+            450 => 'Blocked by Windows Parental Controls',
+            451 => 'Unavailable For Legal Reasons',
+            494 => 'Request Header Too Large',
+            495 => 'Cert Error',
+            496 => 'No Cert',
+            497 => 'HTTP to HTTPS',
+            499 => 'Client Closed Request',
+            500 => 'Internal Server Error',
+            501 => 'Not Implemented',
+            502 => 'Bad Gateway',
+            503 => 'Service Unavailable',
+            504 => 'Gateway Timeout',
+            505 => 'HTTP Version Not Supported',
+            506 => 'Variant Also Negotiates',
+            507 => 'Insufficient Storage',
+            508 => 'Loop Detected',
+            509 => 'Bandwidth Limit Exceeded',
+            510 => 'Not Extended',
+            511 => 'Network Authentication Required',
+            598 => 'Network read timeout error',
+            599 => 'Network connect timeout error',
+        );
+
+        return $msg[$statusCode];
+    }
+
+    /**
+     * Set HTTP Headers
+     *
+     * @param $statusCode
+     * @param $headers
+     */
+    private function setHTTPHeaders($statusCode, $headers)
+    {
+        //Set HTTP Version and status header
+        header("{$_SERVER['SERVER_PROTOCOL']} {$statusCode} {$this->getStatusCodeMsg($statusCode)}");
+        //Set other headers
+        foreach ($headers as $k => $v)
+            header("{$k}: $v");
+    }
+
+    /**
+     * Send Response.
+     *
+     * @param $content
+     * @param int $statusCode
+     * @param array $headers
+     *
+     * @return mixed
+     */
+    public function sendResponse($content, $statusCode = 200, $headers = [])
+    {
+        if ($content == '' || $content == null)
+            die('Set response content!');
+
+        $this->setHTTPHeaders($statusCode, $headers);
+
+        return $content;
+    }
 }