First commit for HTTP Response Header

pH-7 · pH-7 · commit 8de1f9ab3c2a · 2023-06-09T12:08:03.000+09:00
diff --git a/.github/worflows/ci-test.yml b/.github/worflows/ci-test.yml
@@ -0,0 +1,51 @@
+name: Tests
+
+on: [ push, pull_request ]
+
+jobs:
+  run:
+    runs-on: ${{ matrix.operating-system }}
+    strategy:
+      matrix:
+        operating-system: [ 'ubuntu-latest' ]
+        php-versions: [ '8.0', '8.1', '8.2' ]
+    name: PHP ${{ matrix.php-versions }} Test on ${{ matrix.operating-system }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-versions }}
+          coverage: none
+
+      - name: Check PHP Version
+        run: php -v
+
+      - name: Check Composer Version
+        run: composer -V
+
+      - name: Check PHP Extensions
+        run: php -m
+
+      - name: Get Composer Cache Directory
+        id: composer-cache
+        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+
+      - name: Cache Composer dependencies
+        uses: actions/cache@v3
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: ${{ runner.os }}-composer-
+
+      - name: Validate composer.json and composer.lock
+        run: composer validate --strict
+
+      - name: Install dependencies for PHP
+        run: composer update --no-interaction --no-progress --no-suggest
+
+      - name: Run test suite
+        run: composer test
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,11 @@
+# Depedency folders
+/vendor/
+composer.lock
+
+# IDE config folders
+.idea/
+
+# Testing
+/.phpunit.cache/
+.phpunit.result.cache
+phpunit.xml
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,21 @@
+# MIT License
+
+*Copyright (c) 2023 Pierre-Henry Soria*
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,31 @@
+# PHP HTTP Response
+
+**Send easily HTTP status codes to the browser.**
+
+
+```php
+
+
+```
+
+
+
+## 🧑‍🍳 Who made this...?
+
+[![Pierre-Henry Soria](https://s.gravatar.com/avatar/a210fe61253c43c869d71eaed0e90149?s=200)](https://PH7.me 'Pierre-Henry Soria personal website')
+
+**Pierre-Henry Soria**. A super passionate & enthusiastic software engineer! 🚀 True cheese 🧀 , mushrooms, and chocolate lover! 😋 Reach me at [PH7.me](https://PH7.me) 💫
+️
+☕️ Are you enjoying it? **[Offer me a coffee](https://ko-fi.com/phenry)** and boost the software development at the same time! 💪
+
+[![@phenrysay][twitter-image]](https://twitter.com/phenrysay) [![pH-7][github-image]](https://github.com/pH-7)
+
+
+## ⚖️ License
+
+**PHP HTTP Response** is generously distributed under the _[MIT](https://opensource.org/licenses/MIT)_ 🎉 Enjoy!
+
+
+<!-- GitHub's Markdown reference links -->
+[twitter-image]: https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white
+[github-image]: https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white
diff --git a/composer.json b/composer.json
@@ -0,0 +1,40 @@
+{
+    "name": "ph-7/php-http-response-header",
+    "description": "A simple package that sends HTTP header status codes",
+    "keywords": [
+        "HTTP code",
+        "HTTP status code",
+        "status code",
+        "PHP status codes",
+        "clean code",
+        "constant",
+        "constants",
+        "http",
+        "code",
+        "magic number",
+        "all status codes",
+        "all HTTP status codes"
+    ],
+    "homepage": "https://pierrehenry.be",
+
+    "type": "library",
+    "require": {
+        "php": ">=8.0",
+        "ph-7/just-http-status-codes": "^1.1"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^10.2"
+    },
+    "license": "MIT",
+    "autoload": {
+        "psr-4": {
+            "PH7\\PhpHttpResponseHeader\\": "src/"
+        }
+    },
+    "authors": [
+        {
+            "name": "Pierre-Henry Soria",
+            "email": "hi@PH7.me"
+        }
+    ]
+}
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="utf-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/autoload.php" colors="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.2/phpunit.xsd" cacheDirectory=".phpunit.cache">
+  <coverage/>
+  <testsuites>
+    <testsuite name="Unit Tests">
+      <directory>tests</directory>
+    </testsuite>
+  </testsuites>
+  <source>
+    <include>
+      <directory suffix=".php">src</directory>
+    </include>
+  </source>
+</phpunit>
diff --git a/src/Exception.php b/src/Exception.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace PH7\PhpHttpResponseHeader;
+
+use RuntimeException;
+
+class Exception extends RuntimeException
+{
+
+}
diff --git a/src/Http.php b/src/Http.php
@@ -0,0 +1,172 @@
+<?php
+
+namespace PH7\PhpHttpResponseHeader;
+
+use PH7\JustHttp\StatusCode;
+
+class Http
+{
+    protected const STATUS_CODE = [
+        100 => '100 Continue',
+        101 => '101 Switching Protocols',
+        102 => '102 Processing',
+        103 => 'Early Hints',
+        200 => '200 OK',
+        201 => '201 Created',
+        202 => '202 Accepted',
+        203 => '203 Non-Authoritative Information',
+        204 => '204 No Content',
+        205 => '205 Reset Content',
+        206 => '206 Partial Content',
+        207 => '207 Multi-Status',
+        208 => '208 Already Reported',
+        226 => '226 IM Used',
+        300 => '300 Multiple Choices',
+        301 => '301 Moved Permanently',
+        302 => '302 Found',
+        303 => '303 See Other',
+        304 => '304 Not Modified',
+        305 => '305 Use Proxy',
+        307 => '307 Temporary Redirect',
+        308 => '308 Permanent Redirect',
+        400 => '400 Bad Request',
+        401 => '401 Unauthorized',
+        402 => '402 Payment Required',
+        403 => '403 Forbidden',
+        404 => '404 Not Found',
+        405 => '405 Method Not Allowed',
+        406 => '406 Not Acceptable',
+        407 => '407 Proxy Authentication Required',
+        408 => '408 Request Time-out',
+        409 => '409 Conflict',
+        410 => '410 Gone',
+        411 => '411 Length Required',
+        412 => '412 Precondition Failed',
+        413 => '413 Request Entity Too Large',
+        414 => '414 Request-URI Too Large',
+        415 => '415 Unsupported Media Type',
+        416 => '416 Requested range not satisfiable',
+        417 => '417 Expectation Failed',
+        422 => '422 Unprocessable Entity',
+        423 => '423 Locked',
+        424 => '424 Method Failure',
+        425 => '425 Unordered Collection',
+        426 => '426 Upgrade Required',
+        428 => '428 Precondition Required',
+        429 => '429 Too Many Requests',
+        431 => '431 Request Header Fields Too Large',
+        500 => '500 Internal Server Error',
+        501 => '501 Not Implemented',
+        502 => '502 Bad Gateway',
+        503 => '503 Service Unavailable',
+        504 => '504 Gateway Time-out',
+        505 => '505 HTTP Version Unsupported',
+        506 => '506 Variant Also Negotiates',
+        507 => '507 Insufficient Storage',
+        508 => '508 Loop Detected',
+        509 => '509 Bandwidth Limit Exceede',
+        510 => '510 Not Extended',
+        511 => '511 Network Authentication Required',
+        598 => '598 Network read timeout error',
+        599 => '599 Network connect timeout error'
+    ];
+
+
+    /**
+     * Give the HTTP status code name (e.g. "204 No Content").
+     *
+     * @param int $iStatus The "code" for the HTTP status.
+     *
+     * @return string|bool $iStatus Returns the "HTTP status code" if found, FALSE otherwise.
+     */
+    public static function getStatusCode(int $iStatus): string|bool
+    {
+        return !empty(static::STATUS_CODE[$iStatus]) ? static::STATUS_CODE[$iStatus] : false;
+    }
+
+    /**
+     * Retrieve the list with headers that are sent or to be sent.
+     */
+    public static function getHeadersList(): array
+    {
+        return headers_list();
+    }
+
+    /**
+     * Set one or multiple headers.
+     *
+     * @param string|array $mHeaders Headers to send.
+     *
+     * @throws Exception
+     */
+    public static function setHeaders(string|array $mHeaders): void
+    {
+        // Header already sent
+        if (static::isSent()) {
+            throw new Exception('Headers were already sent.');
+        }
+
+        // Loop elements and set header
+        foreach ((array)$mHeaders as $sHeader) {
+            header((string)$sHeader);
+        }
+    }
+
+    /**
+     * Parse headers for a given status code.
+     *
+     * @param int $iCode The code to use, possible values are: 200, 301, 302, 304, 307, 400, 401, 403, 404, 410, 500, 501, ...
+     *
+     * @throws Exception
+     */
+    public static function setHeadersByCode(int $iCode = StatusCode::OK): void
+    {
+        if (!static::getStatusCode($iCode)) {
+            $iCode = StatusCode::OK;
+        }
+
+        static::setHeaders(static::getProtocol() . ' ' . static::getStatusCode($iCode));
+    }
+
+    /**
+     * Set a HTTP Content Type.
+     *
+     * @param string $sType Example: "text/xml".
+     *
+     * @throws Exception
+     */
+    public static function setContentType(string $sType): void
+    {
+        static::setHeaders('Content-Type: ' . $sType);
+    }
+
+    /**
+     * Set the HTTP status code for the maintenance page.
+     *
+     * @param int $iMaintenanceTime Time site will be down for (in seconds).
+     */
+    public static function setMaintenanceCode(int $iMaintenanceTime): void
+    {
+        header(static::getProtocol() . ' 503 Service Temporarily Unavailable');
+        header('Retry-After: ' . $iMaintenanceTime);
+    }
+
+
+    /**
+     * @return string|null The HTTP server protocol.
+     */
+    public static function getProtocol(): ?string
+    {
+        return Server::getVariable(Server::SERVER_PROTOCOL);
+    }
+
+    /**
+     * Checks if any headers were already sent.
+     *
+     * @return bool TRUE if the headers were sent, FALSE if not.
+     */
+    private static function isSent(): bool
+    {
+        return headers_sent();
+    }
+}
diff --git a/src/Server.php b/src/Server.php
@@ -0,0 +1,23 @@
+<?php
+
+namespace PH7\PhpHttpResponseHeader;
+
+final class Server
+{
+    const SERVER_PROTOCOL = 'SERVER_PROTOCOL';
+
+    /**
+     * Retrieve a member of the $_SERVER super global.
+     *
+     * @param string|null $sKey If NULL, returns the entire $_SERVER variable.
+     * @param string|null $sDefVal A default value to use if server key is not found.
+     */
+    public static function getVariable(?string $sKey = null, ?string $sDefVal = null): string|array|null
+    {
+        if (null === $sKey) {
+            return $_SERVER;
+        }
+
+        return !empty($_SERVER[$sKey]) ? htmlspecialchars((string)$_SERVER[$sKey], ENT_QUOTES) : $sDefVal;
+    }
+}
diff --git a/tests/HttpTest.php b/tests/HttpTest.php
