\thinkRequest

Summary

Methods

Properties

Constants

__call()
hook()
instance()
destroy()
create()
domain()
url()
baseUrl()
baseFile()
root()
pathinfo()
path()
ext()
time()
type()
mimeType()
method()
isGet()
isPost()
isPut()
isDelete()
isHead()
isPatch()
isOptions()
isCli()
isCgi()
param()
route()
get()
post()
put()
delete()
patch()
request()
session()
cookie()
server()
file()
env()
header()
input()
filter()
filterExp()
has()
only()
except()
isSsl()
isAjax()
isPjax()
ip()
isMobile()
scheme()
query()
host()
port()
protocol()
remotePort()
contentType()
routeInfo()
dispatch()
module()
controller()
action()
langset()
getContent()
getInput()
token()
cache()
getCache()
bind()
__set()
__get()
__isset()

No public properties found

No constants found

__construct()
getFilter()

$instance
$method
$domain
$url
$baseUrl
$baseFile
$root
$pathinfo
$path
$routeInfo
$env
$dispatch
$module
$controller
$action
$langset
$param
$get
$post
$request
$route
$put
$session
$file
$cookie
$server
$header
$mimeType
$content
$filter
$hook
$bind
$input
$cache
$isCheckCache
$mergeParam

N/A

filterValue()
typeCast()

No private properties found

N/A

File: back/vendor/topthink/framework/library/think/Request.php
Package: Application
Class hierarchy: \think\Request
Uses

Properties

$instance

$instance : object

Type

object — 对象实例

$method

$method

$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

$controller

$controller

$action

$action

$langset

$langset

$param

$param : array

Type

array — 请求参数

$get

$get

$post

$post

$request

$request

$route

$route

$put

$put

$session

$session

$file

$file

$cookie

$cookie

$server

$server

$header

$header

$mimeType

$mimeType : array

Type

array — 资源类型

$content

$content

$filter

$filter

$hook

$hook

$bind

$bind

$input

$input

$cache

$cache

$isCheckCache

$isCheckCache

$mergeParam

$mergeParam : bool

是否合并Param

Type

bool —

Methods

__call()

__call(mixed  $method, mixed  $args) : mixed

Parameters

mixed	$method
mixed	$args

Returns

mixed —

hook()

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

Hook 方法注入

Parameters

string\|array	$method	方法名
mixed	$callback	callable

instance()

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

初始化

Parameters

array

$options

参数

Returns

\think\Request —

destroy()

destroy() : void

销毁当前请求对象

create()

create(string  $uri, string  $method = 'GET', array  $params = [], array  $cookie = [], array  $files = [], array  $server = [], 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

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

获取当前请求的时间

Parameters

bool

$float

是否使用浮点类型

Returns

int|float —

type()

type() : false|string

当前请求的资源类型

Returns

false|string —

mimeType()

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

设置资源类型

Parameters

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

method()

method(bool  $method = 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 —

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 = [], 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', bool  $checkEmpty = false) : mixed

是否存在某个请求参数

Parameters

string	$name	变量名
string	$type	变量类型
bool	$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() : bool

当前是否ssl

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(int  $type, bool  $adv = true) : mixed

获取客户端IP地址

Parameters

int	$type	返回类型 0 返回IP地址 1 返回IPV4地址数字
bool	$adv	是否进行高级模式获取（有可能被伪装）

Returns

mixed —

isMobile()

isMobile() : bool

检测是否使用手机访问

Returns

bool —

scheme()

scheme() : string

当前URL地址中的scheme参数

Returns

string —

query()

query() : string

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

Returns

string —

host()

host(bool  $strict = false) : string

当前请求的host

Parameters

bool

routeInfo(array  $route = []) : 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

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

生成请求令牌

Parameters

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

Returns

string —

cache()

cache(string  $key, mixed  $expire = null, array  $except = [], 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(mixed  $name, mixed  $value) : mixed

Parameters

mixed	$name
mixed	$value

Returns

mixed —

__get()

__get(mixed  $name) : mixed

Parameters

mixed

$name

Returns

mixed —

__isset()

__isset(mixed  $name) : mixed

Parameters

mixed

$name

Returns

mixed —

__construct()

__construct(array  $options = []) : mixed

构造函数

Parameters

array

$options

参数

Returns

mixed —

getFilter()

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

Parameters

mixed	$filter
mixed	$default

Returns

mixed —

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 —