Download the PHP package marcosdipaolo/router without Composer

MDP Router

A modern, production-ready PHP router library built with PHP 8.2+ and attribute-based routing. It provides a clean, expressive API for defining routes, handling middleware, and managing HTTP requests and responses.

Features

• ✨ Attribute-Based Routing: Define routes using modern PHP 8 attributes
• 🎯 Dynamic Route Parameters: Support for path parameters like /users/{id}
• 🔄 Middleware Pipeline: Built-in middleware support with global and route-specific middleware
• ⚡ Route Caching: Cache compiled routes for optimal performance
• 🌐 Full HTTP Support: GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS
• 🔀 Route Groups: Organize related routes under common prefixes and middleware
• 🔗 Reverse Routing: Generate URLs from route names and parameters
• 📨 Method Spoofing: Support for _method parameter to simulate HTTP verbs in forms
• 🛡️ Security Headers: Built-in CORS and security header support
• 📝 Request/Response Objects: Clean abstractions for HTTP requests and responses
• 🧪 Comprehensive Testing: Full test suite for all features

Installation

Quick Start

1. Setup Your Entry Point

Create an index.php file at your project root:

2. Configure Your .htaccess

3. Define Routes in Controllers

Core Concepts

Request/Response Objects

The router provides clean abstractions for HTTP requests and responses:

Route Parameters

Define dynamic routes with parameters:

Route Groups

Group related routes with common prefixes and middleware:

Middleware

Create custom middleware by implementing MiddlewareInterface:

Add middleware globally or per-route:

Built-in Middleware

CORS Middleware

Handle cross-origin requests:

Security Headers Middleware

Add security headers automatically:

Method Spoofing Middleware

Allow forms to use PUT/PATCH/DELETE via _method parameter:

In your HTML form:

Route Caching

Routes are automatically cached when enabled. This compiles all route definitions into a PHP file for maximum performance:

Reverse Routing

Generate URLs from route names:

Debugging

Enable debug mode to get detailed error information:

HTTP Status Codes

Commonly used status codes:

Security Best Practices

1. Always validate input: Validate and sanitize all user input
2. Use HTTPS: Ensure all traffic is encrypted
3. Add CORS headers: Only allow trusted origins
4. Implement authentication: Protect sensitive routes with middleware
5. Use prepared statements: When working with databases
6. Keep cache directory secret: Don't expose the cache directory publicly
7. Enable security headers: Always include security headers

Error Handling

The router provides built-in error handling with debug mode for development:

Create custom error handling middleware:

Testing

The router includes comprehensive tests:

Write your own tests:

Performance Tips

1. Enable route caching (production)
2. Use parameter constraints in routes
3. Load only needed controllers in Router::create()
4. Cache middleware results when possible
5. Use lazy loading for dependencies in container

Contributing

Contributions are welcome! Please read CONTRIBUTING.md first.

License

MIT License - see LICENSE file