Joomla! API

下载
启动

AdministratorRouter

继承自 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

参数

callback

callable要调用的函数

stage

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

参数

callback

callable要调用的函数。

stage

string应将此规则添加到解析过程的哪个阶段。可能的值：'preprocess'，'' 表示主解析过程，'postprocess'

返回值

void

build

将内部 URI 转换为路由的函数

build( url) : \Joomla\CMS\Uri\Uri
自版本

1.5

参数

url

string内部 URL

返回值

Uri绝对的搜索引擎友好 URL

createUri

基于完整或部分 URL 字符串创建 URI

createUri( url) : \Joomla\CMS\Uri\Uri
继承
自版本

3.2

参数

url

stringURI 或关联数组

返回值

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
抛出

InvalidArgumentException

参数

类型

string要移除的规则类型（解析或构建）

rule

callable要移除的规则。

stage

string应将此规则添加到解析过程的哪个阶段。可能的值：'preprocess'，'' 表示主解析过程，'postprocess'

返回值

bool是否已移除规则？

getInstance

返回全局 Router 对象，仅当它不存在时才创建它。

getInstance( client, mixed||string|int options = []) : \Joomla\CMS\Router\Router
继承 静态 已弃用
自版本

1.5
抛出

RuntimeException
已弃用

4.0 将在 6.0 中移除 注入路由器或从依赖注入容器加载它 示例：Factory::getContainer()->get(SiteRouter::class);

参数

client

string客户端名称

options

array<string|int, mixed>选项的关联数组

返回值

RouterRouter 对象。

getRules

获取所有当前附加的规则

getRules() : mixed||string|int
继承
自版本

4.0.0

返回值

array<string|int, mixed>所有当前附加的规则，存储在数组中

getVar

获取路由器变量

getVar( key) :
继承
自版本

1.5

参数

key

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
自版本

1.5

参数

uri

UriURI。

setVars

bool在当前请求 URL 的内部存储中设置解析的数据

返回值

array<string|int, mixed>

processBuildRules

根据自定义定义的规则处理构建的 uri 查询数据

processBuildRules(\Joomla\CMS\Uri\Uri &uri,  stage = self::PROCESS_DURING) :
继承
自版本

3.2

参数

uri

UriURI

stage

string应处理的阶段。可能的值：'preprocess'、'postprocess' 和 '' 表示主构建阶段

返回值

void

processParseRules

根据自定义定义的规则处理解析的路由器变量

processParseRules(\Joomla\CMS\Uri\Uri &uri,  stage = self::PROCESS_DURING) :
继承
自版本

3.2

参数

uri

Uri要解析的 URI

stage

string应处理的阶段。可能的值：'preprocess'、'postprocess' 和 '' 表示主解析阶段

返回值

void

setVar

设置路由器变量，如果它不存在则创建它

setVar( key,  value,  create = true) :
继承
自版本

1.5

参数

key

string变量名称

value

mixed变量的值

create

bool如果为 True，则如果变量尚不存在，则会创建它

返回值

void

setVars

设置路由器变量数组

setVars(mixed||string|int vars = [],  merge = true) :
继承
自版本

1.5

参数

vars

array<string|int, mixed>包含变量的关联数组

merge

bool如果为 True，则将合并数组而不是覆盖它

返回值

void

常量

PROCESS_BEFORE

之前处理阶段的掩码

继承
值 'preprocess'
自版本

3.4

类型

string

PROCESS_DURING

期间处理阶段的掩码

继承
值 ''
自版本

3.4

类型

string

PROCESS_AFTER

之后处理阶段的掩码

继承
值 'postprocess'
自版本

3.4

类型

string

属性

vars

变量数组

继承
自版本

1.5

类型

array<string|int, mixed>

rules

规则数组

继承
自版本

1.5

类型

array<string|int, mixed>

cache

已处理 URI 的缓存

继承
自版本

3.3

类型

array<string|int, mixed>

instances

路由器实例容器。

继承 静态
自版本

1.7

类型

array<string|int, Router>
  • \ Joomla
  • \ CMS
  • \ Router
  • \ AdministratorRouter