Router
实现 RouterInterface，Serializable路径路由器。
| 自 |
1.0 |
|---|---|
| 包 |
Joomla 框架 |
方法
__construct
构造函数。
__construct(\Joomla\Router\Route[]|array[] routes = []) :
| 自 |
1.0 |
|---|
参数
- routes
array<string|int, Route>|array<string|int, array<string|int, mixed>>要添加到路由器的一组路由映射或 Route 对象。
返回值
mixed
__serialize
序列化路由器。
__serialize() : mixed||string|int
| 自 |
2.0.0 |
|---|
返回值
array<string|int, mixed>要序列化的数据
__unserialize
反序列化路由器。
__unserialize(mixed||string|int data) :
| 自 |
2.0.0 |
|---|
参数
- data
array<string|int, mixed>已序列化的路由器。
返回值
void
addRoutes
向路由器添加一组路由映射或对象。
addRoutes(\Joomla\Router\Route[]|array[] routes) :
| 自 |
2.0.0 |
|---|---|
| 抛出 |
|
参数
- routes
array<string|int, Route>|array<string|int, array<string|int, mixed>>要添加到路由器的一组路由映射或 Route 对象。
返回值
$this
all
向路由器添加一个接受所有请求方法的路由。
all( pattern, controller, mixed||string|int rules = [], mixed||string|int defaults = []) :
| 自 |
2.0.0 |
|---|
参数
- pattern
string用于匹配的路由模式。- controller
mixed映射到给定模式的控制器。- rules
array<string|int, mixed>使用路由变量作为键的正则表达式规则数组。- defaults
array<string|int, mixed>匹配 URL 时使用的默认值数组。
返回值
$this
delete
向路由器添加 DELETE 路由。
delete( pattern, controller, mixed||string|int rules = [], mixed||string|int defaults = []) :
| 自 |
2.0.0 |
|---|
参数
- pattern
string用于匹配的路由模式。- controller
mixed映射到给定模式的控制器。- rules
array<string|int, mixed>使用路由变量作为键的正则表达式规则数组。- defaults
array<string|int, mixed>匹配 URL 时使用的默认值数组。
返回值
$this
get
向路由器添加 GET 路由。
get( pattern, controller, mixed||string|int rules = [], mixed||string|int defaults = []) :
| 自 |
2.0.0 |
|---|
参数
- pattern
string用于匹配的路由模式。- controller
mixed映射到给定模式的控制器。- rules
array<string|int, mixed>使用路由变量作为键的正则表达式规则数组。- defaults
array<string|int, mixed>匹配 URL 时使用的默认值数组。
返回值
$this
getRoutes
获取在此路由器中注册的路由。
getRoutes() : \Joomla\Router\Route||string|int
head
向路由器添加 HEAD 路由。
head( pattern, controller, mixed||string|int rules = [], mixed||string|int defaults = []) :
| 自 |
2.0.0 |
|---|
参数
- pattern
string用于匹配的路由模式。- controller
mixed映射到给定模式的控制器。- rules
array<string|int, mixed>使用路由变量作为键的正则表达式规则数组。- defaults
array<string|int, mixed>匹配 URL 时使用的默认值数组。
返回值
$this
options
向路由器添加 OPTIONS 路由。
options( pattern, controller, mixed||string|int rules = [], mixed||string|int defaults = []) :
| 自 |
2.0.0 |
|---|
参数
- pattern
string用于匹配的路由模式。- controller
mixed映射到给定模式的控制器。- rules
array<string|int, mixed>使用路由变量作为键的正则表达式规则数组。- defaults
array<string|int, mixed>匹配 URL 时使用的默认值数组。
返回值
$this
parseRoute
解析给定的路由并返回有关路由的信息，包括分配给路由的控制器。
parseRoute( route, method = 'GET') : \Joomla\Router\ResolvedRoute
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- route
string要查找并执行控制器的路由字符串。- method
string要匹配的请求方法，应为有效的 HTTP 请求方法。
返回值
patch
向路由器添加 PATCH 路由。
patch( pattern, controller, mixed||string|int rules = [], mixed||string|int defaults = []) :
| 自 |
2.0.0 |
|---|
参数
- pattern
string用于匹配的路由模式。- controller
mixed映射到给定模式的控制器。- rules
array<string|int, mixed>使用路由变量作为键的正则表达式规则数组。- defaults
array<string|int, mixed>匹配 URL 时使用的默认值数组。
返回值
$this
post
向路由器添加 POST 路由。
post( pattern, controller, mixed||string|int rules = [], mixed||string|int defaults = []) :
| 自 |
2.0.0 |
|---|
参数
- pattern
string用于匹配的路由模式。- controller
mixed映射到给定模式的控制器。- rules
array<string|int, mixed>使用路由变量作为键的正则表达式规则数组。- defaults
array<string|int, mixed>匹配 URL 时使用的默认值数组。
返回值
$this
put
向路由器添加 PUT 路由。
put( pattern, controller, mixed||string|int rules = [], mixed||string|int defaults = []) :
| 自 |
2.0.0 |
|---|
参数
- pattern
string用于匹配的路由模式。- controller
mixed映射到给定模式的控制器。- rules
array<string|int, mixed>使用路由变量作为键的正则表达式规则数组。- defaults
array<string|int, mixed>匹配 URL 时使用的默认值数组。
返回值
$this
serialize
序列化路由器。
serialize() :
| 自 |
2.0.0 |
|---|
返回值
string已序列化的路由器。
trace
向路由器添加 TRACE 路由。
trace( pattern, controller, mixed||string|int rules = [], mixed||string|int defaults = []) :
| 自 |
2.0.0 |
|---|
参数
- pattern
string用于匹配的路由模式。- controller
mixed映射到给定模式的控制器。- rules
array<string|int, mixed>使用路由变量作为键的正则表达式规则数组。- defaults
array<string|int, mixed>匹配 URL 时使用的默认值数组。
返回值
$this
unserialize
反序列化路由器。
unserialize( serialized) :
| 自 |
2.0.0 |
|---|
参数
- serialized
string已序列化的路由器。
返回值
void