\thinkRoute

Summary

Methods

Properties

Constants

__construct()
config()
setConfig()
__make()
setRequest()
lazy()
setTestMode()
isTest()
mergeRuleRegex()
autoSearchController()
setGroup()
getGroup()
pattern()
option()
domain()
getDomains()
bind()
getBind()
getName()
getRule()
getRuleList()
setName()
import()
rule()
setCrossDomainRule()
rules()
group()
any()
get()
post()
put()
delete()
patch()
resource()
controller()
view()
redirect()
alias()
getAlias()
setMethodPrefix()
getMethodPrefix()
rest()
getRest()
miss()
auto()
check()
clear()
__call()
__debugInfo()

No public properties found

No constants found

setDefaultDomain()
checkDomain()

$rest
$methodPrefix
$app
$request
$host
$domain
$group
$config
$bind
$domains
$cross
$alias
$lazy
$isTest
$mergeRuleRegex
$autoSearchController

N/A

No private methods found

No private properties found

N/A

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

Properties

$rest

$rest : array

REST定义

Type

array —

$methodPrefix

$methodPrefix : array

请求方法前缀定义

Type

array —

$app

$app : \think\App

应用对象

Type

App —

$request

$request : \think\Request

请求对象

Type

Request —

$host

$host : string

当前HOST

Type

string —

$domain

$domain : string

当前域名

Type

string —

$group

$group : \think\route\RuleGroup

当前分组对象

Type

RuleGroup —

$config

$config : array

配置参数

Type

array —

$bind

$bind : array

路由绑定

Type

array —

$domains

$domains : array

域名对象

Type

array —

$cross

$cross : \think\route\RuleGroup

跨域路由规则

Type

RuleGroup —

$alias

$alias : array

路由别名

Type

array —

$lazy

$lazy : bool

路由是否延迟解析

Type

bool —

$isTest

$isTest : bool

路由是否测试模式

Type

bool —

$mergeRuleRegex

$mergeRuleRegex : bool

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

Type

bool —

$autoSearchController

$autoSearchController : bool

路由解析自动搜索多级控制器

Type

bool —

Methods

__construct()

__construct(\think\App  $app, array  $config = []) : mixed

Parameters

\think\App	$app
array	$config

Returns

mixed —

config()

config(mixed  $name = null) : mixed

Parameters

mixed

$name

Returns

mixed —

setConfig()

setConfig(array  $config = []) : void

配置

Parameters

array

$config

__make()

__make(\think\App  $app, \think\Config  $config) : mixed

Parameters

\think\App	$app
\think\Config	$config

Returns

mixed —

setRequest()

setRequest(\think\Request  $request) : void

设置路由的请求对象实例

Parameters

\think\Request

$request

请求对象实例

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 —

autoSearchController()

autoSearchController(bool  $auto = true) : $this

设置路由自动解析是否搜索多级控制器

Parameters

bool

$auto

是否自动搜索多级控制器

Returns

$this —

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  $pattern = []) : \think\route\Domain

注册域名路由

Parameters

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

Returns

\think\route\Domain —

getDomains()

getDomains() : array

获取域名

Returns

array —

bind()

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

设置路由绑定

Parameters

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

Returns

$this —

getBind()

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

读取路由绑定

Parameters

string

$domain

域名

Returns

string|null —

getName()

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

读取路由标识

Parameters

string	$name	路由标识
string	$domain	域名
mixed	$method

Returns

mixed —

getRule()

getRule(string  $rule, string  $domain = null) : array

读取路由

Parameters

string	$rule	路由规则
string	$domain	域名

Returns

array —

getRuleList()

getRuleList(string  $domain = null) : array

读取路由

Parameters

string

$domain

域名

Returns

array —

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  $pattern = []) : \think\route\RuleItem

注册路由规则

Parameters

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

Returns

\think\route\RuleItem —

setCrossDomainRule()

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

设置跨域有效路由规则

Parameters

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

Returns

$this —

rules()

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

批量注册路由规则

Parameters

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

group()

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

注册路由分组

Parameters

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

Returns

\think\route\RuleGroup —

any()

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

注册路由

Parameters

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

Returns

\think\route\RuleItem —

get()

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

注册GET路由

Parameters

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

Returns

\think\route\RuleItem —

post()

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

注册POST路由

Parameters

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

Returns

\think\route\RuleItem —

put()

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

注册PUT路由

Parameters

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

Returns

\think\route\RuleItem —

delete()

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

注册DELETE路由

Parameters

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

Returns

\think\route\RuleItem —

patch()

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

注册PATCH路由

Parameters

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

Returns

\think\route\RuleItem —

resource()

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

注册资源路由

Parameters

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

Returns

resource —

controller()

controller(string  $rule, string  $route = '', array  $option = [], array  $pattern = []) : \think\route\RuleGroup

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

Parameters

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

Returns

\think\route\RuleGroup —

view()

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

注册视图路由

Parameters

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

Returns

\think\route\RuleItem —

redirect()

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

注册重定向路由

Parameters

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

Returns

\think\route\RuleItem —

alias()

alias(string  $rule, string  $route, array  $option = []) : \think\route\AliasRule

注册别名路由

Parameters

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

Returns

\think\route\AliasRule —

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|bool  $resource = []) : $this

rest方法定义和修改

Parameters

string	$name	方法名称
array\|bool	$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 = []) : \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, bool  $must = false) : \think\route\Dispatch

检测URL路由

Parameters

string	$url	URL地址
bool	$must	是否强制路由

Throws

\think\exception\RouteNotFoundException

Returns

\think\route\Dispatch —

clear()

clear() : void

清空路由规则

__call()

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

设置全局的路由分组参数

Parameters

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

Returns

\think\route\RuleGroup —

__debugInfo()

__debugInfo() : mixed

Returns

mixed —

setDefaultDomain()

setDefaultDomain() : void

初始化默认域名

checkDomain()

checkDomain() : \think\route\Domain

检测域名的路由规则

Returns

\think\route\Domain —