类路由

路由器用来连接请求和参数映射的单个路由。

通常不作为独立的创建。使用 Router::connect() 为你的应用程序创建路由。

命名空间： Cake\Routing\Route

常量

字符串

PLACEHOLDER_REGEX ¶
```
'#\\{([a-z][a-z0-9-_]*)\\}#i'
```
用于匹配路由模板中带括号的占位符的正则表达式。

list<string>

VALID_METHODS ¶

['GET', 'PUT', 'POST', 'PATCH', 'DELETE', 'OPTIONS', 'HEAD']

有效的 HTTP 方法。

属性摘要

$_compiledRoute protected

string|null

编译后的路由正则表达式
$_extensions protected

list<string>

与该路由连接的扩展列表。
$_greedy protected

bool

此路由是否为贪婪路由？贪婪路由在模板中有一个 /*
$_name protected

string|null

路由的名称。使用 Route::getName(); 获取。
$defaults public

array

路由的默认参数
$keys public

array

路由中命名段的数组。/{controller}/{action}/{id} 有 3 个关键元素
$middleware protected

array

应应用的中间件列表。
$options public

array<string, mixed>

路由的附加参数数组。
$template public

字符串

路由模板字符串。

方法摘要

__construct() public

路由的构造函数
__set_state() public static

Set state 魔术方法来支持 var_export
_matchMethod() protected

检查 URL 的 HTTP 方法是否匹配。
_parseArgs() protected

将传递的参数解析为传递参数列表。
_parseExtension() protected

如果 $url 包含注册的扩展，则从 $url 中删除扩展。如果没有找到注册的扩展，则不返回扩展，并返回未修改的 URL。
_persistParams() protected

将持久参数应用于 URL 数组。持久参数是在路由创建期间使用的特殊键，用于强制路由参数在 URL 数组中省略时保持持久性。
_writeRoute() protected

构建路由正则表达式。
_writeUrl() protected

将匹配的路由数组转换为 URL 字符串。
compile() public

编译路由的正则表达式。
compiled() public

检查路由是否已编译为正则表达式。
getExtensions() public

获取此路由支持的扩展。
getMiddleware() public

获取应应用于此路由的中间件名称。
getName() public

获取路由的标准化插件.控制器:操作名称。
hostMatches() public

检查主机是否与路由要求匹配
match() public

检查 URL 数组是否与该路由实例匹配。
normalizeAndValidateMethods() protected

将方法名称规范化为大写，并验证它们是否为有效的 HTTP 方法。
parse() public

检查给定的 URL 是否可以被此路由解析。
parseRequest() public

检查给定的 URL 是否可以被此路由解析。
setExtensions() public

设置此路由支持的扩展。
setHost() public

设置主机要求
setMethods() public

设置此路由接受的 HTTP 方法。
setMiddleware() public

设置应应用于此路由的中间件名称。
setPass() public

设置将转换为传递参数的参数名称
setPatterns() public

设置路由参数的正则表达式模式
setPersist() public

设置将自动持久化的参数名称
staticPath() public

获取此路由的静态路径部分。

方法详细说明

__construct() ¶ public

__construct(string $template, array $defaults = [], array<string, mixed> $options = [])

路由的构造函数

选项

_ext - 定义此路由使用的扩展。
_middleware - 定义此路由的中间件名称。
pass - 将列出的参数复制到 params['pass'] 中。
_method - 定义路由适用的 HTTP 方法。可以是字符串或有效 HTTP 方法名称数组。
_host - 如果要使此路由仅匹配特定主机名，请定义主机名模式。可以使用 .* 和创建通配符子域/主机，例如 *.example.com 匹配 example.com 上的所有子域。
'_port` - 如果要使此路由仅匹配特定端口号，请定义端口号。
'_urldecode' - 设置为 false 以在路由解析之前禁用 URL 解码。

参数

string $template: 带有参数占位符的模板字符串
array $defaults optional: 路由的默认值。
array<string, mixed> $options optional: 路由的附加选项数组

抛出

InvalidArgumentException
当 `$options['_method']` 不在 `VALID_METHODS` 列表中时。

__set_state() ¶ public static

__set_state(array<string, mixed> $fields): static

Set state 魔术方法来支持 var_export

此方法有助于想要实现路由缓存的应用程序。

参数

array<string, mixed> $fields: 对象属性的键值对

static

_matchMethod() ¶ protected

_matchMethod(array $url): bool

检查 URL 的 HTTP 方法是否匹配。

参数

array $url: 要生成的 URL 的数组。

bool

_parseArgs() ¶ protected

_parseArgs(string $args, array $context): list<string>

将传递的参数解析为传递参数列表。

如果给定的命名 $param 的 $val 匹配给定的 $rule（取决于 $context），则返回 true。当前实现的规则类型是控制器、操作和匹配，可以相互组合。

参数

string $args: 带有传递参数的字符串。例如：/1/foo
array $context: 当前路由上下文，应该包含控制器/操作键。

list<string>

_parseExtension() ¶ protected

_parseExtension(string $url): array

如果 $url 包含注册的扩展，则从 $url 中删除扩展。如果没有找到注册的扩展，则不返回扩展，并返回未修改的 URL。

参数

string $url: 要解析的 URL。

array

_persistParams() ¶ protected

_persistParams(array $url, array $params): array

将持久参数应用于 URL 数组。持久参数是在路由创建期间使用的特殊键，用于强制路由参数在 URL 数组中省略时保持持久性。

参数

array $url: 要应用持久参数的数组。
array $params: 要替换持久参数的持久值数组。

array

_writeRoute() ¶ protected

_writeRoute(): void

构建路由正则表达式。

使用模板、默认值和选项属性来编译一个正则表达式，该表达式可用于解析请求字符串。

void

_writeUrl() ¶ protected

_writeUrl(array $params, array $pass = [], array $query = []): string

将匹配的路由数组转换为 URL 字符串。

使用创建路由的模板组合字符串 URL。

参数

array $params: 要转换为字符串 URL 的参数
array $pass optional: 其他传递的参数
array $query optional: 参数数组

字符串

compile() ¶ public

compile(): string

编译路由的正则表达式。

修改 defaults 属性，以便设置所有必要的键并使用命名路由元素填充 $this->names。

字符串

compiled() ¶ public

compiled(): bool

检查路由是否已编译为正则表达式。

bool

getExtensions() ¶ public

getExtensions(): list<string>

获取此路由支持的扩展。

list<string>

getMiddleware() ¶ public

getMiddleware(): array

获取应应用于此路由的中间件名称。

array

getName() ¶ public

getName(): string

获取路由的标准化插件.控制器:操作名称。

字符串

hostMatches() ¶ public

hostMatches(string $host): bool

检查主机是否与路由要求匹配

参数

string $host: 请求的域名

bool

match() ¶ public

match(array $url, array $context = []): string|null

检查 URL 数组是否与该路由实例匹配。

如果 URL 与路由参数和设置匹配，则返回生成的字符串 URL。如果 URL 与路由参数不匹配，则返回 false。此方法处理反向路由或将 URL 数组转换为字符串 URL。

参数

array $url: 要检查匹配的参数数组。
array $context optional: 当前请求上下文的数组。包含当前域名、方案、端口、基本目录和其他 URL 参数等信息。

string|null

normalizeAndValidateMethods() ¶ protected

normalizeAndValidateMethods(list<string>|string $methods): list<string>|string

将方法名称规范化为大写，并验证它们是否为有效的 HTTP 方法。

参数

list<string>|string $methods: 方法。

list<string>|string

抛出

InvalidArgumentException
当方法不在 `VALID_METHODS` 列表中时。

parse() ¶ public

parse(string $url, string $method): array|null

检查给定的 URL 是否可以被此路由解析。

如果可以解析路由，则返回参数数组；如果不能解析，则返回 null。如果字符串 URL 与路由的正则表达式匹配，则会解析它们。

参数

string $url: 要尝试解析的 URL。
string $method: 正在解析的请求的 HTTP 方法。

array|null

抛出

Cake\Http\Exception\BadRequestException
当方法不是空字符串且不在 `VALID_METHODS` 列表中时。

parseRequest() ¶ public

parseRequest(Psr\Http\Message\ServerRequestInterface $request): array|null

检查给定的 URL 是否可以被此路由解析。

如果可以解析路由，则返回参数数组；如果不能解析，则返回 null。

参数

Psr\Http\Message\ServerRequestInterface $request: 要尝试解析的 URL。

array|null

setExtensions() ¶ public

setExtensions(list<string> $extensions): $this

设置此路由支持的扩展。

参数

list<string> $extensions: 要设置的扩展名。

$this

setHost() ¶ public

setHost(string $host): $this

设置主机要求

参数

string $host: 此路由绑定的域名

$this

setMethods() ¶ public

setMethods(list<string> $methods): $this

设置此路由接受的 HTTP 方法。

参数

list<string> $methods: 要接受的 HTTP 方法。

$this

抛出

InvalidArgumentException
当方法不在 `VALID_METHODS` 列表中时。

setMiddleware() ¶ public

setMiddleware(array $middleware): $this

设置应应用于此路由的中间件名称。

参数

array $middleware: 要应用于此路由的中介软件名称列表。在路由匹配之前不会检查中介软件名称。

$this

setPass() ¶ public

setPass(list<string> $names): $this

设置将转换为传递参数的参数名称

参数

list<string> $names: 要传递的参数的名称。

$this

setPatterns() ¶ public

setPatterns(array<string, string> $patterns): $this

设置路由参数的正则表达式模式

如果任何模式包含多字节值，则将启用 `multibytePattern` 模式。

参数

array<string, string> $patterns: 要应用于路由元素的模式

$this

setPersist() ¶ public

setPersist(array $names): $this

设置将自动持久化的参数名称

持久参数允许您定义在生成新 URL 时应自动包含哪些路由参数。您可以通过在 URL 中重新定义持久参数来覆盖它们，或者通过将持久参数设置为 false 来删除它们。

// remove a persistent 'date' parameter
Router::url(['date' => false', ...]);

参数

array $names: 要传递的参数的名称。

$this

staticPath() ¶ public

staticPath(): string

获取此路由的静态路径部分。

字符串

属性详情

`$_compiledRoute` ¶ protected

编译后的路由正则表达式

类型

string|null

`$_extensions` ¶ protected

与该路由连接的扩展列表。

类型

list<string>

`$_greedy` ¶ protected

此路由是否为贪婪路由？贪婪路由在模板中有一个 /*

类型

bool

`$_name` ¶ protected

路由的名称。使用 Route::getName(); 获取。

类型

string|null

`$defaults` ¶ public

路由的默认参数

类型

array

`$keys` ¶ public

路由中命名段的数组。/{controller}/{action}/{id} 有 3 个关键元素

类型

array

`$middleware` ¶ protected

应应用的中间件列表。

类型

array

`$options` ¶ public

路由的附加参数数组。

类型

array<string, mixed>

`$template` ¶ public

路由模板字符串。

类型

字符串

命名空间

类路由

常量

属性摘要

方法摘要

__construct() public

__set_state() public static

_matchMethod() protected

_parseArgs() protected

_parseExtension() protected

_persistParams() protected

_writeRoute() protected

_writeUrl() protected

compile() public

compiled() public

getExtensions() public

getMiddleware() public

getName() public

hostMatches() public

match() public

normalizeAndValidateMethods() protected

parse() public

parseRequest() public

setExtensions() public

setHost() public

setMethods() public

setMiddleware() public

setPass() public

setPatterns() public

setPersist() public

staticPath() public

方法详细说明

__construct() ¶ public

选项

参数

抛出

__set_state() ¶ public static

参数

返回

_matchMethod() ¶ protected

参数

返回

_parseArgs() ¶ protected

参数

返回

_parseExtension() ¶ protected

参数

返回

_persistParams() ¶ protected

参数

返回

_writeRoute() ¶ protected

返回

_writeUrl() ¶ protected

参数

返回

compile() ¶ public

返回

compiled() ¶ public

返回

getExtensions() ¶ public

返回

getMiddleware() ¶ public

返回

getName() ¶ public

返回

hostMatches() ¶ public

参数

返回

match() ¶ public

参数

返回

normalizeAndValidateMethods() ¶ protected

参数

返回

抛出

parse() ¶ public

参数

返回

抛出

`$_compiledRoute` ¶ protected

`$_extensions` ¶ protected

`$_greedy` ¶ protected

`$_name` ¶ protected

`$defaults` ¶ public

`$keys` ¶ public

`$middleware` ¶ protected

`$options` ¶ public

`$template` ¶ public