\thinkRoute

Summary

Methods

Properties

Constants

__construct()
setGroup()
getGroup()
pattern()
option()
domain()
parseGroupRule()
getDomains()
bind()
getBind()
name()
getName()
setName()
import()
rule()
setRuleName()
setCrossDomainRule()
rules()
group()
any()
get()
post()
put()
delete()
patch()
resource()
controller()
view()
redirect()
alias()
getAlias()
setMethodPrefix()
getMethodPrefix()
rest()
getRest()
miss()
auto()
check()
parseVar()
__call()

No public properties found

No constants found

setDefaultDomain()
createTopGroup()
getRootDomain()
checkDomain()

$rest
$methodPrefix
$config
$request
$host
$domain
$group
$name
$bind
$domains
$cross
$ruleName
$alias

N/A

No private methods found

No private properties found

N/A

File: thinkphp/library/think/Route.php
Package: Default
Class hierarchy: \think\Route

Properties

$rest

$rest : array

REST定义

Type

array

$methodPrefix

$methodPrefix : array

请求方法前缀定义

Type

array

$config

$config : \think\Config

配置对象

Type

\think\Config

$request

$request : \think\Request

请求对象

Type

\think\Request

$host

$host : string

当前HOST

Type

string

$domain

$domain : string

当前域名

Type

string

$group

$group : string

当前分组

Type

string

$name

$name : array

路由标识

Type

array

$bind

$bind : array

路由绑定

Type

array

$domains

$domains : array

域名对象

Type

array

$cross

$cross : \think\route\RuleGroup

跨域路由规则

Type

\think\route\RuleGroup

$ruleName

$ruleName : string

当前路由标识

Type

string

$alias

$alias : array

路由别名

Type

array

Methods

__construct()

__construct(\think\Request  $request, \think\Config  $config)

Parameters

\think\Request	$request
\think\Config	$config

setGroup()

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

设置当前域名

Parameters

\think\route\RuleGroup

$group

域名

getGroup()

getGroup() : \think\route\RuleGroup

获取当前分组

Returns

\think\route\RuleGroup

pattern()

pattern(string|array  $name, string  $rule = '') : $this

注册变量规则

Parameters

string\|array	$name	变量名
string	$rule	变量规则

Returns

$this

option()

option(string|array  $name, mixed  $value = '') : $this

注册路由参数

Parameters

string\|array	$name	参数名
mixed	$value	值

Returns

$this

domain()

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

注册域名路由

Parameters

string\|array	$name	子域名
mixed	$rule	路由规则
array	$option	路由参数
array	$pattern	变量规则

Returns

\think\route\Domain

parseGroupRule()

parseGroupRule(\think\route\RuleGroup  $group, mixed  $rule) : void

解析分组和域名的路由规则及绑定

Parameters

\think\route\RuleGroup	$group	分组路由对象
mixed	$rule	路由规则

getDomains()

getDomains() : array

获取域名

Returns

array

bind()

bind(string  $bind) : $this

设置路由绑定

Parameters

string

$bind

绑定信息

Returns

$this

getBind()

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

读取路由绑定

Parameters

string

$domain

域名

Returns

string|null

name()

name(string  $name) : $this

设置当前路由标识

Parameters

string

$name

路由命名标识

Returns

$this

getName()

getName(string  $name = null) : mixed

读取路由标识

Parameters

string

$name

路由标识

Returns

mixed

setName()

setName(array  $name) : $this

批量导入路由标识

Parameters

array

$name

路由标识

Returns

$this

import()

import(array  $rules, string  $type = '*') : void

导入配置文件的路由规则

Parameters

array	$rules	路由规则
string	$type	请求类型

rule()

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

注册路由规则

Parameters

string	$rule	路由规则
mixed	$route	路由地址
string	$method	请求类型
array	$option	路由参数
array	$pattern	变量规则

Returns

\think\route\RuleItem

setRuleName()

setRuleName(string  $rule, string  $name, array  $option = array()) : void

设置路由标识用于URL反解生成

Parameters

string	$rule	路由规则
string	$name	路由标识
array	$option	路由参数

setCrossDomainRule()

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

设置跨域有效路由规则

Parameters

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

Returns

$this

rules()

rules(array  $rules, string  $method = '*', array  $option = array(), array  $pattern = array()) : void

批量注册路由规则

Parameters

array	$rules	路由规则
string	$method	请求类型
array	$option	路由参数
array	$pattern	变量规则

group()

group(string|array  $name, array|\Closure  $route, array  $option = array(), array  $pattern = array()) : \think\route\RuleGroup

注册路由分组

Parameters

string\|array	$name	分组名称或者参数
array\|\Closure	$route	分组路由
array	$option	路由参数
array	$pattern	变量规则

Returns

\think\route\RuleGroup

any()

any(string  $rule, string  $route = '', array  $option = array(), array  $pattern = array()) : \think\route\RuleItem

注册路由

Parameters

string	$rule	路由规则
string	$route	路由地址
array	$option	路由参数
array	$pattern	变量规则

Returns

\think\route\RuleItem

get()

get(string  $rule, string  $route = '', array  $option = array(), array  $pattern = array()) : \think\route\RuleItem

注册GET路由

Parameters

string	$rule	路由规则
string	$route	路由地址
array	$option	路由参数
array	$pattern	变量规则

Returns

\think\route\RuleItem

post()

post(string  $rule, string  $route = '', array  $option = array(), array  $pattern = array()) : \think\route\RuleItem

注册POST路由

Parameters

string	$rule	路由规则
string	$route	路由地址
array	$option	路由参数
array	$pattern	变量规则

Returns

\think\route\RuleItem

put()

put(string  $rule, string  $route = '', array  $option = array(), array  $pattern = array()) : \think\route\RuleItem

注册PUT路由

Parameters

string	$rule	路由规则
string	$route	路由地址
array	$option	路由参数
array	$pattern	变量规则

Returns

\think\route\RuleItem

delete()

delete(string  $rule, string  $route = '', array  $option = array(), array  $pattern = array()) : \think\route\RuleItem

注册DELETE路由

Parameters

string	$rule	路由规则
string	$route	路由地址
array	$option	路由参数
array	$pattern	变量规则

Returns

\think\route\RuleItem

patch()

patch(string  $rule, string  $route = '', array  $option = array(), array  $pattern = array()) : \think\route\RuleItem

注册PATCH路由

Parameters

string	$rule	路由规则
string	$route	路由地址
array	$option	路由参数
array	$pattern	变量规则

Returns

\think\route\RuleItem

resource()

resource(string  $rule, string  $route = '', array  $option = array(), array  $pattern = array()) : Resource

注册资源路由

Parameters

string	$rule	路由规则
string	$route	路由地址
array	$option	路由参数
array	$pattern	变量规则

Returns

Resource

controller()

controller(string  $rule, string  $route = '', array  $option = array(), array  $pattern = array()) : $this

注册控制器路由操作方法对应不同的请求后缀

Parameters

string	$rule	路由规则
string	$route	路由地址
array	$option	路由参数
array	$pattern	变量规则

Returns

$this

view()

view(string|array  $rule, string  $template = '', array  $vars = array(), array  $option = array(), array  $pattern = array()) : \think\route\RuleItem

注册视图路由

Parameters

string\|array	$rule	路由规则
string	$template	路由模板地址
array	$vars	模板变量
array	$option	路由参数
array	$pattern	变量规则

Returns

\think\route\RuleItem

redirect()

redirect(string|array  $rule,   $route = '', array  $status = 301, array  $option = array(), array  $pattern = array()) : \think\route\RuleItem

注册重定向路由

Parameters

string\|array	$rule	路由规则
	$route
array	$status	状态码
array	$option	路由参数
array	$pattern	变量规则

Returns

\think\route\RuleItem

alias()

alias(string|array  $rule = null, string  $route = '', array  $option = array()) : $this

注册别名路由

Parameters

string\|array	$rule	路由别名
string	$route	路由地址
array	$option	路由参数

Returns

$this

getAlias()

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

获取别名路由定义

Parameters

string

$name

路由别名

Returns

string|array|null

setMethodPrefix()

setMethodPrefix(string|array  $method, string  $prefix = '') : $this

设置不同请求类型下面的方法前缀

Parameters

string\|array	$method	请求类型
string	$prefix	类型前缀

Returns

$this

getMethodPrefix()

getMethodPrefix(string  $method) : string|null

获取请求类型的方法前缀

Parameters

string

$method

请求类型

Returns

string|null

rest()

rest(string  $name, array|boolean  $resource = array()) : $this

rest方法定义和修改

Parameters

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

Returns

$this

getRest()

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

获取rest方法定义的参数

Parameters

string

$name

方法名称

Returns

array|null

miss()

miss(string  $route, string  $method = '*', array  $option = array()) : \think\route\RuleItem

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

Parameters

string	$route	路由地址
string	$method	请求类型
array	$option	路由参数

Returns

\think\route\RuleItem

auto()

auto(string  $route) : \think\route\RuleItem

注册一个自动解析的URL路由

Parameters

string

$route

路由地址

Returns

\think\route\RuleItem

check()

check(string  $url, string  $depr = '/', boolean  $must = false, boolean  $completeMatch = false) : \think\Dispatch

检测URL路由

Parameters

string	$url	URL地址
string	$depr	URL分隔符
boolean	$must	是否强制路由
boolean	$completeMatch	路由是否完全匹配

Throws

\think\exception\RouteNotFoundException

Returns

\think\Dispatch

parseVar()

parseVar(string  $rule) : array

分析路由规则中的变量

Parameters

string

$rule

路由规则

Returns

array

__call()

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

设置全局的路由分组参数

Parameters

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

Returns

\think\route\RuleGroup

setDefaultDomain()

setDefaultDomain() : void

初始化默认域名

createTopGroup()

createTopGroup(\think\route\Domain  $domain) : \think\route\RuleGroup

创建一个域名下的顶级路由分组

Parameters

\think\route\Domain

$domain

域名

Returns

\think\route\RuleGroup

getRootDomain()

getRootDomain() : string

获取当前根域名

Returns

string

checkDomain()

checkDomain() : \think\route\Domain

检测域名的路由规则

Returns

\think\route\Domain