An open API service indexing awesome lists of open source software.

https://github.com/ph-7/php-http-header-response

A simple package to send HTTP header responses ✨
https://github.com/ph-7/php-http-header-response

header http http-codes http-headers php php-header-response php-headers php-http-headers

Last synced: 3 months ago
JSON representation

A simple package to send HTTP header responses ✨

Awesome Lists containing this project

README

          

# PHP HTTP Response Headers

**Simple PHP package to safely send the right HTTP header responses to the browser 🐘**

- [⚙️ Requirement](#%EF%B8%8F-requirement)
- [📦 Installation](#-installation)
- [🪄 Examples](#-usage---examples)
- [👨‍🍳 Who is the baker?](#-who-baked-this)
- [🎥 Me building this package](#-me-building-this-package)
- [⚖️ License](#%EF%B8%8F-license)

## ⚙️ Requirement
* [PHP v8.0](https://www.php.net/releases/8.0/en.php) or higher 🚀

## 📦 Installation

The simplest way to add this library to your project, is with [Composer](https://getcomposer.org).

```console
composer require ph-7/php-http-response-header
```

## 🪄 Usage - Examples

### Send Header By HTTP Code
```php
use PH7\PhpHttpResponseHeader\Header;

// Sends "200 OK" header to the browser
Http::setHeadersByCode(200);

// ...

// Send "201 Created" header
Http::setHeadersByCode(201);

// ...

// Sends "404 Not Found" to the browser
Http::setHeadersByCode(404);

// ...

// Sends "400 Bad Request" header to the browser
Http::setHeadersByCode(400);

// and so on ...
```

**But, the library has many more handy methods such as below:**

### Maintenance Code
```php
use PH7\PhpHttpResponseHeader\Header;

// Send 503, Service Temporarily Unavailable to the browser mentioning that you are doing a maintenance (good practice!)
Http::setMaintenanceCode($maintenanceTimeSeconds: 360);
```

### Get HTTP Protocol

```php
use PH7\PhpHttpResponseHeader\Header;

// The HTTP server protocol
Http::getProtocol()
```

### Set Content Type
```php
use PH7\PhpHttpResponseHeader\Header;

// Send "Content-Type: application/json" header to the browser
Http::setContentType('application/json');

// Send "Content-type: text/xml" to the browser
Http::setContentType('text/xml');
```

## 🧑‍🍳 Who baked 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 and enthusiastic software engineer! 🚀 True cheese 🧀 , coffee, and chocolate lover! 😋 Reach me at [PH7.me](https://PH7.me) 💫

☕️ Are you enjoying it? **[Offer me a coffee](https://ko-fi.com/phenry)** (my favorite coffee to start the day is almond flat white 😋)

[![@phenrysay][twitter-icon]](https://x.com/phenrysay) [![YouTube Tech Videos][youtube-icon]](https://www.youtube.com/@pH7Programming "My YouTube Tech Channel") [![pH-7][github-icon]](https://github.com/pH-7)

## 🎥 Me building this package

[![Watch the video][video-thumbnail]](https://youtu.be/Q4djsRczxgo)

👉 **[Click here to watch on YouTube](https://youtu.be/Q4djsRczxgo)**, me building this package from A to Z.

---

![PHP HTTP Response Headers - Send Header By HTTP Code](media/php-http-header-response.png)

## ⚖️ License

**PHP HTTP Response** is generously distributed under the _[MIT](https://opensource.org/licenses/MIT)_ 🎉 Enjoy!

[twitter-icon]: https://img.shields.io/badge/x-000000?style=for-the-badge&logo=x
[github-icon]: https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white
[youtube-icon]: https://img.shields.io/badge/YouTube-FF0000?style=for-the-badge&logo=youtube&logoColor=white
[video-thumbnail]: https://i1.ytimg.com/vi/Q4djsRczxgo/maxresdefault.jpg