Route
class Route (View source)
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 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. |
|
| static protected array | $validators | The validators used by the routes. |
Methods
Run the route action and return the response.
Compile the route into a Symfony CompiledRoute instance.
Get the optional parameters for the route.
Get the "before" filters for the route.
Get the "after" filters for the route.
Parse the given filter string.
Turn the filters into an array if they aren't already.
Flatten out an array of filter declarations.
Parse the given filter into name and parameters.
Parse a filter with parameters.
Get a given parameter from the route.
Get a given parameter from the route.
Set a parameter to the given value.
Unset a parameter on the route if it is set.
Get the key / value list of parameters for the route.
Get the key / value list of parameters without null values.
Get all of the parameter names for the route.
Get the parameter names for the route.
Extract the parameter list from the host part of the request.
Combine a set of parameter matches with the route's keys.
Replace null parameters with their defaults.
Parse the route action into a standard array.
Find the Closure in an action array.
Get the route validators for the instance.
Add before filters to the route.
Add after filters to the route.
Add the given filters to the route by type.
Set a default value for the route.
Set a regular expression requirement on the route.
Parse arguments to the where method into an array.
Set a list of regular expression requirements on the route.
Add a prefix to the route URI.
Get the URI associated with the route.
Get the URI associated with the route.
Get the HTTP verbs the route responds to.
Get the HTTP verbs the route responds to.
Determine if the route only responds to HTTP requests.
Determine if the route only responds to HTTPS requests.
Determine if the route only responds to HTTPS requests.
Get the domain defined for the route.
Get the URI that the route responds to.
Get the prefix of the route instance.
Get the name of the route instance.
Get the action name for the route.
Get the action array for the route.
Set the action array for the route.
Get the compiled version of the route.
Details
void
__construct(array $methods, string $uri, Closure|array $action)
Create a new Route instance.
mixed
run()
Run the route action and return the response.
bool
matches(Request $request, bool $includingMethod = true)
Determine if the route matches given request.
protected void
compileRoute()
Compile the route into a Symfony CompiledRoute instance.
protected array
extractOptionalParameters()
Get the optional parameters for 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 protected array
explodeFilters(array|string $filters)
Turn the filters into an array if they aren't already.
static protected array
explodeArrayFilters(array $filters)
Flatten out an array of filter declarations.
static array
parseFilter(string $filter)
Parse the given filter into name and parameters.
static protected array
parseParameterFilter(string $filter)
Parse a filter with parameters.
string
getParameter(string $name, mixed $default = null)
Get a given parameter from the route.
string
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.
protected 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.
protected array
bindPathParameters(Request $request)
Get the parameter matches for the path portion of the URI.
protected array
bindHostParameters(Request $request, array $parameters)
Extract the parameter list from the host part of the request.
protected array
matchToKeys(array $matches)
Combine a set of parameter matches with the route's keys.
protected array
replaceDefaults(array $parameters)
Replace null parameters with their defaults.
protected array
parseAction(callable|array $action)
Parse the route action into a standard array.
protected Closure
findClosure(array $action)
Find the Closure in an action array.
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.
protected $this
addFilters(string $type, string $filters)
Add the given filters to the route by type.
$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.
protected array
parseWhere(array|string $name, string $expression)
Parse arguments to the where method into an array.
protected $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.
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.
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.