ThinkPHP I()函数详解

本文转载http://www.thinkphp.cn/topic/14132.html

/**
 * 获取输入参数 支持过滤和默认值
 * 使用方法:
 * <code>
 * I('id',0); 获取id参数 自动判断get或者post
 * I('post.name','','htmlspecialchars'); 获取$_POST['name']
 * I('get.'); 获取$_GET
 * </code>
 * @param string $name 变量的名称 支持指定类型
 * @param mixed $default 不存在的时候默认值
 * @param mixed $filter 参数过滤方法
 * @return mixed
 */
function I($name,$default='',$filter=null) {
    if(strpos($name,'.')) { // 指定参数来源
        //判断参数$name中是否包括.号
        list($method,$name) =   explode('.',$name,2);
        //如果包括.号将.号前后分隔，并且分别赋值给$method以及$name
    }else{ // 默认为自动判断
        //如果没有.号
        $method =   'param';
    }
    switch(strtolower($method)) {//将$method转换为小写
        //如果$method为get，则$input为$_GET
        case 'get'     :   $input =& $_GET;break;
        //如果$method为get，则$input为$_POST
        case 'post'    :   $input =& $_POST;break;
        //如果为put，则将post的原始数据转参数给$input
        case 'put'     :   parse_str(file_get_contents('php://input'), $input);break;
        //如果是param
        case 'param'   :
            //判断$_SERVER['REQUEST_METHOD']
            switch($_SERVER['REQUEST_METHOD']) {
                //如果为post，则$input的内容为$_POST的内容
                case 'POST':
                    $input  =  $_POST;
                    break;
                //如果为PUT.则input的内容为PUT的内容
                case 'PUT':
                    parse_str(file_get_contents('php://input'), $input);
                    break;
                //默认为$_GET的内容
                default:
                    $input  =  $_GET;
            }
            break;
        //如果$method为request，则$input为$_REQUEST
        case 'request' :   $input =& $_REQUEST;   break;
        //如果$method为session，则$input为$_SESSION
        case 'session' :   $input =& $_SESSION;   break;
        //如果$method为cookie，则$input为$_COOKIE
        case 'cookie'  :   $input =& $_COOKIE;    break;
        //如果$method为server，则$input为$_SERVER
        case 'server'  :   $input =& $_SERVER;    break;
        //如果$method为globals，则$input为$GLOBALS
        case 'globals' :   $input =& $GLOBALS;    break;
        //默认返回空
        default:
            return NULL;
    }
    /**
     * 到此为止，已经根据传入的参数的需要（第一个参数.号前面的），把所有的变量都取到了。下面就是返回变量的内容了。
    **/
    //如果$name为空，也就是I()第一个参数的.号后面为空的时候
    if(empty($name)) { // 获取全部变量
        //获取到的变量$input全部复制给$data
        $data       =   $input;
        //array_walk_recursive — 对数组中的每个成员递归地应用用户函数
        //将$data的键值作为filter_exp函数的第一个参数，键名作为第二个参数
        //如果$data的键值中含有or或者exp这两个字符，自动在后面加一个空格
        array_walk_recursive($data,'filter_exp');
        //判断过滤参数是否有，如果有的话，就直接使用过滤方法，如果没有的话，就使用配置中的过滤方法
        $filters    =   isset($filter)?$filter:C('DEFAULT_FILTER');
        if($filters) {
            $filters    =   explode(',',$filters);
            //将过滤参数中的每个方法都应用到$data中
            foreach($filters as $filter){
                //将$data的每个值使用$filters过滤
                $data   =   array_map_recursive($filter,$data); // 参数过滤
            }
        }
    }elseif(isset($input[$name])) { // 取值操作
        $data       =   $input[$name];
        is_array($data) && array_walk_recursive($data,'filter_exp');
        $filters    =   isset($filter)?$filter:C('DEFAULT_FILTER');
        if($filters) {
            $filters    =   explode(',',$filters);
            foreach($filters as $filter){
                if(function_exists($filter)) {
                    $data   =   is_array($data)?array_map_recursive($filter,$data):$filter($data); // 参数过滤
                }else{
                    $data   =   filter_var($data,is_int($filter)?$filter:filter_id($filter));
                    if(false === $data) {
                        return   isset($default)?$default:NULL;
                    }
                }
            }
        }
    }else{ // 变量默认值
        $data       =    isset($default)?$default:NULL;
    }
    return $data;
}