输入变量 · ThinkPHP5.0完全开发手册

## 概述可以通过`Request`对象完成全局输入变量的检测、获取和安全过滤，支持包括`$_GET`、`$_POST`、`$_REQUEST`、`$_SERVER`、`$_SESSION`、`$_COOKIE`、`$_ENV`等系统变量，以及文件上传信息。 ## 检测变量是否设置可以使用`has`方法来检测一个变量参数是否设置，如下： ~~~ Request::instance()->has('id','get'); Request::instance()->has('name','post'); ~~~ 或者使用助手函数 ~~~ input('?get.id'); input('?post.name'); ~~~ 变量检测可以支持所有支持的系统变量。 ## 变量获取变量获取使用`\think\Request`类的如下方法及参数： >[info] ### 变量类型方法('变量名/变量修饰符','默认值','过滤方法') 变量类型方法包括： |方法|描述| |---|---| |param|获取当前请求的变量| |get|获取 $_GET 变量| |post|获取 $_POST 变量| |put|获取 PUT 变量| |delete|获取 DELETE 变量| |session|获取 $_SESSION 变量| |cookie|获取 $_COOKIE 变量| |request|获取 $_REQUEST 变量| |server|获取 $_SERVER 变量| |env|获取 $_ENV 变量| |route|获取路由（包括PATHINFO）变量| |file|获取 $_FILES 变量| ### 获取`PARAM`变量 PARAM变量是框架提供的用于自动识别`GET`、`POST`或者`PUT`请求的一种变量获取方式，是系统推荐的获取请求参数的方法，用法如下： ~~~ // 获取当前请求的name变量 Request::instance()->param('name'); // 获取当前请求的所有变量（经过过滤） Request::instance()->param(); // 获取当前请求的所有变量（原始数据） Request::instance()->param(false); // 获取当前请求的所有变量（包含上传文件） Request::instance()->param(true); ~~~ > param方法会把当前请求类型的参数和PATH_INFO变量以及GET请求合并。使用助手函数实现： ~~~ input('param.name'); input('param.'); 或者 input('name'); input(''); ~~~ 因为`input`函数默认就采用PARAM变量读取方式。 ### 获取`GET`变量 ~~~ Request::instance()->get('id'); // 获取某个get变量 Request::instance()->get('name'); // 获取get变量 Request::instance()->get(); // 获取所有的get变量（经过过滤的数组） Request::instance()->get(false); // 获取所有的get变量（原始数组） ~~~ 或者使用内置的助手函数`input`方法实现相同的功能： ~~~ input('get.id'); input('get.name'); input('get.'); ~~~ > 注：pathinfo地址参数不能通过get方法获取，查看“获取PARAM变量” ### 获取`POST`变量 ~~~ Request::instance()->post('name'); // 获取某个post变量 Request::instance()->post(); // 获取经过过滤的全部post变量 Request::instance()->post(false); // 获取全部的post原始变量 ~~~ 使用助手函数实现： ~~~ input('post.name'); input('post.'); ~~~ ### 获取`PUT`变量 ~~~ Request::instance()->put('name'); // 获取某个put变量 Request::instance()->put(); // 获取全部的put变量（经过过滤） Request::instance()->put(false); // 获取全部的put原始变量 ~~~ 使用助手函数实现： ~~~ input('put.name'); input('put.'); ~~~ ### 获取`REQUEST`变量 ~~~ Request::instance()->request('id'); // 获取某个request变量 Request::instance()->request(); // 获取全部的request变量（经过过滤） Request::instance()->request(false); // 获取全部的request原始变量数据 ~~~ 使用助手函数实现： ~~~ input('request.id'); input('request.'); ~~~ ### 获取`SERVER`变量 ~~~ Request::instance()->server('PHP_SELF'); // 获取某个server变量 Request::instance()->server(); // 获取全部的server变量 ~~~ 使用助手函数实现： ~~~ input('server.PHP_SELF'); input('server.'); ~~~ ### 获取`SESSION`变量 ~~~ Request::instance()->session('user_id'); // 获取某个session变量 Request::instance()->session(); // 获取全部的session变量 ~~~ 使用助手函数实现： ~~~ input('session.user_id'); input('session.'); ~~~ ### 获取`Cookie`变量 ~~~ Request::instance()->cookie('user_id'); // 获取某个cookie变量 Request::instance()->cookie(); // 获取全部的cookie变量 ~~~ 使用助手函数实现： ~~~ input('cookie.user_id'); input('cookie.'); ~~~ ## 变量过滤 >[danger] 框架默认没有设置任何过滤规则，你可以是配置文件中设置全局的过滤规则： ~~~ // 默认全局过滤方法用逗号分隔多个 'default_filter' => 'htmlspecialchars', ~~~ 也支持使用`Request`对象进行全局变量的获取过滤，过滤方式包括函数、方法过滤，以及PHP内置的Types of filters，我们可以设置全局变量过滤方法，例如： ~~~ Request::instance()->filter('htmlspecialchars'); ~~~ 支持设置多个过滤方法，例如： ~~~ Request::instance()->filter(['strip_tags','htmlspecialchars']), ~~~ 也可以在获取变量的时候添加过滤方法，例如： ~~~ Request::instance()->get('name','','htmlspecialchars'); // 获取get变量并用htmlspecialchars函数过滤 Request::instance()->param('username','','strip_tags'); // 获取param变量并用strip_tags函数过滤 Request::instance()->post('name','','org\Filter::safeHtml'); // 获取post变量并用org\Filter类的safeHtml方法过滤 ~~~ 可以支持传入多个过滤规则，例如： ~~~ Request::instance()->param('username','','strip_tags,strtolower'); // 获取param变量并依次调用strip_tags、strtolower函数过滤 ~~~ Request对象还支持PHP内置提供的Filter ID过滤，例如： ~~~ Request::instance()->post('email','',FILTER_VALIDATE_EMAIL); ~~~ 框架对FilterID做了转换支持，因此也可以使用字符串的方式，例如： ~~~ Request::instance()->post('email','','email'); ~~~ 采用字符串方式定义`FilterID`的时候，系统会自动进行一次`filter_id`调用转换成`Filter`常量。具体的字符串根据`filter_list`函数的返回值来定义。 > 需要注意的是，采用Filter ID 进行过滤的话，如果不符合过滤要求的话会返回false，因此你需要配合默认值来确保最终的值符合你的规范。例如， ~~~ Request::instance()->post('email','',FILTER_VALIDATE_EMAIL); ~~~ 就表示，如果不是规范的email地址的话返回空字符串。如果当前不需要进行任何过滤的话，可以使用（`V5.0.3+`版本） ~~~ // 获取get变量并且不进行任何过滤即使设置了全局过滤 Request::instance()->get('name','',null); ~~~ ## 获取部分变量如果你只需要获取当前请求的部分参数，可以使用： ~~~ // 只获取当前请求的id和name变量 Request::instance()->only('id,name'); ~~~ 或者使用数组方式 ~~~ // 只获取当前请求的id和name变量 Request::instance()->only(['id','name']); ~~~ 默认获取的是当前请求参数，如果需要获取其它类型的参数，可以使用第二个参数，例如： ~~~ // 只获取GET请求的id和name变量 Request::instance()->only(['id','name'],'get'); // 只获取POST请求的id和name变量 Request::instance()->only(['id','name'],'post'); ~~~ ## 排除部分变量也支持排除某些变量获取，例如 ~~~ // 排除id和name变量 Request::instance()->except('id,name'); ~~~ 或者使用数组方式 ~~~ // 排除id和name变量 Request::instance()->except(['id','name']); ~~~ 同样支持指定变量类型获取： ~~~ // 排除GET请求的id和name变量 Request::instance()->except(['id','name'],'get'); // 排除POST请求的id和name变量 Request::instance()->except(['id','name'],'post'); ~~~ ## 变量修饰符 `input`函数支持对变量使用修饰符功能，可以更好的过滤变量。用法如下： >[info] ### input('变量类型.变量名/修饰符'); 或者 >[info] ### Request::instance()->变量类型('变量名/修饰符'); 例如： ~~~ input('get.id/d'); input('post.name/s'); input('post.ids/a'); Request::instance()->get('id/d'); ~~~ ThinkPHP5.0版本默认的变量修饰符是`/s`，如果需要传入字符串之外的变量可以使用下面的修饰符，包括： | 修饰符 | 作用 | | --- | --- | | s | 强制转换为字符串类型 | | d | 强制转换为整型类型 | | b | 强制转换为布尔类型 | | a | 强制转换为数组类型 | | f | 强制转换为浮点类型 | >[danger] 如果你要获取的数据为数组，请一定注意要加上 `/a` 修饰符才能正确获取到。