1. class
  2. Illuminate
  3. Routing
  4. Route

Route

class Route (View source)

Traits

RouteDependencyResolverTrait

Properties

static array $validators The validators used by the routes.

Methods

array
resolveMethodDependencies( array $parameters, ReflectionFunctionAbstract $reflector)

Resolve the given method's type-hinted dependencies.

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

Determine if the route matches given request.

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

Get or set the middlewares attached to the route.

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.

$this
bind( Request $request)

Bind the route to a given request for execution.

array
bindParameters( Request $request)

Extract the parameter list from the request.

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.

$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
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

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

Resolve the given method's type-hinted dependencies.

Parameters

array $parameters
ReflectionFunctionAbstract $reflector

Return Value

array

at line line 110
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 line 131
mixed run( Request $request)

Run the route action and return the response.

Parameters

Request $request

Return Value

mixed

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

Determine if the route matches given request.

Parameters

Request $request
bool $includingMethod

Return Value

bool

at line line 235
$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 line 273
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 line 295
bool hasParameters()

Determine if the route has parameters.

Return Value

bool

at line line 306
bool hasParameter( string $name)

Determine a given parameter exists from the route.

Parameters

string $name

Return Value

bool

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

Get a given parameter from the route.

Parameters

string $name
mixed $default

Return Value

string|object

at line line 334
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 line 346
void setParameter( string $name, mixed $value)

Set a parameter to the given value.

Parameters

string $name
mixed $value

Return Value

void

at line line 359
void forgetParameter( string $name)

Unset a parameter on the route if it is set.

Parameters

string $name

Return Value

void

at line line 373
array parameters()

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

Return Value

array

Exceptions

LogicException

at line line 390
array parametersWithoutNulls()

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

Return Value

array

at line line 402
array parameterNames()

Get all of the parameter names for the route.

Return Value

array

at line line 431
$this bind( Request $request)

Bind the route to a given request for execution.

Parameters

Request $request

Return Value

$this

at line line 446
array bindParameters( Request $request)

Extract the parameter list from the request.

Parameters

Request $request

Return Value

array

at line line 594
static array getValidators()

Get the route validators for the instance.

Return Value

array

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

Set a default value for the route.

Parameters

string $key
mixed $value

Return Value

$this

at line line 630
$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 line 672
$this prefix( string $prefix)

Add a prefix to the route URI.

Parameters

string $prefix

Return Value

$this

at line line 686
string getPath()

Get the URI associated with the route.

Return Value

string

at line line 696
string uri()

Get the URI associated with the route.

Return Value

string

at line line 706
array getMethods()

Get the HTTP verbs the route responds to.

Return Value

array

at line line 716
array methods()

Get the HTTP verbs the route responds to.

Return Value

array

at line line 726
bool httpOnly()

Determine if the route only responds to HTTP requests.

Return Value

bool

at line line 736
bool httpsOnly()

Determine if the route only responds to HTTPS requests.

Return Value

bool

at line line 746
bool secure()

Determine if the route only responds to HTTPS requests.

Return Value

bool

at line line 756
string|null domain()

Get the domain defined for the route.

Return Value

string|null

at line line 766
string getUri()

Get the URI that the route responds to.

Return Value

string

at line line 777
$this setUri( string $uri)

Set the URI that the route responds to.

Parameters

string $uri

Return Value

$this

at line line 789
string getPrefix()

Get the prefix of the route instance.

Return Value

string

at line line 799
string getName()

Get the name of the route instance.

Return Value

string

at line line 810
$this name( string $name)

Add or change the route name.

Parameters

string $name

Return Value

$this

at line line 823
$this uses( Closure|string $action)

Set the handler for the route.

Parameters

Closure|string $action

Return Value

$this

at line line 855
string getActionName()

Get the action name for the route.

Return Value

string

at line line 865
array getAction()

Get the action array for the route.

Return Value

array

at line line 876
$this setAction( array $action)

Set the action array for the route.

Parameters

array $action

Return Value

$this

at line line 888
CompiledRoute getCompiled()

Get the compiled version of the route.

Return Value

CompiledRoute

at line line 899
$this setRouter( Router $router)

Set the router instance on the route.

Parameters

Router $router

Return Value

$this

at line line 912
$this setContainer( Container $container)

Set the container instance on the route.

Parameters

Container $container

Return Value

$this

at line line 926
void prepareForSerialization()

Prepare the route instance for serialization.

Return Value

void

Exceptions

LogicException

at line line 941
mixed __get( string $key)

Dynamically access route parameters.

Parameters

string $key

Return Value

mixed