Route (Routing)
Route
class Route (View source)
Traits
RouteDependencyResolverTrait |
Properties
string | $uri | The URI pattern the route responds to. | |
array | $methods | The HTTP methods the route responds to. | |
array | $action | The route action array. | |
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. | |
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() Run the route action and return the response. | |
mixed | getController() Get the controller instance for the route. | |
bool | matches(Request $request, bool $includingMethod = true) Determine if the route matches given request. | |
$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 | 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 | 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 | 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(string $name) Determine whether the route's name matches the given name. | |
$this | uses(Closure|string $action) Set the handler for the route. | |
string | getActionName() Get the action name for the route. | |
string | getActionMethod() Get the method name of the route action. | |
array | getAction() Get the action array 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. | |
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
array resolveMethodDependencies(array $parameters, ReflectionFunctionAbstract $reflector)
Resolve the given method's type-hinted dependencies.
void __construct(array|string $methods, string $uri, Closure|array $action)
Create a new Route instance.
mixed run()
Run the route action and return the response.
mixed getController()
Get the controller instance for the route.
bool matches(Request $request, bool $includingMethod = true)
Determine if the route matches given request.
$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 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 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 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(string $name)
Determine whether the route's name matches the given name.
$this uses(Closure|string $action)
Set the handler for the route.
string getActionName()
Get the action name for the route.
string getActionMethod()
Get the method name of the route action.
array getAction()
Get the action array 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.
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.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.4/Illuminate/Routing/Route.html