klein · Ostico · Oct 14, 2025 · Oct 15, 2025 · Oct 16, 2025 · Oct 17, 2025
diff --git a/.gitignore b/.gitignore
@@ -7,3 +7,8 @@ docs/
 
 # Auto-generated code coverage report
 report/
+/.phpunit.cache/
+/.phpunit.result.cache
+/coverage.clover
+/cache/
+/Benchmarks/
diff --git a/.travis.yml b/.travis.yml
@@ -1,19 +1,15 @@
 sudo: false
 
+env:
+  global:
+    - XDEBUG_MODE=coverage
+
 language: php
 php:
-  - 5.3
-  - 5.4
-  - 5.5
-  - 5.6
-  - 7.0
-  - nightly
-  - hhvm
+  - 8.3
+  - 8.4
 
 matrix:
-  allow_failures:
-    - php: nightly
-    - php: hhvm
   fast_finish: true
 
 before_script:
@@ -22,4 +18,3 @@ before_script:
 script:
   - composer validate
   - ./vendor/bin/phpunit
-  - ./vendor/bin/phpcs --standard=PSR2 --encoding=utf-8 -p src/ tests/
diff --git a/BENCHMARKS.md b/BENCHMARKS.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,34 @@
 # CHANGELOG
 
+## 3.2.0
+
+### Features
+
+- Lightning fast routing! From **100x to 1000x** faster dispatch. Big performance improvements for large route collections with radix Tree routing. [Benchmarks](BENCHMARKS.md)
+- 100% Code Coverage
+- Breaking changes, see [UPGRADING.md](UPGRADING.md)
+
+## 3.1.0
+
+### Features
+
+- Support for PHP 8.3
+- Dropped support for previous PHP versions
+- Updated PHPUnit to version 12
+
+## 3.0.0
+
+### Features
+
+- Support for PHP >= 8.1
+- Dropped support for previous PHP versions
+- Removed the "magical" way of inputting mask in DataCollections in favor of PHP 8 named arguments.
+- Removed use of 404/405 "routes" (deprecated in previous versions). Use `$klein->onHttpError()` instead.
+- Removed "magical" callback behavior in favor of PHP 8.3 named arguments. Now the function accepts an optional string path as the first parameter and a NOT optional callback.
+- Removed "magical" markdown behavior. Now the function accepts a string and an optional array of values.
+- Removed "magical" markdown behavior. Now the function accepts a string and an optional array of values.
+- Removed "magical" behavior of `ServiceProvider::flash()` method. Now the function accepts a string and an optional array of values.
+- Updated PHPUnit to version 10
 
 ## 2.1.2
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -4,7 +4,7 @@ Contributing is absolutely encouraged, but a few things should be taken into acc
 
 - Always test any bug-fixes or changes with [unit testing][unit-testing]
 - When adding or changing a feature, make sure to write a **new** [unit test][unit-testing]
-- This project adheres to the [PSR-2][psr-2] standards. Please make sure your contributions [comply][code-sniffer].
+- This project adheres to the [PSR-12][psr-12] standards. Please make sure your contributions [comply][code-sniffer].
 - Code and comment styles should be made as consistent as possible with the rest of the project
 - Make sure to document your code with the [PHPDoc syntax][php-doc]
 - Pull Requests and Issues should contain no more than **1** bug-fix, feature, or documentation change
@@ -18,6 +18,7 @@ Contributing is absolutely encouraged, but a few things should be taken into acc
 Klein is an open library designed for a specific purpose. You may find that a certain requested feature or change may not be accepted. Please don't take those actions personally, as the controlling contributors are simply just trying to keep the project's purpose clear and designated.
 
  [unit-testing]: README.md#unit-testing
- [psr-2]: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md
+ [psr-12]: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-12-extended-coding-style-guide.md
  [code-sniffer]: https://github.com/squizlabs/PHP_CodeSniffer
  [php-doc]: http://www.phpdoc.org/docs/latest/for-users/phpdoc-reference.html
+ [phpstan]: https://phpstan.org/user-guide/getting-started
diff --git a/README.md b/README.md
@@ -1,16 +1,23 @@
 # Klein.php
 
-[![Build Status](https://travis-ci.org/klein/klein.php.png?branch=master)](https://travis-ci.org/klein/klein.php)
+[![Build Status](https://app.travis-ci.com/matecat/klein.php.svg?token=qBazxkHwP18h3EWnHjjF&branch=master)](https://app.travis-ci.com/matecat/klein.php)
 
-**klein.php** is a fast & flexible router for PHP 5.3+
+**klein.php** is a fast & flexible router for PHP
 
 * Flexible regular expression routing (inspired by [Sinatra](http://www.sinatrarb.com/))
 * A set of [boilerplate methods](#api) for rapidly building web apps
-* Almost no overhead => [2500+ requests/second](https://gist.github.com/878833)
+* Almost no overhead => [Benchmarks](BENCHMARKS.md)
+  * Benchmark framework: https://github.com/follestad/php-router-benchmark
+
+## Overview
+
+This repository is a fork of the original project, created to restore active maintenance and modernize the codebase.
+We use this library in production and have committed to keeping it up to date and compatible with current PHP versions.
+The primary goal of this fork is to enable and support PHP 8.3 while preserving the original project's spirit and API where possible.
 
 ## Getting started
 
-1. PHP 5.3.x is required
+1. PHP >= 8.3 is required
 2. Install Klein using [Composer](#composer-installation) (recommended) or manually
 3. Setup [URL rewriting](https://gist.github.com/874000) so that all requests are handled by **index.php**
 4. (Optional) Throw in some [APC](http://pecl.php.net/package/APC) for good measure
@@ -41,23 +48,23 @@ $klein->dispatch();
 *Example 1* - Respond to all requests
 
 ```php
-$klein->respond(function () {
+$klein->respond(callback: function () {
     return 'All the things';
 });
 ```
 
 *Example 2* - Named parameters
 
 ```php
-$klein->respond('/[:name]', function ($request) {
+$klein->respond(path: '/[:name]', callback: function ($request) {
     return 'Hello ' . $request->name;
 });
 ```
 
 *Example 3* - [So RESTful](http://bit.ly/g93B1s)
 
 ```php
-$klein->respond('GET', '/posts', $callback);
+$klein->respond(method: 'GET', path: '/posts', callback: $callback);
 $klein->respond('POST', '/posts', $callback);
 $klein->respond('PUT', '/posts/[i:id]', $callback);
 $klein->respond('DELETE', '/posts/[i:id]', $callback);
@@ -67,7 +74,7 @@ $klein->respond('OPTIONS', null, $callback);
 $klein->respond(array('POST','GET'), $route, $callback);
 
 // Or you might want to handle the requests in the same place
-$klein->respond('/posts/[create|edit:action]?/[i:id]?', function ($request, $response) {
+$klein->respond(path: '/posts/[create|edit:action]?/[i:id]?', callback: function ($request, $response) {
     switch ($request->action) {
         //
     }
@@ -77,7 +84,7 @@ $klein->respond('/posts/[create|edit:action]?/[i:id]?', function ($request, $res
 *Example 4* - Sending objects / files
 
 ```php
-$klein->respond(function ($request, $response, $service) {
+$klein->respond(callback: function ($request, $response, $service) {
     $service->xml = function ($object) {
         // Custom xml output function
     }
@@ -86,7 +93,7 @@ $klein->respond(function ($request, $response, $service) {
     }
 });
 
-$klein->respond('/report.[xml|csv|json:format]?', function ($request, $response, $service) {
+$klein->respond(path: '/report.[xml|csv|json:format]?', callback: function ($request, $response, $service) {
     // Get the format or fallback to JSON as the default
     $send = $request->param('format', 'json');
     $response->$send($report);
@@ -100,7 +107,7 @@ $klein->respond('/report/latest', function ($request, $response, $service) {
 *Example 5* - All together
 
 ```php
-$klein->respond(function ($request, $response, $service, $app) use ($klein) {
+$klein->respond(callback: function ($request, $response, $service, $app) use ($klein) {
     // Handle exceptions => flash the message and redirect to the referrer
     $klein->onError(function ($klein, $err_msg) {
         $klein->service()->flash($err_msg);
@@ -251,9 +258,9 @@ authentication or view layouts. e.g. as a basic example, the following
 code will wrap other routes with a header and footer
 
 ```php
-$klein->respond('*', function ($request, $response, $service) { $service->render('header.phtml'); });
+$klein->respond(path: '*', callback: function ($request, $response, $service) { $service->render('header.phtml'); });
 //other routes
-$klein->respond('*', function ($request, $response, $service) { $service->render('footer.phtml'); });
+$klein->respond(path: '*', callback: function ($request, $response, $service) { $service->render('footer.phtml'); });
 ```
 
 Routes automatically match the entire request URI. If you need to match
@@ -262,10 +269,10 @@ negate a route, use the `!` operator
 
 ```php
 // Match all requests that end with '.json' or '.csv'
-$klein->respond('@\.(json|csv)$', ...
+$klein->respond(path: '@\.(json|csv)$', ...
 
 // Match all requests that _don't_ start with /admin
-$klein->respond('!@^/admin/', ...
+$klein->respond(path: '!@^/admin/', ...
 ```
 
 ## Views
@@ -424,6 +431,7 @@ See the [wiki](https://github.com/klein/klein.php/wiki) for more information
 
 ## Contributors
 
+- [Domenico Lupinetti](https://github.com/Ostico)
 - [Trevor N. Suarez](https://github.com/Rican7)
 
 ## License

diff --git a/UPGRADING.md b/UPGRADING.md
@@ -1,5 +1,38 @@
 # Klein Upgrade Guide
 
+## 3.1.0 to 3.2.0
+
+### Behavior Changes
+
+- The execution order of the route callbacks is no more guaranteed to be the same as the order in which they were registered when mixing catch all routes and routes with specified paths.
+  - The `HeaderDataCollection` class now uses `ucwords()` sanitization
+     Underscores are not allowed in the header field names since 
+     nginx and Apache will silently drop HTTP headers with underscores 
+     (which are perfectly valid, according to the HTTP standard). 
+     This is done to prevent ambiguities when mapping headers to CGI variables, 
+     as both dashes and underscores are mapped to underscores during that process.
+  - Fields are now case-sensitive.
+
+    Ex: 
+```shell
+    curl -H 'content-TOP: FooBar' -H 'content-type: application/json' https://localhost
+    [
+        'Host' => 'localhost',
+        'User-Agent' => 'curl/8.5.0',
+        'Accept' => '*/*',
+        'content-TOP' => 'Fake',
+        'content-type' => 'application/json',
+    ] => 
+    HeaderDataCollection::get('content-TOP') => NULL
+    HeaderDataCollection::get('content-type') => NULL
+    HeaderDataCollection::get('Content-Top') => 'FooBar'
+    HeaderDataCollection::get('Content-Type') => 'application/json'
+```
+
+### Breaking Changes
+
+- Renamed `Request::method` to `Request::httpMethod` to allow the Klein library to be mocked with PHPUnit >= 12
+  - Because of PHPUnit decision to not allow methods named "method" to be mocked (it throws an Exception), we must introduce a big breaking change: https://github.com/sebastianbergmann/phpunit/issues/5415
 
 ## 2.1.1 to 2.1.2
 

diff --git a/composer.json b/composer.json
@@ -1,39 +1,54 @@
 {
-   "name": "klein/klein",
-   "description": "A lightning fast router for PHP",
-   "keywords": ["router", "routing", "sinatra", "boilerplate"],
-   "homepage": "https://github.com/klein/klein.php",
-   "license": "MIT",
-   "authors": [
-      {
-         "name": "Chris O'Hara",
-         "email": "cohara87@gmail.com",
-         "homepage": "http://chris6f.com/",
-         "role": "Creator/Developer"
-      },
-      {
-         "name": "Trevor Suarez",
-         "email": "rican7@gmail.com",
-         "homepage": "https://trevorsuarez.com/",
-         "role": "Contributor/Developer"
-      }
-   ],
-   "require": {
-      "php": ">=5.3.0"
-   },
-   "require-dev": {
-      "phpunit/phpunit": "^4.8",
-      "phpunit/php-code-coverage": "^2.2",
-      "squizlabs/php_codesniffer": "1.4.8"
-   },
-   "autoload": {
-      "psr-4": {
-         "Klein\\": "src/Klein/"
-      }
-   },
-   "autoload-dev": {
-      "psr-4": {
-         "Klein\\Tests\\": "tests/Klein/Tests"
-      }
-   }
+  "name": "matecat/klein",
+  "description": "A lightning fast router for PHP",
+  "keywords": [
+    "router",
+    "routing",
+    "sinatra",
+    "boilerplate"
+  ],
+  "homepage": "https://github.com/matecat/klein.php",
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Chris O'Hara",
+      "email": "cohara87@gmail.com",
+      "homepage": "http://chris6f.com/",
+      "role": "Creator/Developer"
+    },
+    {
+      "name": "Trevor Suarez",
+      "email": "rican7@gmail.com",
+      "homepage": "https://trevorsuarez.com/",
+      "role": "Contributor/Developer"
+    },
+    {
+      "name": "Domenico Lupinetti",
+      "email": "ostico@gmail.com",
+      "role": "Contributor/Developer"
+    }
+  ],
+  "require": {
+    "php": ">=8.3",
+    "ext-ctype": "*",
+    "ext-fileinfo": "*"
+  },
+  "require-dev": {
+    "phpunit/phpunit": "^12",
+    "phpunit/php-code-coverage": "^12",
+    "squizlabs/php_codesniffer": "^4",
+    "phpstan/phpstan": "@stable",
+    "ext-xdebug": "*"
+  },
+  "autoload": {
+    "psr-4": {
+      "Klein\\": "src/Klein/"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "Klein\\Tests\\": "tests/Klein/Tests",
+      "Benchmarks\\": "Benchmarks/"
+    }
+  }
 }