\thinkRequest

请求管理类

Summary

Methods

Properties

Constants

__construct()
__make()
setDomain()
domain()
rootDomain()
setSubDomain()
subDomain()
setPanDomain()
panDomain()
setUrl()
url()
setBaseUrl()
baseUrl()
baseFile()
setRoot()
root()
rootUrl()
setPathinfo()
pathinfo()
ext()
time()
type()
mimeType()
setMethod()
method()
isGet()
isPost()
isPut()
isDelete()
isHead()
isPatch()
isOptions()
isCli()
isCgi()
param()
setRule()
rule()
setRoute()
route()
get()
middleware()
post()
put()
delete()
patch()
request()
env()
session()
cookie()
server()
file()
header()
input()
filter()
filterValue()
has()
only()
except()
isSsl()
isJson()
isAjax()
isPjax()
ip()
isValidIP()
ip2bin()
isMobile()
scheme()
query()
setHost()
host()
port()
protocol()
remotePort()
contentType()
secureKey()
setController()
setAction()
controller()
action()
getContent()
getInput()
buildToken()
checkToken()
withMiddleware()
withGet()
withPost()
withCookie()
withSession()
withServer()
withHeader()
withEnv()
withInput()
withFiles()
withRoute()
__set()
__get()
__isset()
offsetExists()
offsetGet()
offsetSet()
offsetUnset()

No public properties found

No constants found

getInputData()
dealUploadFile()
throwUploadFileError()
filterData()
getData()
getFilter()

$pathinfoFetch
$varPathinfo
$varMethod
$varAjax
$varPjax
$rootDomain
$httpsAgentName
$proxyServerIp
$proxyServerIpHeader
$method
$domain
$host
$subDomain
$panDomain
$url
$baseUrl
$baseFile
$root
$pathinfo
$path
$realIP
$controller
$action
$param
$get
$post
$request
$rule
$route
$middleware
$put
$session
$cookie
$env
$server
$file
$header
$mimeType
$content
$filter
$input
$secureKey
$mergeParam

N/A

typeCast()

No private properties found

N/A

File: vendor/topthink/framework/src/think/Request.php
Package: think
Class hierarchy: \think\Request
Implements
Uses

Properties

$pathinfoFetch

$pathinfoFetch : array

兼容PATH_INFO获取

Type

array —

$varPathinfo

$varPathinfo : string

PATHINFO变量名用于兼容模式

Type

string —

$varMethod

$varMethod : string

请求类型

Type

string —

$varAjax

$varAjax : string

表单ajax伪装变量

Type

string —

$varPjax

$varPjax : string

表单pjax伪装变量

Type

string —

$rootDomain

$rootDomain : string

域名根

Type

string —

$httpsAgentName

$httpsAgentName : string

HTTPS代理标识

Type

string —

$proxyServerIp

$proxyServerIp : array

前端代理服务器IP

Type

array —

$proxyServerIpHeader

$proxyServerIpHeader : array

前端代理服务器真实IP头

Type

array —

$method

$method : string

请求类型

Type

string —

$domain

$domain : string

域名（含协议及端口）

Type

string —

$host

$host : string

HOST（含端口）

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 —

$realIP

$realIP : string

当前请求的IP地址

Type

string —

$controller

$controller : string

当前控制器名

Type

string —

$action

$action : 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 —

$rule

$rule : \think\route\Rule

当前路由对象

Type

Rule —

$route

$route : array

当前ROUTE参数

Type

array —

$middleware

$middleware : array

中间件传递的参数

Type

array —

$put

$put : array

当前PUT参数

Type

array —

$session

$session : \think\Session

SESSION对象

Type

Session —

$cookie

$cookie : array

COOKIE数据

Type

array —

$env

$env : \think\Env

ENV对象

Type

Env —

$server

$server : array

当前SERVER参数

Type

array —

$file

$file : array

当前FILE参数

Type

array —

$header

$header : array

当前HEADER参数

Type

array —

$mimeType

$mimeType : array

资源类型定义

Type

array —

$content

$content : string

当前请求内容

Type

string —

$filter

$filter : array

全局过滤规则

Type

array —

$input

$input : string

php://input内容

Type

string —

$secureKey

$secureKey : string

请求安全Key

Type

string —

$mergeParam

$mergeParam : bool

是否合并Param

Type

bool —

Methods

__construct()

__construct() : mixed

架构函数

Returns

mixed —

__make()

__make(\think\App  $app) : mixed

Parameters

\think\App

$app

Returns

mixed —

setDomain()

setDomain(string  $domain) : $this

设置当前包含协议的域名

Parameters

string

$domain

域名

Returns

$this —

domain()

domain(bool  $port = false) : string

获取当前包含协议的域名

Parameters

bool

$port

是否需要去除端口号

Returns

string —

rootDomain()

rootDomain() : string

获取当前根域名

Returns

string —

setSubDomain()

setSubDomain(string  $domain) : $this

设置当前泛域名的值

Parameters

string

$domain

域名

Returns

$this —

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(bool  $complete = false) : string

获取当前完整URL 包括QUERY_STRING

Parameters

bool

$complete

是否包含完整域名

Returns

string —

setBaseUrl()

setBaseUrl(string  $url) : $this

设置当前URL 不含QUERY_STRING

Parameters

string

$url

URL地址

Returns

$this —

baseUrl()

baseUrl(bool  $complete = false) : string

获取当前URL 不含QUERY_STRING

Parameters

bool

$complete

是否包含完整域名

Returns

string —

baseFile()

baseFile(bool  $complete = false) : string

获取当前执行的文件 SCRIPT_NAME

Parameters

bool

$complete

是否包含完整域名

Returns

string —

setRoot()

setRoot(string  $url) : $this

设置URL访问根地址

Parameters

string

$url

URL地址

Returns

$this —

root()

root(bool  $complete = false) : string

获取URL访问根地址

Parameters

bool

$complete

是否包含完整域名

Returns

string —

rootUrl()

rootUrl() : string

获取URL访问根目录

Returns

string —

setPathinfo()

setPathinfo(string  $pathinfo) : $this

设置当前请求的pathinfo

Parameters

string

$pathinfo

Returns

$this —

pathinfo()

pathinfo() : string

获取当前请求URL的pathinfo信息（含URL后缀）

Returns

string —

ext()

ext() : string

当前URL的访问后缀

Returns

string —

time()

time(bool  $float = false) : int|float

获取当前请求的时间

Parameters

bool

$float

是否使用浮点类型

Returns

int|float —

type()

type() : string

当前请求的资源类型

Returns

string —

mimeType()

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

设置资源类型

Parameters

string\|array	$type	资源类型名
string	$val	资源类型

setMethod()

setMethod(string  $method) : $this

设置请求类型

Parameters

string

$method

请求类型

Returns

$this —

method()

method(bool  $origin = false) : string

当前的请求类型

Parameters

bool

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

获取当前请求的参数

Parameters

string\|array	$name	变量名
mixed	$default	默认值
string\|array	$filter	过滤方法

Returns

mixed —

setRule()

setRule(\think\route\Rule  $rule) : $this

设置路由变量

Parameters

\think\route\Rule

$rule

路由对象

Returns

$this —

rule()

rule() : \think\route\Rule|null

获取当前路由对象

Returns

\think\route\Rule|null —

setRoute()

setRoute(array  $route) : $this

设置路由变量

Parameters

array

$route

路由变量

Returns

$this —

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 —

middleware()

middleware(mixed  $name, mixed  $default = null) : mixed

获取中间件传递的参数

Parameters

mixed	$name	变量名
mixed	$default	默认值

Returns

mixed —

post()

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

获取POST参数

Parameters

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

设置获取DELETE参数

Parameters

mixed	$name	变量名
mixed	$default	默认值
string\|array	$filter	过滤方法

Returns

mixed —

patch()

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

设置获取PATCH参数

Parameters

mixed	$name	变量名
mixed	$default	默认值
string\|array	$filter	过滤方法

Returns

mixed —

request()

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

获取request变量

Parameters

string\|array	$name	数据名称
mixed	$default	默认值
string\|array	$filter	过滤方法

Returns

mixed —

env()

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

获取环境变量

Parameters

string	$name	数据名称
string	$default	默认值

Returns

mixed —

session()

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

获取session数据

Parameters

string	$name	数据名称
string	$default	默认值

Returns

mixed —

cookie()

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

获取cookie参数

Parameters

mixed	$name	数据名称
string	$default	默认值
string\|array	$filter	过滤方法

Returns

mixed —

server()

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

获取server参数

Parameters

string	$name	数据名称
string	$default	默认值

Returns

mixed —

file()

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

获取上传的文件信息

Parameters

string

$name

名称

Returns

null|array|\think\file\UploadedFile —

header()

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

设置或者获取当前的Header

Parameters

string	$name	header名称
string	$default	默认值

Returns

string|array —

input()

input(array  $data = [], 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 —

filterValue()

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

递归过滤给定的值

Parameters

mixed	$value	键值
mixed	$key	键名
array	$filters	过滤方法+默认值

Returns

mixed —

has()

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

是否存在某个请求参数

Parameters

string	$name	变量名
string	$type	变量类型
bool	$checkEmpty	是否检测空值

Returns

bool —

only()

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

获取指定的参数

Parameters

array	$name	变量名
mixed	$data	数据或者变量类型
string\|array	$filter	过滤方法

Returns

array —

except()

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

排除指定参数获取

Parameters

array	$name	变量名
string	$type	变量类型

Returns

mixed —

isSsl()

isSsl() : bool

当前是否ssl

Returns

bool —

isJson()

isJson() : bool

当前是否JSON请求

Returns

bool —

isAjax()

isAjax(bool  $ajax = false) : bool

当前是否Ajax请求

Parameters

bool

$ajax

true 获取原始ajax请求

Returns

bool —

isPjax()

isPjax(bool  $pjax = false) : bool

当前是否Pjax请求

Parameters

bool

$pjax

true 获取原始pjax请求

Returns

bool —

ip()

ip() : string

获取客户端IP地址

Returns

string —

isValidIP()

isValidIP(string  $ip, string  $type = '') : bool

检测是否是合法的IP地址

Parameters

string	$ip	IP地址
string	$type	IP地址类型 (ipv4, ipv6)

Returns

bool —

ip2bin()

ip2bin(string  $ip) : string

将IP地址转换为二进制字符串

Parameters

string

$ip

Returns

string —

isMobile()

isMobile() : bool

检测是否使用手机访问

Returns

bool —

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(bool  $strict = false) : string

当前请求的host

Parameters

bool

setController(string  $controller) : $this

设置当前的控制器名

Parameters

string

$controller

控制器名

Returns

$this —

setAction()

setAction(string  $action) : $this

设置当前的操作名

Parameters

string

$action

操作名

Returns

$this —

controller()

controller(bool  $convert = false) : string

获取当前的控制器名

Parameters

bool

$convert

转换为小写

Returns

string —

action()

action(bool  $convert = false) : string

获取当前的操作名

Parameters

bool

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

生成请求令牌

Parameters

string	$name	令牌名称
mixed	$type	令牌生成方法

Returns

string —

checkToken()

checkToken(string  $token = '__token__', array  $data = []) : bool

检查请求令牌

Parameters

string	$token	令牌名称
array	$data	表单数据

Returns

bool —

withMiddleware()

withMiddleware(array  $middleware) : $this

设置在中间件传递的数据

Parameters

array

$middleware

数据

Returns

$this —

withGet()

withGet(array  $get) : $this

设置GET数据

Parameters

array

$get

数据

Returns

$this —

withPost()

withPost(array  $post) : $this

设置POST数据

Parameters

array

$post

数据

Returns

$this —

withCookie()

withCookie(array  $cookie) : $this

设置COOKIE数据

Parameters

array

$cookie

数据

Returns

$this —

withSession()

withSession(\think\Session  $session) : $this

设置SESSION数据

Parameters

\think\Session

$session

数据

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(\think\Env  $env) : $this

设置ENV数据

Parameters

\think\Env

$env

数据

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 —

withRoute()

withRoute(array  $route) : $this

设置ROUTE变量

Parameters

array

$route

数据

Returns

$this —

__set()

__set(string  $name, mixed  $value) : mixed

设置中间传递数据

Parameters

string	$name	参数名
mixed	$value	值

Returns

mixed —

__get()

__get(string  $name) : mixed

获取中间传递数据的值

Parameters

string

$name

名称

Returns

mixed —

__isset()

__isset(string  $name) : bool

检测中间传递数据的值

Parameters

string

$name

名称

Returns

bool —

offsetExists()

offsetExists(mixed  $name) : bool

Parameters

mixed

$name

Returns

bool —

offsetGet()

offsetGet(mixed  $name) : mixed

Parameters

mixed

$name

Returns

mixed —

offsetSet()

offsetSet(mixed  $name, mixed  $value) : mixed

Parameters

mixed	$name
mixed	$value

Returns

mixed —

offsetUnset()

offsetUnset(mixed  $name) : mixed

Parameters

mixed

$name

Returns

mixed —

getInputData()

getInputData(mixed  $content) : array

Parameters

mixed

$content

Returns

array —

dealUploadFile()

dealUploadFile(array  $files, string  $name) : array

Parameters

array	$files
string	$name

Returns

array —

throwUploadFileError()

throwUploadFileError(mixed  $error) : mixed

Parameters

mixed

$error

Returns

mixed —

filterData()

filterData(mixed  $data, mixed  $filter, mixed  $name, mixed  $default) : mixed

Parameters

mixed	$data
mixed	$filter
mixed	$name
mixed	$default

Returns

mixed —

getData()

getData(array  $data, string  $name, mixed  $default = null) : mixed

获取数据

Parameters

array	$data	数据源
string	$name	字段名
mixed	$default	默认值

Returns

mixed —

getFilter()

getFilter(mixed  $filter, mixed  $default) : array

Parameters

mixed	$filter
mixed	$default

Returns

array —

typeCast()

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

强制类型转换

Parameters

mixed	$data
string	$type

Returns

mixed —