Route

class Route (View source)

Traits

RouteDependencyResolverTrait

Properties

protected string $uri The URI pattern the route responds to.
protected array $methods The HTTP methods the route responds to.
protected array $action The route action array.
protected mixed $controller The controller instance.
protected array $defaults The default values for the route.
protected array $wheres The regular expression requirements.
protected array $parameters The array of matched parameters.
protected array|null $parameterNames The parameter names for the route.
protected 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

mixed callWithDependencies(object $instance, string $method)

Call a class method with the resolved dependencies.

 from RouteDependencyResolverTrait
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, array $originalParameters)

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 $key, mixed $instance)

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.
mixed run(Request $request)

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.
bool matches(Request $request, bool $includingMethod = true)

Determine if the route matches given request.
void compileRoute()

Compile the route into a Symfony CompiledRoute instance.
array extractOptionalParameters()

Get the optional parameters 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.
array signatureParameters(string|null $subClass = null)

Get the parameters that are listed in the route / controller signature.
bool hasParameters()

Determine if the route has parameters.
bool hasParameter(string $name)

Determine a given parameter exists from the route.
string|object getParameter(string $name, mixed $default = null)

Get a given parameter 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.
$this bind(Request $request)

Bind the route to a given request for execution.
array bindParameters(Request $request)

Extract the parameter list from the request.
array bindPathParameters(Request $request)

Get the parameter matches for the path portion of the URI.
array bindHostParameters(Request $request, array $parameters)

Extract the parameter list from the host part of the request.
array matchToKeys(array $matches)

Combine a set of parameter matches with the route's keys.
array replaceDefaults(array $parameters)

Replace null parameters with their defaults.
array parseAction(callable|array|null $action)

Parse the route action into a standard array.
callable findCallable(array $action)

Find the callable in an action array.
string makeInvokableAction(string $action)

Make an action for an invokable controller.
static array getValidators()

Get the route validators for the instance.
$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 prefix(string $prefix)

Add a prefix to the route URI.
string getPath()

Get the URI associated with the route.
string uri()

Get the URI associated with the route.
array getMethods()

Get the HTTP verbs the route responds to.
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.
string|null domain()

Get the domain defined for the route.
string getUri()

Get the URI that the route responds to.
$this setUri(string $uri)

Set the URI that the route responds to.
string getPrefix()

Get the prefix of the route instance.
string getName()

Get the name of the route instance.
$this name(string $name)

Add or change the route name.
$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.
array getAction()

Get the action array for the route.
$this setAction(array $action)

Set the action array for the route.
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

protected mixed callWithDependencies(object $instance, string $method)

Call a class method with the resolved dependencies.

Parameters

object $instance
string $method

Return Value

mixed

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

array resolveMethodDependencies(array $parameters, ReflectionFunctionAbstract $reflector)

Resolve the given method's type-hinted dependencies.

Parameters

array $parameters
ReflectionFunctionAbstract $reflector

Return Value

array

protected mixed transformDependency(ReflectionParameter $parameter, array $parameters, array $originalParameters)

Attempt to transform the given parameter into a class instance.

Parameters

ReflectionParameter $parameter
array $parameters
array $originalParameters

Return Value

mixed

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

protected void spliceIntoParameters(array $parameters, string $key, mixed $instance)

Splice the given value into the parameter list.

Parameters

array $parameters
string $key
mixed $instance

Return Value

void

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

mixed run(Request $request)

Run the route action and return the response.

Parameters

Request $request

Return Value

mixed

protected bool isControllerAction()

Checks whether the route's action is a controller.

Return Value

bool

protected mixed runCallable()

Run the route action and return the response.

Return Value

mixed

protected mixed runController()

Run the route action and return the response.

Return Value

mixed

Exceptions

NotFoundHttpException

mixed getController()

Get the controller instance for the route.

Return Value

mixed

protected string getControllerMethod()

Get the controller method used for the route.

Return Value

string

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

Determine if the route matches given request.

Parameters

Request $request
bool $includingMethod

Return Value

bool

protected void compileRoute()

Compile the route into a Symfony CompiledRoute instance.

Return Value

void

protected array extractOptionalParameters()

Get the optional parameters for the route.

Return Value

array

array gatherMiddleware()

Get all middleware, including the ones from the controller.

Return Value

array

$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

array controllerMiddleware()

Get the middleware for the route's controller.

Return Value

array

array signatureParameters(string|null $subClass = null)

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

Parameters

string|null $subClass

Return Value

array

bool hasParameters()

Determine if the route has parameters.

Return Value

bool

bool hasParameter(string $name)

Determine a given parameter exists from the route.

Parameters

string $name

Return Value

bool

string|object getParameter(string $name, mixed $default = null)

Get a given parameter from the route.

Parameters

string $name
mixed $default

Return Value

string|object

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

Get a given parameter from the route.

Parameters

string $name
mixed $default

Return Value

string|object

void setParameter(string $name, mixed $value)

Set a parameter to the given value.

Parameters

string $name
mixed $value

Return Value

void

void forgetParameter(string $name)

Unset a parameter on the route if it is set.

Parameters

string $name

Return Value

void

array parameters()

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

Return Value

array

Exceptions

LogicException

array parametersWithoutNulls()

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

Return Value

array

array parameterNames()

Get all of the parameter names for the route.

Return Value

array

protected array compileParameterNames()

Get the parameter names for the route.

Return Value

array

$this bind(Request $request)

Bind the route to a given request for execution.

Parameters

Request $request

Return Value

$this

array bindParameters(Request $request)

Extract the parameter list from the request.

Parameters

Request $request

Return Value

array

protected array bindPathParameters(Request $request)

Get the parameter matches for the path portion of the URI.

Parameters

Request $request

Return Value

array

protected array bindHostParameters(Request $request, array $parameters)

Extract the parameter list from the host part of the request.

Parameters

Request $request
array $parameters

Return Value

array

protected array matchToKeys(array $matches)

Combine a set of parameter matches with the route's keys.

Parameters

array $matches

Return Value

array

protected array replaceDefaults(array $parameters)

Replace null parameters with their defaults.

Parameters

array $parameters

Return Value

array

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

protected callable findCallable(array $action)

Find the callable in an action array.

Parameters

array $action

Return Value

callable

protected string makeInvokableAction(string $action)

Make an action for an invokable controller.

Parameters

string $action

Return Value

string

static array getValidators()

Get the route validators for the instance.

Return Value

array

$this defaults(string $key, mixed $value)

Set a default value for the route.

Parameters

string $key
mixed $value

Return Value

$this

$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

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

protected $this whereArray(array $wheres)

Set a list of regular expression requirements on the route.

Parameters

array $wheres

Return Value

$this

$this prefix(string $prefix)

Add a prefix to the route URI.

Parameters

string $prefix

Return Value

$this

string getPath()

Get the URI associated with the route.

Return Value

string

string uri()

Get the URI associated with the route.

Return Value

string

array getMethods()

Get the HTTP verbs the route responds to.

Return Value

array

array methods()

Get the HTTP verbs the route responds to.

Return Value

array

bool httpOnly()

Determine if the route only responds to HTTP requests.

Return Value

bool

bool httpsOnly()

Determine if the route only responds to HTTPS requests.

Return Value

bool

bool secure()

Determine if the route only responds to HTTPS requests.

Return Value

bool

string|null domain()

Get the domain defined for the route.

Return Value

string|null

string getUri()

Get the URI that the route responds to.

Return Value

string

$this setUri(string $uri)

Set the URI that the route responds to.

Parameters

string $uri

Return Value

$this

string getPrefix()

Get the prefix of the route instance.

Return Value

string

string getName()

Get the name of the route instance.

Return Value

string

$this name(string $name)

Add or change the route name.

Parameters

string $name

Return Value

$this

$this uses(Closure|string $action)

Set the handler for the route.

Parameters

Closure|string $action

Return Value

$this

protected string addGroupNamespaceToStringUses(string $action)

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

Parameters

string $action

Return Value

string

string getActionName()

Get the action name for the route.

Return Value

string

array getAction()

Get the action array for the route.

Return Value

array

$this setAction(array $action)

Set the action array for the route.

Parameters

array $action

Return Value

$this

CompiledRoute getCompiled()

Get the compiled version of the route.

Return Value

CompiledRoute

$this setRouter(Router $router)

Set the router instance on the route.

Parameters

Router $router

Return Value

$this

$this setContainer(Container $container)

Set the container instance on the route.

Parameters

Container $container

Return Value

$this

void prepareForSerialization()

Prepare the route instance for serialization.

Return Value

void

Exceptions

LogicException

mixed __get(string $key)

Dynamically access route parameters.

Parameters

string $key

Return Value

mixed

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.3/Illuminate/Routing/Route.html