ThinkPHP5


think\Request
library\think\Request.php at line 19

Class Request

Request

public class Request


Constructor Summary
mixed

__construct(string name, string default, string|array filter)

获取request变量

Method Summary
static void

hook(string|array method, mixed callback)

Hook 方法注入

static \think\Request

instance(array options)

初始化

static \think\Request

create(string uri, string method, array params, array cookie, array files, array server, string content)

创建一个URL请求

string

domain(string domain)

获取当前包含协议的域名

string

url(string|true url)

获取当前完整URL 包括QUERY_STRING

string

baseUrl(string url)

获取当前URL 不含QUERY_STRING

string

baseFile(string file)

获取当前执行的文件 SCRIPT_NAME

string

root(string url)

获取URL访问根地址

string

pathinfo()

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

string

path()

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

string

ext()

当前URL的访问后缀

integer|float

time(bool float)

获取当前请求的时间

false|string

type()

当前请求的资源类型

void

mimeType(string|array type, string val)

设置资源类型

string

method(bool method)

当前的请求类型

bool

isGet()

是否为GET请求

bool

isPost()

是否为POST请求

bool

isPut()

是否为PUT请求

bool

isDelete()

是否为DELTE请求

bool

isHead()

是否为HEAD请求

bool

isPatch()

是否为PATCH请求

bool

isOptions()

是否为OPTIONS请求

bool

isCli()

是否为cli

bool

isCgi()

是否为cgi

mixed

param(string|array name, mixed default, string|array filter)

设置获取获取当前请求的参数

mixed

route(string|array name, mixed default, string|array filter)

设置获取获取路由参数

mixed

get(string|array name, mixed default, string|array filter)

设置获取获取GET参数

mixed

post(string name, mixed default, string|array filter)

设置获取获取POST参数

mixed

put(string|array name, mixed default, string|array filter)

设置获取获取PUT参数

mixed

delete(string|array name, mixed default, string|array filter)

设置获取获取DELETE参数

mixed

patch(string|array name, mixed default, string|array filter)

设置获取获取PATCH参数

mixed

session(string|array name, string default, string|array filter)

获取session数据

mixed

cookie(string|array name, string default, string|array filter)

获取cookie参数

mixed

server(string|array name, string default, string|array filter)

获取server参数

null|array|\think\File

file(string|array name)

获取上传的文件信息

mixed

env(string|array name, string default, string|array filter)

获取环境变量

string

header(string|array name, string default)

设置或者获取当前的Header

mixed

input(array data, string|false name, mixed default, string|array filter)

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

mixed

filter(mixed filter)

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

void

filterExp(string value)

过滤表单中的表达式

mixed

has(string name, string type, bool checkEmpty)

是否存在某个请求参数

mixed

only(string|array name, string type)

获取指定的参数

mixed

except(string|array name, string type)

排除指定参数获取

bool

isSsl()

当前是否ssl

bool

isAjax(bool ajax)

当前是否Ajax请求

bool

isPjax(bool pjax)

当前是否Pjax请求

mixed

ip(integer type, boolean adv)

获取客户端IP地址

static bool

isMobile()

检测是否使用手机访问

string

scheme()

当前URL地址中的scheme参数

string

query()

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

string

host()

当前请求的host

integer

port()

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

integer

protocol()

当前请求 SERVER_PROTOCOL

integer

remotePort()

当前请求 REMOTE_PORT

array

routeInfo(array route)

获取当前请求的路由信息

array

dispatch(array dispatch)

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

string|$this

module(string module)

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

string|$this

controller(string controller)

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

string

action(string action)

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

string

langset(string lang)

设置或者获取当前的语言

string

getContent()

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

string

getInput()

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

string

token(string name, mixed type)

生成请求令牌

mixed

cache(string key, mixed expire)

读取或者设置缓存

array

getCache()

读取缓存设置

mixed

bind(string name, mixed obj)

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

Constructor Detail

library\think\Request.php at line 740

__construct

public mixed __construct(string name, string default, string|array filter)

获取request变量

Parameters:
name - 数据名称
default - 默认值
filter - 过滤方法

Method Detail

library\think\Request.php at line 146

hook

public static void hook(string|array method, mixed callback)

Hook 方法注入

Parameters:
method - 方法名
callback - callable

library\think\Request.php at line 161

instance

public static \think\Request instance(array options)

初始化

Parameters:
options - 参数

library\think\Request.php at line 181

create

public static \think\Request create(string uri, string method, array params, array cookie, array files, array server, string content)

创建一个URL请求

Parameters:
uri - URL地址
method - 请求类型
params - 请求参数

library\think\Request.php at line 248

domain

public string domain(string domain)

获取当前包含协议的域名

Parameters:
domain - 域名

library\think\Request.php at line 265

url

public string url(string|true url)

获取当前完整URL 包括QUERY_STRING

Parameters:
url - URL地址 true 带域名获取

library\think\Request.php at line 292

baseUrl

public string baseUrl(string url)

获取当前URL 不含QUERY_STRING

Parameters:
url - URL地址

library\think\Request.php at line 310

baseFile

public string baseFile(string file)

获取当前执行的文件 SCRIPT_NAME

Parameters:
file - 当前执行的文件

library\think\Request.php at line 342

root

public string root(string url)

获取URL访问根地址

Parameters:
url - URL地址

library\think\Request.php at line 362

pathinfo

public string pathinfo()

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


library\think\Request.php at line 394

path

public string path()

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


library\think\Request.php at line 418

ext

public string ext()

当前URL的访问后缀


library\think\Request.php at line 429

time

public integer|float time(bool float)

获取当前请求的时间

Parameters:
float - 是否使用浮点类型

library\think\Request.php at line 439

type

public false|string type()

当前请求的资源类型


library\think\Request.php at line 464

mimeType

public void mimeType(string|array type, string val)

设置资源类型

Parameters:
type - 资源类型名
val - 资源类型

library\think\Request.php at line 479

method

public string method(bool method)

当前的请求类型

Parameters:
method - true 获取原始请求类型

library\think\Request.php at line 502

isGet

public bool isGet()

是否为GET请求


library\think\Request.php at line 512

isPost

public bool isPost()

是否为POST请求


library\think\Request.php at line 522

isPut

public bool isPut()

是否为PUT请求


library\think\Request.php at line 532

isDelete

public bool isDelete()

是否为DELTE请求


library\think\Request.php at line 542

isHead

public bool isHead()

是否为HEAD请求


library\think\Request.php at line 552

isPatch

public bool isPatch()

是否为PATCH请求


library\think\Request.php at line 562

isOptions

public bool isOptions()

是否为OPTIONS请求


library\think\Request.php at line 572

isCli

public bool isCli()

是否为cli


library\think\Request.php at line 582

isCgi

public bool isCgi()

是否为cgi


library\think\Request.php at line 595

param

public mixed param(string|array name, mixed default, string|array filter)

设置获取获取当前请求的参数

Parameters:
name - 变量名
default - 默认值
filter - 过滤方法

library\think\Request.php at line 632

route

public mixed route(string|array name, mixed default, string|array filter)

设置获取获取路由参数

Parameters:
name - 变量名
default - 默认值
filter - 过滤方法

library\think\Request.php at line 649

get

public mixed get(string|array name, mixed default, string|array filter)

设置获取获取GET参数

Parameters:
name - 变量名
default - 默认值
filter - 过滤方法

library\think\Request.php at line 669

post

public mixed post(string name, mixed default, string|array filter)

设置获取获取POST参数

Parameters:
name - 变量名
default - 默认值
filter - 过滤方法

library\think\Request.php at line 689

put

public mixed put(string|array name, mixed default, string|array filter)

设置获取获取PUT参数

Parameters:
name - 变量名
default - 默认值
filter - 过滤方法

library\think\Request.php at line 715

delete

public mixed delete(string|array name, mixed default, string|array filter)

设置获取获取DELETE参数

Parameters:
name - 变量名
default - 默认值
filter - 过滤方法

library\think\Request.php at line 728

patch

public mixed patch(string|array name, mixed default, string|array filter)

设置获取获取PATCH参数

Parameters:
name - 变量名
default - 默认值
filter - 过滤方法

library\think\Request.php at line 760

session

public mixed session(string|array name, string default, string|array filter)

获取session数据

Parameters:
name - 数据名称
default - 默认值
filter - 过滤方法

library\think\Request.php at line 779

cookie

public mixed cookie(string|array name, string default, string|array filter)

获取cookie参数

Parameters:
name - 数据名称
default - 默认值
filter - 过滤方法

library\think\Request.php at line 798

server

public mixed server(string|array name, string default, string|array filter)

获取server参数

Parameters:
name - 数据名称
default - 默认值
filter - 过滤方法

library\think\Request.php at line 815

file

public null|array|\think\File file(string|array name)

获取上传的文件信息

Parameters:
name - 名称

library\think\Request.php at line 876

env

public mixed env(string|array name, string default, string|array filter)

获取环境变量

Parameters:
name - 数据名称
default - 默认值
filter - 过滤方法

library\think\Request.php at line 894

header

public string header(string|array name, string default)

设置或者获取当前的Header

Parameters:
name - header名称
default - 默认值

library\think\Request.php at line 935

input

public mixed input(array data, string|false name, mixed default, string|array filter)

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

Parameters:
data - 数据源
name - 字段名
default - 默认值
filter - 过滤函数

library\think\Request.php at line 991

filter

public mixed filter(mixed filter)

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

Parameters:
filter - 过滤规则

library\think\Request.php at line 1041

filterExp

public void filterExp(string value)

过滤表单中的表达式


library\think\Request.php at line 1094

has

public mixed has(string name, string type, bool checkEmpty)

是否存在某个请求参数

Parameters:
name - 变量名
type - 变量类型
checkEmpty - 是否检测空值

library\think\Request.php at line 1119

only

public mixed only(string|array name, string type)

获取指定的参数

Parameters:
name - 变量名
type - 变量类型

library\think\Request.php at line 1141

except

public mixed except(string|array name, string type)

排除指定参数获取

Parameters:
name - 变量名
type - 变量类型

library\think\Request.php at line 1160

isSsl

public bool isSsl()

当前是否ssl


library\think\Request.php at line 1181

isAjax

public bool isAjax(bool ajax)

当前是否Ajax请求

Parameters:
ajax - true 获取原始ajax请求

library\think\Request.php at line 1198

isPjax

public bool isPjax(bool pjax)

当前是否Pjax请求

Parameters:
pjax - true 获取原始pjax请求

library\think\Request.php at line 1214

ip

public mixed ip(integer type, boolean adv)

获取客户端IP地址

Parameters:
type - 返回类型 0 返回IP地址 1 返回IPV4地址数字
adv - 是否进行高级模式获取(有可能被伪装)

library\think\Request.php at line 1250

isMobile

public static bool isMobile()

检测是否使用手机访问


library\think\Request.php at line 1270

scheme

public string scheme()

当前URL地址中的scheme参数


library\think\Request.php at line 1280

query

public string query()

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


library\think\Request.php at line 1290

host

public string host()

当前请求的host


library\think\Request.php at line 1300

port

public integer port()

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


library\think\Request.php at line 1310

protocol

public integer protocol()

当前请求 SERVER_PROTOCOL


library\think\Request.php at line 1320

remotePort

public integer remotePort()

当前请求 REMOTE_PORT


library\think\Request.php at line 1331

routeInfo

public array routeInfo(array route)

获取当前请求的路由信息

Parameters:
route - 路由名称

library\think\Request.php at line 1346

dispatch

public array dispatch(array dispatch)

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

Parameters:
dispatch - 调度信息

library\think\Request.php at line 1360

module

public string|$this module(string module)

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

Parameters:
module - 模块名

library\think\Request.php at line 1376

controller

public string|$this controller(string controller)

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

Parameters:
controller - 控制器名

library\think\Request.php at line 1392

action

public string action(string action)

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

Parameters:
action - 操作名

library\think\Request.php at line 1408

langset

public string langset(string lang)

设置或者获取当前的语言

Parameters:
lang - 语言名

library\think\Request.php at line 1423

getContent

public string getContent()

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


library\think\Request.php at line 1436

getInput

public string getInput()

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


library\think\Request.php at line 1448

token

public string token(string name, mixed type)

生成请求令牌

Parameters:
name - 令牌名称
type - 令牌生成方法

library\think\Request.php at line 1466

cache

public mixed cache(string key, mixed expire)

读取或者设置缓存

Parameters:
key - 缓存标识,支持变量规则 ,例如 item/:name/:id
expire - 缓存有效期

library\think\Request.php at line 1507

getCache

public array getCache()

读取缓存设置


library\think\Request.php at line 1519

bind

public mixed bind(string name, mixed obj)

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

Parameters:
name - 绑定的对象标识
obj - 绑定的对象实例

ThinkPHP5