PHPackages                             williamheelis/restful-inputs - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. williamheelis/restful-inputs

ActiveLibrary

williamheelis/restful-inputs
============================

Simple RESTful globals: $\_PUT, $\_PATCH, $\_DELETE, $\_HEADER, $\_JSON, $\_PATH, $\_RES for PHP APIs. Basically this is an extension of the logic PHP probably intended when they introduced \_GET and \_POST and this package simply extends it and is useful shorthand option for RESTful api end points as a result. The focus was on inline brevity, and assumes plenty of `/api/someItem/index.php` -> `PATCH::/api/someItem/` structure. (i.e lots of dirs with one index.php each!)

v1.1.3(1y ago)0142MITPHPPHP >=7.4

Since May 9Pushed 1y ago1 watchersCompare

[ Source](https://github.com/williamheelis/restful-inputs)[ Packagist](https://packagist.org/packages/williamheelis/restful-inputs)[ RSS](/packages/williamheelis-restful-inputs/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (15)Used By (0)

Restful Inputs for PHP
======================

[](#restful-inputs-for-php)

Automatically sets useful REST globals in plain PHP:

- `$_HEADER`: request headers
- `$_PUT`, `$_PATCH`, `$_DELETE`: request body data (if `Inputs::is('PUT')` it means to was sent PUT)
- `$_JSON`: parsed JSON body (if `Inputs::is('JSON')` it means to was sent JSON)
- `$_PATH`: parsed path parameters (EG: a input mask of `Inputs::setPath('api/someItem/{uid}')` will make `$_PATH['uid']` available)
- `$_RES`: response wrapper sent automatically on shutdown - use \['data'\], \['status\_code'\] and \['headers'\]

TLDR; Auto Behaviour Summary
----------------------------

[](#tldr-auto-behaviour-summary)

RequestWhen Available`$_HEADER`Always — all request headers`$_JSON`Only if body is JSON`$_PUT`Only on PUT request`$_PATCH`Only on PATCH request`$_DELETE`Only on DELETE request`$_PATH`After `Inputs::setPath()` or fallbackRESponse`$_RES`Always — sent automatically at shutdown\_RES$\_RES\['status\_code'\]number$\_RES\['error'\]string$\_RES\['data'\]any$\_RES\['headers'\]EG: $\_RES\['headers'\]\['Content-Type'\] = 'application/json';don't mix echo
--------------

[](#dont-mix-echo)

If you're using `$_RES` avoid using `echo` (even `echo json_encode("me");` will make it go weird) and don't use the `header` command -- it can give odd results)

`$_RES` DEFAULTS are only \['error'\] and \['data'\]
----------------------------------------------------

[](#_res-defaults-are-only-error-and-data)

Out of the box this

```
$_RES['debug'] = "bob"
```

will return this

```
{
  "data": null,
  "error": null
}
```

If you want to extend (EG: to add `debug`) you need to tell it to by using `Inputs::extend('debug');`. This is by design.

EG: use this

```
Inputs::extend('debug');
$_RES['debug'] = "bob"
```

to get

```
{
  "data": null,
  "debug": null,
  "error": null
}
```

You will have to have added the line `Inputs::extend('debug');` you can then use it

`$_RES` WARNING
---------------

[](#_res-warning)

If you don't call `exit;` and the script continues running (e.g., later logic or another `$_RES['data']` overwrite), the final values of `$_RES` at the end of execution are what gets sent.

You control exactly when to respond by calling `exit;` after setting `$_RES`. That is the right and recommended usage pattern for this design.

Install via Composer
--------------------

[](#install-via-composer)

```
composer require restful-inputs
```

$\_PATH
-------

[](#_path)

`$_PATH` if you've inserted and `id` or perhaps `uid` in the url you can get it but you need to provide the input mask. More complicated set ups are not supported at the moment - terminal params only on `index.php`

```
use Restful\Inputs;
Inputs::init();
Inputs::setPath('api/something/{uid}'); //only needed if you actually have a path with params - and it assumes you're in an index.php

$uid = $_PATH['uid'] ?? null;
$name = $_JSON['name'] ?? 'guest';

$_RES['data'] = ['uid' => $uid, 'name' => $name];
$_RES['status_code'] = 200;
```

$\_HEADER
---------

[](#_header)

Access all request headers:

```
use Restful\Inputs;
Inputs::init();

$auth = $_HEADER['Authorization'] ?? null;
$userAgent = $_HEADER['User-Agent'] ?? null;

if (!$auth) {
    $_RES['status_code'] = 401;
    $_RES['data'] = ['error' => 'Missing auth token'];
    exit;
}
```

$\_PUT, $\_PATCH, $\_DELETE
---------------------------

[](#_put-_patch-_delete)

These are automatically available when the request method matches: Example `PUT` `/api/profile` with body:

```
{
  "username": "jdoe",
  "email": "jdoe@example.com"
}
```

```
use Restful\Inputs;
Inputs::init();

if (Inputs::is('PUT')) {
    $username = $_PUT['username'] ?? null;
    $email = $_PUT['email'] ?? null;

    $_RES['data'] = ['updated' => compact('username', 'email')];
}
```

it is safe to test/bail on error like this `if (Inputs::is('PUT')){`

```
use Restful\Inputs;
Inputs::init();

if (!Inputs::is('PUT')) {
    $_RES['status_code'] = 401;
    $_RES['data'] = ['error' => 'not _PUT'];
    //or $_RES['error'] = 'Name is required';
    exit;
}
```

$\_JSON
-------

[](#_json)

Always available if request has `Content-Type: application/json.`

```
use Restful\Inputs;
Inputs::init();

$name = $_JSON['name'] ?? 'guest';

if (!$name) {
    $_RES['status_code'] = 400;
    $_RES['data'] = ['error' => 'Name is required'];
    //or $_RES['error'] = 'Name is required';
    exit;
}
```

Even for POST, PATCH, etc., $\_JSON will work as long as the input is JSON.

it is safe to test `if (Inputs::is('JSON')){`

$\_RES (Auto-Sent Response)
---------------------------

[](#_res-auto-sent-response)

`$_RES` is automatically sent when the script finishes — no need to manually `echo` or `http_response_code()`.

```
$_RES['status_code'] = 200;
$_RES['headers']['X-Custom-Header'] = 'Foobar';
$_RES['data'] = ['success' => true];
exit;
```

```
$_RES['status_code'] = 404;
$_RES['data'] = ['error' => 'Not found'];
exit;
```

```
$_RES['status_code'] = 204;
$_RES['data'] = null; // no body
exit;
```

License
-------

[](#license)

MIT

###  Health Score

30

—

LowBetter than 64% of packages

Maintenance50

Moderate activity, may be stable

Popularity10

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity44

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~1 days

Total

14

Last Release

366d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/9a183016ed34d16919406f1af9c36aac09802c584c8cc814c727475d2dc0a485?d=identicon)[williamheelis](/maintainers/williamheelis)

---

Top Contributors

[![OpenTranslationBible](https://avatars.githubusercontent.com/u/2874585?v=4)](https://github.com/OpenTranslationBible "OpenTranslationBible (2 commits)")

### Embed Badge

![Health badge](/badges/williamheelis-restful-inputs/health.svg)

```
[![Health](https://phpackages.com/badges/williamheelis-restful-inputs/health.svg)](https://phpackages.com/packages/williamheelis-restful-inputs)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)