| Methods |
public
|
__construct(array|string $methods, string $uri, Closure|array $action): void
Create a new Route instance.
Create a new Route instance.
|
#
|
protected
|
parseAction(callable|array|null $action): array
Parse the route action into a standard array.
Parse the route action into a standard array.
Throws
|
#
|
public
|
run(): mixed
Run the route action and return the response.
Run the route action and return the response.
|
#
|
protected
|
isControllerAction(): bool
Checks whether the route's action is a controller.
Checks whether the route's action is a controller.
|
#
|
protected
|
runCallable(): mixed
Run the route action and return the response.
Run the route action and return the response.
|
#
|
protected
|
isSerializedClosure(): bool
Determine if the route action is a serialized Closure.
Determine if the route action is a serialized Closure.
|
#
|
protected
|
runController(): mixed
Run the route action and return the response.
Run the route action and return the response.
Throws
|
#
|
public
|
getController(): mixed
Get the controller instance for the route.
Get the controller instance for the route.
|
#
|
public
|
getControllerClass(): string|null
Get the controller class used for the route.
Get the controller class used for the route.
|
#
|
protected
|
getControllerMethod(): string
Get the controller method used for the route.
Get the controller method used for the route.
|
#
|
protected
|
parseControllerCallback(): array
Parse the controller.
|
#
|
public
|
flushController(): void
Flush the cached container instance on the route.
Flush the cached container instance on the route.
|
#
|
public
|
matches(Request $request, bool $includingMethod = true): bool
Determine if the route matches a given request.
Determine if the route matches a given request.
|
#
|
protected
|
compileRoute(): CompiledRoute
Compile the route into a Symfony CompiledRoute instance.
Compile the route into a Symfony CompiledRoute instance.
|
#
|
public
|
bind(Request $request): $this
Bind the route to a given request for execution.
Bind the route to a given request for execution.
|
#
|
public
|
hasParameters(): bool
Determine if the route has parameters.
Determine if the route has parameters.
|
#
|
public
|
hasParameter(string $name): bool
Determine a given parameter exists from the route.
Determine a given parameter exists from the route.
|
#
|
public
|
parameter(string $name, string|object|null $default = null): string|object|null
Get a given parameter from the route.
Get a given parameter from the route.
|
#
|
public
|
originalParameter(string $name, string|null $default = null): string|null
Get original value of a given parameter from the route.
Get original value of a given parameter from the route.
|
#
|
public
|
setParameter(string $name, string|object|null $value): void
Set a parameter to the given value.
Set a parameter to the given value.
|
#
|
public
|
forgetParameter(string $name): void
Unset a parameter on the route if it is set.
Unset a parameter on the route if it is set.
|
#
|
public
|
parameters(): array
Get the key / value list of parameters for the route.
Get the key / value list of parameters for the route.
Throws
|
#
|
public
|
originalParameters(): array
Get the key / value list of original parameters for the route.
Get the key / value list of original parameters for the route.
Throws
|
#
|
public
|
parametersWithoutNulls(): array
Get the key / value list of parameters without null values.
Get the key / value list of parameters without null values.
|
#
|
public
|
parameterNames(): array
Get all of the parameter names for the route.
Get all of the parameter names for the route.
|
#
|
protected
|
compileParameterNames(): array
Get the parameter names for the route.
Get the parameter names for the route.
|
#
|
public
|
signatureParameters(array $conditions = []): array
Get the parameters that are listed in the route / controller signature.
Get the parameters that are listed in the route / controller signature.
|
#
|
public
|
bindingFieldFor(string|int $parameter): string|null
Get the binding field for the given parameter.
Get the binding field for the given parameter.
|
#
|
public
|
bindingFields(): array
Get the binding fields for the route.
Get the binding fields for the route.
|
#
|
public
|
setBindingFields(array $bindingFields): $this
Set the binding fields for the route.
Set the binding fields for the route.
|
#
|
public
|
parentOfParameter(string $parameter): string|null
Get the parent parameter of the given parameter.
Get the parent parameter of the given parameter.
|
#
|
public
|
withTrashed(bool $withTrashed = true): $this
Allow "trashed" models to be retrieved when resolving implicit model bindings for this route.
Allow "trashed" models to be retrieved when resolving implicit model bindings for this route.
|
#
|
public
|
allowsTrashedBindings(): bool
Determines if the route allows "trashed" models to be retrieved when resolving implicit model bindings.
Determines if the route allows "trashed" models to be retrieved when resolving implicit model bindings.
|
#
|
public
|
defaults(string $key, mixed $value): $this
Set a default value for the route.
Set a default value for the route.
|
#
|
public
|
setDefaults(array $defaults): $this
Set the default values for the route.
Set the default values for the route.
|
#
|
public
|
where(array|string $name, string|null $expression = null): $this
Set a regular expression requirement on the route.
Set a regular expression requirement on the route.
|
#
|
protected
|
parseWhere(array|string $name, string $expression): array
Parse arguments to the where method into an array.
Parse arguments to the where method into an array.
|
#
|
public
|
setWheres(array $wheres): $this
Set a list of regular expression requirements on the route.
Set a list of regular expression requirements on the route.
|
#
|
public
|
fallback(): $this
Mark this route as a fallback route.
Mark this route as a fallback route.
|
#
|
public
|
setFallback(bool $isFallback): $this
Set the fallback value.
|
#
|
public
|
methods(): array
Get the HTTP verbs the route responds to.
Get the HTTP verbs the route responds to.
|
#
|
public
|
httpOnly(): bool
Determine if the route only responds to HTTP requests.
Determine if the route only responds to HTTP requests.
|
#
|
public
|
httpsOnly(): bool
Determine if the route only responds to HTTPS requests.
Determine if the route only responds to HTTPS requests.
|
#
|
public
|
secure(): bool
Determine if the route only responds to HTTPS requests.
Determine if the route only responds to HTTPS requests.
|
#
|
public
|
domain(BackedEnum|string|null $domain = null): $this|string|null
Get or set the domain for the route.
Get or set the domain for the route.
Throws
|
#
|
public
|
getDomain(): string|null
Get the domain defined for the route.
Get the domain defined for the route.
|
#
|
public
|
getPrefix(): string|null
Get the prefix of the route instance.
Get the prefix of the route instance.
|
#
|
public
|
prefix(string|null $prefix): $this
Add a prefix to the route URI.
Add a prefix to the route URI.
|
#
|
protected
|
updatePrefixOnAction(string $prefix): void
Update the "prefix" attribute on the action array.
Update the "prefix" attribute on the action array.
|
#
|
public
|
uri(): string
Get the URI associated with the route.
Get the URI associated with the route.
|
#
|
public
|
setUri(string $uri): $this
Set the URI that the route responds to.
Set the URI that the route responds to.
|
#
|
protected
|
parseUri(string $uri): string
Parse the route URI and normalize / store any implicit binding fields.
Parse the route URI and normalize / store any implicit binding fields.
|
#
|
public
|
getName(): string|null
Get the name of the route instance.
Get the name of the route instance.
|
#
|
public
|
name(BackedEnum|string $name): $this
Add or change the route name.
Add or change the route name.
Throws
|
#
|
public
|
named(mixed ...$patterns): bool
Determine whether the route's name matches the given patterns.
Determine whether the route's name matches the given patterns.
|
#
|
public
|
uses(Closure|array|string $action): $this
Set the handler for the route.
Set the handler for the route.
|
#
|
protected
|
addGroupNamespaceToStringUses(string $action): string
Parse a string based action for the "uses" fluent method.
Parse a string based action for the "uses" fluent method.
|
#
|
public
|
getActionName(): string
Get the action name for the route.
Get the action name for the route.
|
#
|
public
|
getActionMethod(): string
Get the method name of the route action.
Get the method name of the route action.
|
#
|
public
|
getAction(string|null $key = null): mixed
Get the action array or one of its properties for the route.
Get the action array or one of its properties for the route.
|
#
|
public
|
setAction(array $action): $this
Set the action array for the route.
Set the action array for the route.
|
#
|
public
|
getMissing(): Closure|null
Get the value of the action that should be taken on a missing model exception.
Get the value of the action that should be taken on a missing model exception.
|
#
|
public
|
missing(Closure $missing): $this
Define the callable that should be invoked on a missing model exception.
Define the callable that should be invoked on a missing model exception.
|
#
|
public
|
gatherMiddleware(): array
Get all middleware, including the ones from the controller.
Get all middleware, including the ones from the controller.
|
#
|
public
|
middleware(array|string|null $middleware = null): $this|array
Get or set the middlewares attached to the route.
Get or set the middlewares attached to the route.
|
#
|
public
|
can(UnitEnum|string $ability, array|string $models = []): $this
Specify that the "Authorize" / "can" middleware should be applied to the route with the given options.
Specify that the "Authorize" / "can" middleware should be applied to the route with the given options.
|
#
|
public
|
controllerMiddleware(): array
Get the middleware for the route's controller.
Get the middleware for the route's controller.
|
#
|
protected
|
staticallyProvidedControllerMiddleware(string $class, string $method): array
Get the statically provided controller middleware for the given class and method.
Get the statically provided controller middleware for the given class and method.
|
#
|
public
|
withoutMiddleware(array|string $middleware): $this
Specify middleware that should be removed from the given route.
Specify middleware that should be removed from the given route.
|
#
|
public
|
excludedMiddleware(): array
Get the middleware that should be removed from the route.
Get the middleware that should be removed from the route.
|
#
|
public
|
scopeBindings(): $this
Indicate that the route should enforce scoping of multiple implicit Eloquent bindings.
Indicate that the route should enforce scoping of multiple implicit Eloquent bindings.
|
#
|
public
|
withoutScopedBindings(): $this
Indicate that the route should not enforce scoping of multiple implicit Eloquent bindings.
Indicate that the route should not enforce scoping of multiple implicit Eloquent bindings.
|
#
|
public
|
enforcesScopedBindings(): bool
Determine if the route should enforce scoping of multiple implicit Eloquent bindings.
Determine if the route should enforce scoping of multiple implicit Eloquent bindings.
|
#
|
public
|
preventsScopedBindings(): bool
Determine if the route should prevent scoping of multiple implicit Eloquent bindings.
Determine if the route should prevent scoping of multiple implicit Eloquent bindings.
|
#
|
public
|
block(int|null $lockSeconds = 10, int|null $waitSeconds = 10): $this
Specify that the route should not allow concurrent requests from the same session.
Specify that the route should not allow concurrent requests from the same session.
|
#
|
public
|
withoutBlocking(): $this
Specify that the route should allow concurrent requests from the same session.
Specify that the route should allow concurrent requests from the same session.
|
#
|
public
|
locksFor(): int|null
Get the maximum number of seconds the route's session lock should be held for.
Get the maximum number of seconds the route's session lock should be held for.
|
#
|
public
|
waitsFor(): int|null
Get the maximum number of seconds to wait while attempting to acquire a session lock.
Get the maximum number of seconds to wait while attempting to acquire a session lock.
|
#
|
public
|
controllerDispatcher(): ControllerDispatcher
Get the dispatcher for the route's controller.
Get the dispatcher for the route's controller.
|
#
|
public
static
|
getValidators(): array
Get the route validators for the instance.
Get the route validators for the instance.
|
#
|
public
|
toSymfonyRoute(): Route
Convert the route to a Symfony route.
Convert the route to a Symfony route.
|
#
|
protected
|
getOptionalParameterNames(): array
Get the optional parameter names for the route.
Get the optional parameter names for the route.
|
#
|
public
|
getCompiled(): CompiledRoute
Get the compiled version of the route.
Get the compiled version of the route.
|
#
|
public
|
setRouter(Router $router): $this
Set the router instance on the route.
Set the router instance on the route.
|
#
|
public
|
setContainer(Container $container): $this
Set the container instance on the route.
Set the container instance on the route.
|
#
|
public
|
prepareForSerialization(): void
Prepare the route instance for serialization.
Prepare the route instance for serialization.
Throws
|
#
|
public
|
__get(string $key): mixed
Dynamically access route parameters.
Dynamically access route parameters.
|
#
|