ThinkPHP函数详解：I方法

admin

概述

正如你所见到的一样，I方法是ThinkPHP众多单字母函数中的新成员，其命名来自于英文Input（输入），主要用于更加方便和安全的获取系统输入变量，可以用于任何地方，用法格式如下：
6 v+ z" E# a9 O0 x% j# UI('变量类型.变量名',['默认值'],['过滤方法'])
6 g. T# G( T; M/ r0 W变量类型是指请求方式或者输入类型，包括：

8 @$ ]5 Y/ Y6 ?% U; ]" k( G% D

变量类型	含义
get	获取GET参数
post	获取POST参数
param	自动判断请求类型获取GET、POST或者PUT参数
request	获取REQUEST 参数
put	获取PUT 参数
session	获取 $_SESSION 参数
cookie	获取 $_COOKIE 参数
server	获取 $_SERVER 参数
globals	获取 $GLOBALS参数

注意：变量类型不区分大小写。
6 ^- H. }: W8 A: h变量名则严格区分大小写。
5 U7 J. N% p( Y9 {默认值和过滤方法均属于可选参数。

用法

我们以GET变量类型为例，说明下I方法的使用：

• echo I('get.id'); // 相当于 $_GET['id']
• echo I('get.name'); // 相当于 $_GET['name']
  + E3 A- [. s+ b' l

复制代码
6 z' x9 T- W/ D& F" V5 u

支持默认值：

• echo I('get.id',0); // 如果不存在$_GET['id'] 则返回0
• echo I('get.name',''); // 如果不存在$_GET['name'] 则返回空字符串
  + O4 k  u- ~5 {8 h7 W

复制代码

采用方法过滤：

• echo I('get.name','','htmlspecialchars'); // 采用htmlspecialchars方法对$_GET['name'] 进行过滤，如果不存在则返回空字符串
  1 l" A: ~- h9 Z+ _" Z% d- H

复制代码
- i. n0 c  H3 {; k& J" ]) ]

支持直接获取整个变量类型，例如：

• I('get.'); // 获取整个$_GET 数组
  

复制代码
1 y: q7 h& Q9 j4 ^2 |

用同样的方式，我们可以获取post或者其他输入类型的变量，例如：

• I('post.name','','htmlspecialchars'); // 采用htmlspecialchars方法对$_POST['name'] 进行过滤，如果不存在则返回空字符串
• I('session.user_id',0); // 获取$_SESSION['user_id'] 如果不存在则默认为0
• I('cookie.'); // 获取整个 $_COOKIE 数组
• I('server.REQUEST_METHOD'); // 获取 $_SERVER['REQUEST_METHOD']
  

复制代码
- g) N* ?6 S8 I7 G4 G0 p

param变量类型是框架特有的支持自动判断当前请求类型的变量获取方式，例如：

• echo I('param.id');
  

复制代码
3 ?+ S: R5 `9 q; Y, A- I

如果当前请求类型是GET，那么等效于 $_GET['id']，如果当前请求类型是POST或者PUT，那么相当于获取 $_POST['id'] 或者 PUT参数id。
并且param类型变量还可以用数字索引的方式获取URL参数（必须是PATHINFO模式参数有效，无论是GET还是POST方式都有效），例如：
当前访问URL地址是

• http://serverName/index.php/New/2013/06/01
  

复制代码

那么我们可以通过

• echo I('param.1'); // 输出2013
• echo I('param.2'); // 输出06
• echo I('param.3'); // 输出01
  7 t( l8 H5 U2 v. O9 ?/ j3 ~2 w: W

复制代码
6 @% H- a7 L; S' r8 O+ f, N

事实上，param变量类型的写法可以简化为：

• I('id'); // 等同于 I('param.id')
• I('name'); // 等同于 I('param.name')
  

复制代码
变量过滤

使用I方法的时候 变量其实经过了两道过滤，首先是全局的过滤，全局过滤是通过配置VAR_FILTERS参数，这里一定要注意，3.1版本之后，VAR_FILTERS参数的过滤机制已经更改为采用array_walk_recursive方法递归过滤了，主要对过滤方法的要求是必须引用返回，所以这里设置htmlspecialchars是无效的，你可以自定义一个方法，例如：

• function filter_default(&$value){
•     $value = htmlspecialchars($value);
• }
  

复制代码
+ a7 {- k( g( Z' e8 S! B0 O5 R

然后配置：

• 'VAR_FILTERS'=>'filter_default'
  : n/ `& Q8 L/ t' z  U% ^) t+ I

复制代码

如果需要进行多次过滤，可以用：

• 'VAR_FILTERS'=>'filter_default,filter_exp'
  

复制代码

filter_exp方法是框架内置的安全过滤方法，用于防止利用模型的EXP功能进行注入攻击。

因为VAR_FILTERS参数设置的是全局过滤机制，而且采用的是递归过滤，对效率有所影响，所以，我们更建议直接对获取变量过滤的方式，除了在I方法的第三个参数设置过滤方法外，还可以采用配置DEFAULT_FILTER参数的方式设置过滤，事实上，该参数的默认设置是：

• 'DEFAULT_FILTER'        => 'htmlspecialchars'
  

复制代码
! D2 R! g) {$ U( M; U

也就说，I方法的所有获取变量都会进行htmlspecialchars过滤，那么：

• I('get.name'); // 等同于 htmlspecialchars($_GET['name'])
  7 _' \. I7 d6 w- N7 ]6 I' y

复制代码
" U% x2 @- X& n; i+ @0 _

同样，该参数也可以支持多个过滤，例如：

• 'DEFAULT_FILTER'        => 'strip_tags,htmlspecialchars'
  7 H3 f! l6 t6 m' i) J6 e7 w

复制代码
* V: \( ?! j2 I/ U5 a& @, v; D3 v

• I('get.name'); // 等同于 htmlspecialchars(strip_tags($_GET['name']))
  * T  e+ P5 Q5 V: f: E$ ]) E

复制代码
  V0 i4 Q" K- \2 `( w" \1 e

如果我们在使用I方法的时候 指定了过滤方法，那么就会忽略DEFAULT_FILTER的设置，例如：

• echo I('get.name','','strip_tags'); // 等同于 strip_tags($_GET['name'])
  

复制代码

I方法的第三个参数如果传入函数名，则表示调用该函数对变量进行过滤并返回（在变量是数组的情况下自动使用array_map进行过滤处理），否则会调用PHP内置的filter_var方法进行过滤处理，例如：

• I('post.email','',FILTER_VALIDATE_EMAIL);
  

复制代码

表示 会对$_POST['email'] 进行 格式验证，如果不符合要求的话，返回空字符串。
（关于更多的验证格式，可以参考 官方手册的filter_var用法。）
或者可以用下面的字符标识方式：

• I('post.email','','email');
  & J+ Y: N/ \/ c0 `8 f" Z; d1 k

复制代码
7 Z( q* D7 r7 c( q

可以支持的过滤名称必须是filter_list方法中的有效值（不同的服务器环境可能有所不同），可能支持的包括：

• int
• boolean
• float
• validate_regexp
• validate_url
• validate_email
• validate_ip
• string
• stripped
• encoded
• special_chars
• unsafe_raw
• email
• url
• number_int
• number_float
• magic_quotes
• callback
  - r1 R" ^' {, p

复制代码

在有些特殊的情况下，我们不希望进行任何过滤，即使DEFAULT_FILTER已经有所设置，可以使用：

• I('get.name','',NULL);
  * H; X2 Q7 R& b) }

复制代码

一旦过滤参数设置为NULL，即表示不再进行任何的过滤。