RouteCollector

The main class for defining routes with a fluent API.

use Solo\Router\RouteCollector;

$router = new RouteCollector();

HTTP Method Shortcuts

get()

public function get(string $path, callable|array|string $handler): Route

Register a GET route.

$router->get('/users', [UserController::class, 'index']);
$router->get('/users/{id}', [UserController::class, 'show']);

post()

public function post(string $path, callable|array|string $handler): Route

Register a POST route.

$router->post('/users', [UserController::class, 'store']);

put()

public function put(string $path, callable|array|string $handler): Route

Register a PUT route.

$router->put('/users/{id}', [UserController::class, 'update']);

patch()

public function patch(string $path, callable|array|string $handler): Route

Register a PATCH route.

$router->patch('/users/{id}', [UserController::class, 'patch']);

delete()

public function delete(string $path, callable|array|string $handler): Route

Register a DELETE route.

$router->delete('/users/{id}', [UserController::class, 'destroy']);

---

group()

public function group(
    string $prefix,
    callable $callback,
    array $middlewares = []
): void

Create a route group with shared prefix and middleware.

Parameters:

Parameter	Type	Description
$prefix	string	URL prefix for all routes in the group
$callback	callable	Function receiving RouteCollector instance
$middlewares	array	Middleware to apply to all routes

Example:

$router->group('/api/v1', function(RouteCollector $router) {
    $router->get('/users', [UserController::class, 'index']);
    $router->get('/posts', [PostController::class, 'index']);
}, [ApiMiddleware::class, AuthMiddleware::class]);

Nested groups:

$router->group('/api', function(RouteCollector $router) {
    $router->group('/v1', function(RouteCollector $router) {
        $router->get('/users', [V1UserController::class, 'index']);
    });
    
    $router->group('/v2', function(RouteCollector $router) {
        $router->get('/users', [V2UserController::class, 'index']);
    });
});

---

Inherited from Router

RouteCollector extends Router, so all Router methods are available:

• match()
• getRoutes()
• getRouteByName()
• addRoute()

---

Complete Example

use Solo\Router\RouteCollector;

$router = new RouteCollector();

// Public routes
$router->get('/', [HomeController::class, 'index'])->name('home');
$router->get('/about', [PageController::class, 'about'])->name('about');

// Auth routes
$router->group('/auth', function(RouteCollector $router) {
    $router->get('/login', [AuthController::class, 'showLogin'])->name('login');
    $router->post('/login', [AuthController::class, 'login'])->name('login.submit');
    $router->post('/logout', [AuthController::class, 'logout'])->name('logout');
});

// API routes
$router->group('/api', function(RouteCollector $router) {
    $router->group('/v1', function(RouteCollector $router) {
        $router->get('/users', [ApiUserController::class, 'index']);
        $router->get('/users/{id}', [ApiUserController::class, 'show']);
        $router->post('/users', [ApiUserController::class, 'store']);
        $router->put('/users/{id}', [ApiUserController::class, 'update']);
        $router->delete('/users/{id}', [ApiUserController::class, 'destroy']);
    }, [RateLimitMiddleware::class]);
}, [ApiAuthMiddleware::class, JsonMiddleware::class]);

// Match request
$match = $router->match($_SERVER['REQUEST_METHOD'], parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH));