Router

Register a custom macro.

Boot-only. Macros persist in a static property for the worker lifetime and apply to every subsequent call on the macroable class.

Mix another object into the class.

Boot-only. Delegates to macro() for each method; registered macros persist in a static property for the worker lifetime.

Check if macro is registered.

Flush the existing macros.

Boot or tests only. Clears worker-wide macros; concurrent coroutines may resolve different methods depending on timing.

Dynamically handle calls to the class.

Dynamically handle calls into the router instance.

Call the given Closure with this instance then return the instance.

Create a new Router instance.

Register a new GET route with the router.

Register a new POST route with the router.

Register a new PUT route with the router.

Register a new PATCH route with the router.

Register a new DELETE route with the router.

Register a new OPTIONS route with the router.

Register a new QUERY route with the router.

Register a new route responding to all verbs.

Register a new fallback route with the router.

Create a redirect from one URI to another.

Create a permanent redirect from one URI to another.

Register a new route that returns a view.

Register a new route with the given verbs.

Register an array of resource controllers.

Register an array of resource controllers that can be soft deleted.

Route a resource to a controller.

Register an array of API resource controllers.

Route an API resource to a controller.

Register an array of singleton resource controllers.

Route a singleton resource to a controller.

Register an array of API singleton resource controllers.

Route an API singleton resource to a controller.

Create a route group with shared attributes.

Update the group stack with the given attributes.

Merge the given array with the last group stack.

Load the provided routes.

Get the prefix from the last group on the stack.

Add a route to the underlying route collection.

Create a new route instance.

Determine if the action is routing to a controller.

Add a controller based route action to the action array.

Prepend the last group namespace onto the use clause.

Prepend the last group controller onto the use clause.

Create a new Route object.

Prefix the given URI with the last prefix.

Add the necessary where clauses to the route based on its initial registration.

Merge the group stack with the controller action.

Return the response returned by the given route.

Dispatch the request to the application.

Dispatch the request to a route and return the response.

Match a route, run middleware, and call the given callback instead of the controller.

Performs the full route context lifecycle (route matching, context setup, route resolver, RouteMatched event, middleware pipeline) but calls the provided callback as the terminal handler instead of the route's action.

Used by the WebSocket server for handshake requests where route matching and middleware must run but the controller must not be invoked.

Find the route matching a given request.

Return the response for the given route.

Run the given route within a Stack "onion" instance.

Create the middleware pipeline used to dispatch a route.

Resolve middleware for one route dispatch.

Convert gathered middleware into descriptors, caching only the route's canonical list.

Convert class-string middleware into immutable pipe descriptors.

Gather the middleware for the given route with resolved class names.

Resolve a flat array of middleware classes from the provided array.

Resolve middleware aliases without expanding middleware groups.

Resolve middleware using the given middleware groups.

Sort the given middleware by priority.

Create a response instance from the given value.

Static version of prepareResponse.

Substitute the route bindings onto the route.

Substitute the implicit route bindings for the given route.

Register a callback to run after implicit bindings are substituted.

Boot-only. The callback persists on the singleton Router and affects every subsequent route binding.

Call the binding callback for the given key.

Register a route matched event listener.

Boot-only. The listener persists on the worker-lifetime event dispatcher and runs for every subsequent route match.

Get all of the defined middleware short-hand names.

Register a short-hand name for a middleware.

Boot-only. The alias persists in the singleton Router for the worker lifetime and applies to every subsequent route resolution.

Check if a middlewareGroup with the given name exists.

Get all of the defined middleware groups.

Register a group of middleware.

Boot-only. The middleware group persists in the singleton Router for the worker lifetime and applies to every subsequent route resolution.

Add a middleware to the beginning of a middleware group.

If the middleware is already in the group, it will not be added again.

Boot-only. The middleware group persists in the singleton Router for the worker lifetime and applies to every subsequent route resolution.

Add a middleware to the end of a middleware group.

If the middleware is already in the group, it will not be added again.

Boot-only. The middleware group persists in the singleton Router for the worker lifetime and applies to every subsequent route resolution.

Remove the given middleware from the specified group.

Boot-only. The group mutation persists on the singleton Router and does not invalidate middleware already resolved on routes.

Flush the router's middleware groups.

Boot or tests only. Clears the singleton Router's middleware-group registry shared by every coroutine; concurrent requests lose middleware mid-dispatch.

Add a new route parameter binder.

Boot-only. The binder persists in the singleton Router for the worker lifetime and runs on every subsequent route parameter resolution.

Register a model binder for a wildcard.

Boot-only. The model binder persists in the singleton Router for the worker lifetime and runs on every subsequent route parameter resolution.

Get the binding callback for a given binding.

Get the global "where" patterns.

Set a global where pattern on all routes.

Boot-only. The pattern persists in the singleton Router for the worker lifetime and applies to every subsequent route definition.

Set a group of global where patterns on all routes.

Boot-only. The patterns persist in the singleton Router for the worker lifetime and apply to every subsequent route definition.

Determine if the router currently has a group stack.

Get the current group stack for the router.

Get a route parameter for the current route.

Get the request currently being dispatched.

Get the currently dispatched route instance.

Get the currently dispatched route instance.

Check if a route with the given name exists.

Get the current route name.

Alias for the "currentRouteNamed" method.

Determine if the current route matches a pattern.

Get the current route action.

Alias for the "currentRouteUses" method.

Determine if the current route action matches a given action.

Set the unmapped global resource parameters to singular.

Boot-only. Delegates to ResourceRegistrar::singularParameters() which persists in a static property for the worker lifetime.

Set the global resource parameter mapping.

Boot-only. The mapping persists in static state for the worker lifetime.

Get or set the verbs used in the resource URIs.

Boot-only when setting. Custom verbs persist in static state for the worker lifetime.

Get the underlying route collection.

Set the route collection instance.

Boot or tests only. Replacing the collection mutates the singleton Router and its shared route binding for every subsequent request.

Set the compiled route collection instance.

Boot-only. Replaces the singleton Router's route collection and rebinds the container's 'routes' instance; runtime use breaks every concurrent request mid-dispatch.

Determine whether this router owns the application's global route state.

Flush all static routing caches.

Called when the route collection is replaced to clear stale data. In Swoole workers live forever, so stale statics would persist.

Compile routes and pre-warm collection and static caches.

In dev mode, compiles RouteCollection → CompiledRouteCollection for CompiledUrlMatcher performance (O(1) hash + single regex). In production with route:cache, routes are already CompiledRouteCollection — compile is skipped and only warmUp() runs.

Called from HttpServer\Server and WebSocketServer\Server after Kernel::bootstrap() returns, before $server->start(). Idempotent — safe to call from both servers in combined setups.

Boot-only. Replaces the route collection and populates process-wide caches before fork.

Pre-warm all caches for the registered routes.

Eagerly populates route compilation, middleware resolution, and reflection caches so they're available before fork. Workers inherit via copy-on-write in both SWOOLE_PROCESS and SWOOLE_BASE modes.

Remove any duplicate middleware from the given array.

Set the container instance used by the router.

Tests only. Swaps the singleton Router's container reference; per-request use races across coroutines and breaks every concurrent route dispatch.

Flush all static state.