Properties

$instance

$instance : object

Type

object — 对象实例

$method

$method : 

Type

$domain

$domain : string

Type

string — 域名(含协议和端口)

$url

$url : string

Type

string — URL地址

$baseUrl

$baseUrl : string

Type

string — 基础URL

$baseFile

$baseFile : string

Type

string — 当前执行的文件

$root

$root : string

Type

string — 访问的ROOT地址

$pathinfo

$pathinfo : string

Type

string — pathinfo

$path

$path : string

Type

string — pathinfo(不含后缀)

$routeInfo

$routeInfo : array

Type

array — 当前路由信息

$env

$env : array

Type

array — 环境变量

$dispatch

$dispatch : array

Type

array — 当前调度信息

$module

$module : 

Type

$controller

$controller : 

Type

$action

$action : 

Type

$langset

$langset : 

Type

$param

$param : array

Type

array — 请求参数

$get

$get : 

Type

$post

$post : 

Type

$request

$request : 

Type

$route

$route : 

Type

$put

$put : 

Type

$session

$session : 

Type

$file

$file : 

Type

$cookie

$cookie : 

Type

$server

$server : 

Type

$header

$header : 

Type

$mimeType

$mimeType : array

Type

array — 资源类型

$content

$content : 

Type

$filter

$filter : 

Type

$hook

$hook : 

Type

$bind

$bind : 

Type

$input

$input : 

Type

$cache

$cache : 

Type

$isCheckCache

$isCheckCache : 

Type

Methods

__call()

__call(  $method,   $args) 

Parameters

$method
$args

hook()

hook(string|array  $method, mixed  $callback = null) : void

Hook 方法注入

Parameters

string|array $method

方法名

mixed $callback

callable

instance()

instance(array  $options = array()) : \think\Request

初始化

Parameters

array $options

参数

Returns

\think\Request

create()

create(string  $uri, string  $method = 'GET', array  $params = array(), array  $cookie = array(), array  $files = array(), array  $server = array(), string  $content = null) : \think\Request

创建一个URL请求

Parameters

string $uri

URL地址

string $method

请求类型

array $params

请求参数

array $cookie
array $files
array $server
string $content

Returns

\think\Request

domain()

domain(string  $domain = null) : string

设置或获取当前包含协议的域名

Parameters

string $domain

域名

Returns

string

url()

url(string|true  $url = null) : string

设置或获取当前完整URL 包括QUERY_STRING

Parameters

string|true $url

URL地址 true 带域名获取

Returns

string

baseUrl()

baseUrl(string  $url = null) : string

设置或获取当前URL 不含QUERY_STRING

Parameters

string $url

URL地址

Returns

string

baseFile()

baseFile(string  $file = null) : string

设置或获取当前执行的文件 SCRIPT_NAME

Parameters

string $file

当前执行的文件

Returns

string

root()

root(string  $url = null) : string

设置或获取URL访问根地址

Parameters

string $url

URL地址

Returns

string

pathinfo()

pathinfo() : string

获取当前请求URL的pathinfo信息(含URL后缀)

Returns

string

path()

path() : string

获取当前请求URL的pathinfo信息(不含URL后缀)

Returns

string

ext()

ext() : string

当前URL的访问后缀

Returns

string

time()

time(boolean  $float = false) : integer|float

获取当前请求的时间

Parameters

boolean $float

是否使用浮点类型

Returns

integer|float

type()

type() : false|string

当前请求的资源类型

Returns

false|string

mimeType()

mimeType(string|array  $type, string  $val = '') : void

设置资源类型

Parameters

string|array $type

资源类型名

string $val

资源类型

method()

method(boolean  $method = false) : string

当前的请求类型

Parameters

boolean $method

true 获取原始请求类型

Returns

string

isGet()

isGet() : boolean

是否为GET请求

Returns

boolean

isPost()

isPost() : boolean

是否为POST请求

Returns

boolean

isPut()

isPut() : boolean

是否为PUT请求

Returns

boolean

isDelete()

isDelete() : boolean

是否为DELTE请求

Returns

boolean

isHead()

isHead() : boolean

是否为HEAD请求

Returns

boolean

isPatch()

isPatch() : boolean

是否为PATCH请求

Returns

boolean

isOptions()

isOptions() : boolean

是否为OPTIONS请求

Returns

boolean

isCli()

isCli() : boolean

是否为cli

Returns

boolean

isCgi()

isCgi() : boolean

是否为cgi

Returns

boolean

param()

param(string|array  $name = '', mixed  $default = null, string|array  $filter = '') : mixed

获取当前请求的参数

Parameters

string|array $name

变量名

mixed $default

默认值

string|array $filter

过滤方法

Returns

mixed

route()

route(string|array  $name = '', mixed  $default = null, string|array  $filter = '') : mixed

设置获取路由参数

Parameters

string|array $name

变量名

mixed $default

默认值

string|array $filter

过滤方法

Returns

mixed

get()

get(string|array  $name = '', mixed  $default = null, string|array  $filter = '') : mixed

设置获取GET参数

Parameters

string|array $name

变量名

mixed $default

默认值

string|array $filter

过滤方法

Returns

mixed

post()

post(string  $name = '', mixed  $default = null, string|array  $filter = '') : mixed

设置获取POST参数

Parameters

string $name

变量名

mixed $default

默认值

string|array $filter

过滤方法

Returns

mixed

put()

put(string|array  $name = '', mixed  $default = null, string|array  $filter = '') : mixed

设置获取PUT参数

Parameters

string|array $name

变量名

mixed $default

默认值

string|array $filter

过滤方法

Returns

mixed

delete()

delete(string|array  $name = '', mixed  $default = null, string|array  $filter = '') : mixed

设置获取DELETE参数

Parameters

string|array $name

变量名

mixed $default

默认值

string|array $filter

过滤方法

Returns

mixed

patch()

patch(string|array  $name = '', mixed  $default = null, string|array  $filter = '') : mixed

设置获取PATCH参数

Parameters

string|array $name

变量名

mixed $default

默认值

string|array $filter

过滤方法

Returns

mixed

request()

request(string  $name = '', string  $default = null, string|array  $filter = '') : mixed

获取request变量

Parameters

string $name

数据名称

string $default

默认值

string|array $filter

过滤方法

Returns

mixed

session()

session(string|array  $name = '', string  $default = null, string|array  $filter = '') : mixed

获取session数据

Parameters

string|array $name

数据名称

string $default

默认值

string|array $filter

过滤方法

Returns

mixed

cookie()

cookie(string|array  $name = '', string  $default = null, string|array  $filter = '') : mixed

获取cookie参数

Parameters

string|array $name

数据名称

string $default

默认值

string|array $filter

过滤方法

Returns

mixed

server()

server(string|array  $name = '', string  $default = null, string|array  $filter = '') : mixed

获取server参数

Parameters

string|array $name

数据名称

string $default

默认值

string|array $filter

过滤方法

Returns

mixed

file()

file(string|array  $name = '') : null|array|\think\File

获取上传的文件信息

Parameters

string|array $name

名称

Returns

null|array|\think\File

env()

env(string|array  $name = '', string  $default = null, string|array  $filter = '') : mixed

获取环境变量

Parameters

string|array $name

数据名称

string $default

默认值

string|array $filter

过滤方法

Returns

mixed

header()

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

设置或者获取当前的Header

Parameters

string|array $name

header名称

string $default

默认值

Returns

string

input()

input(array  $data = array(), string|false  $name = '', mixed  $default = null, string|array  $filter = '') : mixed

获取变量 支持过滤和默认值

Parameters

array $data

数据源

string|false $name

字段名

mixed $default

默认值

string|array $filter

过滤函数

Returns

mixed

filter()

filter(mixed  $filter = null) : mixed

设置或获取当前的过滤规则

Parameters

mixed $filter

过滤规则

Returns

mixed

filterExp()

filterExp(string  $value) : void

过滤表单中的表达式

Parameters

string $value

has()

has(string  $name, string  $type = 'param', boolean  $checkEmpty = false) : mixed

是否存在某个请求参数

Parameters

string $name

变量名

string $type

变量类型

boolean $checkEmpty

是否检测空值

Returns

mixed

only()

only(string|array  $name, string  $type = 'param') : mixed

获取指定的参数

Parameters

string|array $name

变量名

string $type

变量类型

Returns

mixed

except()

except(string|array  $name, string  $type = 'param') : mixed

排除指定参数获取

Parameters

string|array $name

变量名

string $type

变量类型

Returns

mixed

isSsl()

isSsl() : boolean

当前是否ssl

Returns

boolean

isAjax()

isAjax(boolean  $ajax = false) : boolean

当前是否Ajax请求

Parameters

boolean $ajax

true 获取原始ajax请求

Returns

boolean

isPjax()

isPjax(boolean  $pjax = false) : boolean

当前是否Pjax请求

Parameters

boolean $pjax

true 获取原始pjax请求

Returns

boolean

ip()

ip(integer  $type, boolean  $adv = true) : mixed

获取客户端IP地址

Parameters

integer $type

返回类型 0 返回IP地址 1 返回IPV4地址数字

boolean $adv

是否进行高级模式获取(有可能被伪装)

Returns

mixed

isMobile()

isMobile() : boolean

检测是否使用手机访问

Returns

boolean

scheme()

scheme() : string

当前URL地址中的scheme参数

Returns

string

query()

query() : string

当前请求URL地址中的query参数

Returns

string

host()

host(boolean  $strict = false) : string

当前请求的host

Parameters

boolean $strict

true 仅仅获取HOST

Returns

string

port()

port() : integer

当前请求URL地址中的port参数

Returns

integer

protocol()

protocol() : integer

当前请求 SERVER_PROTOCOL

Returns

integer

remotePort()

remotePort() : integer

当前请求 REMOTE_PORT

Returns

integer

contentType()

contentType() : string

当前请求 HTTP_CONTENT_TYPE

Returns

string

routeInfo()

routeInfo(array  $route = array()) : array

获取当前请求的路由信息

Parameters

array $route

路由名称

Returns

array

dispatch()

dispatch(array  $dispatch = null) : array

设置或者获取当前请求的调度信息

Parameters

array $dispatch

调度信息

Returns

array

module()

module(string  $module = null) : string|\think\Request

设置或者获取当前的模块名

Parameters

string $module

模块名

Returns

string|\think\Request

controller()

controller(string  $controller = null) : string|\think\Request

设置或者获取当前的控制器名

Parameters

string $controller

控制器名

Returns

string|\think\Request

action()

action(string  $action = null) : string|\think\Request

设置或者获取当前的操作名

Parameters

string $action

操作名

Returns

string|\think\Request

langset()

langset(string  $lang = null) : string|\think\Request

设置或者获取当前的语言

Parameters

string $lang

语言名

Returns

string|\think\Request

getContent()

getContent() : string

设置或者获取当前请求的content

Returns

string

getInput()

getInput() : string

获取当前请求的php://input

Returns

string

token()

token(string  $name = '__token__', mixed  $type = 'md5') : string

生成请求令牌

Parameters

string $name

令牌名称

mixed $type

令牌生成方法

Returns

string

cache()

cache(string  $key, mixed  $expire = null, array  $except = array(), string  $tag = null) : void

设置当前地址的请求缓存

Parameters

string $key

缓存标识,支持变量规则 ,例如 item/:name/:id

mixed $expire

缓存有效期

array $except

缓存排除

string $tag

缓存标签

getCache()

getCache() : array

读取请求缓存设置

Returns

array

bind()

bind(string|array  $name, mixed  $obj = null) : mixed

设置当前请求绑定的对象实例

Parameters

string|array $name

绑定的对象标识

mixed $obj

绑定的对象实例

Returns

mixed

__set()

__set(  $name,   $value) 

Parameters

$name
$value

__get()

__get(  $name) 

Parameters

$name

__isset()

__isset(  $name) 

Parameters

$name

__construct()

__construct(array  $options = array()) 

构造函数

Parameters

array $options

参数

getFilter()

getFilter(  $filter,   $default) 

Parameters

$filter
$default

filterValue()

filterValue(mixed  $value, mixed  $key, array  $filters) : mixed

递归过滤给定的值

Parameters

mixed $value

键值

mixed $key

键名

array $filters

过滤方法+默认值

Returns

mixed

typeCast()

typeCast(string  $data, string  $type) : mixed

强制类型转换

Parameters

string $data
string $type

Returns

mixed