W3cubDocs

/Laravel 5.1

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 $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 beforeFilters()

Get the "before" filters for the route.
array afterFilters()

Get the "after" filters for the route.
static array parseFilters( string $filters)

Parse the given filter string.
static array parseFilter( string $filter)

Parse the given filter into name and 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 before( string $filters)

Add before filters to the route.
$this after( string $filters)

Add after filters to the route.
$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.
Route 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.
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 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

array resolveMethodDependencies( array $parameters, ReflectionFunctionAbstract $reflector)

Resolve the given method's type-hinted dependencies.

Parameters

array $parameters
ReflectionFunctionAbstract $reflector

Return Value

array

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

Create a new Route instance.

Parameters

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

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

Determine if the route matches given request.

Parameters

Request $request
bool $includingMethod

Return Value

bool

$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 beforeFilters()

Get the "before" filters for the route.

Return Value

array

array afterFilters()

Get the "after" filters for the route.

Return Value

array

static array parseFilters( string $filters)

Parse the given filter string.

Parameters

string $filters

Return Value

array

static array parseFilter( string $filter)

Parse the given filter into name and parameters.

Parameters

string $filter

Return Value

array

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

$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

static array getValidators()

Get the route validators for the instance.

Return Value

array

$this before( string $filters)

Add before filters to the route.

Parameters

string $filters

Return Value

$this

$this after( string $filters)

Add after filters to the route.

Parameters

string $filters

Return Value

$this

$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

$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

Route setUri( string $uri)

Set the URI that the route responds to.

Parameters

string $uri

Return Value

Route

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

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 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.1/Illuminate/Routing/Route.html