Properties

$rest

$rest : array

REST定义

Type

array

$methodPrefix

$methodPrefix : array

请求方法前缀定义

Type

array

$app

$app : \think\App

应用对象

Type

\think\App

$host

$host : string

当前HOST

Type

string

$domain

$domain : string

当前域名

Type

string

$config

$config : array

配置参数

Type

array

$bind

$bind : array

路由绑定

Type

array

$domains

$domains : array

域名对象

Type

array

$alias

$alias : array

路由别名

Type

array

$lazy

$lazy : boolean

路由是否延迟解析

Type

boolean

$isTest

$isTest : boolean

路由是否测试模式

Type

boolean

$mergeRuleRegex

$mergeRuleRegex : boolean

(分组)路由规则是否合并解析

Type

boolean

$autoSearchController

$autoSearchController : boolean

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

Type

boolean

Methods

__construct()

__construct(\think\App  $app, array  $config = array()) 

Parameters

\think\App $app
array $config

config()

config(  $name = null) 

Parameters

$name

setConfig()

setConfig(array  $config = array()) : void

配置

Parameters

array $config

setRequest()

setRequest(\think\Request  $request) : void

设置路由的请求对象实例

Parameters

\think\Request $request

请求对象实例

lazy()

lazy(boolean  $lazy = true) : $this

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

Parameters

boolean $lazy

路由是否延迟解析

Returns

$this

setTestMode()

setTestMode(boolean  $test) : void

设置路由为测试模式

Parameters

boolean $test

路由是否测试模式

isTest()

isTest() : boolean

检查路由是否为测试模式

Returns

boolean

mergeRuleRegex()

mergeRuleRegex(boolean  $merge = true) : $this

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

Parameters

boolean $merge

路由是否合并解析

Returns

$this

autoSearchController()

autoSearchController(boolean  $auto = true) : $this

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

Parameters

boolean $auto

是否自动搜索多级控制器

Returns

$this

setGroup()

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

设置当前域名

Parameters

\think\route\RuleGroup $group

域名

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

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,   $method = '*') : mixed

读取路由标识

Parameters

string $name

路由标识

string $domain

域名

$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(), array  $pattern = array()) : \think\route\RuleItem

注册路由规则

Parameters

string $rule

路由规则

mixed $route

路由地址

string $method

请求类型

array $option

路由参数

array $pattern

变量规则

Returns

\think\route\RuleItem

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, mixed  $route = '', array  $option = array(), array  $pattern = array()) : \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(), array  $pattern = array()) : \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(), array  $pattern = array()) : \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(), array  $pattern = array()) : \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(), array  $pattern = array()) : \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(), array  $pattern = array()) : \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(), 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()) : \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(), 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, string  $route = '', array  $status = 301, array  $option = array(), array  $pattern = array()) : \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 = array()) : \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|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, boolean  $must = false) : \think\Dispatch

检测URL路由

Parameters

string $url

URL地址

boolean $must

是否强制路由

Throws

\think\exception\RouteNotFoundException

Returns

\think\Dispatch

clear()

clear() : void

清空路由规则

__call()

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

设置全局的路由分组参数

Parameters

string $method

方法名

array $args

调用参数

Returns

\think\route\RuleGroup

__debugInfo()

__debugInfo() 

setDefaultDomain()

setDefaultDomain() : void

初始化默认域名

checkDomain()

checkDomain() : \think\route\Domain

检测域名的路由规则

Returns

\think\route\Domain