\think\routeRule

Summary

Methods

Properties

Constants

check()
option()
pattern()
name()
getName()
getPattern()
getOption()
append()
method()
before()
after()
ext()
denyExt()
domain()
model()
validate()
response()
header()
cache()
depr()
mergeExtraVars()
mergeOptions()
https()
ajax()
pjax()
view()
redirect()
completeMatch()
removeSlash()
allowCrossDomain()
crossDomainRule()
parseRule()
__call()

No public properties found

No constants found

checkCrossDomain()
mergeGroupOptions()
createBindModel()
parseRequestCache()
autoValidate()
checkBefore()
checkAfter()
dispatch()
parseModule()
checkOption()
parseUrlParams()
parseUrlPath()

$name
$router
$parent
$option
$pattern
$mergeOptions

N/A

No private methods found

No private properties found

N/A

abstract

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

Properties

$name

$name :

Type

$router

$router :

Type

$parent

$parent :

Type

$option

$option :

Type

$pattern

$pattern :

Type

$mergeOptions

$mergeOptions :

Type

Methods

check()

check(  $request,   $url,   $depr = '/')

Parameters

	$request
	$url
	$depr

option()

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

注册路由参数

Parameters

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

Returns

$this

pattern()

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

注册变量规则

Parameters

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

Returns

$this

name()

name(string|array  $name) : $this

设置Name

Parameters

string|array

$name

变量名

Returns

$this

getName()

getName() : string

获取Name

Returns

string

getPattern()

getPattern(string  $name = '') : mixed

获取变量规则定义

Parameters

string

$name

变量名

Returns

mixed

getOption()

getOption(string  $name = '') : mixed

获取路由参数定义

Parameters

string

$name

参数名

Returns

mixed

append()

append(array  $append = array()) : $this

附加路由隐式参数

Parameters

array

$append

Returns

$this

method()

method(string  $method) : $this

设置路由请求类型

Parameters

string

$method

Returns

$this

before()

before(array|\Closure  $before) : $this

设置路由前置行为

Parameters

array|\Closure

$before

Returns

$this

after()

after(array|\Closure  $after) : $this

设置路由后置行为

Parameters

array|\Closure

$after

Returns

$this

ext()

ext(string  $ext = '') : $this

检查后缀

Parameters

string

$ext

Returns

$this

denyExt()

denyExt(string  $ext = '') : $this

检查禁止后缀

Parameters

string

$ext

Returns

$this

domain()

domain(string  $domain) : $this

检查域名

Parameters

string

$domain

Returns

$this

model()

model(array|string  $var, string|\Closure  $model = null, boolean  $exception = true) : $this

绑定模型

Parameters

array\|string	$var	路由变量名多个使用 & 分割
string\|\Closure	$model	绑定模型类
boolean	$exception	是否抛出异常

Returns

$this

validate()

validate(mixed  $validate, string  $scene = null, array  $message = array(), boolean  $batch = false) : $this

绑定验证

Parameters

mixed	$validate	验证器类
string	$scene	验证场景
array	$message	验证提示
boolean	$batch	批量验证

Returns

$this

response()

response(mixed  $response) : $this

绑定Response对象

Parameters

mixed

$response

Returns

$this

header()

header(  $header, string  $value = null) : $this

设置Response Header信息

Parameters

	$header
string	$value	参数值

Returns

$this

cache()

cache(array|string  $cache) : $this

设置路由缓存

Parameters

array|string

$cache

Returns

$this

depr()

depr(boolean  $depr) : $this

检查URL分隔符

Parameters

boolean

$depr

Returns

$this

mergeExtraVars()

mergeExtraVars(boolean  $merge = true) : $this

是否合并额外参数

Parameters

boolean

$merge

Returns

$this

mergeOptions()

mergeOptions(array  $option = array()) : $this

设置需要合并的路由参数

Parameters

array

$option

Returns

$this

https()

https(boolean  $https = true) : $this

检查是否为HTTPS请求

Parameters

boolean

$https

Returns

$this

ajax()

ajax(boolean  $ajax = true) : $this

检查是否为AJAX请求

Parameters

boolean

$ajax

Returns

$this

pjax()

pjax(boolean  $pjax = true) : $this

检查是否为PJAX请求

Parameters

boolean

$pjax

Returns

$this

view()

view(boolean|array  $view = true) : $this

当前路由到一个模板地址当使用数组的时候可以传入模板变量

Parameters

boolean|array

$view

Returns

$this

redirect()

redirect(boolean  $redirect = true) : $this

当前路由为重定向

Parameters

boolean

$redirect

是否为重定向

Returns

$this

completeMatch()

completeMatch(boolean  $match = true) : $this

设置路由完整匹配

Parameters

boolean

$match

Returns

$this

removeSlash()

removeSlash(boolean  $remove = true) : $this

是否去除URL最后的斜线

Parameters

boolean

$remove

Returns

$this

allowCrossDomain()

allowCrossDomain(boolean  $allow = true, array  $header = array()) : $this

设置是否允许跨域

Parameters

boolean	$allow
array	$header

Returns

$this

crossDomainRule()

crossDomainRule() : $this

设置路由规则全局有效

Returns

$this

parseRule()

parseRule(\think\Request  $request, string  $rule, string  $route, string  $url, array  $option = array(), array  $matches = array()) : \think\route\Dispatch

解析匹配到的规则路由

Parameters

\think\Request	$request	请求对象
string	$rule	路由规则
string	$route	路由地址
string	$url	URL地址
array	$option	路由参数
array	$matches	匹配的变量

Returns

\think\route\Dispatch

__call()

__call(string  $method, array  $args) : $this

设置路由参数

Parameters

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

Returns

$this

checkCrossDomain()

checkCrossDomain(\think\Request  $request) : \think\route\Dispatch|void

检查OPTIONS请求

Parameters

\think\Request

$request

Returns

\think\route\Dispatch|void

mergeGroupOptions()

mergeGroupOptions() : void

合并分组参数

createBindModel()

createBindModel(array|\Clousre  $bindModel, array  $matches) : void

路由绑定模型实例

Parameters

array\|\Clousre	$bindModel	绑定模型
array	$matches	路由变量

parseRequestCache()

parseRequestCache(\think\Request  $request, string|array  $cache) : void

处理路由请求缓存

Parameters

\think\Request	$request	请求对象
string\|array	$cache	路由缓存

autoValidate()

autoValidate(array  $option, \think\Request  $request) : void

验证数据

Parameters

array	$option
\think\Request	$request

Throws

\think\exception\ValidateException

checkBefore()

checkBefore(mixed  $before) : mixed

检查路由前置行为

Parameters

mixed

$before

前置行为

Returns

mixed

checkAfter()

checkAfter(mixed  $after) : mixed

检查路由后置行为

Parameters

mixed

$after

后置行为

Returns

mixed

dispatch()

dispatch(\think\Request  $request, mixed  $route, array  $option) : \think\route\Dispatch

发起路由调度

Parameters

\think\Request	$request	Request对象
mixed	$route	路由地址
array	$option	路由参数

Returns

\think\route\Dispatch

parseModule()

parseModule(string  $url) : array

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

Parameters

string

$url

URL地址

Returns

array

checkOption()

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

路由检查

Parameters

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

Returns

boolean

parseUrlParams()

parseUrlParams(  $url, array  $var = array()) : void

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

Parameters

	$url
array	$var	变量

parseUrlPath()

parseUrlPath(string  $url) : array

解析URL的pathinfo参数和变量

Parameters

string

$url

URL地址

Returns

array