Route

Apply the callback if the given "value" is (or resolves to) truthy.

Apply the callback if the given "value" is (or resolves to) falsy.

Specify that the given route parameters must be alphabetic.

Specify that the given route parameters must be alphanumeric.

Specify that the given route parameters must be numeric.

Specify that the given route parameters must be ULIDs.

Specify that the given route parameters must be UUIDs.

Specify that the given route parameters must be one of the given values.

Apply the given regular expression to the given parameters.

Determine if the given options exclude a particular method.

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 to the class.

Flush the static enum cache.

Boot or tests only. Clears the process-wide enum lookup cache shared by every coroutine; next resolution re-resolves.

Resolve the object method's type-hinted dependencies.

Resolve the given method's type-hinted dependencies.

Attempt to transform the given parameter into a class instance.

Determine if an object of the given class is in a list of parameters.

Splice the given value into the parameter list.

Create a new Route instance.

Parse the route action into a standard array.

Run the route action and return the response.

Check whether the route's action is a controller.

Run the callable route action and return the response.

Get the callable dispatcher for the route.

Determine if the route action is a serialized Closure.

Run the controller route action and return the response.

Get the controller instance for the route.

For worker-shared controllers (singletons and unbound auto-singletons), the instance is cached directly on the Route property for zero-overhead access across coroutines.

For controllers with per-coroutine semantics (#[Scoped] or explicit bind()), the instance is stored in coroutine Context to preserve the container's binding contract. CoroutineContext::getOrSet memoizes within a coroutine (getController() is called twice — middleware + dispatch) while still giving each coroutine its own instance.

Get the controller class used for the route.

Get the controller method used for the route.

Parse the controller.

Flush the cached controller state on the route.

Boot or tests only. Clears caches on the worker-shared route and evicts its controller class from the container.

Clears both the route-level property cache (for worker-shared controllers) and the coroutine Context entry (for scoped/bound controllers), plus the container's auto-singleton cache so make() creates a fresh instance.

Determine if the route matches a given request.

Compile the route into a Symfony CompiledRoute instance.

The compiled result is cached on the Route instance for the worker lifetime — it's immutable after compilation and safe to share.

Ensure the route is compiled.

Called during server boot pre-warming to populate the compiled regex cache before fork, so workers inherit it via copy-on-write.

Bind the route to a given request for execution.

Parameters are stored in coroutine Context, not on the Route instance, because Route objects are cached and shared across coroutines.

Bind parameters returned by the compiled route matcher.

Determine if the route has parameters.

Determine if a given parameter exists on the route.

Get a given parameter from the route.

Get original value of a given parameter from the route.

Set a parameter to the given value.

Unset a parameter on the route if it is set.

Get the key / value list of parameters for the route.

Get the key / value list of original parameters for the route.

Get the key / value list of parameters without null values.

Get all of the parameter names for the route.

Get the parameter names for the route.

Get the parameters that are listed in the route / controller signature.

Get the binding field for the given parameter.

Get the binding fields for the route.

Set the binding fields for the route.

Get the parent parameter of the given parameter.

Allow "trashed" models to be retrieved when resolving implicit model bindings for this route.

Determine if the route allows "trashed" models to be retrieved when resolving implicit model bindings.

Set a default value for the route.

Set the default values for the route.

Set a regular expression requirement on the route.

Parse arguments to the where method into an array.

Set a list of regular expression requirements on the route.

Mark this route as a fallback route.

Set the fallback value.

Get the HTTP verbs the route responds to.

Determine if the route only responds to HTTP requests.

Determine if the route only responds to HTTPS requests.

Determine if the route only responds to HTTPS requests.

Get or set the domain for the route.

Get the domain defined for the route.

Get or set the port for the route.

Get the port defined for the route.

Get the prefix of the route instance.

Add a prefix to the route URI.

Update the "prefix" attribute on the action array.

Get the URI associated with the route.

Set the URI that the route responds to.

Parse the route URI and normalize / store any implicit binding fields.

Get the name of the route instance.

Add or change the route name.

Determine whether the route's name matches the given patterns.

Set the handler for the route.

Parse a string based action for the "uses" fluent method.

Get the action name for the route.

Get the method name of the route action.

Get the action array or one of its properties for the route.

Set the action array for the route.

Get the value of the action that should be taken on a missing model exception.

Define the callable that should be invoked on a missing model exception.

Get all middleware, including the ones from the controller.

Get or set the middlewares attached to the route.

Specify that the "Authorize" / "can" middleware should be applied to the route.

Get the middleware for the route's controller.

Get the statically provided controller middleware for the given class and method.

Get the attribute provided controller middleware for the given class and method.

Get the excluded middleware for the route's controller.

Get the attribute provided excluded controller middleware for the given class and method.

Specify middleware that should be removed from the given route.

Get the middleware that should be removed from the route.

Indicate that the route should enforce scoping of multiple implicit Eloquent bindings.

Indicate that the route should not enforce scoping of multiple implicit Eloquent bindings.

Determine if the route should enforce scoping of multiple implicit Eloquent bindings.

Determine if the route should prevent scoping of multiple implicit Eloquent bindings.

Specify that the route should not allow concurrent requests from the same session.

Specify that the route should allow concurrent requests from the same session.

Get the maximum number of seconds the route's session lock should be held for.

Get the maximum number of seconds to wait while attempting to acquire a session lock.

Add metadata to the route.

Get metadata for the route.

Set the metadata for the route, replacing any existing metadata.

Get the dispatcher for the route's controller.

Get the route validators for the instance.

Convert the route to a Symfony route.

Get the optional parameter names for the route.

Get the compiled version of the route.

Set the router instance on the route.

Set the container instance on the route.

Prepare the route instance for serialization.

Flush all static state.

Dynamically access route parameters.