Joomla! 框架 3.x API » \Joomla\Router\RouterInterface

向路由器添加路由。

addRoute(\Joomla\Router\Route route) :

自版本	2.0.0

参数

路由: Route路由定义

返回值

$this

向路由器添加一系列路由映射或对象。

addRoutes(\Joomla\Router\Route[]|array[] routes) :

自版本	2.0.0
抛出	`UnexpectedValueException`如果映射数组中缺少 `pattern` 或 `controller` 键。

参数

路由: array<string|int, Route>|array<string|int, array<string|int, mixed>>要添加到路由器的一系列路由映射或 Route 对象。

返回值

$this

向路由器添加接受所有请求方法的路由。

all( pattern,  controller, mixed||string|int rules = [], mixed||string|int defaults = []) :

自版本	2.0.0

参数

模式: string用于匹配的路由模式。
控制器: mixed映射到给定模式的控制器。
规则: array<string|int, mixed>使用路由变量作为键的正则表达式规则数组。
默认值: array<string|int, mixed>匹配 URL 时使用的默认值数组。

返回值

$this

向路由器添加 DELETE 路由。

delete( pattern,  controller, mixed||string|int rules = [], mixed||string|int defaults = []) :

自版本	2.0.0

参数

模式: string用于匹配的路由模式。
控制器: mixed映射到给定模式的控制器。
规则: array<string|int, mixed>使用路由变量作为键的正则表达式规则数组。
默认值: array<string|int, mixed>匹配 URL 时使用的默认值数组。

返回值

$this

向路由器添加 GET 路由。

get( pattern,  controller, mixed||string|int rules = [], mixed||string|int defaults = []) :

自版本	2.0.0

参数

模式: string用于匹配的路由模式。
控制器: mixed映射到给定模式的控制器。
规则: array<string|int, mixed>使用路由变量作为键的正则表达式规则数组。
默认值: array<string|int, mixed>匹配 URL 时使用的默认值数组。

返回值

$this

获取在此路由器中注册的路由。

getRoutes() : \Joomla\Router\Route||string|int

自版本	2.0.0

返回值

array<string|int, Route>

向路由器添加 HEAD 路由。

head( pattern,  controller, mixed||string|int rules = [], mixed||string|int defaults = []) :

自版本	2.0.0

参数

模式: string用于匹配的路由模式。
控制器: mixed映射到给定模式的控制器。
规则: array<string|int, mixed>使用路由变量作为键的正则表达式规则数组。
默认值: array<string|int, mixed>匹配 URL 时使用的默认值数组。

返回值

$this

向路由器添加 OPTIONS 路由。

options( pattern,  controller, mixed||string|int rules = [], mixed||string|int defaults = []) :

自版本	2.0.0

参数

模式: string用于匹配的路由模式。
控制器: mixed映射到给定模式的控制器。
规则: array<string|int, mixed>使用路由变量作为键的正则表达式规则数组。
默认值: array<string|int, mixed>匹配 URL 时使用的默认值数组。

返回值

$this

解析给定的路由并返回有关路由的信息，包括分配给路由的控制器。

parseRoute( route,  method = 'GET') : \Joomla\Router\ResolvedRoute

自版本

2.0.0

抛出

MethodNotAllowedException如果找到路由但它不支持请求方法

RouteNotFoundException如果未找到路由

参数

路由: string要查找并执行控制器的路由字符串。
方法: string要匹配的请求方法，应为有效的 HTTP 请求方法。

返回值

ResolvedRoute

向路由器添加 PATCH 路由。

patch( pattern,  controller, mixed||string|int rules = [], mixed||string|int defaults = []) :

自版本	2.0.0

参数

模式: string用于匹配的路由模式。
控制器: mixed映射到给定模式的控制器。
规则: array<string|int, mixed>使用路由变量作为键的正则表达式规则数组。
默认值: array<string|int, mixed>匹配 URL 时使用的默认值数组。

返回值

$this

向路由器添加 POST 路由。

post( pattern,  controller, mixed||string|int rules = [], mixed||string|int defaults = []) :

自版本	2.0.0

参数

模式: string用于匹配的路由模式。
控制器: mixed映射到给定模式的控制器。
规则: array<string|int, mixed>使用路由变量作为键的正则表达式规则数组。
默认值: array<string|int, mixed>匹配 URL 时使用的默认值数组。

返回值

$this

向路由器添加 PUT 路由。

put( pattern,  controller, mixed||string|int rules = [], mixed||string|int defaults = []) :

自版本	2.0.0

参数

模式: string用于匹配的路由模式。
控制器: mixed映射到给定模式的控制器。
规则: array<string|int, mixed>使用路由变量作为键的正则表达式规则数组。
默认值: array<string|int, mixed>匹配 URL 时使用的默认值数组。

返回值

$this

向路由器添加 TRACE 路由。

trace( pattern,  controller, mixed||string|int rules = [], mixed||string|int defaults = []) :

自版本	2.0.0

参数

模式: string用于匹配的路由模式。
控制器: mixed映射到给定模式的控制器。
规则: array<string|int, mixed>使用路由变量作为键的正则表达式规则数组。
默认值: array<string|int, mixed>匹配 URL 时使用的默认值数组。

返回值

$this