A single Route used by the Router to connect requests to parameter maps.
Not normally created as a standalone. Use Router::connect() to create Routes for your application.
string '#\\{([a-z][a-z0-9-_]*)\\}#i' Regex for matching braced placholders in route template.
array<string> ['GET', 'PUT', 'POST', 'PATCH', 'DELETE', 'OPTIONS', 'HEAD']
Valid HTTP methods.
string|nullThe compiled route regular expression
array<string>List of connected extensions for this route.
boolIs this route a greedy route? Greedy routes have a /* in their template
string|nullThe name for a route. Fetch with Route::getName();
boolTrack whether brace keys {var} were used.
arrayDefault parameters for a Route
arrayAn array of named segments in a Route. /{controller}/{action}/{id} has 3 key elements
arrayList of middleware that should be applied.
arrayAn array of additional parameters for the Route.
stringThe routes template string.
Constructor for a Route
Set state magic method to support var_export
Check whether the URL's HTTP method matches.
Parse passed parameters into a list of passed args.
Removes the extension from $url if it contains a registered extension. If no registered extension is found, no extension is returned and the URL is returned unmodified.
Apply persistent parameters to a URL array. Persistent parameters are a special key used during route creation to force route parameters to persist when omitted from a URL array.
Builds a route regular expression.
Converts a matching route array into a URL string.
Compiles the route's regular expression.
Check if a Route has been compiled into a regular expression.
Get the supported extensions for this route.
Get the names of the middleware that should be applied to this route.
Get the standardized plugin.controller:action name for a route.
Check to see if the host matches the route requirements
Check if a URL array matches this route instance.
Normalize method names to upper case and validate that they are valid HTTP methods.
Checks to see if the given URL can be parsed by this route.
Checks to see if the given URL can be parsed by this route.
Set the supported extensions for this route.
Set host requirement
Set the accepted HTTP methods for this route.
Set the names of the middleware that should be applied to this route.
Set the names of parameters that will be converted into passed parameters
Set regexp patterns for routing parameters
Set the names of parameters that will persisted automatically
Get the static path portion for this route.
__construct(string $template, array $defaults = [], array<string, mixed> $options = [])
Constructor for a Route
_ext - Defines the extensions used for this route._middleware - Define the middleware names for this route.pass - Copies the listed parameters into params['pass']._method - Defines the HTTP method(s) the route applies to. It can be a string or array of valid HTTP method name._host - Define the host name pattern if you want this route to only match specific host names. You can use .* and to create wildcard subdomains/hosts e.g. *.example.com matches all subdomains on example.com.false to disable URL decoding before route parsing.string $template Template string with parameter placeholders
array $defaults optional Defaults for the route.
array<string, mixed> $options optional Array of additional options for the Route
InvalidArgumentException__set_state(array<string, mixed> $fields): static
Set state magic method to support var_export
This method helps for applications that want to implement router caching.
array<string, mixed> $fields Key/Value of object attributes
static_matchMethod(array $url): bool
Check whether the URL's HTTP method matches.
array $url The array for the URL being generated.
bool_parseArgs(string $args, array $context): array<string>
Parse passed parameters into a list of passed args.
Return true if a given named $param's $val matches a given $rule depending on $context. Currently implemented rule types are controller, action and match that can be combined with each other.
string $args A string with the passed params. eg. /1/foo
array $context The current route context, which should contain controller/action keys.
array<string>_parseExtension(string $url): array
Removes the extension from $url if it contains a registered extension. If no registered extension is found, no extension is returned and the URL is returned unmodified.
string $url The url to parse.
array_persistParams(array $url, array $params): array
Apply persistent parameters to a URL array. Persistent parameters are a special key used during route creation to force route parameters to persist when omitted from a URL array.
array $url The array to apply persistent parameters to.
array $params An array of persistent values to replace persistent ones.
array_writeRoute(): void
Builds a route regular expression.
Uses the template, defaults and options properties to compile a regular expression that can be used to parse request strings.
void_writeUrl(array $params, array $pass = [], array $query = []): string
Converts a matching route array into a URL string.
Composes the string URL using the template used to create the route.
array $params The params to convert to a string url
array $pass optional The additional passed arguments
array $query optional An array of parameters
stringcompile(): string
Compiles the route's regular expression.
Modifies defaults property so all necessary keys are set and populates $this->names with the named routing elements.
stringcompiled(): bool
Check if a Route has been compiled into a regular expression.
boolgetExtensions(): array<string>
Get the supported extensions for this route.
array<string>getMiddleware(): array
Get the names of the middleware that should be applied to this route.
arraygetName(): string
Get the standardized plugin.controller:action name for a route.
stringhostMatches(string $host): bool
Check to see if the host matches the route requirements
string $host The request's host name
boolmatch(array $url, array $context = []): string|null
Check if a URL array matches this route instance.
If the URL matches the route parameters and settings, then return a generated string URL. If the URL doesn't match the route parameters, false will be returned. This method handles the reverse routing or conversion of URL arrays into string URLs.
array $url An array of parameters to check matching with.
array $context optional An array of the current request context. Contains information such as the current host, scheme, port, base directory and other url params.
string|nullnormalizeAndValidateMethods(array<string>|string $methods): array<string>|string
Normalize method names to upper case and validate that they are valid HTTP methods.
array<string>|string $methods Methods.
array<string>|stringInvalidArgumentExceptionparse(string $url, string $method): array|null
Checks to see if the given URL can be parsed by this route.
If the route can be parsed an array of parameters will be returned; if not null will be returned. String URLs are parsed if they match a routes regular expression.
string $url The URL to attempt to parse.
string $method The HTTP method of the request being parsed.
array|nullCake\Http\Exception\BadRequestExceptionparseRequest(Psr\Http\Message\ServerRequestInterface $request): array|null
Checks to see if the given URL can be parsed by this route.
If the route can be parsed an array of parameters will be returned; if not null will be returned.
Psr\Http\Message\ServerRequestInterface $request The URL to attempt to parse.
array|nullsetExtensions(array<string> $extensions): $this
Set the supported extensions for this route.
array<string> $extensions The extensions to set.
$thissetHost(string $host): $this
Set host requirement
string $host The host name this route is bound to
$thissetMethods(array<string> $methods): $this
Set the accepted HTTP methods for this route.
array<string> $methods The HTTP methods to accept.
$thisInvalidArgumentExceptionsetMiddleware(array $middleware): $this
Set the names of the middleware that should be applied to this route.
array $middleware The list of middleware names to apply to this route. Middleware names will not be checked until the route is matched.
$thissetPass(array<string> $names): $this
Set the names of parameters that will be converted into passed parameters
array<string> $names The names of the parameters that should be passed.
$thissetPatterns(array<string> $patterns): $this
Set regexp patterns for routing parameters
If any of your patterns contain multibyte values, the multibytePattern mode will be enabled.
array<string> $patterns The patterns to apply to routing elements
$thissetPersist(array $names): $this
Set the names of parameters that will persisted automatically
Persistent parameters allow you to define which route parameters should be automatically included when generating new URLs. You can override persistent parameters by redefining them in a URL or remove them by setting the persistent parameter to false.
// remove a persistent 'date' parameter Router::url(['date' => false', ...]);
array $names The names of the parameters that should be passed.
$thisstaticPath(): string
Get the static path portion for this route.
stringThe compiled route regular expression
string|nullList of connected extensions for this route.
array<string>Is this route a greedy route? Greedy routes have a /* in their template
boolThe name for a route. Fetch with Route::getName();
string|nullTrack whether brace keys {var} were used.
boolDefault parameters for a Route
arrayAn array of named segments in a Route. /{controller}/{action}/{id} has 3 key elements
arrayList of middleware that should be applied.
arrayAn array of additional parameters for the Route.
arrayThe routes template string.
string
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.4/class-Cake.Routing.Route.Route.html