\thinkRoute

路由管理类

Summary

Methods

Properties

Constants

__construct()
config()
lazy()
setTestMode()
isTest()
mergeRuleRegex()
setGroup()
getGroup()
pattern()
option()
domain()
getDomains()
getRuleName()
bind()
getBind()
getDomainBind()
getName()
import()
setName()
setRule()
getRule()
getRuleList()
clear()
rule()
setCrossDomainRule()
group()
any()
get()
post()
put()
delete()
patch()
options()
resource()
view()
redirect()
rest()
getRest()
miss()
dispatch()
check()
url()
buildUrl()
__call()

No public properties found

No constants found

init()
setDefaultDomain()
path()
checkDomain()

$rest
$config
$app
$request
$ruleName
$host
$group
$bind
$domains
$cross
$lazy
$isTest
$mergeRuleRegex
$removeSlash

N/A

No private methods found

No private properties found

N/A

File: serve/vendor/topthink/framework/src/think/Route.php
Package: think
Class hierarchy: \think\Route
Uses

Properties

$rest

$rest : array

REST定义

Type

array —

$config

$config : array

配置参数

Type

array —

$app

$app : \think\App

当前应用

Type

App —

$request

$request : \think\Request

请求对象

Type

Request —

$ruleName

$ruleName : \think\route\RuleName

Type

RuleName —

$host

$host : string

当前HOST

Type

string —

$group

$group : \think\route\RuleGroup

当前分组对象

Type

RuleGroup —

$bind

$bind : array

路由绑定

Type

array —

$domains

$domains : \think\route\Domain[]

域名对象

Type

Domain[] —

$cross

$cross : \think\route\RuleGroup

跨域路由规则

Type

RuleGroup —

$lazy

$lazy : bool

路由是否延迟解析

Type

bool —

$isTest

$isTest : bool

路由是否测试模式

Type

bool —

$mergeRuleRegex

$mergeRuleRegex : bool

（分组）路由规则是否合并解析

Type

bool —

$removeSlash

$removeSlash : bool

是否去除URL最后的斜线

Type

bool —

Methods

__construct()

__construct(\think\App  $app) : mixed

Parameters

\think\App

$app

Returns

mixed —

config()

config(string  $name = null) : mixed

Parameters

string

$name

Returns

mixed —

lazy()

lazy(bool  $lazy = true) : $this

设置路由域名及分组（包括资源路由）是否延迟解析

Parameters

bool

$lazy

路由是否延迟解析

Returns

$this —

setTestMode()

setTestMode(bool  $test) : void

设置路由为测试模式

Parameters

bool

$test

路由是否测试模式

isTest()

isTest() : bool

检查路由是否为测试模式

Returns

bool —

mergeRuleRegex()

mergeRuleRegex(bool  $merge = true) : $this

设置路由域名及分组（包括资源路由）是否合并解析

Parameters

bool

$merge

路由是否合并解析

Returns

$this —

setGroup()

setGroup(\think\route\RuleGroup  $group) : void

设置当前分组

Parameters

\think\route\RuleGroup

$group

域名

getGroup()

getGroup(string  $name = null) : \think\route\RuleGroup

获取指定标识的路由分组不指定则获取当前分组

Parameters

string

$name

分组标识

Returns

\think\route\RuleGroup —

pattern()

pattern(array  $pattern) : $this

注册变量规则

Parameters

array

$pattern

变量规则

Returns

$this —

option()

option(array  $option) : $this

注册路由参数

Parameters

array

$option

参数

Returns

$this —

domain()

domain(string|array  $name, mixed  $rule = null) : \think\route\Domain

注册域名路由

Parameters

string\|array	$name	子域名
mixed	$rule	路由规则

Returns

\think\route\Domain —

getDomains()

getDomains() : array

获取域名

Returns

array —

getRuleName()

getRuleName() : \think\route\RuleName

获取RuleName对象

Returns

\think\route\RuleName —

bind()

bind(string  $bind, string  $domain = null) : $this

设置路由绑定

Parameters

string	$bind	绑定信息
string	$domain	域名

Returns

$this —

getBind()

getBind() : array

读取路由绑定信息

Returns

array —

getDomainBind()

getDomainBind(string  $domain = null) : string|null

读取路由绑定

Parameters

string

$domain

域名

Returns

string|null —

getName()

getName(string  $name = null, string  $domain = null, string  $method = '*') : array

读取路由标识

Parameters

string	$name	路由标识
string	$domain	域名
string	$method	请求类型

Returns

array —

import()

import(array  $name) : void

批量导入路由标识

Parameters

array

$name

路由标识

setName()

setName(string  $name, \think\route\RuleItem  $ruleItem, bool  $first = false) : void

注册路由标识

Parameters

string	$name	路由标识
\think\route\RuleItem	$ruleItem	路由规则
bool	$first	是否优先

setRule()

setRule(string  $rule, \think\route\RuleItem  $ruleItem = null) : void

保存路由规则

Parameters

string	$rule	路由规则
\think\route\RuleItem	$ruleItem	RuleItem对象

getRule()

getRule(string  $rule) : \think\route\RuleItem[]

读取路由

Parameters

string

$rule

路由规则

Returns

\think\route\RuleItem[] —

getRuleList()

getRuleList() : array

读取路由列表

Returns

array —

clear()

clear() : void

清空路由规则

rule()

rule(string  $rule, mixed  $route = null, string  $method = '*') : \think\route\RuleItem

注册路由规则

Parameters

string	$rule	路由规则
mixed	$route	路由地址
string	$method	请求类型

Returns

\think\route\RuleItem —

setCrossDomainRule()

setCrossDomainRule(\think\route\Rule  $rule, string  $method = '*') : $this

设置跨域有效路由规则

Parameters

\think\route\Rule	$rule	路由规则
string	$method	请求类型

Returns

$this —

group()

group(string|\Closure  $name, mixed  $route = null) : \think\route\RuleGroup

注册路由分组

Parameters

string\|\Closure	$name	分组名称或者参数
mixed	$route	分组路由

Returns

\think\route\RuleGroup —

any()

any(string  $rule, mixed  $route) : \think\route\RuleItem

注册路由

Parameters

string	$rule	路由规则
mixed	$route	路由地址

Returns

\think\route\RuleItem —

get()

get(string  $rule, mixed  $route) : \think\route\RuleItem

注册GET路由

Parameters

string	$rule	路由规则
mixed	$route	路由地址

Returns

\think\route\RuleItem —

post()

post(string  $rule, mixed  $route) : \think\route\RuleItem

注册POST路由

Parameters

string	$rule	路由规则
mixed	$route	路由地址

Returns

\think\route\RuleItem —

put()

put(string  $rule, mixed  $route) : \think\route\RuleItem

注册PUT路由

Parameters

string	$rule	路由规则
mixed	$route	路由地址

Returns

\think\route\RuleItem —

delete()

delete(string  $rule, mixed  $route) : \think\route\RuleItem

注册DELETE路由

Parameters

string	$rule	路由规则
mixed	$route	路由地址

Returns

\think\route\RuleItem —

patch()

patch(string  $rule, mixed  $route) : \think\route\RuleItem

注册PATCH路由

Parameters

string	$rule	路由规则
mixed	$route	路由地址

Returns

\think\route\RuleItem —

options()

options(string  $rule, mixed  $route) : \think\route\RuleItem

注册OPTIONS路由

Parameters

string	$rule	路由规则
mixed	$route	路由地址

Returns

\think\route\RuleItem —

resource()

resource(string  $rule, string  $route) : resource

注册资源路由

Parameters

string	$rule	路由规则
string	$route	路由地址

Returns

resource —

view()

view(string  $rule, string  $template = '', array  $vars = []) : \think\route\RuleItem

注册视图路由

Parameters

string	$rule	路由规则
string	$template	路由模板地址
array	$vars	模板变量

Returns

\think\route\RuleItem —

redirect()

redirect(string  $rule, string  $route = '', int  $status = 301) : \think\route\RuleItem

注册重定向路由

Parameters

string	$rule	路由规则
string	$route	路由地址
int	$status	状态码

Returns

\think\route\RuleItem —

rest()

rest(string|array  $name, array|bool  $resource = []) : $this

rest方法定义和修改

Parameters

string\|array	$name	方法名称
array\|bool	$resource	资源

Returns

$this —

getRest()

getRest(string  $name = null) : array|null

获取rest方法定义的参数

Parameters

string

$name

方法名称

Returns

array|null —

miss()

miss(string|\Closure  $route, string  $method = '*') : \think\route\RuleItem

注册未匹配路由规则后的处理

Parameters

string\|\Closure	$route	路由地址
string	$method	请求类型

Returns

\think\route\RuleItem —

dispatch()

dispatch(\think\Request  $request, \Closure|bool  $withRoute = true) : \think\Response

路由调度

Parameters

\think\Request	$request
\Closure\|bool	$withRoute

Returns

\think\Response —

check()

check() : \think\route\Dispatch|false

检测URL路由

Throws

\think\exception\RouteNotFoundException

Returns

\think\route\Dispatch|false —

url()

url(string  $url) : \think\route\Dispatch

默认URL解析

Parameters

string

$url

URL地址

Returns

\think\route\Dispatch —

buildUrl()

buildUrl(string  $url = '', array  $vars = []) : \think\route\Url

URL生成支持路由反射

Parameters

string	$url	路由地址
array	$vars	参数 ['a'=>'val1', 'b'=>'val2']

Returns

\think\route\Url —

__call()

__call(string  $method, array  $args) : \think\route\RuleGroup

设置全局的路由分组参数

Parameters

string	$method	方法名
array	$args	调用参数

Returns

\think\route\RuleGroup —

init()

init() : mixed

Returns

mixed —

setDefaultDomain()

setDefaultDomain() : void

初始化默认域名

path()

path() : string

获取当前请求URL的pathinfo信息(不含URL后缀)

Returns

string —

checkDomain()

checkDomain() : \think\route\Domain

检测域名的路由规则

Returns

\think\route\Domain —