Illuminate\Routing\Route

class Route (View source)

Traits

Macroable

RouteDependencyResolverTrait

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

static void

macro(string $name, object|callable $macro)

from Macroable

static void

mixin(object $mixin)

Mix another object into the class.

from Macroable

static bool

hasMacro(string $name)

Checks if macro is registered.

from Macroable

static mixed

__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

from Macroable

mixed

__call(string $method, array $parameters)

Dynamically handle calls to the class.

from Macroable

array

resolveClassMethodDependencies(array $parameters, object $instance, string $method)

Resolve the object method's type-hinted dependencies.

from RouteDependencyResolverTrait

array

resolveMethodDependencies(array $parameters, ReflectionFunctionAbstract $reflector)

Resolve the given method's type-hinted dependencies.

from RouteDependencyResolverTrait

mixed

transformDependency(ReflectionParameter $parameter, array $parameters)

Attempt to transform the given parameter into a class instance.

from RouteDependencyResolverTrait

bool

alreadyInParameters(string $class, array $parameters)

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

from RouteDependencyResolverTrait

void

spliceIntoParameters(array $parameters, string $offset, mixed $value)

Splice the given value into the parameter list.

from RouteDependencyResolverTrait

void

__construct(array|string $methods, string $uri, Closure|array $action)

Create a new Route instance.

array

parseAction(callable|array|null $action)

Parse the route action into a standard array.

mixed

run()

Run the route action and return the response.

bool

isControllerAction()

Checks whether the route's action is a controller.

mixed

runCallable()

Run the route action and return the response.

mixed

runController()

Run the route action and return the response.

mixed

getController()

Get the controller instance for the route.

string

getControllerMethod()

Get the controller method used for the route.

array

parseControllerCallback()

Parse the controller.

bool

matches(Request $request, bool $includingMethod = true)

Determine if the route matches given request.

CompiledRoute

compileRoute()

Compile the route into a Symfony CompiledRoute instance.

$this

bind(Request $request)

Bind the route to a given request for execution.

bool

hasParameters()

Determine if the route has parameters.

bool

hasParameter(string $name)

Determine a given parameter exists from the route.

string|object

parameter(string $name, mixed $default = null)

Get a given parameter from the route.

void

setParameter(string $name, mixed $value)

Set a parameter to the given value.

void

forgetParameter(string $name)

Unset a parameter on the route if it is set.

array

parameters()

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

array

parametersWithoutNulls()

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

array

parameterNames()

Get all of the parameter names for the route.

array

compileParameterNames()

Get the parameter names for the route.

array

signatureParameters(string|null $subClass = null)

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

$this

defaults(string $key, mixed $value)

Set a default value for the route.

$this

where(array|string $name, string $expression = null)

Set a regular expression requirement on the route.

array

parseWhere(array|string $name, string $expression)

Parse arguments to the where method into an array.

$this

whereArray(array $wheres)

Set a list of regular expression requirements on the route.

$this

fallback()

Mark this route as a fallback route.

array

methods()

Get the HTTP verbs the route responds to.

bool

httpOnly()

Determine if the route only responds to HTTP requests.

bool

httpsOnly()

Determine if the route only responds to HTTPS requests.

bool

secure()

Determine if the route only responds to HTTPS requests.

$this|string|null

domain(string|null $domain = null)

Get or set the domain for the route.

string|null

getDomain()

Get the domain defined for the route.

string

getPrefix()

Get the prefix of the route instance.

$this

prefix(string $prefix)

Add a prefix to the route URI.

string

uri()

Get the URI associated with the route.

$this

setUri(string $uri)

Set the URI that the route responds to.

string

getName()

Get the name of the route instance.

$this

name(string $name)

Add or change the route name.

bool

named(dynamic ...$patterns)

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

$this

uses(Closure|string $action)

Set the handler for the route.

string

addGroupNamespaceToStringUses(string $action)

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

string

getActionName()

Get the action name for the route.

string

getActionMethod()

Get the method name of the route action.

mixed

getAction(string|null $key = null)

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

$this

setAction(array $action)

Set the action array for the route.

array

gatherMiddleware()

Get all middleware, including the ones from the controller.

$this|array

middleware(array|string|null $middleware = null)

Get or set the middlewares attached to the route.

array

controllerMiddleware()

Get the middleware for the route's controller.

ControllerDispatcher

controllerDispatcher()

Get the dispatcher for the route's controller.

static array

getValidators()

Get the route validators for the instance.

CompiledRoute

getCompiled()

Get the compiled version of the route.

$this

setRouter(Router $router)

Set the router instance on the route.

$this

setContainer(Container $container)

Set the container instance on the route.

void

prepareForSerialization()

Prepare the route instance for serialization.

mixed

__get(string $key)

Dynamically access route parameters.

Details

in Macroable at line 27
`static void macro(string $name, object|callable $macro)`

Parameters

string	$name
object\|callable	$macro

Return Value

void

in Macroable at line 39
`static void mixin(object $mixin)`

Mix another object into the class.

Parameters

object

$mixin

Return Value

void

Exceptions

ReflectionException

in Macroable at line 58
`static bool hasMacro(string $name)`

Checks if macro is registered.

Parameters

string

$name

Return Value

bool

in Macroable at line 72
`static mixed __callStatic(string $method, array $parameters)`

Dynamically handle calls to the class.

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line 96
`mixed __call(string $method, array $parameters)`

Dynamically handle calls to the class.

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

in RouteDependencyResolverTrait at line 20
`protected array resolveClassMethodDependencies(array $parameters, object $instance, string $method)`

Resolve the object method's type-hinted dependencies.

Parameters

array	$parameters
object	$instance
string	$method

Return Value

array

in RouteDependencyResolverTrait at line 38
`array resolveMethodDependencies(array $parameters, ReflectionFunctionAbstract $reflector)`

Resolve the given method's type-hinted dependencies.

Parameters

array	$parameters
ReflectionFunctionAbstract	$reflector

Return Value

array

in RouteDependencyResolverTrait at line 69
`protected mixed transformDependency(ReflectionParameter $parameter, array $parameters)`

Attempt to transform the given parameter into a class instance.

Parameters

ReflectionParameter	$parameter
array	$parameters

Return Value

mixed

in RouteDependencyResolverTrait at line 90
`protected bool alreadyInParameters(string $class, array $parameters)`

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

Parameters

string	$class
array	$parameters

Return Value

bool

in RouteDependencyResolverTrait at line 105
`protected void spliceIntoParameters(array $parameters, string $offset, mixed $value)`

Splice the given value into the parameter list.

Parameters

array	$parameters
string	$offset
mixed	$value

Return Value

void

at line 130
`void __construct(array|string $methods, string $uri, Closure|array $action)`

Create a new Route instance.

Parameters

array\|string	$methods
string	$uri
Closure\|array	$action

Return Value

void

at line 153
`protected array parseAction(callable|array|null $action)`

Parse the route action into a standard array.

Parameters

callable|array|null

$action

Return Value

array

Exceptions

UnexpectedValueException

at line 163
`mixed run()`

Run the route action and return the response.

Return Value

mixed

at line 183
`protected bool isControllerAction()`

Checks whether the route's action is a controller.

Return Value

bool

at line 193
`protected mixed runCallable()`

Run the route action and return the response.

Return Value

mixed

at line 209
`protected mixed runController()`

Run the route action and return the response.

Return Value

mixed

Exceptions

NotFoundHttpException

at line 221
`mixed getController()`

Get the controller instance for the route.

Return Value

mixed

at line 237
`protected string getControllerMethod()`

Get the controller method used for the route.

Return Value

string

at line 247
`protected array parseControllerCallback()`

Parse the controller.

Return Value

array

at line 259
`bool matches(Request $request, bool $includingMethod = true)`

Determine if the route matches given request.

Parameters

Request	$request
bool	$includingMethod

Return Value

bool

at line 281
`protected CompiledRoute compileRoute()`

Compile the route into a Symfony CompiledRoute instance.

Return Value

CompiledRoute

at line 296
`$this bind(Request $request)`

Bind the route to a given request for execution.

Parameters

Request

$request

Return Value

$this

at line 311
`bool hasParameters()`

Determine if the route has parameters.

Return Value

bool

at line 322
`bool hasParameter(string $name)`

Determine a given parameter exists from the route.

Parameters

string

$name

Return Value

bool

at line 338
`string|object parameter(string $name, mixed $default = null)`

Get a given parameter from the route.

Parameters

string	$name
mixed	$default

Return Value

string|object

at line 350
`void setParameter(string $name, mixed $value)`

Set a parameter to the given value.

Parameters

string	$name
mixed	$value

Return Value

void

at line 363
`void forgetParameter(string $name)`

Unset a parameter on the route if it is set.

Parameters

string

$name

Return Value

void

at line 377
`array parameters()`

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

Return Value

array

Exceptions

LogicException

at line 391
`array parametersWithoutNulls()`

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

Return Value

array

at line 403
`array parameterNames()`

Get all of the parameter names for the route.

Return Value

array

at line 417
`protected array compileParameterNames()`

Get the parameter names for the route.

Return Value

array

at line 432
`array signatureParameters(string|null $subClass = null)`

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

Parameters

string|null

$subClass

Return Value

array

at line 444
`$this defaults(string $key, mixed $value)`

Set a default value for the route.

Parameters

string	$key
mixed	$value

Return Value

$this

at line 458
`$this where(array|string $name, string $expression = null)`

Set a regular expression requirement on the route.

Parameters

array\|string	$name
string	$expression

Return Value

$this

at line 474
`protected array parseWhere(array|string $name, string $expression)`

Parse arguments to the where method into an array.

Parameters

array\|string	$name
string	$expression

Return Value

array

at line 485
`protected $this whereArray(array $wheres)`

Set a list of regular expression requirements on the route.

Parameters

array

$wheres

Return Value

$this

at line 499
`$this fallback()`

Mark this route as a fallback route.

Return Value

$this

at line 511
`array methods()`

Get the HTTP verbs the route responds to.

Return Value

array

at line 521
`bool httpOnly()`

Determine if the route only responds to HTTP requests.

Return Value

bool

at line 531
`bool httpsOnly()`

Determine if the route only responds to HTTPS requests.

Return Value

bool

at line 541
`bool secure()`

Determine if the route only responds to HTTPS requests.

Return Value

bool

at line 552
`$this|string|null domain(string|null $domain = null)`

Get or set the domain for the route.

Parameters

string|null

$domain

Return Value

$this|string|null

at line 568
`string|null getDomain()`

Get the domain defined for the route.

Return Value

string|null

at line 579
`string getPrefix()`

Get the prefix of the route instance.

Return Value

string

at line 590
`$this prefix(string $prefix)`

Add a prefix to the route URI.

Parameters

string

$prefix

Return Value

$this

at line 604
`string uri()`

Get the URI associated with the route.

Return Value

string

at line 615
`$this setUri(string $uri)`

Set the URI that the route responds to.

Parameters

string

$uri

Return Value

$this

at line 627
`string getName()`

Get the name of the route instance.

Return Value

string

at line 638
`$this name(string $name)`

Add or change the route name.

Parameters

string

$name

Return Value

$this

at line 651
`bool named(dynamic ...$patterns)`

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

Parameters

dynamic

...$patterns

Return Value

bool

at line 672
`$this uses(Closure|string $action)`

Set the handler for the route.

Parameters

Closure|string

$action

Return Value

$this

at line 688
`protected string addGroupNamespaceToStringUses(string $action)`

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

Parameters

string

$action

Return Value

string

at line 704
`string getActionName()`

Get the action name for the route.

Return Value

string

at line 714
`string getActionMethod()`

Get the method name of the route action.

Return Value

string

at line 725
`mixed getAction(string|null $key = null)`

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

Parameters

string|null

$key

Return Value

mixed

at line 736
`$this setAction(array $action)`

Set the action array for the route.

Parameters

array

$action

Return Value

$this

at line 748
`array gatherMiddleware()`

Get all middleware, including the ones from the controller.

Return Value

array

at line 767
`$this|array middleware(array|string|null $middleware = null)`

Get or set the middlewares attached to the route.

Parameters

array|string|null

$middleware

Return Value

$this|array

at line 789
`array controllerMiddleware()`

Get the middleware for the route's controller.

Return Value

array

at line 805
`ControllerDispatcher controllerDispatcher()`

Get the dispatcher for the route's controller.

Return Value

ControllerDispatcher

at line 819
`static array getValidators()`

Get the route validators for the instance.

Return Value

array

at line 839
`CompiledRoute getCompiled()`

Get the compiled version of the route.

Return Value

CompiledRoute

at line 850
`$this setRouter(Router $router)`

Set the router instance on the route.

Parameters

Router

$router

Return Value

$this

at line 863
`$this setContainer(Container $container)`

Set the container instance on the route.

Parameters

Container

$container

Return Value

$this

at line 877
`void prepareForSerialization()`

Prepare the route instance for serialization.

Return Value

void

Exceptions

LogicException

at line 894
`mixed __get(string $key)`

Dynamically access route parameters.

Parameters

string

$key

Return Value

mixed

Route

Traits

Properties

Methods

Details

in Macroable at line 27 static void macro(string $name, object|callable $macro)

Parameters

Return Value

in Macroable at line 39 static void mixin(object $mixin)

Parameters

Return Value

Exceptions

in Macroable at line 58 static bool hasMacro(string $name)

Parameters

Return Value

in Macroable at line 72 static mixed __callStatic(string $method, array $parameters)

Parameters

Return Value

Exceptions

in Macroable at line 96 mixed __call(string $method, array $parameters)

Parameters

Return Value

Exceptions

in RouteDependencyResolverTrait at line 20 protected array resolveClassMethodDependencies(array $parameters, object $instance, string $method)

Parameters

Return Value

in RouteDependencyResolverTrait at line 38 array resolveMethodDependencies(array $parameters, ReflectionFunctionAbstract $reflector)

Parameters

Return Value

in RouteDependencyResolverTrait at line 69 protected mixed transformDependency(ReflectionParameter $parameter, array $parameters)

Parameters

Return Value

in RouteDependencyResolverTrait at line 90 protected bool alreadyInParameters(string $class, array $parameters)

Parameters

Return Value

in RouteDependencyResolverTrait at line 105 protected void spliceIntoParameters(array $parameters, string $offset, mixed $value)

Parameters

Return Value

at line 130 void __construct(array|string $methods, string $uri, Closure|array $action)

Parameters

Return Value

at line 153 protected array parseAction(callable|array|null $action)

Parameters

Return Value

Exceptions

at line 163 mixed run()

Return Value

at line 183 protected bool isControllerAction()

Return Value

at line 193 protected mixed runCallable()

Return Value

at line 209 protected mixed runController()

Return Value

Exceptions

at line 221 mixed getController()

Return Value

at line 237 protected string getControllerMethod()

Return Value

at line 247 protected array parseControllerCallback()

Return Value

at line 259 bool matches(Request $request, bool $includingMethod = true)

Parameters

Return Value

at line 281 protected CompiledRoute compileRoute()

Return Value

at line 296 $this bind(Request $request)

Parameters

Return Value

at line 311 bool hasParameters()

Return Value

at line 322 bool hasParameter(string $name)

Parameters

Return Value

at line 338 string|object parameter(string $name, mixed $default = null)

Parameters

Return Value

at line 350 void setParameter(string $name, mixed $value)

Parameters

Return Value

at line 363 void forgetParameter(string $name)

in Macroable at line 27
`static void macro(string $name, object|callable $macro)`

in Macroable at line 39
`static void mixin(object $mixin)`

in Macroable at line 58
`static bool hasMacro(string $name)`

in Macroable at line 72
`static mixed __callStatic(string $method, array $parameters)`

in Macroable at line 96
`mixed __call(string $method, array $parameters)`

in RouteDependencyResolverTrait at line 20
`protected array resolveClassMethodDependencies(array $parameters, object $instance, string $method)`

in RouteDependencyResolverTrait at line 38
`array resolveMethodDependencies(array $parameters, ReflectionFunctionAbstract $reflector)`

in RouteDependencyResolverTrait at line 69
`protected mixed transformDependency(ReflectionParameter $parameter, array $parameters)`

in RouteDependencyResolverTrait at line 90
`protected bool alreadyInParameters(string $class, array $parameters)`

in RouteDependencyResolverTrait at line 105
`protected void spliceIntoParameters(array $parameters, string $offset, mixed $value)`

at line 130
`void __construct(array|string $methods, string $uri, Closure|array $action)`

at line 153
`protected array parseAction(callable|array|null $action)`

at line 163
`mixed run()`

at line 183
`protected bool isControllerAction()`

at line 193
`protected mixed runCallable()`

at line 209
`protected mixed runController()`

at line 221
`mixed getController()`

at line 237
`protected string getControllerMethod()`

at line 247
`protected array parseControllerCallback()`

at line 259
`bool matches(Request $request, bool $includingMethod = true)`

at line 281
`protected CompiledRoute compileRoute()`

at line 296
`$this bind(Request $request)`

at line 311
`bool hasParameters()`

at line 322
`bool hasParameter(string $name)`

at line 338
`string|object parameter(string $name, mixed $default = null)`

at line 350
`void setParameter(string $name, mixed $value)`

at line 363
`void forgetParameter(string $name)`

at line 377
`array parameters()`

at line 391
`array parametersWithoutNulls()`

at line 403
`array parameterNames()`

at line 417
`protected array compileParameterNames()`

at line 432
`array signatureParameters(string|null $subClass = null)`

at line 444
`$this defaults(string $key, mixed $value)`

at line 458
`$this where(array|string $name, string $expression = null)`

at line 474
`protected array parseWhere(array|string $name, string $expression)`

at line 485
`protected $this whereArray(array $wheres)`

at line 499
`$this fallback()`

at line 511
`array methods()`

at line 521
`bool httpOnly()`

at line 531
`bool httpsOnly()`

at line 541
`bool secure()`

at line 552
`$this|string|null domain(string|null $domain = null)`

at line 568
`string|null getDomain()`

at line 579
`string getPrefix()`

at line 590
`$this prefix(string $prefix)`

at line 604
`string uri()`

at line 615
`$this setUri(string $uri)`

at line 627
`string getName()`

at line 638
`$this name(string $name)`

at line 651
`bool named(dynamic ...$patterns)`

at line 672
`$this uses(Closure|string $action)`

at line 688
`protected string addGroupNamespaceToStringUses(string $action)`

at line 704
`string getActionName()`

at line 714
`string getActionMethod()`

at line 725
`mixed getAction(string|null $key = null)`