PHPackages                             karewan/knroute - 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. [Caching](/categories/caching)
4. /
5. karewan/knroute

ActiveLibrary[Caching](/categories/caching)

karewan/knroute
===============

Simple and fast PHP 8.3+ router with routes attributes and caching (+Inertia.js compatiblity)

3.0.6(6mo ago)62.0k↓50%MITPHPPHP >=8.3

Since Jan 7Pushed 6mo ago1 watchersCompare

[ Source](https://github.com/Karewan/KnRoute)[ Packagist](https://packagist.org/packages/karewan/knroute)[ Docs](https://github.com/Karewan/KnRoute)[ RSS](/packages/karewan-knroute/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)DependenciesVersions (20)Used By (0)

KnRoute
=======

[](#knroute)

Simple and fast PHP 8.3+ router with routes attributes and caching (+Inertia.js compatiblity).

Table of content
----------------

[](#table-of-content)

- [KnRoute](#knroute)
    - [Table of content](#table-of-content)
    - [Installation](#installation)
        - [Requirements](#requirements)
        - [Getting started](#getting-started)
    - [Usage](#usage)
        - [Register routes from the controllers and run the router](#register-routes-from-the-controllers-and-run-the-router)
        - [Different types of routes](#different-types-of-routes)
        - [Add route attributes to controller methods](#add-route-attributes-to-controller-methods)
        - [Use variables inside a path](#use-variables-inside-a-path)
        - [Variable types with their corresponding regex](#variable-types-with-their-corresponding-regex)
        - [Create a middleware](#create-a-middleware)
        - [Use a middleware on a class](#use-a-middleware-on-a-class)
        - [Use a middleware on a class method](#use-a-middleware-on-a-class-method)
        - [Create a middleware with parameters](#create-a-middleware-with-parameters)
        - [Use a middleware with parameters](#use-a-middleware-with-parameters)
        - [HttpUtils class (all methods are static)](#httputils-class-all-methods-are-static)
    - [Inertia.js plugin usage](#inertiajs-plugin-usage)
        - [Init the plugin](#init-the-plugin)
        - [The template file](#the-template-file)
        - [Render a component with its props](#render-a-component-with-its-props)
        - [Share props](#share-props)
        - [View data](#view-data)
        - [Inertia class (all methods are static)](#inertia-class-all-methods-are-static)
    - [Changelog](#changelog)
    - [License](#license)

Installation
------------

[](#installation)

### Requirements

[](#requirements)

PHP 8.3+

### Getting started

[](#getting-started)

```
$ composer require karewan/knroute

```

Usage
-----

[](#usage)

### Register routes from the controllers and run the router

[](#register-routes-from-the-controllers-and-run-the-router)

```
declare(strict_types=1);

use Karewan\KnRoute\Router;

// DEV / PROD env
const IS_DEV = true;

// Init the router
$router = new Router();

// Scan controllers, register routes and optionnaly cache them
$router->registerRoutesFromControllers(
	// Folder to be scanned
	controllersPath: __DIR__ . '/App/Controllers',
	// Use cache only for prod (do not forget to clear cache after deploy) or use in dev with scanForModifiedControllers set to true
	cacheFile: __DIR__ . '/tmp/cache.php'
	// Optional parameter, default to false, for using the cache file in dev mode (avoid the heavy controllers scanning each time)
	scanForModifiedControllers: IS_DEV
);

// Run the router (nothing will be executed below this line)
$router->run();
```

### Different types of routes

[](#different-types-of-routes)

All are method attributes.

```
// All HTTP methods
#[Any('/test')]

// HTTP DELETE method
#[Delete('/test')]

// HTTP GET method
#[Get('/test')]

// HTTP PATCH method
#[Patch('/test')]

// HTTP POST method
#[Post('/test')]

// HTTP PUT method
#[Put('/test')]

// Use an array of HTTP methods
#[Route(['GET', 'POST'], '/test')]
```

### Add route attributes to controller methods

[](#add-route-attributes-to-controller-methods)

```
declare(strict_types=1);

namespace App\Controllers;

use Karewan\KnRoute\Attributes\Get;
use Karewan\KnRoute\Attributes\Post;
use Karewan\KnRoute\HttpUtils;

class IndexController
{
	#[Get('/')]
	public function index(): never
	{
		HttpUtils::outputText("IndexController@index\n");
	}

	#[Post('/login')]
	public function login(): never
	{
		HttpUtils::outputJson(['error' => 'Bad credentials']);
	}
}
```

### Use variables inside a path

[](#use-variables-inside-a-path)

Name of the variable followed by the type.

```
#[Post('/amd/{id:num}/ryzen/{model:alpha}')]
public function topSecret(int $id, string $model):void {
	echo "AmdController@topSecret(id={$id},model={$model})";
}
```

### Variable types with their corresponding regex

[](#variable-types-with-their-corresponding-regex)

```
:alpha		[a-z0-9]+
:letters	[a-z]+
:num		[0-9]+
:slug		[a-z0-9\-]+
:hex		[a-f0-9]+'
:any		[^\/]+
:all		.*

```

### Create a middleware

[](#create-a-middleware)

```
declare(strict_types=1);

namespace App\Middlewares;

use Attribute;
use Karewan\KnRoute\HttpUtils;
use Karewan\KnRoute\IMiddleware;

#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)]
class AuthMiddleware implements IMiddleware
{
	/**
	 * Do your logic here
	 * @return void
	 */
	public function handle(): void
	{
		if(!isLogged()) {
			HttpUtils::dieStatus(401);
		}
	}
}
```

### Use a middleware on a class

[](#use-a-middleware-on-a-class)

Will be executed before instantiating the class.

```
declare(strict_types=1);

namespace App\Controllers;

use App\Middlewares\AuthMiddleware;
use Karewan\KnRoute\Attributes\Get;
use Karewan\KnRoute\HttpUtils;

#[AuthMiddleware()]
class TestController
{
	#[Get('/')]
	public function index(): void
	{
		HttpUtils::outputText("TestController@index\n");
	}
}
```

### Use a middleware on a class method

[](#use-a-middleware-on-a-class-method)

Will be executed after instantiating the class and before calling the method.

```
declare(strict_types=1);

namespace App\Controllers;

use App\Middlewares\AuthMiddleware;
use Karewan\KnRoute\Attributes\Get;
use Karewan\KnRoute\HttpUtils;

class TestController
{
	#[Get('/'), AuthMiddleware()]
	public function index(): void
	{
		HttpUtils::outputText("TestController@index\n");
	}
}
```

### Create a middleware with parameters

[](#create-a-middleware-with-parameters)

```
declare(strict_types=1);

namespace App\Middlewares;

use Attribute;
use Karewan\KnRoute\HttpUtils;
use Karewan\KnRoute\IMiddleware;

#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)]
class SecretMiddleware implements IMiddleware
{
	/**
	 * Class constructor
	 * @param null|int $requireType
	 * @return void
	 */
	public function __construct(private ?int $requireType = null) {}

	/**
	 * Define your logic here
	 * @return void
	 */
	public function handle(): void
	{
		if (!is_null($this->requireType)) {
			HttpUtils::outputText("SecretMiddleware@handle(requireType={$this->requireType})\n");
		}
	}
}
```

### Use a middleware with parameters

[](#use-a-middleware-with-parameters)

```
declare(strict_types=1);

namespace App\Controllers;

use App\Middlewares\SecretMiddleware;
use Karewan\KnRoute\Attributes\Get;
use Karewan\KnRoute\HttpUtils;

#[SecretMiddleware(requireType: 10)]
class TestController
{
	#[Get('/'), SecretMiddleware(requireType: 99)]
	public function index(): void
	{
		HttpUtils::outputText("TestController@index\n");
	}
}
```

### HttpUtils class (all methods are static)

[](#httputils-class-all-methods-are-static)

Karewan\\KnRoute\\HttpUtils::

```
function getHost(): string;
function getPath(): string;
function getMethod(): string;
function getProtocol():string;
function hasHeader(string $name): bool;
function getHeader(string $name): string;
function getHeaders(): array;
function setHeader(string $key, string $value, int $httpCode = 0, bool $replace = true): void;
function setHeaders(array $headers, int $httpCode = 0, bool $replace = true): void;
function getQueryString(): string;
function getContentType(): string;
function getContentLength(): string;
function getUserAgent(): string;
function getLanguages(): string;
function getAcceptEncoding(): string;
function getReferer(): string;
function getIp(): string;
function getServerPort(): int;
function getClientPort(): int;
function getBody(): string;
function getJsonBody(bool $associative = false, int $depth = 512, int $flags = JSON_BIGINT_AS_STRING): mixed;
function outputJson(mixed $data, int $httpCode = 200): never;
function outputHtml(string $html, int $httpCode = 200): never;
function outputText(string $text, int $httpCode = 200, string $charset = 'utf-8'): never;
function outputXml(string $xmlString, int $httpCode = 200, string $charset = 'utf-8'): never;
function outputString(string $contentType, string $str, int $httpCode = 200, string $charset = 'utf-8'): never;
function location(string $path = '/', int $httpCode = 302): never;
function dieStatus(int $code): never;
```

Global constant (bool)

```
IS_XHR
```

Inertia.js plugin usage
-----------------------

[](#inertiajs-plugin-usage)

### Init the plugin

[](#init-the-plugin)

Must be init before the router.

```
declare(strict_types=1);

use Karewan\KnRoute\Plugins\Inertia\Inertia;
use Karewan\KnRoute\Router;

// App / Assets version
const APP_VERSION = 'b3d5e9f30';

// Init Inertia
Inertia::init(
	// Use your view rendering method here with your Template file (from your framework or your custom method)
	viewFnc: fn(array $data): string => view('MyTemplate', $data),
	// Assets version (not mandatory)
	version: APP_VERSION
);

// Router...
$router = new Router();
```

If you don't have a view rendering method, you can use the method below.

```
/**
 * Return the content of a view file
 * @param string $view
 * @param array $data
 * @return string
 */
function view(string $view, array $data = []): string
{
	ob_start();
	extract($data, EXTR_OVERWRITE);
	require APPDIR . "Views/{$view}.php";
	return ob_get_clean();
}
```

### The template file

[](#the-template-file)

App/Views/MyTemplate.php

```
DOCTYPE html>

...

	>

```

### Render a component with its props

[](#render-a-component-with-its-props)

```
declare(strict_types=1);

namespace App\Controllers;

use Karewan\KnRoute\Attributes\Get;
use Karewan\KnRoute\HttpUtils;
use Karewan\KnRoute\Plugins\Inertia\Inertia;

class TestController
{
	#[Get('/')]
	public function index(): void
	{
		Inertia::render('Index', [
			'data1' => 'data1',
			'data2' => fn() => 'data2',
			'data3' => Inertia::lazy(fn() => 'data3'),
			'data4' => Inertia::always('data4')
		]);
	}
}
```

### Share props

[](#share-props)

Shared props will be merged with Inertia::render props. Must be called before the Inertia::render method.

```
declare(strict_types=1);

use Karewan\KnRoute\Plugins\Inertia\Inertia;

// One key
Inertia::share('user', 'John Doe');
// OR a full array
Inertia::share([
	'user', 'John Doe',
	'foo' => []
]);
```

### View data

[](#view-data)

Data to send to the template file. Must be called before the Inertia::render method.

```
declare(strict_types=1);

use Karewan\KnRoute\Plugins\Inertia\Inertia;

// One key
Inertia::viewData('foo', 'bar');
// OR a full array
Inertia::viewData([
	'foo', 'bar',
	'fooArr' => []
]);
```

Usage from the template file

```
DOCTYPE html>

...

	>

```

### Inertia class (all methods are static)

[](#inertia-class-all-methods-are-static)

Karewan\\KnRoute\\Plugins\\Inertia\\Inertia::

```
function init(Closure $viewFnc, string $version = ''): void;
function getVersion(): string;
function viewData(string|array $key, mixed $data): void;
function getViewData(): array;
function flushViewData(): void;
function share(string|array $key, mixed $data): void;
function getShared(): array;
function flushShared(): void;
// Inertia redirect (this initiate a full page reload on the client side)
function location(string $url = '/'): never;
function always(mixed $data): AlwaysProp;
function lazy(Closure $data): LazyProp;
function render(string $component, array $props = []): never;
```

Global constant (bool, only defined if Inertia::init is called)

```
IS_INERTIA
```

Changelog
---------

[](#changelog)

See the changelog [here](CHANGELOG.md)

License
-------

[](#license)

See the license [here](LICENSE.txt)

```
Copyright © 2024 - 2025 Florent VIALATTE (github.com/Karewan/KnRoute)

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.

```

###  Health Score

45

—

FairBetter than 93% of packages

Maintenance66

Regular maintenance activity

Popularity25

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity66

Established project with proven stability

 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 ~36 days

Recently: every ~63 days

Total

19

Last Release

202d ago

Major Versions

1.0.9 → 2.0.02024-01-29

2.0.1 → 3.0.02024-11-24

PHP version history (3 changes)1.0.0PHP ^8.1

1.0.5PHP >=8.1

3.0.0PHP >=8.3

### Community

Maintainers

![](https://www.gravatar.com/avatar/e3d085e65c8323144412e0ffc0a60bb81e24d84c2f03f3c39f6e44bf0281cbcf?d=identicon)[Karewan](/maintainers/Karewan)

---

Top Contributors

[![Karewan](https://avatars.githubusercontent.com/u/7956112?v=4)](https://github.com/Karewan "Karewan (24 commits)")

---

Tags

attributescachingfastinertiaphprouterroutingsimpleuriurlurlurirouterroutingcachingattributesinertiafast

### Embed Badge

![Health badge](/badges/karewan-knroute/health.svg)

```
[![Health](https://phpackages.com/badges/karewan-knroute/health.svg)](https://phpackages.com/packages/karewan-knroute)
```

###  Alternatives

[symfony/routing

Maps an HTTP request to a set of configuration variables

7.6k789.4M1.8k](/packages/symfony-routing)[putyourlightson/craft-blitz

Intelligent static page caching for creating lightning-fast sites.

153471.5k29](/packages/putyourlightson-craft-blitz)[miladrahimi/phprouter

A powerful, lightweight, and very fast HTTP URL router for PHP projects.

20832.6k2](/packages/miladrahimi-phprouter)[fsasvari/laravel-trailing-slash

The package that adds redirection with trailing slash to Laravel framework.

63164.3k](/packages/fsasvari-laravel-trailing-slash)

PHPackages © 2026

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