\thinkRoute

Summary

Methods

Properties

Constants

pattern()
domain()
bind()
name()
getBind()
import()
rule()
getOption()
getGroup()
setGroup()
group()
any()
get()
post()
put()
delete()
patch()
resource()
controller()
alias()
setMethodPrefix()
rest()
miss()
auto()
rules()
checkDomain()
check()
bindToClass()
bindToNamespace()
bindToController()
bindToModule()
parseUrl()

No public properties found

No constants found

registerRules()
setRule()
setOption()

No protected properties found

N/A

setDomain()
getRouteExpress()
checkRoute()
checkRouteAlias()
checkUrlBind()
checkOption()
checkRule()
parseUrlPath()
match()
parseRule()
parseModule()
parseUrlParams()
parseVar()
getCheckCacheKey()

$rules
$rest
$methodPrefix
$subDomain
$bind
$group
$domainBind
$domainRule
$domain
$option

N/A

File: back/vendor/topthink/framework/library/think/Route.php
Package: Application
Class hierarchy: \think\Route
Uses

Properties

$rules

$rules

$rest

$rest

$methodPrefix

$methodPrefix

$subDomain

$subDomain

$bind

$bind

$group

$group

$domainBind

$domainBind

$domainRule

$domainRule

$domain

$domain

$option

$option

Methods

pattern()

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

注册变量规则

Parameters

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

domain()

domain(string|array  $domain, mixed  $rule = '', array  $option = [], array  $pattern = []) : void

注册子域名部署规则

Parameters

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

bind()

bind(mixed  $bind, string  $type = 'module') : mixed

设置路由绑定

Parameters

mixed	$bind	绑定信息
string	$type	绑定类型默认为module 支持 namespace class controller

Returns

mixed —

name()

name(string|array  $name = '', array  $value = null) : array

设置或者获取路由标识

Parameters

string\|array	$name	路由命名标识数组表示批量设置
array	$value	路由地址及变量信息

Returns

array —

getBind()

getBind(string  $type) : mixed

读取路由绑定

Parameters

string

$type

绑定类型

Returns

mixed —

import()

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

导入配置文件的路由规则

Parameters

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

rule()

rule(string|array  $rule, string  $route = '', string  $type = '*', array  $option = [], array  $pattern = []) : void

注册路由规则

Parameters

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

getOption()

getOption() : array

获取当前执行的所有参数信息

Returns

array —

getGroup()

getGroup(string  $type) : mixed

获取当前的分组信息

Parameters

string

$type

分组信息名称 name option pattern

Returns

mixed —

setGroup()

setGroup(string  $name, array  $option = [], array  $pattern = []) : void

设置当前的路由分组

Parameters

string	$name	分组名称
array	$option	分组路由参数
array	$pattern	分组变量规则

group()

group(string|array  $name, array|\Closure  $routes, array  $option = [], array  $pattern = []) : void

注册路由分组

Parameters

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

any()

any(string|array  $rule, string  $route = '', array  $option = [], array  $pattern = []) : void

注册路由

Parameters

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

get()

get(string|array  $rule, string  $route = '', array  $option = [], array  $pattern = []) : void

注册GET路由

Parameters

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

post()

post(string|array  $rule, string  $route = '', array  $option = [], array  $pattern = []) : void

注册POST路由

Parameters

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

put()

put(string|array  $rule, string  $route = '', array  $option = [], array  $pattern = []) : void

注册PUT路由

Parameters

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

delete()

delete(string|array  $rule, string  $route = '', array  $option = [], array  $pattern = []) : void

注册DELETE路由

Parameters

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

patch()

patch(string|array  $rule, string  $route = '', array  $option = [], array  $pattern = []) : void

注册PATCH路由

Parameters

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

resource()

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

注册资源路由

Parameters

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

controller()

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

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

Parameters

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

alias()

alias(string|array  $rule = null, string  $route = '', array  $option = []) : void

注册别名路由

Parameters

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

setMethodPrefix()

setMethodPrefix(string  $method, string  $prefix = '') : void

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

Parameters

string	$method	请求类型
string	$prefix	类型前缀

rest()

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

rest方法定义和修改

Parameters

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

miss()

miss(string  $route, string  $method = '*', array  $option = []) : void

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

Parameters

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

auto()

auto(string  $route) : void

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

Parameters

string

$route

路由地址

rules()

rules(mixed  $rules = '') : array

获取或者批量设置路由定义

Parameters

mixed

$rules

请求类型或者路由定义数组

Returns

array —

checkDomain()

checkDomain(\think\Request  $request, array  $currentRules, string  $method = 'get') : void

检测子域名部署

Parameters

\think\Request	$request	Request请求对象
array	$currentRules	当前路由规则
string	$method	请求类型

check()

check(\think\Request  $request, string  $url, string  $depr = '/', bool  $checkDomain = false) : false|array

检测URL路由

Parameters

\think\Request	$request	Request请求对象
string	$url	URL地址
string	$depr	URL分隔符
bool	$checkDomain	是否检测域名规则

Returns

false|array —

bindToClass()

bindToClass(string  $url, string  $class, string  $depr = '/') : array

绑定到类

Parameters

string	$url	URL地址
string	$class	类名（带命名空间）
string	$depr	URL分隔符

Returns

array —

bindToNamespace()

bindToNamespace(string  $url, string  $namespace, string  $depr = '/') : array

绑定到命名空间

Parameters

string	$url	URL地址
string	$namespace	命名空间
string	$depr	URL分隔符

Returns

array —

bindToController()

bindToController(string  $url, string  $controller, string  $depr = '/') : array

绑定到控制器类

Parameters

string	$url	URL地址
string	$controller	控制器名（支持带模块名 index/user ）
string	$depr	URL分隔符

Returns

array —

bindToModule()

bindToModule(string  $url, string  $controller, string  $depr = '/') : array

绑定到模块/控制器

Parameters

string	$url	URL地址
string	$controller	控制器类名（带命名空间）
string	$depr	URL分隔符

Returns

array —

parseUrl()

parseUrl(string  $url, string  $depr = '/', bool  $autoSearch = false) : array

解析模块的URL地址 [模块/控制器/操作?]参数1=值1&参数2=值2.

Parameters

string	$url	URL地址
string	$depr	URL分隔符
bool	$autoSearch	是否自动深度搜索控制器

Returns

array —

registerRules()

registerRules(mixed  $rules, mixed  $type = '*') : mixed

Parameters

mixed	$rules
mixed	$type

Returns

mixed —

setRule()

setRule(string|array  $rule, string  $route, string  $type = '*', array  $option = [], array  $pattern = [], string  $group = '') : void

设置路由规则

Parameters

string\|array	$rule	路由规则
string	$route	路由地址
string	$type	请求类型
array	$option	路由参数
array	$pattern	变量规则
string	$group	所属分组

setOption()

setOption(array  $options = []) : mixed

设置当前执行的参数信息

Parameters

array

$options

参数信息

Returns

mixed —

setDomain()

setDomain(mixed  $domain) : mixed

Parameters

mixed

$domain

Returns

mixed —

getRouteExpress()

getRouteExpress(mixed  $key) : mixed

Parameters

mixed

$key

Returns

mixed —

checkRoute()

checkRoute(\think\Request  $request, array  $rules, string  $url, string  $depr = '/', string  $group = '', array  $options = []) : mixed

检测路由规则

Parameters

\think\Request	$request
array	$rules	路由规则
string	$url	URL地址
string	$depr	URL分割符
string	$group	路由分组名
array	$options	路由参数（分组）

Returns

mixed —

checkRouteAlias()

checkRouteAlias(\think\Request  $request, string  $url, string  $depr) : mixed

检测路由别名

Parameters

\think\Request	$request
string	$url	URL地址
string	$depr	URL分隔符

Returns

mixed —

checkUrlBind()

checkUrlBind(string  $url, array  $rules, string  $depr = '/') : mixed

检测URL绑定

Parameters

string	$url	URL地址
array	$rules	路由规则
string	$depr	URL分隔符

Returns

mixed —

checkOption()

checkOption(array  $option, \think\Request  $request) : bool

路由参数有效性检查

Parameters

array	$option	路由参数
\think\Request	$request	Request对象

Returns

bool —

checkRule()

checkRule(string  $rule, string  $route, string  $url, array  $pattern, array  $option, string  $depr) : array|false

检测路由规则

Parameters

string	$rule	路由规则
string	$route	路由地址
string	$url	URL地址
array	$pattern	变量规则
array	$option	路由参数
string	$depr	URL分隔符（全局）

Returns

array|false —

parseUrlPath()

parseUrlPath(string  $url) : array

解析URL的pathinfo参数和变量

Parameters

string

$url

URL地址

Returns

array —

match()

match(string  $url, string  $rule, array  $pattern) : array|false

检测URL和规则路由是否匹配

Parameters

string	$url	URL地址
string	$rule	路由规则
array	$pattern	变量规则

Returns

array|false —

parseRule()

parseRule(string  $rule, string  $route, string  $pathinfo, array  $option = [], array  $matches = [], bool  $fromCache = false) : array

解析规则路由

Parameters

string	$rule	路由规则
string	$route	路由地址
string	$pathinfo	URL地址
array	$option	路由参数
array	$matches	匹配的变量
bool	$fromCache	通过缓存解析

Returns

array —

parseModule()

parseModule(string  $url, bool  $convert = false) : array

解析URL地址为模块/控制器/操作

Parameters

string	$url	URL地址
bool	$convert	是否自动转换URL地址

Returns

array —

parseUrlParams()

parseUrlParams(string  $url, array  $var = []) : void

解析URL地址中的参数Request对象

Parameters

string	$url	路由规则
array	$var	变量

parseVar()

parseVar(mixed  $rule) : mixed

Parameters

mixed

$rule

Returns

mixed —

getCheckCacheKey()

getCheckCacheKey(\think\Request  $request) : string

获取路由解析缓存的key

Parameters

\think\Request

$request

Returns

string —