Initial commit

Author: nabeghe

.gitignore

@@ -0,0 +1,3 @@
+.idea
+.phpunit.result.cache
+/vendor/

LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Hadi Akbarzadeh [email protected]
+
+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.

README.md

@@ -0,0 +1,65 @@
+# Headers Reader for PHP
+
+> A simple way to read headers from the `getallheaders` function in PHP.
+
+<hr>
+
+## 🫡 Usage
+
+### 🚀 Installation
+
+You can install the package via composer:
+
+```bash
+composer require nabeghe/headers-reader
+```
+
+<hr>
+
+### Example 1 - Main Class
+
+```php
+use Nabeghe\HeadersReader\Headers;
+
+echo 'X-Custom-1: '.Headers::get('X-Custom-1', 'The default value for X-Custom-1')."\n<br>";
+echo 'X-Custom-2: '.Headers::get('X-Custom-2', 'The default value for X-Custom-2')."\n<br>";
+echo 'X-Custom-3: '.Headers::get('X-Custom-3', 'The default value for X-Custom-3')."\n<br>";
+echo 'X-Custom-4: '.Headers::get('X-Custom-4', 'The default value for X-Custom-4')."\n<br>";
+echo 'X-Custom-5: '.Headers::get('X-Custom-4')."\n<br><br>"; // Default value is blank.
+
+print_r(Headers::all()); // Returns all headers.
+
+Headers::flush(); // Clears the cache.
+```
+
+### Example 1 - Custom Class
+
+```php
+use Nabeghe\HeadersReader\Headers;
+
+class MyHeaders extends Headers
+{
+    public const DEFAULT = 'The general default value';
+
+    public const DEFAULTS = [
+        'X-Custom-1' => 'The default value for X-Custom-1',
+        'X-Custom-2' => 'The default value for X-Custom-2',
+        'X-Custom-3' => 'The default value for X-Custom-3',
+        'X-Custom-4' => 'The default value for X-Custom-4',
+    ];
+}
+
+echo 'X-Custom-1: '.MyHeaders::get('X-Custom-1')."\n<br>";
+echo 'X-Custom-2: '.MyHeaders::get('X-Custom-2')."\n<br>";
+echo 'X-Custom-3: '.MyHeaders::get('X-Custom-3')."\n<br>";
+echo 'X-Custom-4: '.MyHeaders::get('X-Custom-4')."\n<br>";
+echo 'X-Custom-5: '.MyHeaders::get('X-Custom-5')."\n<br>";
+```
+
+<hr>
+
+## 📖 License
+
+Copyright (c) Hadi Akbarzadeh
+
+Licensed under the MIT license, see [LICENSE.md](LICENSE.md) for details.

composer.json

@@ -0,0 +1,28 @@
+{
+  "name": "nabeghe/headers-reader",
+  "description": "A simple way to read headers from the `getallheaders` function in PHP.",
+  "keywords": [
+    "header", "headers", "headers reader", "headers reader", "reader", "getallheaders",
+    "library", "helper", "support"
+  ],
+  "type": "library",
+  "version": "1.0.0",
+  "homepage": "https://github.com/nabeghe/reflecty-php",
+  "license": "MIT",
+  "autoload": {
+    "psr-4": {
+      "Nabeghe\\HeadersReader\\": "src/"
+    }
+  },
+  "authors": [
+    {
+      "name": "Hadi Akbarzadeh",
+      "email": "[email protected]",
+      "homepage": "https://elatel.ir",
+      "role": "Developer"
+    }
+  ],
+  "require": {
+    "php": ">=5.6"
+  }
+}

src/Headers.php

@@ -0,0 +1,47 @@
+<?php namespace Nabeghe\HeadersReader;
+
+class Headers
+{
+    public const DEFAULT = '';
+
+    public const DEFAULTS = [];
+
+    protected static ?array $headers;
+
+    protected static function init()
+    {
+        if (!isset(static::$headers)) {
+            $headers = getallheaders();
+            if (!is_array($headers)) {
+                $headers = [];
+            }
+            static::$headers = $headers;
+        }
+    }
+
+    public static function all(): array
+    {
+        static::init();
+        return static::$headers;
+    }
+
+    public static function get($name, $default = null)
+    {
+        static::init();
+
+        if (isset(static::$headers[$name])) {
+            return static::$headers[$name];
+        }
+
+        if (func_num_args() > 1) {
+            return $default;
+        }
+
+        return static::DEFAULTS[$name] ?? static::DEFAULT;
+    }
+
+    public static function flush()
+    {
+        static::$headers = null;
+    }
+}