Router
用于创建和解析路由的类
| 自 |
1.5 |
|---|---|
| 包 |
Joomla CMS |
方法
attachBuildRule
附加构建规则
attachBuildRule( Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768 |Array callback, stage = self::PROCESS_DURING) :
| 自 |
1.5 |
|---|
参数
- 回调
callable要调用的函数- 阶段
string应添加此规则的构建过程阶段。可能的值：'preprocess'，'' 表示主构建过程，'postprocess'
响应
void
attachParseRule
附加解析规则
attachParseRule( Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768 |Array callback, stage = self::PROCESS_DURING) :
| 自 |
1.5 |
|---|
参数
- 回调
callable要调用的函数。- 阶段
string应添加此规则的解析过程阶段。可能的值：'preprocess'，'' 表示主解析过程，'postprocess'
响应
void
build
将内部 URI 转换为路由的函数
build(string|array|\Joomla\CMS\Uri\Uri url) : \Joomla\CMS\Uri\Uri
createUri
根据完整或部分 URL 字符串创建 URI
createUri( url) : \Joomla\CMS\Uri\Uri
detachRule
删除规则
detachRule( type, Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768 |Array rule, stage = self::PROCESS_DURING) :
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- 类型
string要删除的规则类型（解析或构建）- 规则
callable要删除的规则。- 阶段
string应添加此规则的解析过程阶段。可能的值：'preprocess'，'' 表示主解析过程，'postprocess'
响应
bool是否删除了规则？
getInstance
返回全局 Router 对象，仅在它不存在时才创建它。
getInstance( client, mixed||string|int options = []) : \Joomla\CMS\Router\Router
| 自 |
1.5 |
|---|---|
| 抛出 |
|
| 已弃用 |
4.0 将在 6.0 中删除。注入路由器或从依赖项注入容器中加载它。示例：Factory::getContainer()->get(SiteRouter::class); |
参数
- 客户端
string客户端的名称- 选项
array<string|int, mixed>选项的关联数组
响应
RouterRouter 对象。
getRules
获取所有当前附加的规则
getRules() : mixed||string|int
| 自 |
4.0.0 |
|---|
响应
array<string|int, mixed>当前所有附加的规则，存储在数组中
getVar
获取路由器变量
getVar( key) :
| 自 |
1.5 |
|---|
参数
- 键
string变量的名称
响应
mixed变量的值
getVars
获取路由器变量数组
getVars() : mixed||string|int
| 自 |
1.5 |
|---|
响应
array<string|int, mixed>路由器变量的关联数组
parse
将路由转换为内部 URI 的函数
parse(\Joomla\CMS\Uri\Uri &uri, setVars = false) : mixed||string|int
processBuildRules
根据自定义定义的规则处理构建的 URI 查询数据
processBuildRules(\Joomla\CMS\Uri\Uri &uri, stage = self::PROCESS_DURING) :
processParseRules
根据自定义定义的规则处理解析后的路由器变量
processParseRules(\Joomla\CMS\Uri\Uri &uri, stage = self::PROCESS_DURING) :
setVar
设置路由器变量，如果变量不存在则创建它
setVar( key, value, create = true) :
| 自 |
1.5 |
|---|
参数
- 键
string变量的名称- 值
mixed变量的值- 创建
bool如果为 True，则在变量不存在时会创建它
响应
void
setVars
设置路由器变量数组
setVars(mixed||string|int vars = [], merge = true) :
| 自 |
1.5 |
|---|
参数
- 变量
array<string|int, mixed>包含变量的关联数组- 合并
bool如果为 True，则数组将合并而不是覆盖
响应
void
常量
PROCESS_BEFORE
进程前阶段的掩码
| 值 | 'preprocess' |
|---|---|
| 自 |
3.4 |
类型
string
PROCESS_DURING
进程中阶段的掩码
| 值 | '' |
|---|---|
| 自 |
3.4 |
类型
string
PROCESS_AFTER
进程后阶段的掩码
| 值 | 'postprocess' |
|---|---|
| 自 |
3.4 |
类型
string
属性
变量
变量数组
| 自 |
1.5 |
|---|
类型
array<string|int, mixed>
规则
规则数组
| 自 |
1.5 |
|---|
类型
array<string|int, mixed>
缓存
已处理 URI 的缓存
| 自 |
3.3 |
|---|
类型
array<string|int, mixed>