Download the PHP package mitsuki/router without Composer

Mitsuki Router

Mitsuki is a modern HTTP routing engine for PHP, powered by Symfony Routing/HttpKernel and PHP 8 attributes. It provides:

• Automatic controller discovery
• Attribute-based routing (#[Controller], #[Route])
• PSR-11 container integration
• HttpKernel-compatible controller resolution
• Compiled routes caching

Installation

The router relies on Symfony Routing, HttpFoundation, HttpKernel, Filesystem, and a PSR-11 container.

Core Concepts

Attributes

• #[Controller('prefix')] on classes
• #[Route('name', 'path', methods)] on methods

Architecture

Router Class

Namespace: Mitsuki\Hermite\Router

Responsibilities:

• Load routes from compiled cache or controller scanning
• Build Symfony RouteCollection
• Delegate matching to UrlMatcher
• Resolve HttpKernel-compatible controller callable

Workflow

1. load()

   • If cache_routes.php exists → load routes from cache
   • Otherwise → use ControllerResolver to discover controllers
   • Analyze attributes, build routes, write cache
2. getCallable(Request $request)
   • Updates RequestContext::setMethod()
   • Uses UrlMatcher to match URL + method
   • Binds route parameters to request attributes
   • Fetches controller instance via container
   • Returns [instance, 'method'] for HttpKernel

Path Concatenation

In getRoutesFromControllers():

• Class prefix: #[Controller('posts')]
• Method path: #[Route('posts.show', '{id}', ['GET'])]
• Normalized result: /posts/{id}

Normalization:

• Removes multiple /
• Strips trailing /
• Falls back to / if empty

Container Integration

Example with PHP-DI:

Request Lifecycle

Usage Example

Testing

Tested with PestPHP (95%+ coverage).

Integration tests:

Run tests with coverage:

Best Practices

• Always define unique route names in #[Route]
• Use consistent prefixes via #[Controller('prefix')]
• Write tests for each CRUD endpoint
• Enable route caching in production for optimal performance

Roadmap

• Route-specific middleware support
• Configurable route groups (auth, API, etc.)
• URL generation from route names
• Request validation & DTO integration

📄 License

This project is licensed under the MIT License.

Maintained by Zgenius Matondo GitHub: https://github.com/zgeniuscoders