\thinkRequest

Summary

Methods
Properties
Constants
__construct()
init()
config()
__make()
__call()
hook()
create()
domain()
rootDomain()
subDomain()
setPanDomain()
panDomain()
setUrl()
url()
setBaseUrl()
baseUrl()
baseFile()
setRoot()
root()
rootUrl()
setPathinfo()
pathinfo()
path()
ext()
time()
type()
mimeType()
method()
isGet()
isPost()
isPut()
isDelete()
isHead()
isPatch()
isOptions()
isCli()
isCgi()
param()
setRouteVars()
route()
get()
post()
put()
delete()
patch()
request()
session()
cookie()
server()
file()
env()
header()
arrayReset()
input()
filter()
has()
only()
except()
isSsl()
isJson()
isAjax()
isPjax()
ip()
isMobile()
scheme()
query()
setHost()
host()
port()
protocol()
remotePort()
contentType()
routeInfo()
dispatch()
secureKey()
setModule()
setController()
setAction()
module()
controller()
action()
setLangset()
langset()
getContent()
getInput()
token()
cache()
getCache()
withGet()
withPost()
withInput()
withFiles()
withCookie()
withServer()
withHeader()
withEnv()
withRoute()
__set()
__get()
__isset()
__debugInfo()
No public properties found
No constants found
getInputData()
dealUploadFile()
throwUploadFileError()
getData()
getFilter()
$config
$method
$host
$domain
$subDomain
$panDomain
$url
$baseUrl
$baseFile
$root
$pathinfo
$path
$routeInfo
$dispatch
$module
$controller
$action
$langset
$param
$get
$post
$request
$route
$put
$session
$file
$cookie
$server
$env
$header
$mimeType
$content
$filter
$hook
$input
$cache
$isCheckCache
$secureKey
$mergeParam
N/A
filterValue()
typeCast()
No private properties found
N/A

Properties

$config

$config : array

配置参数

Type

array

$method

$method : string

请求类型

Type

string

$host

$host : string

主机名(含端口)

Type

string

$domain

$domain : string

域名(含协议及端口)

Type

string

$subDomain

$subDomain : string

子域名

Type

string

$panDomain

$panDomain : string

泛域名

Type

string

$url

$url : string

当前URL地址

Type

string

$baseUrl

$baseUrl : string

基础URL

Type

string

$baseFile

$baseFile : string

当前执行的文件

Type

string

$root

$root : string

访问的ROOT地址

Type

string

$pathinfo

$pathinfo : string

pathinfo

Type

string

$path

$path : string

pathinfo(不含后缀)

Type

string

$routeInfo

$routeInfo : array

当前路由信息

Type

array

$module

$module : string

当前模块名

Type

string

$controller

$controller : string

当前控制器名

Type

string

$action

$action : string

当前操作名

Type

string

$langset

$langset : string

当前语言集

Type

string

$param

$param : array

当前请求参数

Type

array

$get

$get : array

当前GET参数

Type

array

$post

$post : array

当前POST参数

Type

array

$request

$request : array

当前REQUEST参数

Type

array

$route

$route : array

当前ROUTE参数

Type

array

$put

$put : array

当前PUT参数

Type

array

$session

$session : array

当前SESSION参数

Type

array

$file

$file : array

当前FILE参数

Type

array

$cookie

$cookie : array

当前COOKIE参数

Type

array

$server

$server : array

当前SERVER参数

Type

array

$env

$env : array

当前ENV参数

Type

array

$header

$header : array

当前HEADER参数

Type

array

$mimeType

$mimeType : array

资源类型定义

Type

array

$content

$content : string

当前请求内容

Type

string

$filter

$filter : array

全局过滤规则

Type

array

$hook

$hook : array

扩展方法

Type

array

$input

$input : string

php://input内容

Type

string

$cache

$cache : array

请求缓存

Type

array

$isCheckCache

$isCheckCache : boolean

缓存是否检查

Type

boolean

$secureKey

$secureKey : string

请求安全Key

Type

string

$mergeParam

$mergeParam : boolean

是否合并Param

Type

boolean

Methods

__construct()

__construct(array  $options = array()) 

架构函数

Parameters

array $options

参数

init()

init(array  $options = array()) 

Parameters

array $options

config()

config(  $name = null) 

Parameters

$name

__call()

__call(  $method,   $args) 

Parameters

$method
$args

hook()

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

Hook 方法注入

Parameters

string|array $method

方法名

mixed $callback

callable

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(boolean  $port = false) : string

获取当前包含协议、端口的域名

Parameters

boolean $port

是否需要去除端口号

Returns

string

rootDomain()

rootDomain() : string

获取当前根域名

Returns

string

subDomain()

subDomain() : string

获取当前子域名

Returns

string

setPanDomain()

setPanDomain(string  $domain) : $this

设置当前泛域名的值

Parameters

string $domain

域名

Returns

$this

panDomain()

panDomain() : string

获取当前泛域名的值

Returns

string

setUrl()

setUrl(string  $url) : $this

设置当前完整URL 包括QUERY_STRING

Parameters

string $url

URL

Returns

$this

url()

url(boolean  $complete = false) : string

获取当前完整URL 包括QUERY_STRING

Parameters

boolean $complete

是否包含域名

Returns

string

setBaseUrl()

setBaseUrl(string  $url) : $this

设置当前完整URL 不包括QUERY_STRING

Parameters

string $url

URL

Returns

$this

baseUrl()

baseUrl(boolean  $domain = false) : string|$this

获取当前URL 不含QUERY_STRING

Parameters

boolean $domain

是否包含域名

Returns

string|$this

baseFile()

baseFile(boolean  $domain = false) : string|$this

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

Parameters

boolean $domain

是否包含域名

Returns

string|$this

setRoot()

setRoot(string  $url = null) : string|$this

设置URL访问根地址

Parameters

string $url

URL地址

Returns

string|$this

root()

root(boolean  $domain = false) : string|$this

获取URL访问根地址

Parameters

boolean $domain

是否包含域名

Returns

string|$this

rootUrl()

rootUrl() : string

获取URL访问根目录

Returns

string

setPathinfo()

setPathinfo(  $pathinfo) 

Parameters

$pathinfo

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  $origin = false) : string

当前的请求类型

Parameters

boolean $origin

是否获取原始请求类型

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(mixed  $name = '', mixed  $default = null, string|array  $filter = '') : mixed

获取当前请求的参数

Parameters

mixed $name

变量名

mixed $default

默认值

string|array $filter

过滤方法

Returns

mixed

setRouteVars()

setRouteVars(array  $route) : $this

设置路由变量

Parameters

array $route

路由变量

Returns

$this

route()

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

获取路由参数

Parameters

string|false $name

变量名

mixed $default

默认值

string|array $filter

过滤方法

Returns

mixed

get()

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

获取GET参数

Parameters

string|false $name

变量名

mixed $default

默认值

string|array $filter

过滤方法

Returns

mixed

post()

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

获取POST参数

Parameters

string|false $name

变量名

mixed $default

默认值

string|array $filter

过滤方法

Returns

mixed

put()

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

获取PUT参数

Parameters

string|false $name

变量名

mixed $default

默认值

string|array $filter

过滤方法

Returns

mixed

delete()

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

获取DELETE参数

Parameters

string|false $name

变量名

mixed $default

默认值

string|array $filter

过滤方法

Returns

mixed

patch()

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

获取PATCH参数

Parameters

string|false $name

变量名

mixed $default

默认值

string|array $filter

过滤方法

Returns

mixed

request()

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

获取request变量

Parameters

string|false $name

变量名

mixed $default

默认值

string|array $filter

过滤方法

Returns

mixed

session()

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

获取session数据

Parameters

string $name

数据名称

string $default

默认值

Returns

mixed

cookie()

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

获取cookie参数

Parameters

string $name

变量名

string $default

默认值

string|array $filter

过滤方法

Returns

mixed

server()

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

获取server参数

Parameters

string $name

数据名称

string $default

默认值

Returns

mixed

file()

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

获取上传的文件信息

Parameters

string $name

名称

Returns

null|array|\think\File

env()

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

获取环境变量

Parameters

string $name

数据名称

string $default

默认值

Returns

mixed

header()

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

获取当前的Header

Parameters

string $name

header名称

string $default

默认值

Returns

string|array

arrayReset()

arrayReset(array  $data) : void

递归重置数组指针

Parameters

array $data

数据源

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

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

isJson()

isJson() : boolean

当前是否JSON请求

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

setHost()

setHost(string  $host) : $this

设置当前请求的host(包含端口)

Parameters

string $host

主机名(含端口)

Returns

$this

host()

host(boolean  $strict = false) : string

当前请求的host

Parameters

boolean $strict

true 仅仅获取HOST

Returns

string

port()

port() : integer

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

Returns

integer

protocol()

protocol() : string

当前请求 SERVER_PROTOCOL

Returns

string

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(\think\route\Dispatch  $dispatch = null) : \think\route\Dispatch

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

Parameters

\think\route\Dispatch $dispatch

调度信息

Returns

\think\route\Dispatch

secureKey()

secureKey() : string

获取当前请求的安全Key

Returns

string

setModule()

setModule(string  $module) : $this

设置当前的模块名

Parameters

string $module

模块名

Returns

$this

setController()

setController(string  $controller) : $this

设置当前的控制器名

Parameters

string $controller

控制器名

Returns

$this

setAction()

setAction(string  $action) : $this

设置当前的操作名

Parameters

string $action

操作名

Returns

$this

module()

module() : string

获取当前的模块名

Returns

string

controller()

controller(boolean  $convert = false) : string

获取当前的控制器名

Parameters

boolean $convert

转换为小写

Returns

string

action()

action(boolean  $convert = false) : string

获取当前的操作名

Parameters

boolean $convert

转换为驼峰

Returns

string

setLangset()

setLangset(string  $lang) : $this

设置当前的语言

Parameters

string $lang

语言名

Returns

$this

langset()

langset() : string

获取当前的语言

Returns

string

getContent()

getContent() : string

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

Returns

string

getInput()

getInput() : string

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

Returns

string

token()

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

生成请求令牌

Parameters

string $name

令牌名称

mixed $type

令牌生成方法

Returns

string

cache()

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

设置当前地址的请求缓存

Parameters

string $key

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

mixed $expire

缓存有效期

array $except

缓存排除

string $tag

缓存标签

Returns

mixed

getCache()

getCache() : array

读取请求缓存设置

Returns

array

withGet()

withGet(array  $get) : $this

设置GET数据

Parameters

array $get

数据

Returns

$this

withPost()

withPost(array  $post) : $this

设置POST数据

Parameters

array $post

数据

Returns

$this

withInput()

withInput(string  $input) : $this

设置php://input数据

Parameters

string $input

RAW数据

Returns

$this

withFiles()

withFiles(array  $files) : $this

设置文件上传数据

Parameters

array $files

上传信息

Returns

$this

withCookie()

withCookie(array  $cookie) : $this

设置COOKIE数据

Parameters

array $cookie

数据

Returns

$this

withServer()

withServer(array  $server) : $this

设置SERVER数据

Parameters

array $server

数据

Returns

$this

withHeader()

withHeader(array  $header) : $this

设置HEADER数据

Parameters

array $header

数据

Returns

$this

withEnv()

withEnv(array  $env) : $this

设置ENV数据

Parameters

array $env

数据

Returns

$this

withRoute()

withRoute(array  $route) : $this

设置ROUTE变量

Parameters

array $route

数据

Returns

$this

__set()

__set(string  $name, mixed  $value) 

设置请求数据

Parameters

string $name

参数名

mixed $value

__get()

__get(string  $name) : mixed

获取请求数据的值

Parameters

string $name

参数名

Returns

mixed

__isset()

__isset(string  $name) : boolean

检测请求数据的值

Parameters

string $name

名称

Returns

boolean

__debugInfo()

__debugInfo() 

getInputData()

getInputData(  $content) 

Parameters

$content

dealUploadFile()

dealUploadFile(  $files,   $name) 

Parameters

$files
$name

throwUploadFileError()

throwUploadFileError(  $error) 

Parameters

$error

getData()

getData(array  $data, string|false  $name) : mixed

获取数据

Parameters

array $data

数据源

string|false $name

字段名

Returns

mixed

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