Download the PHP package rudra/router without Composer

Rudra-Router

A lightweight and transparent HTTP router for PHP. Supports dynamic parameters, regular expressions, optional URL segments, middleware, and RESTful resources.

Features

• Dynamic URL parameters (:name) and regular expressions (:[\d]{1,3})
• Optional URL segments with bracket syntax (admin[/item[/page[/:page]]])
• Multiple URLs per route via arrays
• Attribute-based routing with #[Routing] and #[Middleware]
• All HTTP methods supported: GET, POST, PUT, PATCH, DELETE
• Method spoofing via _method (for PUT/PATCH/DELETE from POST requests)
• Middleware executed before and after controller execution
• RESTful resources in a single line
• Automatic dependency injection via IoC container
• Works via instance or Facade

Installation

Basic Usage

Initialization

Facade Usage

Route Definition

Simple Routes with Closure

With Regular Expressions

Controller Method Call

Via Facade

Attribute-based Routing

The most concise way to define routes — declare them directly on controller methods using PHP 8 attributes. Routes are discovered automatically via annotationCollector().

Basic Attribute Route

Optional URL Segments

Use square brackets [...] to mark segments as optional. Nested brackets are supported for deeply optional paths.

This single attribute expands into 4 separate routes at cache-build time:

Note: Expansion happens once during cache generation. At runtime the router works with flat strings — zero performance overhead.

Multiple URLs per Route

Pass an array of URLs to register several routes for a single method:

Combining Arrays and Optional Segments

Both features compose naturally — each element of the array is expanded independently:

This produces 8 routes (4 for admin/* + 4 for manager/*).

Regex Parameters Inside Routes

Regular expressions can be used freely — the bracket syntax for optional segments does not interfere with regex character classes:

Attributes with Middleware

Combine #[Routing] and #[Middleware] on the same method:

Preserving Route Parameters

All route parameters are preserved across expanded routes:

HTTP Methods

Any Method (GET|POST|PUT|PATCH|DELETE)

Middleware

Middleware runs before (before) and after (after) the controller. Each middleware must implement the __invoke() method.

Basic Setup

Middleware with Parameters

Middleware Example

Simple middleware without chain:

RESTful Resources

Registers standard CRUD routes with explicit plural and singular URL patterns. No magic pluralization — you define exactly what the URLs look like.

This creates the following routes:

The default action names are [index, read, create, update, delete].

Custom Method Names

You can override the default action names by passing a custom array of 5 methods:

The array order is fixed: [index, read, create, update, delete].

The set() Method — Extended Syntax

Allows defining a route with multiple HTTP methods via |:

Controller Lifecycle

When a controller method is invoked, the following stages are executed:

1. shipInit() — base component initialization
2. containerInit() — container initialization
3. init() — user-defined initialization
4. before() — hook before middleware
5. before middleware
6. Action method call (with automatic dependency injection)
7. after middleware
8. after() — hook after middleware

Automatic Dependency Injection

Action method parameters are automatically resolved via the IoC container:

Method Spoofing

For forms that do not support PUT/PATCH/DELETE, use the _method parameter:

The router automatically recognizes this as a PUT request.

Error Handling

• RouterException("Not Found", 404) — route not found or parameters do not match
• RouterException("Service Unavailable", 503) — controller method does not exist
• MiddlewareException — error in the middleware chain

License

This project is licensed under the Mozilla Public License 2.0 (MPL-2.0) — a free, open-source license that:

• Requires preservation of copyright and license notices,
• Allows commercial and non-commercial use,
• Requires that any modifications to the original files remain open under MPL-2.0,
• Permits combining with proprietary code in larger works.

📄 Full license text: LICENSE
🌐 Official MPL-2.0 page: https://mozilla.org/MPL/2.0/