Properties

$alwaysNewInstance

$alwaysNewInstance : bool

始终创建新的对象实例

Type

bool

Methods

instance()

instance(mixed  ...$args) : object

带参数实例化当前Facade类

Parameters

mixed $args variadic

Returns

object —

make()

make(string  $class, array|true  $args = [], bool  $newInstance = false) : object

调用类的实例

Parameters

string $class

类名或者标识

array|true $args

变量

bool $newInstance

是否每次创建新的实例

Returns

object —

__callStatic()

__callStatic(mixed  $method, mixed  $params) : mixed

Parameters

mixed $method
mixed $params

Returns

mixed —

setDomain()

setDomain(string  $domain) : \think\Request

设置当前包含协议的域名

Parameters

string $domain

Returns

\think\Request —

domain()

domain(bool  $port = false) : string

获取当前包含协议的域名

Parameters

bool $port = false

Returns

string —

rootDomain()

rootDomain() : string

获取当前根域名

Returns

string —

setSubDomain()

setSubDomain(string  $domain) : \think\Request

设置当前泛域名的值

Parameters

string $domain

Returns

\think\Request —

subDomain()

subDomain() : string

获取当前子域名

Returns

string —

setPanDomain()

setPanDomain(string  $domain) : \think\Request

设置当前泛域名的值

Parameters

string $domain

Returns

\think\Request —

panDomain()

panDomain() : string

获取当前泛域名的值

Returns

string —

setUrl()

setUrl(string  $url) : \think\Request

设置当前完整URL 包括QUERY_STRING

Parameters

string $url

Returns

\think\Request —

url()

url(bool  $complete = false) : string

获取当前完整URL 包括QUERY_STRING

Parameters

bool $complete = false

Returns

string —

setBaseUrl()

setBaseUrl(string  $url) : \think\Request

设置当前URL 不含QUERY_STRING

Parameters

string $url

Returns

\think\Request —

baseUrl()

baseUrl(bool  $complete = false) : string

获取当前URL 不含QUERY_STRING

Parameters

bool $complete = false

Returns

string —

baseFile()

baseFile(bool  $complete = false) : string

获取当前执行的文件 SCRIPT_NAME

Parameters

bool $complete = false

Returns

string —

setRoot()

setRoot(string  $url) : \think\Request

设置URL访问根地址

Parameters

string $url

Returns

\think\Request —

root()

root(bool  $complete = false) : string

获取URL访问根地址

Parameters

bool $complete = false

Returns

string —

rootUrl()

rootUrl() : string

获取URL访问根目录

Returns

string —

setPathinfo()

setPathinfo(string  $pathinfo) : \think\Request

设置当前请求的pathinfo

Parameters

string $pathinfo

Returns

\think\Request —

pathinfo()

pathinfo() : string

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

Returns

string —

ext()

ext() : string

当前URL的访问后缀

Returns

string —

time()

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

获取当前请求的时间

Parameters

bool $float = false

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) : \think\Request

设置请求类型

Parameters

string $method

Returns

\think\Request —

method()

method(bool  $origin = false) : string

当前的请求类型

Parameters

bool $origin = false

Returns

string —

isGet()

isGet() : bool

是否为GET请求

Returns

bool —

isPost()

isPost() : bool

是否为POST请求

Returns

bool —

isPut()

isPut() : bool

是否为PUT请求

Returns

bool —

isDelete()

isDelete() : bool

是否为DELTE请求

Returns

bool —

isHead()

isHead() : bool

是否为HEAD请求

Returns

bool —

isPatch()

isPatch() : bool

是否为PATCH请求

Returns

bool —

isOptions()

isOptions() : bool

是否为OPTIONS请求

Returns

bool —

isCli()

isCli() : bool

是否为cli

Returns

bool —

isCgi()

isCgi() : bool

是否为cgi

Returns

bool —

param()

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

获取当前请求的参数

Parameters

string|array $name = ''
mixed $default = null
string|array $filter = ''

Returns

mixed —

setRule()

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

设置路由变量

Parameters

\think\route\Rule $rule

Returns

\think\Request —

rule()

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

获取当前路由对象

Returns

\think\route\Rule|null —

setRoute()

setRoute(array  $route) : \think\Request

设置路由变量

Parameters

array $route

Returns

\think\Request —

route()

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

获取路由参数

Parameters

string|array $name = ''
mixed $default = null
string|array $filter = ''

Returns

mixed —

get()

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

获取GET参数

Parameters

string|array $name = ''
mixed $default = null
string|array $filter = ''

Returns

mixed —

middleware()

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

获取中间件传递的参数

Parameters

mixed $name
mixed $default = null

Returns

mixed —

post()

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

获取POST参数

Parameters

string|array $name = ''
mixed $default = null
string|array $filter = ''

Returns

mixed —

put()

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

获取PUT参数

Parameters

string|array $name = ''
mixed $default = null
string|array $filter = ''

Returns

mixed —

delete()

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

设置获取DELETE参数

Parameters

mixed $name = ''
mixed $default = null
string|array $filter = ''

Returns

mixed —

patch()

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

设置获取PATCH参数

Parameters

mixed $name = ''
mixed $default = null
string|array $filter = ''

Returns

mixed —

request()

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

获取request变量

Parameters

string|array $name = ''
mixed $default = null
string|array $filter = ''

Returns

mixed —

env()

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

获取环境变量

Parameters

string $name = ''
string $default = null

Returns

mixed —

session()

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

获取session数据

Parameters

string $name = ''
string $default = null

Returns

mixed —

cookie()

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

获取cookie参数

Parameters

mixed $name = ''
string $default = null
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 = ''
string $default = null

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 = null
string|array $filter = ''

Returns

mixed —

filter()

filter(mixed  $filter = null) : mixed

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

Parameters

mixed $filter = null

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 = 'param'
bool $checkEmpty = false

Returns

bool —

only()

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

获取指定的参数

Parameters

array $name
mixed $data = 'param'
string|array $filter = ''

Returns

array —

except()

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

排除指定参数获取

Parameters

array $name
string $type = 'param'

Returns

mixed —

isSsl()

isSsl() : bool

当前是否ssl

Returns

bool —

isJson()

isJson() : bool

当前是否JSON请求

Returns

bool —

isAjax()

isAjax(bool  $ajax = false) : bool

当前是否Ajax请求

Parameters

bool $ajax = false

Returns

bool —

isPjax()

isPjax(bool  $pjax = false) : bool

当前是否Pjax请求

Parameters

bool $pjax = false

Returns

bool —

ip()

ip() : string

获取客户端IP地址

Returns

string —

isValidIP()

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

检测是否是合法的IP地址

Parameters

string $ip
string $type = ''

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) : \think\Request

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

Parameters

string $host

Returns

\think\Request —

host()

host(bool  $strict = false) : string

当前请求的host

Parameters

bool $strict = false

Returns

string —

port()

port() : int

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

Returns

int —

protocol()

protocol() : string

当前请求 SERVER_PROTOCOL

Returns

string —

remotePort()

remotePort() : int

当前请求 REMOTE_PORT

Returns

int —

contentType()

contentType() : string

当前请求 HTTP_CONTENT_TYPE

Returns

string —

secureKey()

secureKey() : string

获取当前请求的安全Key

Returns

string —

setController()

setController(string  $controller) : \think\Request

设置当前的控制器名

Parameters

string $controller

Returns

\think\Request —

setAction()

setAction(string  $action) : \think\Request

设置当前的操作名

Parameters

string $action

Returns

\think\Request —

controller()

controller(bool  $convert = false) : string

获取当前的控制器名

Parameters

bool $convert = false

Returns

string —

action()

action(bool  $convert = false) : string

获取当前的操作名

Parameters

bool $convert = false

Returns

string —

getContent()

getContent() : string

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

Returns

string —

getInput()

getInput() : string

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

Returns

string —

buildToken()

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

生成请求令牌

Parameters

string $name = '__token__'
mixed $type = 'md5'

Returns

string —

checkToken()

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

检查请求令牌

Parameters

string $token = '__token__'
array $data = []

Returns

bool —

withMiddleware()

withMiddleware(array  $middleware) : \think\Request

设置在中间件传递的数据

Parameters

array $middleware

Returns

\think\Request —

withGet()

withGet(array  $get) : \think\Request

设置GET数据

Parameters

array $get

Returns

\think\Request —

withPost()

withPost(array  $post) : \think\Request

设置POST数据

Parameters

array $post

Returns

\think\Request —

withCookie()

withCookie(array  $cookie) : \think\Request

设置COOKIE数据

Parameters

array $cookie

Returns

\think\Request —

withSession()

withSession(\think\facade\Session  $session) : \think\Request

设置SESSION数据

Parameters

\think\facade\Session $session

Returns

\think\Request —

withServer()

withServer(array  $server) : \think\Request

设置SERVER数据

Parameters

array $server

Returns

\think\Request —

withHeader()

withHeader(array  $header) : \think\Request

设置HEADER数据

Parameters

array $header

Returns

\think\Request —

withEnv()

withEnv(\think\facade\Env  $env) : \think\Request

设置ENV数据

Parameters

\think\facade\Env $env

Returns

\think\Request —

withInput()

withInput(string  $input) : \think\Request

设置php://input数据

Parameters

string $input

Returns

\think\Request —

withFiles()

withFiles(array  $files) : \think\Request

设置文件上传数据

Parameters

array $files

Returns

\think\Request —

withRoute()

withRoute(array  $route) : \think\Request

设置ROUTE变量

Parameters

array $route

Returns

\think\Request —

__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 —

createFacade()

createFacade(string  $class = '', array  $args = [], bool  $newInstance = false) : object

创建Facade实例

Parameters

string $class

类名或标识

array $args

变量

bool $newInstance

是否每次创建新的实例

Returns

object —

getFacadeClass()

getFacadeClass() : string

获取当前Facade对应类名(或者已经绑定的容器对象标识)

Returns

string —