Route
class Route (View source)
Traits
Properties
static protected array | $macros | The registered string macros. | from Macroable |
string | $uri | The URI pattern the route responds to. | |
array | $methods | The HTTP methods the route responds to. | |
array | $action | The route action array. | |
bool | $isFallback | Indicates whether the route is a fallback route. | |
mixed | $controller | The controller instance. | |
array | $defaults | The default values for the route. | |
array | $wheres | The regular expression requirements. | |
array | $parameters | The array of matched parameters. | |
array|null | $parameterNames | The parameter names for the route. | |
array|null | $computedMiddleware | The computed gathered middleware. | |
CompiledRoute | $compiled | The compiled version of the route. | |
protected Router | $router | The router instance used by the route. | |
protected Container | $container | The container instance used by the route. | |
static array | $validators | The validators used by the routes. |
Methods
Dynamically handle calls to the class.
Dynamically handle calls to the class.
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.
Parse the route action into a standard array.
Run the route action and return the response.
Checks whether the route's action is a controller.
Run the route action and return the response.
Run the route action and return the response.
Get the controller instance for the route.
Get the controller method used for the route.
Parse the controller.
Compile the route into a Symfony CompiledRoute instance.
Determine if the route has parameters.
Determine a given parameter exists from the route.
Get 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 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.
Set a default value 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.
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 the prefix of the route instance.
Add a prefix to the route URI.
Get the URI associated with the route.
Set the URI that the route responds to.
Get the name of the route instance.
Add or change the route name.
Determine whether the route's name matches the given patterns.
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 all middleware, including the ones from the controller.
Get or set the middlewares attached to the route.
Get the middleware for the route's controller.
Get the dispatcher for the route's controller.
Get the route validators for the instance.
Get the compiled version of the route.
Prepare the route instance for serialization.
Dynamically access route parameters.
Details
static void
macro(string $name, object|callable $macro)
Register a custom macro.
static mixed
__callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
mixed
__call(string $method, array $parameters)
Dynamically handle calls to the class.
protected array
resolveClassMethodDependencies(array $parameters, object $instance, string $method)
Resolve the object method's type-hinted dependencies.
array
resolveMethodDependencies(array $parameters, ReflectionFunctionAbstract $reflector)
Resolve the given method's type-hinted dependencies.
protected mixed
transformDependency(ReflectionParameter $parameter, array $parameters)
Attempt to transform the given parameter into a class instance.
protected bool
alreadyInParameters(string $class, array $parameters)
Determine if an object of the given class is in a list of parameters.
protected void
spliceIntoParameters(array $parameters, string $offset, mixed $value)
Splice the given value into the parameter list.
at line 130
void
__construct(array|string $methods, string $uri, Closure|array $action)
Create a new Route instance.
at line 153
protected array
parseAction(callable|array|null $action)
Parse the route action into a standard array.
at line 163
mixed
run()
Run the route action and return the response.
at line 183
protected bool
isControllerAction()
Checks whether the route's action is a controller.
at line 193
protected mixed
runCallable()
Run the route action and return the response.
at line 209
protected mixed
runController()
Run the route action and return the response.
at line 221
mixed
getController()
Get the controller instance for the route.
at line 237
protected string
getControllerMethod()
Get the controller method used for the route.
at line 247
protected array
parseControllerCallback()
Parse the controller.
at line 259
bool
matches(Request $request, bool $includingMethod = true)
Determine if the route matches given request.
at line 281
protected CompiledRoute
compileRoute()
Compile the route into a Symfony CompiledRoute instance.
at line 311
bool
hasParameters()
Determine if the route has parameters.
at line 322
bool
hasParameter(string $name)
Determine a given parameter exists from the route.
at line 338
string|object
parameter(string $name, mixed $default = null)
Get a given parameter from the route.
at line 350
void
setParameter(string $name, mixed $value)
Set a parameter to the given value.
at line 363
void
forgetParameter(string $name)
Unset a parameter on the route if it is set.
at line 377
array
parameters()
Get the key / value list of parameters for the route.
at line 391
array
parametersWithoutNulls()
Get the key / value list of parameters without null values.
at line 403
array
parameterNames()
Get all of the parameter names for the route.
at line 417
protected array
compileParameterNames()
Get the parameter names for the route.
at line 432
array
signatureParameters(string|null $subClass = null)
Get the parameters that are listed in the route / controller signature.
at line 444
$this
defaults(string $key, mixed $value)
Set a default value for the route.
at line 458
$this
where(array|string $name, string $expression = null)
Set a regular expression requirement on the route.
at line 474
protected array
parseWhere(array|string $name, string $expression)
Parse arguments to the where method into an array.
at line 485
protected $this
whereArray(array $wheres)
Set a list of regular expression requirements on the route.
at line 499
$this
fallback()
Mark this route as a fallback route.
at line 511
array
methods()
Get the HTTP verbs the route responds to.
at line 521
bool
httpOnly()
Determine if the route only responds to HTTP requests.
at line 531
bool
httpsOnly()
Determine if the route only responds to HTTPS requests.
at line 541
bool
secure()
Determine if the route only responds to HTTPS requests.
at line 552
$this|string|null
domain(string|null $domain = null)
Get or set the domain for the route.
at line 568
string|null
getDomain()
Get the domain defined for the route.
at line 579
string
getPrefix()
Get the prefix of the route instance.
at line 590
$this
prefix(string $prefix)
Add a prefix to the route URI.
at line 604
string
uri()
Get the URI associated with the route.
at line 615
$this
setUri(string $uri)
Set the URI that the route responds to.
at line 627
string
getName()
Get the name of the route instance.
at line 638
$this
name(string $name)
Add or change the route name.
at line 651
bool
named(dynamic $patterns)
Determine whether the route's name matches the given patterns.
at line 688
protected string
addGroupNamespaceToStringUses(string $action)
Parse a string based action for the "uses" fluent method.
at line 704
string
getActionName()
Get the action name for the route.
at line 714
string
getActionMethod()
Get the method name of the route action.
at line 725
mixed
getAction(string|null $key = null)
Get the action array or one of its properties for the route.
at line 736
$this
setAction(array $action)
Set the action array for the route.
at line 748
array
gatherMiddleware()
Get all middleware, including the ones from the controller.
at line 767
$this|array
middleware(array|string|null $middleware = null)
Get or set the middlewares attached to the route.
at line 789
array
controllerMiddleware()
Get the middleware for the route's controller.
at line 805
ControllerDispatcher
controllerDispatcher()
Get the dispatcher for the route's controller.
at line 819
static array
getValidators()
Get the route validators for the instance.
at line 839
CompiledRoute
getCompiled()
Get the compiled version of the route.
at line 877
void
prepareForSerialization()
Prepare the route instance for serialization.
at line 894
mixed
__get(string $key)
Dynamically access route parameters.